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. Form
  2. Text
  3. Executable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Form(title: Option[String] = scala.None, rows: Seq[Row] = ..., result: Option[Result] = scala.None)

Value Members

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

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

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

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

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

    Definition Classes
    Any
  6. lazy val allRows: Seq[Row]

    returns

    all rows, including the header

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

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

    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: Seq[Row]

  14. def finalize(): Unit

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

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

    Definition Classes
    Form → AnyRef → Any
  17. def inline: InlinedForm

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

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

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. def map(f: (Result) ⇒ Result): Executable

    Definition Classes
    Executable
  20. lazy val maxSizes: Seq[Int]

    returns

    the maximum cell size, column by column

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. def newForm(title: Option[String] = None, rows: Seq[Row] = Vector(), result: Option[Result] = None): Form

    returns

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

    Attributes
    protected
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. val result: Option[Result]

  26. val rows: Seq[Row]

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

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

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

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

  31. def setFailure: Form

    returns

    a Form where every Row is executed with a Failure

  32. def setPending: Form

    returns

    a Form where every Row is executed with a Pending

  33. def setResult(r: Result): Form

    returns

    a Form where every Row is executed with a given Result

  34. def setSkipped: Form

    returns

    a Form where every Row is executed with a Skipped

  35. def setSuccess: Form

    returns

    a Form where every Row is executed with a Success

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

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

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

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

  40. final def synchronized[T0](arg0: ⇒ T0): T0

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

    create new tabs in the Form

  42. def text: String

    returns

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

    Definition Classes
    FormText
  43. def th(h1: String, hs: String*): Form

    add a new Header, with at least one Field

  44. def th(hs: Seq[String])(implicit p: control.ImplicitParameters.ImplicitParam): Form

    add a new Header

  45. def th(h1: Field[_], hs: Field[_]*): Form

    add a new Header, with at least one Field

  46. def th(hs: Seq[Field[_]]): Form

    add a new Header with some fields

  47. val title: Option[String]

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

    returns

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

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

    encapsulate this form into an effect

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

    encapsulate this form into a Prop

  51. def toString(): String

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

    returns

    an xml description of this form

  53. def tr(row: Row): Form

    add a new Row

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

    add a new Row, with at least one Cell

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

    create new rows in the Form

  56. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. 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

Ungrouped