Packages

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

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. 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
  2. class CssClassBinding extends AnyRef
    Definition Classes
    ScreenWizardRendered
  3. trait Snapshot extends AnyRef
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  4. type DispatchIt = PartialFunction[String, (NodeSeq) ⇒ NodeSeq]
    Definition Classes
    DispatchSnippet
  5. trait Screen extends AbstractScreen

    Define a screen within this wizard

  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.

    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.

  8. 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.

    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

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: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addName(name: String): Unit
    Definition Classes
    StatefulSnippet
  5. def additionalFormBindings: Box[CssSel]
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  6. 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
  7. def allTemplate: NodeSeq
    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  8. def allTemplateNodeSeq: NodeSeq
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  9. def allTemplatePath: List[String]
    Attributes
    protected
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def calcAjax: Boolean

    Calculate if this Screen/Wizard should be ajax

    Calculate if this Screen/Wizard should be ajax

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

    What's the first screen in this wizard

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

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

  16. def cancelButton: Elem
  17. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def createSnapshot: WizardSnapshot
    Definition Classes
    WizardScreenWizardRendered
  19. lazy val cssClassBinding: CssClassBinding
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  20. def currentScreen: Box[Screen]
  21. def dbConnections: List[LoanWrapper]
  22. def defaultFieldNodeSeq: NodeSeq
    Definition Classes
    ScreenWizardRendered
  23. 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
  24. 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
  25. def dispatch: PartialFunction[String, (NodeSeq) ⇒ NodeSeq]
    Definition Classes
    WizardDispatchSnippet
  26. implicit def elemInABox(in: Elem): Box[Elem]
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def finishButton: Elem
  31. def formAttrs: MetaData

    What additional attributes should be put on the

    What additional attributes should be put on the

    Attributes
    protected
  32. def formName: String
    Definition Classes
    WizardScreenWizardRendered
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  34. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  35. 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
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def labelSuffix: NodeSeq
    Definition Classes
    ScreenWizardRendered
  38. 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
  39. 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
  40. val logger: Logger
    Attributes
    protected
    Definition Classes
    Loggable
    Annotations
    @transient()
  41. def names: Set[String]
    Definition Classes
    StatefulSnippet
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. def nextButton: Elem
  44. def nextScreen(): JsCmd
  45. def noticeTypeToAttr(screen: AbstractScreen): Box[(Value) ⇒ MetaData]
    Definition Classes
    WizardScreenWizardRendered
  46. final def notify(): Unit
    Definition Classes
    AnyRef
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  48. def onConfirm_?: Boolean

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

  49. def prevButton: Elem
  50. def prevScreen(): JsCmd
  51. def redirectBack(): JsCmd
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  52. 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
  53. 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
  54. def registerThisSnippet(): Unit
    Definition Classes
    StatefulSnippet
  55. 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
  56. def renderHtml(): NodeSeq
    Attributes
    protected
  57. lazy val screenCount: Int

    Total number of screens in the wizard

  58. def screens: List[Screen]

    The ordered list of Screens

  59. 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
  60. def submitOrAjax(id: String): String
    Attributes
    protected
  61. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  62. def toForm: NodeSeq
  63. def toString(): String
    Definition Classes
    AnyRef → Any
  64. def unregisterThisSnippet(): Unit
    Definition Classes
    StatefulSnippet
  65. def vendAVar[T](dflt: ⇒ T): NonCleanAnyVar[T]
    Attributes
    protected
  66. def vendForm[T](implicit man: Manifest[T]): Box[(T, (T) ⇒ Any) ⇒ NodeSeq]
    Attributes
    protected
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. def wizardBottom: Box[Elem]
    Attributes
    protected
  71. def wizardTop: Box[Elem]
    Attributes
    protected
  72. def wrapInDiv(in: NodeSeq): Elem
    Attributes
    protected
    Definition Classes
    ScreenWizardRendered
  73. 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
    WizardScreenWizardRendered
  74. object Ajax_? extends WizardVar[Boolean]
    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  75. object CurrentScreen extends WizardVar[Box[Screen]]
    Attributes
    protected
  76. 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
    WizardScreenWizardRendered
  77. object OnFirstScreen extends TransientRequestVar[Boolean]
    Attributes
    protected
  78. object Referer extends WizardVar[String]
    Attributes
    protected
    Definition Classes
    WizardScreenWizardRendered
  79. object VisitedScreens extends WizardVar[Vector[Screen]]
    Attributes
    protected
  80. 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

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