org.specs2.specification

Forms

Related Docs: object Forms | package specification

trait Forms extends FormsBuilder with FormFragmentsBuilder with DecoratedProperties with FormFragmentExecution with FormSpecificationStringContext

Allow a Form to be inserted among Fragments as a Text Fragment Allow a Form to be used as an example body and return a Result automatically

Self Type
Forms with FragmentsBuilder with ArgumentsArgs with FormattingTags
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Forms
  2. FormSpecificationStringContext
  3. SpecificationStringContext
  4. FormFragmentExecution
  5. FragmentExecution
  6. DecoratedProperties
  7. FormFragmentsBuilder
  8. FragmentsBuilder
  9. FormattingTags
  10. Tags
  11. ImplicitParameters
  12. ExamplesFactory
  13. FormsBuilder
  14. AnyRef
  15. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class AsFragments(fs: Fragments) extends Product with Serializable

    Definition Classes
    FragmentsBuilder
  2. class Decorated[T <: DecoratedProperty[T]] extends AnyRef

    Definition Classes
    DecoratedProperties
  3. class ExampleDesc extends AnyRef

    transient class to hold an example description before creating a full Example

    transient class to hold an example description before creating a full Example

    Definition Classes
    FragmentsBuilder
  4. case class FormattingTagParameter(condition: Boolean) extends Product with Serializable

    Definition Classes
    FormattingTags
  5. class HtmlLinkFragments extends AnyRef

    Definition Classes
    FragmentsBuilder
  6. class HtmlLinkFragments2 extends AnyRef

    Definition Classes
    FragmentsBuilder
  7. trait ImplicitParam extends AnyRef

    Definition Classes
    ImplicitParameters
  8. trait ImplicitParam1 extends AnyRef

    Definition Classes
    ImplicitParameters
  9. trait ImplicitParam10 extends AnyRef

    Definition Classes
    ImplicitParameters
  10. trait ImplicitParam2 extends AnyRef

    Definition Classes
    ImplicitParameters
  11. trait ImplicitParam3 extends AnyRef

    Definition Classes
    ImplicitParameters
  12. trait ImplicitParam4 extends AnyRef

    Definition Classes
    ImplicitParameters
  13. trait ImplicitParam5 extends AnyRef

    Definition Classes
    ImplicitParameters
  14. trait ImplicitParam6 extends AnyRef

    Definition Classes
    ImplicitParameters
  15. trait ImplicitParam7 extends AnyRef

    Definition Classes
    ImplicitParameters
  16. trait ImplicitParam8 extends AnyRef

    Definition Classes
    ImplicitParameters
  17. trait ImplicitParam9 extends AnyRef

    Definition Classes
    ImplicitParameters
  18. case class SpecIdentificationMarkdownLink(s: String) extends Product with Serializable

    Definition Classes
    FragmentsBuilder
  19. class SpecTitle extends AnyRef

    Definition Classes
    FragmentsBuilder
  20. implicit class specificationInStringContext extends AnyRef

    Definition Classes
    SpecificationStringContext

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. implicit def ToFormattingTagParameter(condition: Boolean): Option[(Forms.this)#FormattingTagParameter]

    Definition Classes
    FormattingTags
  5. implicit def anyAsResultIsSpecPart(r: ⇒ Function0Result): SpecPart

    Definition Classes
    SpecificationStringContext
  6. implicit def anyCellableSeq[T](seq: Seq[T])(implicit arg0: (T) ⇒ Cell): Seq[Cell]

    any seq of object convertible to cells

    any seq of object convertible to cells

    Definition Classes
    FormsBuilder
  7. implicit def anyIsField[T](t: ⇒ T): Field[T]

    anything can be added on a Form row as a Field

    anything can be added on a Form row as a Field

    Definition Classes
    FormsBuilder
  8. implicit def anyIsFieldCell(t: ⇒ Any): FieldCell

    anything can be added on a Form row as a TextCell

    anything can be added on a Form row as a TextCell

    Definition Classes
    FormsBuilder
  9. implicit def argumentsFragment(a: Arguments): FragmentsFragment

    Arguments creation

    Arguments creation

    returns

    a Fragments object which can be chained with other fragments

    Definition Classes
    FragmentsBuilder
  10. implicit def argumentsIsSpecPart(a: Arguments): SpecPart

    Definition Classes
    SpecificationStringContext
  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. implicit def asResultIsSpecPart[R](r: ⇒ R)(implicit arg0: AsResult[R]): SpecPart

    Definition Classes
    SpecificationStringContext
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def effect[T](label: String, value: ⇒ T): Effect[T]

    returns

    a new EffectCell with a label and a value

    Definition Classes
    FormsBuilder
  15. implicit def effectIsTextCell(t: Effect[_]): EffectCell

    a Effect can be added on a Form row as a EffectCell

    a Effect can be added on a Form row as a EffectCell

    Definition Classes
    FormsBuilder
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. implicit def exampleFactory: ExampleFactory

    Definition Classes
    ExamplesFactory
  19. implicit def exampleIsSpecPart(e: Example): SpecPart

    Definition Classes
    SpecificationStringContext
  20. def execute(f: Fragment)(implicit arguments: Arguments = Arguments()): Product with Serializable with ExecutedFragment

    execute a Fragment.

    execute a Fragment.

    A Form is executed separately by executing each row and cell, setting the results on each cell

    Definition Classes
    FormFragmentExecutionFragmentExecution
  21. def executeBody(body: ⇒ Result)(implicit arguments: Arguments): Result

    This method could be overriden to provide alternate behavior when executing an Example

    This method could be overriden to provide alternate behavior when executing an Example

    Definition Classes
    FragmentExecution
  22. def executeFragment(implicit arguments: Arguments): Function[Fragment, ExecutedFragment]

    execute a Fragment.

    execute a Fragment.

    Definition Classes
    FragmentExecution
  23. def field(label: String, value1: Field[_], values: Field[_]*): Field[String]

    returns

    a new Field with a label and several values

    Definition Classes
    FormsBuilder
  24. def field[T](label: String, value: ⇒ T): Field[T]

    returns

    a new Field with a label and a value

    Definition Classes
    FormsBuilder
  25. def field[T](value: ⇒ T): Field[T]

    returns

    a new Field with no label and a value

    Definition Classes
    FormsBuilder
  26. implicit def fieldIsTextCell(t: Field[_]): FieldCell

    a Field can be added on a Form row as a FieldCell

    a Field can be added on a Form row as a FieldCell

    Definition Classes
    FormsBuilder
  27. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. implicit def forExample(s: String): (Forms.this)#ExampleDesc

    Example creation

    Example creation

    returns

    an Example description from a string, to create a full Example once the body is defined

    Definition Classes
    FragmentsBuilder
  29. def form(title: String): Form

    returns

    a new Form with the given title

    Definition Classes
    FormsBuilder
  30. implicit def formIsCell(t: ⇒ Form): FormCell

    a Form can be added on a Form row as a FormCell

    a Form can be added on a Form row as a FormCell

    Definition Classes
    FormsBuilder
  31. implicit def formIsExecutable(f: Form): Result

    a Form can be implicitly executed if necessary

    a Form can be implicitly executed if necessary

    Definition Classes
    FormsBuilder
  32. implicit def formIsSpecPart(f: ⇒ Form): SpecPart

  33. def formatSection(markdown: Option[(Forms.this)#FormattingTagParameter] = None, flow: Option[(Forms.this)#FormattingTagParameter] = None, verbatim: Option[(Forms.this)#FormattingTagParameter] = None): TagFragment

    add a tagging section with special tag names specifying the formatting options

    add a tagging section with special tag names specifying the formatting options

    Definition Classes
    FormattingTags
  34. def formatTag(markdown: Option[(Forms.this)#FormattingTagParameter] = None, flow: Option[(Forms.this)#FormattingTagParameter] = None, verbatim: Option[(Forms.this)#FormattingTagParameter] = None): TagFragment

    add a tag with special tag names specifying the formatting options

    add a tag with special tag names specifying the formatting options

    Definition Classes
    FormattingTags
  35. implicit def formsAreExamples(aForm: ⇒ Form): Example

    Definition Classes
    FormFragmentsBuilder
  36. implicit def formsHoldersAreExamples(f: ⇒ AnyRef { def form: org.specs2.form.Form }): Example

    Definition Classes
    FormFragmentsBuilder
  37. implicit def fragmentFragments(f: ⇒ Fragment): FragmentsFragment

    Definition Classes
    FragmentsBuilder
  38. implicit def fragmentIsSpecPart(f: Fragment): SpecPart

    Definition Classes
    SpecificationStringContext
  39. implicit def fragments(f: ⇒ Fragment): Fragments

    returns

    a Fragments object from a single Fragment

    Definition Classes
    FragmentsBuilder
  40. implicit def fragmentsFragmentIsSpecPart(ffs: FragmentsFragment): SpecPart

    Definition Classes
    SpecificationStringContext
  41. implicit def fragmentsFragmentToFragments(fs: FragmentsFragment): Fragments

    reverse conversion from a Fragment containing a Fragments object to the Fragments object

    reverse conversion from a Fragment containing a Fragments object to the Fragments object

    Definition Classes
    FragmentsBuilder
  42. implicit def fragmentsFragments(fs: ⇒ Fragments): FragmentsFragment

    Definition Classes
    FragmentsBuilder
  43. implicit def fragmentsIsSpecPart(fragments: Fragments): SpecPart

    Definition Classes
    SpecificationStringContext
  44. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  46. implicit lazy val implicitParam: (Forms.this)#ImplicitParam

    Definition Classes
    ImplicitParameters
  47. implicit lazy val implicitParam1: (Forms.this)#ImplicitParam1

    Definition Classes
    ImplicitParameters
  48. implicit lazy val implicitParam10: (Forms.this)#ImplicitParam10

    Definition Classes
    ImplicitParameters
  49. implicit lazy val implicitParam2: (Forms.this)#ImplicitParam2

    Definition Classes
    ImplicitParameters
  50. implicit lazy val implicitParam3: (Forms.this)#ImplicitParam3

    Definition Classes
    ImplicitParameters
  51. implicit lazy val implicitParam4: (Forms.this)#ImplicitParam4

    Definition Classes
    ImplicitParameters
  52. implicit lazy val implicitParam5: (Forms.this)#ImplicitParam5

    Definition Classes
    ImplicitParameters
  53. implicit lazy val implicitParam6: (Forms.this)#ImplicitParam6

    Definition Classes
    ImplicitParameters
  54. implicit lazy val implicitParam7: (Forms.this)#ImplicitParam7

    Definition Classes
    ImplicitParameters
  55. implicit lazy val implicitParam8: (Forms.this)#ImplicitParam8

    Definition Classes
    ImplicitParameters
  56. implicit lazy val implicitParam9: (Forms.this)#ImplicitParam9

    Definition Classes
    ImplicitParameters
  57. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  58. def lazify(c: ⇒ Cell): LazyCell

    a cell can be added lazily to a row.

    a cell can be added lazily to a row. It will only be evaluated when necessary

    Definition Classes
    FormsBuilder
  59. def link(htmlLink: HtmlLink, f: Fragments): Fragments

    Definition Classes
    FragmentsBuilder
  60. def link(htmlLink: HtmlLink, s: SpecificationStructure): Fragments

    create a link directly on a specification, with a given link

    create a link directly on a specification, with a given link

    Definition Classes
    FragmentsBuilder
  61. def link(fss: Seq[Fragments]): Fragments

    Definition Classes
    FragmentsBuilder
  62. def link(fs: Fragments, fss: Fragments*): Fragments

    Definition Classes
    FragmentsBuilder
  63. def link(fs: Fragments): Fragments

    Definition Classes
    FragmentsBuilder
  64. def link(ss: Seq[SpecificationStructure], dummy: Int = 0): Fragments

    Definition Classes
    FragmentsBuilder
  65. def link(s: SpecificationStructure, ss: SpecificationStructure*): Fragments

    Definition Classes
    FragmentsBuilder
  66. def link(s: SpecificationStructure): Fragments

    create a link directly on a specification

    create a link directly on a specification

    Definition Classes
    FragmentsBuilder
  67. implicit def markdownLinkIsSpecPart(link: MarkdownLink): SpecPart

    Definition Classes
    SpecificationStringContext
  68. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  69. final def notify(): Unit

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

    Definition Classes
    AnyRef
  71. def prop[T, S](label: String, actual: ⇒ T, expected: ⇒ S, c: Matcher[T]): Prop[T, S]

    returns

    a new Prop with a label, an actual value and a matcher to apply to the actual value

    Definition Classes
    FormsBuilder
  72. def prop[T](actual: ⇒ T, c: Matcher[T]): Prop[T, T]

    returns

    a new Prop with no label, an actual value and a matcher to apply to the actual value

    Definition Classes
    FormsBuilder
  73. def prop[T](label: String, actual: ⇒ T, c: Matcher[T]): Prop[T, T]

    returns

    a new Prop with a label, an actual value and a matcher to apply to the actual value

    Definition Classes
    FormsBuilder
  74. def prop[T, S](label: String, actual: ⇒ T, c: (S) ⇒ Matcher[T]): Prop[T, S]

    returns

    a new Prop with a label, an actual value and a matcher to apply to values

    Definition Classes
    FormsBuilder
  75. def prop[T, S](label: String, actual: ⇒ T, c: (T, S) ⇒ Result): Prop[T, S]

    returns

    a new Prop with a label, an actual value and a constraint to apply to values

    Definition Classes
    FormsBuilder
  76. def prop[T, S](label: String, actual: ⇒ T, exp: ⇒ S): Prop[T, S]

    returns

    a new Prop with a label, an actual value and expected value

    Definition Classes
    FormsBuilder
  77. def prop[T](label: String, actual: ⇒ T): Prop[T, T]

    returns

    a new Prop with a label and an actual value only

    Definition Classes
    FormsBuilder
  78. def prop[T](act: ⇒ T): Prop[T, T]

    returns

    a new Prop with an actual value only

    Definition Classes
    FormsBuilder
  79. implicit def propIsCell(t: Prop[_, _]): PropCell

    a Prop can be adde d on a Form row as a PropCell

    a Prop can be adde d on a Form row as a PropCell

    Definition Classes
    FormsBuilder
  80. def s2(content: String, Yrangepos: Boolean, texts: Seq[String], variables: Seq[SpecPart], rangeExpressions: Seq[String]): Fragments

    based on the interpolated variables and the expressions captured with the macro, create the appropriate fragments

    based on the interpolated variables and the expressions captured with the macro, create the appropriate fragments

    if the Yrangepos scalac option is not set then we use an approximated method to find the expressions texts

    Definition Classes
    SpecificationStringContext
  81. def section(names: String*): TagFragment

    create a AsSection fragment

    create a AsSection fragment

    Definition Classes
    Tags
  82. def see(htmlLink: HtmlLink, fs: Fragments): Fragments

    Definition Classes
    FragmentsBuilder
  83. def see(htmlLink: HtmlLink, s: SpecificationStructure): Fragments

    create a see-only link directly on a specification, with a given link

    create a see-only link directly on a specification, with a given link

    Definition Classes
    FragmentsBuilder
  84. def see(fss: Seq[Fragments]): Fragments

    Definition Classes
    FragmentsBuilder
  85. def see(fs: Fragments, fss: Fragments*): Fragments

    Definition Classes
    FragmentsBuilder
  86. def see(fs: Fragments): Fragments

    Definition Classes
    FragmentsBuilder
  87. def see(s: SpecificationStructure): Fragments

    Definition Classes
    FragmentsBuilder
  88. def see(ss: Seq[SpecificationStructure])(implicit p1: (Forms.this)#ImplicitParam1): Fragments

    Definition Classes
    FragmentsBuilder
  89. def see(s: SpecificationStructure, ss: SpecificationStructure*): Fragments

    create a html link without including the other specification fragments

    create a html link without including the other specification fragments

    Definition Classes
    FragmentsBuilder
  90. implicit def specIdentificationMarkdownLink(s: String): (Forms.this)#SpecIdentificationMarkdownLink

    create markdown links from string + spec identification

    create markdown links from string + spec identification

    Definition Classes
    FragmentsBuilder
  91. implicit def specStructureIsSpecPart(s: SpecificationStructure): SpecPart

    Definition Classes
    SpecificationStringContext
  92. implicit def specificationStructureToFragments(s: SpecificationStructure): (Forms.this)#AsFragments

    this implicit allows to call some functions directly on a specification, like 'hide'

    this implicit allows to call some functions directly on a specification, like 'hide'

    Definition Classes
    FragmentsBuilder
  93. implicit def stringIsSpecPart(s: ⇒ String): SpecPart

    Definition Classes
    SpecificationStringContext
  94. implicit def stringToHtmlLinkFragments(s: String): (Forms.this)#HtmlLinkFragments

    Links to other specifications creation

    Links to other specifications creation

    Definition Classes
    FragmentsBuilder
    See also

    org.specs2.UserGuide

  95. implicit def stringToHtmlLinkFragments2(s: String): (Forms.this)#HtmlLinkFragments2

    Definition Classes
    FragmentsBuilder
  96. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  97. def tab(label: String, form: Form): Tabs

    returns

    a new Tabs object with a first tab

    Definition Classes
    FormsBuilder
  98. def tabs: Tabs

    returns

    a new Tabs object

    Definition Classes
    FormsBuilder
  99. def tag(names: String*): TagFragment

    create a TaggedAs fragment

    create a TaggedAs fragment

    Definition Classes
    Tags
  100. implicit def textFragment(s: String): FragmentsFragment

    returns

    create a Text Fragment from a string and allow it to be chained to other fragments

    Definition Classes
    FragmentsBuilder
  101. implicit def textStart(s: String): Fragments

    returns

    a Fragments object from a string

    Definition Classes
    FragmentsBuilder
  102. implicit def title(s: String): (Forms.this)#SpecTitle

    This method allows to add a title to the Specification.

    This method allows to add a title to the Specification. It can be used as an operation on a String: "spec title".title

    returns

    a Fragments object from a string, with the given title

    Definition Classes
    FragmentsBuilder
  103. implicit def toDecorated[T <: DecoratedProperty[T]](d: T): (Forms.this)#Decorated[T]

    Definition Classes
    DecoratedProperties
  104. implicit def toFormIsSpecPart(f: AnyRef { def form: org.specs2.form.Form }): SpecPart

  105. def toString(): String

    Definition Classes
    AnyRef → Any
  106. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. implicit def xmlIsACell[T](xml: ⇒ NodeSeq): XmlCell

    any xml can be injected as a cell

    any xml can be injected as a cell

    Definition Classes
    FormsBuilder

Inherited from FormFragmentExecution

Inherited from FragmentExecution

Inherited from DecoratedProperties

Inherited from FormFragmentsBuilder

Inherited from FragmentsBuilder

Inherited from FormattingTags

Inherited from Tags

Inherited from ImplicitParameters

Inherited from ExamplesFactory

Inherited from FormsBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped