org.specs2.form

Form

class Form extends Executable with Text

A Form is a container for Rows (@see Row) where each row contain some Cell (@see Cell). It has an optional title and possibly no rows.

A Form can be executed by executing each row and collecting the results.

Linear Supertypes
Text, Executable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Form
  2. Text
  3. Executable
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Form (title: Option[String], rows: List[Row], result: Option[Result])

Value Members

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

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

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

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

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

    Attributes
    final
    Definition Classes
    Any
  6. lazy val allRows : List[Row]

    returns

    all rows, including the header

  7. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  8. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  9. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  10. def equals (a: Any): Boolean

    Definition Classes
    Form → AnyRef → Any
  11. def execute : Result

    execute all rows

    execute all rows

    returns

    a logical and on all results

    Definition Classes
    Form → Executable
  12. def executeForm : Form

    execute all rows

    execute all rows

    returns

    an executed Form

  13. def executeRows : List[Row]

  14. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  16. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  17. def inline : InlinedForm

    transform this form to a form that will be added as a element inside another form element inside another form

    transform this form to a form that will be added as a element inside another form

  18. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  19. lazy val maxSizes : List[Int]

    returns

    the maximum cell size, column by column

  20. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  21. def newForm (title: Option[String] = None, rows: List[Row] = Nil: List[Row], result: Option[Result] = None): Form

    returns

    a new Form. This method can be overriden to return a more accurate subtype

    Attributes
    protected
  22. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  23. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  24. val result : Option[Result]

  25. val rows : List[Row]

  26. def sequence [T <: Any { def form: org.specs2.form.Form }] (f1: Seq[T], f2: Seq[T]): Form

  27. def sequence (f1: Traversable[Form], f2: Traversable[Form]): Form

  28. def set [T <: Any { def form: org.specs2.form.Form }] (f1: Seq[T], f2: Seq[T]): Form

  29. def set (f1: Traversable[Form], f2: Traversable[Form]): Form

  30. def setFailure : Form

    returns

    a Form where every Row is executed with a Failure

  31. def setSuccess : Form

    returns

    a Form where every Row is executed with a Success

  32. def subsequence [T <: Any { def form: org.specs2.form.Form }] (f1: Seq[T], f2: Seq[T]): Form

  33. def subsequence (f1: Traversable[Form], f2: Traversable[Form]): Form

  34. def subset [T <: Any { def form: org.specs2.form.Form }] (f1: Seq[T], f2: Seq[T]): Form

  35. def subset (f1: Traversable[Form], f2: Traversable[Form]): Form

  36. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  37. def tabs [T] (values: Seq[T])(f: (T) ⇒ Tabs): Form

    create new tabs in the Form

  38. def text : String

    returns

    the printed form with a padding space size to use for each cell

    Definition Classes
    Form → Text
  39. def th (h1: String, hs: String*): Form

    add a new Header, with at least one Field

  40. def th (h1: org.specs2.form.Field[_], hs: org.specs2.form.Field[_]*): Form

    add a new Header, with at least one Field

  41. val title : Option[String]

  42. def toCellXml (implicit args: Arguments = Arguments()): Elem

    returns

    an xml description of this form, to be embedded in a Cell

  43. def toEffect (label: String): Effect[Form]

    encapsulate this form into an effect

  44. def toProp (label: String): Prop[Form, Any]

    encapsulate this form into a Prop

  45. def toString (): String

    Definition Classes
    AnyRef → Any
  46. def toXml (implicit args: Arguments = Arguments()): Elem

    returns

    an xml description of this form

  47. def tr (row: Row): Form

    add a new Row

  48. def tr (c1: Cell, cs: Cell*): Form

    add a new Row, with at least one Cell

  49. def trs [T] (values: Seq[T])(f: (T) ⇒ Row): Form

    create new rows in the Form

  50. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  53. def width : Int

    returns

    the width of the cell, without borders when it's a FormCell

    Definition Classes
    Text

Inherited from Text

Inherited from Executable

Inherited from AnyRef

Inherited from Any