net.liftweb.wizard.Wizard

Screen

trait Screen extends AbstractScreen

Define a screen within this wizard

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

Type Members

  1. case class AFilter [T] (f: (T) ⇒ T) extends FilterOrValidate[T] with Product

    attributes: protected final
  2. case class AVal [T] (v: (T) ⇒ List[FieldError]) extends FilterOrValidate[T] with Product

    attributes: protected final
  3. trait BoxMarker extends AnyRef

    attributes: protected sealed
  4. type Errors = List[FieldError]

    attributes: protected
    definition classes: AbstractScreen
  5. 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.

  6. trait Field extends Field with ConfirmField

    Define a field within the screen

  7. class FieldBuilder [T] extends AnyRef

    attributes: protected
  8. trait FilterOrValidate [+T] extends AnyRef

    attributes: protected sealed
  9. case class FormFieldId (id: String) extends FilterOrValidate[Nothing] with Product

    attributes: protected final
  10. case class FormParam (fp: ElemAttr) extends FilterOrValidate[Nothing] with Product

    attributes: protected final
  11. 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.

  12. trait OtherValueInitializer [T] extends AnyRef

    attributes: protected sealed
  13. case class OtherValueInitializerImpl [T] (f: () ⇒ T) extends OtherValueInitializer[T] with Product

    attributes: protected final

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 BoxMarkerObj extends BoxMarker

    A little hack because => BaseField and => Box[BaseField] have the same method signature

  9. object Field extends AnyRef

  10. object FilterOrValidate extends AnyRef

    attributes: protected
  11. object NotOnConfirmScreen extends FilterOrValidate[Nothing] with Product

    Override the screen default for fields appearing on the confirm screen and force this field not to appear on the confirm screen

  12. object NothingOtherValueInitializer extends OtherValueInitializer[Nothing] with Product

    attributes: protected
  13. object OnConfirmScreen extends FilterOrValidate[Nothing] with Product

    Override the screen default for fields appearing on the confirm screen and force this field to appear on the confirm screen

  14. def _register (field: () ⇒ FieldContainer) : Unit

    Use addFields

    Use addFields

    @deprecated

    attributes: protected
    definition classes: AbstractScreen
      deprecated:
    1. use addFields()

  15. def addFields (fields: () ⇒ FieldContainer) : Unit

    Add a FieldContainer to the Screen.

    Add a FieldContainer to the Screen. A FieldContainer can contain either a single field (a BaseField) or a collection of BaseFields. The key take-away is that if the LiftScreen or Wizard is a singleton, you can still display variable number of fields by returning a variable number of BaseField instances from the FieldContainer.
    WARNING -- this method is public so it can be called from a Wizard. This method should only be called from within the Screen or Wizard that owns the Screen and not from external code.

    definition classes: AbstractScreen
  16. def additionalAttributes : MetaData

    any additional parameters that need to be put in the on the form (e.

    any additional parameters that need to be put in the on the form (e.g., mime type)

    definition classes: AbstractScreen
  17. 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
  18. implicit def boxOfScreen [T <: AbstractScreen] (in: T) : Box[T]

    attributes: implicit
    definition classes: AbstractScreen
  19. implicit def boxStrToListFieldError (msg: Box[String]) : List[FieldError]

    attributes: implicit
    definition classes: AbstractScreen
  20. implicit def boxXmlToListFieldError (msg: Box[NodeSeq]) : List[FieldError]

    attributes: implicit
    definition classes: AbstractScreen
  21. def builder [T] (name: ⇒ String, default: ⇒ T, stuff: FilterOrValidate[T]*)(implicit man: Manifest[T]) : FieldBuilder[T]

    Create a FieldBuilder so you can add help screens, validations and filters.

    Create a FieldBuilder so you can add help screens, validations and filters. Remember to invoke "make" on the returned FieldBuilder to convert it into a field

    name

    - the name of the field. This is a call-by-name parameter, so you can dynamically calculate the name of the fiels (e.g., localize its name)

    default

    - the default value of the field

    attributes: protected
    definition classes: AbstractScreen
  22. def cancelButton : Elem

    definition classes: ScreenAbstractScreen
  23. 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
  24. def confirmScreen_? : Boolean

    Is this screen a confirm screen?

    Is this screen a confirm screen?

  25. object currentField extends ThreadGlobal[FieldIdentifier]

    attributes: protected
  26. implicit def elemInABox (in: Elem) : Box[Elem]

    attributes: protected implicit
    definition classes: AbstractScreen
  27. 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
  28. 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
  29. def field [T] (name: ⇒ String, default: ⇒ T, stuff: FilterOrValidate[T]*)(implicit man: Manifest[T]) : Field {...}

    Create a field with a name, default value, and

    Create a field with a name, default value, and

    name

    - the name of the field. This is a call-by-name parameter, so you can dynamically calculate the name of the fiels (e.g., localize its name)

    default

    - the default value of the field

    attributes: protected
    definition classes: AbstractScreen
  30. def field [T] (underlying: ⇒ Box[BaseField {...}], stuff: FilterOrValidate[T]*)(implicit man: Manifest[T], marker: BoxMarker) : Field {...}

    attributes: protected
    definition classes: AbstractScreen
  31. def field [T] (underlying: ⇒ BaseField {...}, stuff: FilterOrValidate[T]*)(implicit man: Manifest[T]) : Field {...}

    attributes: protected
    definition classes: AbstractScreen
  32. 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
  33. def finish () : Unit

    override this method if there's a screen-specific thing to do on finish.

    override this method if there's a screen-specific thing to do on finish. This method is called before the main Wizard's finish method

  34. def finishButton : Elem

    definition classes: ScreenAbstractScreen
  35. 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
  36. def grabParams (in: Seq[Screen.this.FilterOrValidate[_]]) : List[ElemAttr]

    Grabs the FormFieldId and FormParam parameters

    Grabs the FormFieldId and FormParam parameters

    attributes: protected
    definition classes: AbstractScreen
  37. def hasUploadField : Boolean

    attributes: protected
    definition classes: AbstractScreen
  38. 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
  39. 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
  40. 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
  41. def isLastScreen : Boolean

  42. def localSetup () : Unit

    Override this method to do any setup of this screen

    Override this method to do any setup of this screen

    attributes: protected
    definition classes: AbstractScreen
  43. def makeField [T, OV] (theName: ⇒ String, defaultValue: ⇒ T, theToForm: (Field {...}) ⇒ Box[NodeSeq], otherValue: OtherValueInitializer[OV], stuff: FilterOrValidate[T]*) : Field {...}

    Create a field that's added to the Screen

    Create a field that's added to the Screen

    theName

    - the name of the field. This is call-by-name, so you can do things like S.?("Dog's Name") such that the string will be localized

    defaultValue

    - the starting value for the field. This is also call-by-name which is handy for constructs like:SomeExternalRequestVarOrSessionVar.get

    returns

    a newly minted Field

    attributes: protected
    definition classes: AbstractScreen
  44. def maxVal [T] (len: ⇒ T, msg: ⇒ String)(implicit f: (T) ⇒ Number) : (T) ⇒ List[FieldError]

    attributes: protected
    definition classes: AbstractScreen
  45. def minVal [T] (len: ⇒ T, msg: ⇒ String)(implicit f: (T) ⇒ Number) : (T) ⇒ List[FieldError]

    attributes: protected
    definition classes: AbstractScreen
  46. def multiselect [T] (name: ⇒ String, default: ⇒ Seq[T], choices: ⇒ Seq[T], stuff: FilterOrValidate[Seq[T]]*)(implicit f: PairStringPromoter[T]) : Field {...}

    Create a multi select HTML element

    Create a multi select HTML element

    name

    the name of the field (call-by-name)

    default

    the starting value of the field (call-by-name)

    choices

    the possible choices for the select

    stuff

    - a list of filters and validations for the field

    f

    a PairStringPromoter (a wrapper around a function) that converts T => display String

    attributes: protected
    definition classes: AbstractScreen
  47. val myScreenNum : Int

  48. 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
  49. def nextButton : Elem

  50. def nextScreen : Box[Screen]

  51. def notNull : (String) ⇒ String

    attributes: protected
    definition classes: AbstractScreen
  52. def noticeTypeToAttr (screen: AbstractScreen) : Box[(Value) ⇒ MetaData]

    definition classes: AbstractScreen
  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 this screen on the confirm screen?

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

    definition classes: ScreenAbstractScreen
  56. def password (name: ⇒ String, defaultValue: ⇒ String, stuff: FilterOrValidate[String]*) : Field {...}

    Create a password field

    Create a password field

    name

    the name of the field (call-by-name)

    defaultValue

    the starting value of the field (call-by-name)

    stuff

    the filters, validators and attributes

    attributes: protected
    definition classes: AbstractScreen
  57. def postFinish () : Unit

    override this method if there's a screen-specific thing to do on finish.

    override this method if there's a screen-specific thing to do on finish. This method is executed after the main Wizards finish() method.

  58. def prevButton : Elem

  59. def radio (name: ⇒ String, default: ⇒ String, choices: ⇒ Seq[String], stuff: FilterOrValidate[String]*) : Field {...}

    Create a radio HTML element

    Create a radio HTML element

    name

    the name of the field (call-by-name)

    default

    the starting value of the field (call-by-name)

    choices

    the possible choices for the select

    stuff

    - a list of filters and validations for the field

    attributes: protected
    definition classes: AbstractScreen
  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 removeRegExChars (regEx: String) : (String) ⇒ String

    attributes: protected
    definition classes: AbstractScreen
  62. def screenBottom : Box[Elem]

    definition classes: AbstractScreen
  63. def screenFields : List[BaseField]

    A list of fields in this screen

    A list of fields in this screen

    definition classes: AbstractScreen
  64. def screenName : String

    The name of the screen.

    The name of the screen. Override this to change the screen name

    definition classes: ScreenAbstractScreen
  65. def screenNameAsHtml : NodeSeq

    definition classes: AbstractScreen
  66. def screenTitle : NodeSeq

    definition classes: AbstractScreen
  67. def screenTop : Box[Elem]

    definition classes: AbstractScreen
  68. def screenValidate : List[FieldError]

    definition classes: AbstractScreen
  69. def select [T] (name: ⇒ String, default: ⇒ T, choices: ⇒ Seq[T], stuff: FilterOrValidate[T]*)(implicit f: PairStringPromoter[T]) : Field {...}

    Create a select HTML element

    Create a select HTML element

    name

    the name of the field (call-by-name)

    default

    the starting value of the field (call-by-name)

    choices

    the possible choices for the select

    stuff

    - a list of filters and validations for the field

    f

    a PairStringPromoter (a wrapper around a function) that converts T => display String

    attributes: protected
    definition classes: AbstractScreen
  70. implicit def strToListFieldError (msg: String) : List[FieldError]

    attributes: implicit
    definition classes: AbstractScreen
  71. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  72. def text (name: ⇒ String, defaultValue: ⇒ String, stuff: FilterOrValidate[String]*) : Field {...}

    Create a text field

    Create a text field

    name

    the name of the field (call-by-name)

    defaultValue

    the starting value of the field (call-by-name)

    stuff

    the filters, validators and attributes

    attributes: protected
    definition classes: AbstractScreen
  73. def textarea (name: ⇒ String, defaultValue: ⇒ String, rows: Int, cols: Int, stuff: FilterOrValidate[String]*) : Field {...}

    Create a textarea Field

    Create a textarea Field

    name

    the name of the field (call-by-name)

    defaultValue

    the starting value of the field (call-by-name)

    rows

    the number of rows in the textarea

    cols

    the number of columns in the textarea

    stuff

    - a list of filters and validations for the field

    attributes: protected
    definition classes: AbstractScreen
  74. def textarea (name: ⇒ String, defaultValue: ⇒ String, stuff: FilterOrValidate[String]*) : Field {...}

    Create a textarea Field with 80 columns and 5 rows

    Create a textarea Field with 80 columns and 5 rows

    name

    the name of the field (call-by-name)

    defaultValue

    the starting value of the field (call-by-name)

    stuff

    - a list of filters and validations for the field

    attributes: protected
    definition classes: AbstractScreen
  75. def toLower : (String) ⇒ String

    attributes: protected
    definition classes: AbstractScreen
  76. 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: AbstractScreen → AnyRef → Any
  77. def toUpper : (String) ⇒ String

    attributes: protected
    definition classes: AbstractScreen
  78. def transitionIntoFrom (from: Box[Screen]) : Unit

    A notification that we are transitioning into this screen.

    A notification that we are transitioning into this screen. Override this method to perform some screen-specific actions

    from

    the screen we're coming from

  79. def transitionOutOfTo (to: Box[Screen]) : Unit

    A notification that we are transitioning out of this screen.

    A notification that we are transitioning out of this screen. Override this method to perform some screen-specific actions

    to

    the screen we're transitioning to

  80. def trim : (String) ⇒ String

    attributes: protected
    definition classes: AbstractScreen
  81. def valMaxLen (len: ⇒ Int, msg: ⇒ String) : (String) ⇒ List[FieldError]

    A validation helper.

    A validation helper. Make sure the string is no more than a particular length and generate a validation issue if not

    attributes: protected
    definition classes: AbstractScreen
  82. def valMinLen (len: ⇒ Int, msg: ⇒ String) : (String) ⇒ List[FieldError]

    A validation helper.

    A validation helper. Make sure the string is at least a particular length and generate a validation issue if not

    attributes: protected
    definition classes: AbstractScreen
  83. def valRegex (pat: ⇒ Pattern, msg: ⇒ String) : (String) ⇒ List[FieldError]

    Make sure the field matches a regular expression

    Make sure the field matches a regular expression

    attributes: protected
    definition classes: AbstractScreen
  84. def validate : List[FieldError]

    definition classes: AbstractScreen
  85. def validations : List[() ⇒ List[FieldError]]

    definition classes: AbstractScreen
  86. def vendAVar [T] (dflt: ⇒ T) : NonCleanAnyVar[T]

    attributes: protected
    definition classes: ScreenAbstractScreen
  87. def vendForm [T] (implicit man: Manifest[T]) : Box[(T, (T) ⇒ Any) ⇒ NodeSeq]

    attributes: protected
    definition classes: AbstractScreen
  88. def wait () : Unit

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

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

    attributes: final
    definition classes: AnyRef
  91. implicit def xmlToListFieldError (msg: NodeSeq) : List[FieldError]

    attributes: implicit
    definition classes: AbstractScreen

Inherited from AbstractScreen

Inherited from Factory

Inherited from SimpleInjector

Inherited from Injector

Inherited from AnyRef

Inherited from Any