net.liftweb.wizard

Wizard

trait Wizard extends StatefulSnippet with Factory with ScreenWizardRendered

A wizard allows you to create a multi-screen set of input forms with back-button support and state support

linear super types: ScreenWizardRendered, Factory, SimpleInjector, Injector, StatefulSnippet, DispatchSnippet, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Wizard
  2. ScreenWizardRendered
  3. Factory
  4. SimpleInjector
  5. Injector
  6. StatefulSnippet
  7. DispatchSnippet
  8. AnyRef
  9. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. type DispatchIt = PartialFunction[String, (NodeSeq) ⇒ NodeSeq]

    definition classes: DispatchSnippet
  2. class FactoryMaker [T] extends StackableMaker[T] with Vendor[T]

    Create an object or val that is a subclass of the FactoryMaker to generate factory for a particular class as well as define session and request specific vendors and use doWith to define the vendor just for the scope of the call.

  3. class Inject [T] extends StackableMaker[T] with Vendor[T]

    Create an object or val that is a subclass of the FactoryMaker to generate factory for a particular class as well as define session and request specific vendors and use doWith to define the vendor just for the scope of the call.

  4. trait Screen extends AbstractScreen

    Define a screen within this wizard

  5. trait Snapshot extends AnyRef

    attributes: protected
  6. class WizardSnapshot extends Snapshot

  7. class WizardVar [T] extends NonCleanAnyVar[T]

    Keep request-local information around without the nastiness of naming session variables or the type-unsafety of casting the results.

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. object AjaxOnDone extends WizardVar[JsCmd]

    What to do when the Screen is done.

  9. object Ajax_? extends WizardVar[Boolean]

    attributes: protected
    definition classes: WizardScreenWizardRendered
  10. object CurrentScreen extends WizardVar[Box[Screen]]

    attributes: protected
  11. object FormGUID extends WizardVar[String]

    A unique GUID for the form.

  12. object OnFirstScreen extends TransientRequestVar[Boolean]

    attributes: protected
  13. object Referer extends WizardVar[String]

    attributes: protected
    definition classes: WizardScreenWizardRendered
  14. object VisitedScreens extends WizardVar[Vector[Screen]]

    attributes: protected
  15. object _defaultXml extends TransientRequestVar[NodeSeq]

    Holds the template passed via the snippet for the duration of the request

  16. def addName (name: String) : Unit

    definition classes: StatefulSnippet
  17. def ajaxForms_? : Boolean

    Are the forms Ajax or regular HTTP/HTML.

    Are the forms Ajax or regular HTTP/HTML.

    If the ajax=true attribute is present on the original snippet invocation, the forms will be ajax.

    attributes: protected
    definition classes: ScreenWizardRendered
  18. def allTemplate : NodeSeq

    attributes: protected
    definition classes: WizardScreenWizardRendered
  19. def allTemplateNodeSeq : NodeSeq

    attributes: protected
    definition classes: ScreenWizardRendered
  20. def allTemplatePath : List[String]

    attributes: protected
  21. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  22. def calcAjax : Boolean

    Calculate if this Screen/Wizard should be ajax

    Calculate if this Screen/Wizard should be ajax

    attributes: protected
    definition classes: ScreenWizardRendered
  23. def calcAjaxOnDone : JsCmd

    What should be done at the end of an Ajax session.

    What should be done at the end of an Ajax session. By default, RedirectTo(Referer.get)

    attributes: protected
    definition classes: ScreenWizardRendered
  24. def calcFirstScreen : Box[Screen]

    What's the first screen in this wizard

    What's the first screen in this wizard

  25. def calcReferer : String

    Calculate the referer (the page to go back to on finish).

    Calculate the referer (the page to go back to on finish). defaults to S.referer openOr "/"

    attributes: protected
    definition classes: ScreenWizardRendered
  26. def calcScreenAfter (which: Screen) : Box[Screen]

    Given the current screen, what's the next screen?

    Given the current screen, what's the next screen?

  27. def cancelButton : Elem

  28. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  29. def createSnapshot : WizardSnapshot

    definition classes: WizardScreenWizardRendered
  30. def currentScreen : Box[Screen]

  31. def dbConnections : List[ConnectionIdentifier]

  32. def defaultToAjax_? : Boolean

    Should all instances of this Wizard or Screen unless they are explicitly set to Ajax

    Should all instances of this Wizard or Screen unless they are explicitly set to Ajax

    attributes: protected
    definition classes: ScreenWizardRendered
  33. def defaultXml : NodeSeq

    the NodeSeq passed as a parameter when the snippet was invoked

    the NodeSeq passed as a parameter when the snippet was invoked

    attributes: protected
  34. def dispatch : PartialFunction[String, (NodeSeq) ⇒ NodeSeq]

    definition classes: WizardDispatchSnippet
  35. implicit def elemInABox (in: Elem) : Box[Elem]

    attributes: implicit
  36. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  37. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  38. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  39. def finish () : Unit

    This method will be called within a transactional block when the last screen is completed

    This method will be called within a transactional block when the last screen is completed

    attributes: protected abstract
  40. def finishButton : Elem

  41. def formAttrs : MetaData

    What additional attributes should be put on the

    What additional attributes should be put on the

    attributes: protected
  42. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  43. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  44. implicit def inject [T] (implicit man: Manifest[T]) : Box[T]

    Perform the injection for the given type.

    Perform the injection for the given type. You can call: inject[Date] or inject[List[Map[String, PaymentThing]]]. The appropriate Manifest will be

    attributes: implicit
    definition classes: SimpleInjectorInjector
  45. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  46. def link (to: String, func: () ⇒ Any, body: NodeSeq, attrs: ElemAttr*) : Elem

    create an anchor tag around a body

    create an anchor tag around a body

    func

    - the function to invoke when the link is clicked

    body

    - the NodeSeq to wrap in the anchor tag

    definition classes: StatefulSnippet
  47. def localSetup () : Unit

    Override this method to do setup the first time the screen is entered

    Override this method to do setup the first time the screen is entered

    attributes: protected
  48. def names : Set[String]

    definition classes: StatefulSnippet
  49. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  50. def nextButton : Elem

  51. def nextScreen () : JsCmd

  52. def noticeTypeToAttr (screen: AbstractScreen) : Box[(Value) ⇒ MetaData]

    definition classes: WizardScreenWizardRendered
  53. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  54. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  55. def onConfirm_? : Boolean

    By default, are all the fields on all the screen in this wizard on the confirm screen?

    By default, are all the fields on all the screen in this wizard on the confirm screen?

  56. def prevButton : Elem

  57. def prevScreen () : JsCmd

  58. def redirectBack () : JsCmd

    attributes: protected
    definition classes: ScreenWizardRendered
  59. def redirectTo (where: String) : Nothing

    definition classes: StatefulSnippet
  60. def registerInjection [T] (f: () ⇒ T)(implicit man: Manifest[T]) : Unit

    Register a function that will inject for the given Manifest

    Register a function that will inject for the given Manifest

    definition classes: SimpleInjector
  61. def registerThisSnippet () : Unit

    definition classes: StatefulSnippet
  62. def renderAll (currentScreenNumber: Box[NodeSeq], screenCount: Box[NodeSeq], wizardTop: Box[Elem], screenTop: Box[Elem], fields: List[ScreenFieldInfo], prev: Box[Elem], cancel: Box[Elem], next: Box[Elem], finish: Box[Elem], screenBottom: Box[Elem], wizardBottom: Box[Elem], nextId: (String, () ⇒ JsCmd), prevId: Box[(String, () ⇒ JsCmd)], cancelId: (String, () ⇒ JsCmd), theScreen: AbstractScreen, ajax_?: Boolean) : NodeSeq

    attributes: protected
    definition classes: ScreenWizardRendered
  63. def renderHtml () : NodeSeq

    attributes: protected
  64. lazy val screenCount : Int

  65. def screens : List[Screen]

    The ordered list of Screens

    The ordered list of Screens

  66. def submitOrAjax (id: String) : String

    attributes: protected
  67. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  68. def toForm : NodeSeq

  69. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  70. def unregisterThisSnippet () : Unit

    definition classes: StatefulSnippet
  71. def vendAVar [T] (dflt: ⇒ T) : NonCleanAnyVar[T]

    attributes: protected
  72. def vendForm [T] (implicit man: Manifest[T]) : Box[(T, (T) ⇒ Any) ⇒ NodeSeq]

    attributes: protected
  73. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  74. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  75. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  76. def wizardBottom : Box[Elem]

    attributes: protected
  77. def wizardTop : Box[Elem]

    attributes: protected
  78. def wrapInDiv (in: NodeSeq) : Elem

    attributes: protected
    definition classes: ScreenWizardRendered

Inherited from ScreenWizardRendered

Inherited from Factory

Inherited from SimpleInjector

Inherited from Injector

Inherited from StatefulSnippet

Inherited from DispatchSnippet

Inherited from AnyRef

Inherited from Any