Trait

net.liftweb.http

Wizard

Related Doc: package http

Permalink

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. Wizard
  2. ScreenWizardRendered
  3. Loggable
  4. Factory
  5. SimpleInjector
  6. Injector
  7. StatefulSnippet
  8. DispatchSnippet
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. class CssClassBinding extends AnyRef

    Permalink
    Definition Classes
    ScreenWizardRendered
  2. type DispatchIt = PartialFunction[String, (NodeSeq) ⇒ NodeSeq]

    Permalink
    Definition Classes
    DispatchSnippet
  3. abstract class FactoryMaker[T] extends StackableMaker[T] with Vendor[T]

    Permalink

    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.

    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.

    Definition Classes
    Factory
  4. abstract class Inject[T] extends StackableMaker[T] with Vendor[T]

    Permalink

    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.

    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.

    Definition Classes
    SimpleInjector
  5. trait Screen extends AbstractScreen

    Permalink

    Define a screen within this wizard

  6. trait Snapshot extends AnyRef

    Permalink
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  7. class WizardSnapshot extends Snapshot

    Permalink
  8. abstract class WizardVar[T] extends NonCleanAnyVar[T]

    Permalink

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

    Keep request-local information around without the nastiness of naming session variables or the type-unsafety of casting the results. RequestVars share their value through the scope of the current HTTP request. They have no value at the beginning of request servicing and their value is discarded at the end of request processing. They are helpful to share values across many snippets.

Abstract Value Members

  1. abstract def finish(): Unit

    Permalink

    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: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. object AjaxOnDone extends WizardVar[JsCmd]

    Permalink

    What to do when the Screen is done.

    What to do when the Screen is done. By default, will do a redirect back to Whence, but you can change this behavior, for example, put up some other Ajax thing or alternatively, remove the form from the screen.

    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  5. object Ajax_? extends WizardVar[Boolean]

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

    Permalink
    Attributes
    protected
  7. object FormGUID extends WizardVar[String]

    Permalink

    A unique GUID for the form...

    A unique GUID for the form... this allows us to do an Ajax SetHtml to replace the form

    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  8. object OnFirstScreen extends TransientRequestVar[Boolean]

    Permalink
    Attributes
    protected
  9. object Referer extends WizardVar[String]

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

    Permalink
    Attributes
    protected
  11. object _defaultXml extends TransientRequestVar[NodeSeq]

    Permalink

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

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

    Attributes
    protected
  12. def addName(name: String): Unit

    Permalink
    Definition Classes
    StatefulSnippet
  13. def additionalFormBindings: Box[CssSel]

    Permalink
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  14. def ajaxForms_?: Boolean

    Permalink

    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
  15. def allTemplate: NodeSeq

    Permalink
    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  16. def allTemplateNodeSeq: NodeSeq

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

    Permalink
    Attributes
    protected
  18. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  19. def calcAjax: Boolean

    Permalink

    Calculate if this Screen/Wizard should be ajax

    Calculate if this Screen/Wizard should be ajax

    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  20. def calcAjaxOnDone: JsCmd

    Permalink

    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
  21. def calcFirstScreen: Box[Screen]

    Permalink

    What's the first screen in this wizard

  22. def calcReferer: String

    Permalink

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

    Permalink

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

  24. def cancelButton: Elem

    Permalink
  25. def clone(): AnyRef

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

    Permalink
    Definition Classes
    WizardScreenWizardRendered
  27. lazy val cssClassBinding: CssClassBinding

    Permalink
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  28. def currentScreen: Box[Screen]

    Permalink
  29. def dbConnections: List[LoanWrapper]

    Permalink
  30. def defaultFieldNodeSeq: NodeSeq

    Permalink
    Definition Classes
    ScreenWizardRendered
  31. def defaultToAjax_?: Boolean

    Permalink

    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
  32. def defaultXml: NodeSeq

    Permalink

    the NodeSeq passed as a parameter when the snippet was invoked

    the NodeSeq passed as a parameter when the snippet was invoked

    Attributes
    protected
  33. def dispatch: PartialFunction[String, (NodeSeq) ⇒ NodeSeq]

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

    Permalink
  35. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def finishButton: Elem

    Permalink
  39. def formAttrs: MetaData

    Permalink

    What additional attributes should be put on the

    What additional attributes should be put on the

    Attributes
    protected
  40. def formName: String

    Permalink
    Definition Classes
    WizardScreenWizardRendered
  41. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  43. implicit def inject[T](implicit man: Manifest[T]): Box[T]

    Permalink

    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
  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. def labelSuffix: NodeSeq

    Permalink
    Definition Classes
    ScreenWizardRendered
  46. def link(to: String, func: () ⇒ Any, body: NodeSeq, attrs: SHtml.ElemAttr*): Elem

    Permalink

    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
  47. def localSetup(): Unit

    Permalink

    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. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Loggable
  49. def names: Set[String]

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

    Permalink
    Definition Classes
    AnyRef
  51. def nextButton: Elem

    Permalink
  52. def nextScreen(): JsCmd

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

    Permalink
    Definition Classes
    WizardScreenWizardRendered
  54. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  55. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  56. def onConfirm_?: Boolean

    Permalink

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

  57. def prevButton: Elem

    Permalink
  58. def prevScreen(): JsCmd

    Permalink
  59. def redirectBack(): JsCmd

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

    Permalink

    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
  61. def registerInjection[T](f: () ⇒ T)(implicit man: Manifest[T]): Unit

    Permalink

    Register a function that will inject for the given Manifest

    Register a function that will inject for the given Manifest

    Definition Classes
    SimpleInjector
  62. def registerThisSnippet(): Unit

    Permalink
    Definition Classes
    StatefulSnippet
  63. 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

    Permalink
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  64. def renderHtml(): NodeSeq

    Permalink
    Attributes
    protected
  65. lazy val screenCount: Int

    Permalink

    Total number of screens in the wizard

  66. def screens: List[Screen]

    Permalink

    The ordered list of Screens

  67. def seeOther(where: String): Nothing

    Permalink

    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
  68. def submitOrAjax(id: String): String

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

    Permalink
    Definition Classes
    AnyRef
  70. def toForm: NodeSeq

    Permalink
  71. def toString(): String

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

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

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

    Permalink
    Attributes
    protected
  75. final def wait(): Unit

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

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

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

    Permalink
    Attributes
    protected
  79. def wizardTop: Box[Elem]

    Permalink
    Attributes
    protected
  80. def wrapInDiv(in: NodeSeq): Elem

    Permalink
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered

Inherited from ScreenWizardRendered

Inherited from Loggable

Inherited from Factory

Inherited from SimpleInjector

Inherited from Injector

Inherited from StatefulSnippet

Inherited from DispatchSnippet

Inherited from AnyRef

Inherited from Any

Ungrouped