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
InlinedForm
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Form
  2. Text
  3. Executable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

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. lazy val allRows: Seq[Row]

    returns

    all rows, including the header

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(a: Any): Boolean
    Definition Classes
    Form → AnyRef → Any
  9. def execute: Result

    execute all rows

    execute all rows

    returns

    a logical and on all results

    Definition Classes
    Form → Executable
  10. def executeForm: Form

    execute all rows

    execute all rows

    returns

    an executed Form

  11. def executeRows: Seq[Row]
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    Form → AnyRef → Any
  14. 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

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def map(f: (Result) => Result): Executable
    Definition Classes
    Executable
  17. lazy val maxSizes: Seq[Int]

    returns

    the maximum cell size, column by column

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def newForm(title: Option[String] = None, rows: Seq[Row] = Vector(), result: Option[Result] = None): Form

    returns

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

    Attributes
    protected
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  22. val result: Option[Result]
  23. val rows: Seq[Row]
  24. def sequence[T <: Any { def form: org.specs2.form.Form }](f1: Seq[T], f2: Seq[T]): Form
  25. def sequence(f1: Traversable[Form], f2: Traversable[Form]): Form
  26. def set[T <: Any { def form: org.specs2.form.Form }](f1: Seq[T], f2: Seq[T]): Form
  27. def set(f1: Traversable[Form], f2: Traversable[Form]): Form
  28. def setFailure: Form

    returns

    a Form where every Row is executed with a Failure

  29. def setPending: Form

    returns

    a Form where every Row is executed with a Pending

  30. def setResult(r: Result): Form

    returns

    a Form where every Row is executed with a given Result

  31. def setSkipped: Form

    returns

    a Form where every Row is executed with a Skipped

  32. def setSuccess: Form

    returns

    a Form where every Row is executed with a Success

  33. def subsequence[T <: Any { def form: org.specs2.form.Form }](f1: Seq[T], f2: Seq[T]): Form
  34. def subsequence(f1: Traversable[Form], f2: Traversable[Form]): Form
  35. def subset[T <: Any { def form: org.specs2.form.Form }](f1: Seq[T], f2: Seq[T]): Form
  36. def subset(f1: Traversable[Form], f2: Traversable[Form]): Form
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def tabs[T](values: Seq[T])(f: (T) => Tabs): Form

    create new tabs in the Form

  39. def text: String

    returns

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

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

    add a new Header, with at least one Field

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

    add a new Header

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

    add a new Header, with at least one Field

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

    add a new Header with some fields

  44. val title: Option[String]
  45. def toCellXml(implicit args: Arguments = Arguments()): Elem

    returns

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

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

    encapsulate this form into an effect

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

    encapsulate this form into a Prop

  48. def toString(): String
    Definition Classes
    AnyRef → Any
  49. def toXml(implicit args: Arguments = Arguments()): Elem

    returns

    an xml description of this form

  50. def tr(row: Row): Form

    add a new Row

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

    add a new Row, with at least one Cell

  52. def trs[T](values: Seq[T])(f: (T) => Row): Form

    create new rows in the Form

  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. def width: Int

    returns

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

    Definition Classes
    Text

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Text

Inherited from Executable

Inherited from AnyRef

Inherited from Any

Ungrouped