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
- Alphabetic
- By Inheritance
- Wizard
- ScreenWizardRendered
- Loggable
- Factory
- SimpleInjector
- Injector
- StatefulSnippet
- DispatchSnippet
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- 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.
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
- class CssClassBinding extends AnyRef
- Definition Classes
- ScreenWizardRendered
- trait Snapshot extends AnyRef
- Attributes
- protected
- Definition Classes
- ScreenWizardRendered
- type DispatchIt = PartialFunction[String, (NodeSeq) => NodeSeq]
- Definition Classes
- DispatchSnippet
- abstract class Inject[T] extends StackableMaker[T] with Vendor[T]
- Definition Classes
- SimpleInjector
- trait Screen extends AbstractScreen
Define a screen within this wizard
- class WizardSnapshot extends Snapshot
- 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.
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
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addName(name: String): Unit
- Definition Classes
- StatefulSnippet
- def additionalFormBindings: Box[CssSel]
- Attributes
- protected
- Definition Classes
- ScreenWizardRendered
- 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
- def allTemplate: NodeSeq
- Attributes
- protected
- Definition Classes
- Wizard → ScreenWizardRendered
- def allTemplateNodeSeq: NodeSeq
- Attributes
- protected
- Definition Classes
- ScreenWizardRendered
- def allTemplatePath: List[String]
- Attributes
- protected
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def calcAjax: Boolean
Calculate if this Screen/Wizard should be ajax
Calculate if this Screen/Wizard should be ajax
- Attributes
- protected
- Definition Classes
- ScreenWizardRendered
- 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
- def calcFirstScreen: Box[Screen]
What's the first screen in this wizard
- 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
- def calcScreenAfter(which: Screen): Box[Screen]
Given the current screen, what's the next screen?
- def cancelButton: Elem
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def createSnapshot: WizardSnapshot
- Definition Classes
- Wizard → ScreenWizardRendered
- lazy val cssClassBinding: CssClassBinding
- Attributes
- protected
- Definition Classes
- ScreenWizardRendered
- def currentScreen: Box[Screen]
- def dbConnections: List[LoanWrapper]
- def defaultFieldNodeSeq: NodeSeq
- Definition Classes
- ScreenWizardRendered
- 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
- 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
- def dispatch: PartialFunction[String, (NodeSeq) => NodeSeq]
- Definition Classes
- Wizard → DispatchSnippet
- implicit def elemInABox(in: Elem): Box[Elem]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def finishButton: Elem
- def formAttrs: MetaData
What additional attributes should be put on the
What additional attributes should be put on the
- Attributes
- protected
- def formName: String
- Definition Classes
- Wizard → ScreenWizardRendered
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- implicit def inject[T](implicit man: Manifest[T]): Box[T]
- Definition Classes
- SimpleInjector → Injector
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def labelSuffix: NodeSeq
- Definition Classes
- ScreenWizardRendered
- def link(to: String, func: () => Any, body: NodeSeq, attrs: SHtml.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
- 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
- val logger: Logger
- Attributes
- protected
- Definition Classes
- Loggable
- Annotations
- @transient()
- def names: Set[String]
- Definition Classes
- StatefulSnippet
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nextButton: Elem
- def nextScreen(): JsCmd
- def noticeTypeToAttr(screen: AbstractScreen): Box[(Value) => MetaData]
- Definition Classes
- Wizard → ScreenWizardRendered
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def onConfirm_?: Boolean
By default, are all the fields on all the screen in this wizard on the confirm screen?
- def prevButton: Elem
- def prevScreen(): JsCmd
- def redirectBack(): JsCmd
- Attributes
- protected
- Definition Classes
- ScreenWizardRendered
- 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
- def registerInjection[T](f: () => T)(implicit man: Manifest[T]): Unit
- Definition Classes
- SimpleInjector
- def registerThisSnippet(): Unit
- Definition Classes
- StatefulSnippet
- 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
- def renderHtml(): NodeSeq
- Attributes
- protected
- lazy val screenCount: Int
Total number of screens in the wizard
- def screens: List[Screen]
The ordered list of Screens
- 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
- def submitOrAjax(id: String): String
- Attributes
- protected
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toForm: NodeSeq
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unregisterThisSnippet(): Unit
- Definition Classes
- StatefulSnippet
- def vendAVar[T](dflt: => T): NonCleanAnyVar[T]
- Attributes
- protected
- def vendForm[T](implicit man: Manifest[T]): Box[(T, (T) => Any) => NodeSeq]
- Attributes
- protected
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def wizardBottom: Box[Elem]
- Attributes
- protected
- def wizardTop: Box[Elem]
- Attributes
- protected
- def wrapInDiv(in: NodeSeq): Elem
- Attributes
- protected
- Definition Classes
- ScreenWizardRendered
- object AjaxOnDone extends WizardVar[JsCmd]
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
- Wizard → ScreenWizardRendered
- object Ajax_? extends WizardVar[Boolean]
- Attributes
- protected
- Definition Classes
- Wizard → ScreenWizardRendered
- object CurrentScreen extends WizardVar[Box[Screen]]
- Attributes
- protected
- object FormGUID extends WizardVar[String]
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
- Wizard → ScreenWizardRendered
- object OnFirstScreen extends TransientRequestVar[Boolean]
- Attributes
- protected
- object Referer extends WizardVar[String]
- Attributes
- protected
- Definition Classes
- Wizard → ScreenWizardRendered
- object VisitedScreens extends WizardVar[Vector[Screen]]
- Attributes
- protected
- object _defaultXml extends TransientRequestVar[NodeSeq]
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