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 Supertypes
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

Type Members

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

    Definition Classes
    DispatchSnippet
  2. abstract 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. abstract 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. abstract 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.

Abstract Value Members

  1. abstract 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

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. object AjaxOnDone extends WizardVar[JsCmd]

    What to do when the Screen is done.

  7. object Ajax_? extends WizardVar[Boolean]

    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  8. object CurrentScreen extends WizardVar[Box[Screen]]

    Attributes
    protected
  9. object FormGUID extends WizardVar[String]

    A unique GUID for the form.

  10. object OnFirstScreen extends TransientRequestVar[Boolean]

    Attributes
    protected
  11. object Referer extends WizardVar[String]

    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  12. object VisitedScreens extends WizardVar[Vector[Screen]]

    Attributes
    protected
  13. object _defaultXml extends TransientRequestVar[NodeSeq]

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

  14. def addName(name: String): Unit

    Definition Classes
    StatefulSnippet
  15. 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
  16. def allTemplate: NodeSeq

    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  17. def allTemplateNodeSeq: NodeSeq

    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  18. def allTemplatePath: List[String]

    Attributes
    protected
  19. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  20. def calcAjax: Boolean

    Calculate if this Screen/Wizard should be ajax

    Calculate if this Screen/Wizard should be ajax

    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  21. 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
  22. def calcFirstScreen: Box[Screen]

    What's the first screen in this wizard

  23. 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
  24. def calcScreenAfter(which: Screen): Box[Screen]

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

  25. def cancelButton: Elem

  26. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  27. def createSnapshot: WizardSnapshot

    Definition Classes
    WizardScreenWizardRendered
  28. def currentScreen: Box[Screen]

  29. def dbConnections: List[ConnectionIdentifier]

  30. def defaultToAjax_?: Boolean

    Should all instances of this Wizard or Screen default to Ajax when not explicitly set

    Should all instances of this Wizard or Screen default to Ajax when not explicitly set

    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  31. 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
  32. def dispatch: PartialFunction[String, (NodeSeq) ⇒ NodeSeq]

    Definition Classes
    WizardDispatchSnippet
  33. implicit def elemInABox(in: Elem): Box[Elem]

  34. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  36. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  37. def finishButton: Elem

  38. def formAttrs: MetaData

    What additional attributes should be put on the

    What additional attributes should be put on the

    Attributes
    protected
  39. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  40. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  41. 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

    Definition Classes
    SimpleInjectorInjector
  42. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  43. 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

    to

    - the target

    func

    - the function to invoke when the link is clicked

    body

    - the NodeSeq to wrap in the anchor tag

    attrs

    - the (optional) attributes for the HTML element

    Definition Classes
    StatefulSnippet
  44. 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
  45. def names: Set[String]

    Definition Classes
    StatefulSnippet
  46. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  47. def nextButton: Elem

  48. def nextScreen(): JsCmd

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

    Definition Classes
    WizardScreenWizardRendered
  50. final def notify(): Unit

    Definition Classes
    AnyRef
  51. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  52. def onConfirm_?: Boolean

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

  53. def prevButton: Elem

  54. def prevScreen(): JsCmd

  55. def redirectBack(): JsCmd

    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  56. def redirectTo(where: String): Nothing

    Redirect to another page, but make sure this StatefulSnippet is registered on that page so the state continues on the new page

    Redirect to another page, but make sure this StatefulSnippet is registered on that page so the state continues on the new page

    Definition Classes
    StatefulSnippet
  57. 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
  58. def registerThisSnippet(): Unit

    Definition Classes
    StatefulSnippet
  59. 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
  60. def renderHtml(): NodeSeq

    Attributes
    protected
  61. lazy val screenCount: Int

    Total number of screens in the wizard

  62. def screens: List[Screen]

    The ordered list of Screens

  63. def seeOther(where: String): Nothing

    See Other to another page, but make sure this StatefulSnippet is registered on that page so the state continues on the new page

    See Other to another page, but make sure this StatefulSnippet is registered on that page so the state continues on the new page

    Definition Classes
    StatefulSnippet
  64. def submitOrAjax(id: String): String

    Attributes
    protected
  65. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  66. def toForm: NodeSeq

  67. def toString(): String

    Definition Classes
    AnyRef → Any
  68. def unregisterThisSnippet(): Unit

    Definition Classes
    StatefulSnippet
  69. def vendAVar[T](dflt: ⇒ T): NonCleanAnyVar[T]

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

    Attributes
    protected
  71. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  72. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  73. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  74. def wizardBottom: Box[Elem]

    Attributes
    protected
  75. def wizardTop: Box[Elem]

    Attributes
    protected
  76. 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