specs2-form/org.specs2.specification/Forms

Forms

object Forms extends Forms
Companion:
class
trait Forms
trait FormDsl
trait SpecStructureDsl
trait FragmentsDsl
trait ActionDsl
trait TagDsl
trait ReferenceCreation
trait S2StringContext
trait S2StringContextCreation
trait FragmentsFactory
class Object
trait Matchable
class Any
Forms.type

Type members

Inherited classlikes

class Decorated[T <: DecoratedProperty[T]](d: T)
Inherited from:
DecoratedProperties
implicit class HiddenFragment(fragment: Fragment)
Inherited from:
FragmentsDsl
implicit class MutedFragment(fragment: Fragment)
Inherited from:
FragmentsDsl
implicit class PropOps[T](p: Prop[T, T])
Inherited from:
PropSyntax
object ToCell
Inherited from:
FormsBuilder
trait ToCell[T]
Inherited from:
FormsBuilder
implicit class appendFormToArguments(args: Arguments) extends appendToArguments
Inherited from:
FormDsl
implicit class appendFormToFragment(f: Fragment) extends appendToFragment
Inherited from:
FormDsl
implicit class appendFormToFragments(fs: Fragments) extends appendToFragments
Inherited from:
FormDsl
implicit class appendFormToSpecHeader(header: SpecHeader) extends appendSpecStructureToSpecHeader
Inherited from:
FormDsl
implicit class appendFormToSpecStructure(structure: SpecStructure) extends appendSpecStructureToSpecStructure
Inherited from:
FormDsl
implicit class appendFormToString(s: String) extends appendToString
Inherited from:
FormDsl
implicit class appendSpecStructureToFragment(f: Fragment)
Inherited from:
SpecStructureDsl
implicit class appendSpecStructureToFragments(fs: => Fragments)
implicit class appendSpecStructureToSpecHeader(header: SpecHeader)
Inherited from:
SpecStructureDsl
implicit class appendSpecStructureToSpecStructure(structure: SpecStructure)
Inherited from:
SpecStructureDsl
implicit class appendSpecStructureToString(s: String)
Inherited from:
SpecStructureDsl
implicit class appendToArguments(args: Arguments)
Inherited from:
SpecStructureDsl1
implicit class appendToFragment(f: Fragment)
Inherited from:
FragmentsDsl
implicit class appendToFragments(fs: Fragments)
Inherited from:
FragmentsDsl
implicit class appendToString(s: String)
Inherited from:
FragmentsDsl
implicit class specificationInStringContext(sc: StringContext)

Value members

Inherited methods

def action(a: => Any): Fragment
Inherited from:
ActionDsl
def action[T](label: String, a: => T): Prop[T, T]
Returns:

a new Prop with a label, which has the same actual and expected value to test the result of an action

Inherited from:
FormsBuilder
def createExecutionInterpolatedFragment[R : AsExecution](execution: R): InterpolatedFragment
Inherited from:
S2StringContextCreation
def effect[T](label: String, value: => T): Effect[T]
Returns:

a new Effect with a label and a value

Inherited from:
FormsBuilder
def field(label: String, value1: Field[_], values: Field[_]*): Field[String]
Returns:

a new Field with a label and several values

Inherited from:
FormsBuilder
def field[T](label: String, value: => T): Field[T]
Returns:

a new Field with a label and a value

Inherited from:
FormsBuilder
def field[T](value: => T): Field[T]
Returns:

a new Field with no label and a value

Inherited from:
FormsBuilder
def form(title: String): Form
Returns:

a new Form with the given title

Inherited from:
FormsBuilder
protected def fragmentFactory: FragmentFactory
Inherited from:
FragmentsFactory
def fragmentsBlock(fragments: Seq[Fragment], offset: Int): Fragments

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

Inherited from:
FragmentsDsl
def lazify(c: => Cell): LazyCell

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

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

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
def prop[T](label: String, actual: => T): Prop[T, T]
Returns:

a new Prop with a label and an actual value only

Inherited from:
FormsBuilder
def prop[T](act: => T): Prop[T, T]
Returns:

a new Prop with an actual value only

Inherited from:
FormsBuilder
def s2(content: String, Yrangepos: Boolean, texts: Seq[String], textsStartPositions: Seq[String], textsEndPositions: Seq[String], variables: Seq[InterpolatedFragment], 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

Inherited from:
S2StringContextCreation
def section(tag: NamedTag): Fragment
Inherited from:
TagDsl
def section(names: String*): Fragment
Inherited from:
TagDsl
def see(s: => SpecificationStructure): Fragment
Inherited from:
ReferenceCreation
def see(s: SpecStructure): Fragment
Inherited from:
ReferenceCreation
def step(a: => Any, global: Boolean): Fragment
Inherited from:
ActionDsl
def step(a: => Any): Fragment
Inherited from:
ActionDsl
def tab(label: String, form: Form): Tabs
Returns:

a new Tabs object with a first tab

Inherited from:
FormsBuilder
def tabs: Tabs
Returns:

a new Tabs object

Inherited from:
FormsBuilder
def tag(tag: NamedTag): Fragment
Inherited from:
TagDsl
def tag(names: String*): Fragment
Inherited from:
TagDsl

Implicits

Inherited implicits

final implicit def HiddenFragment(fragment: Fragment): HiddenFragment
Inherited from:
FragmentsDsl
final implicit def MutedFragment(fragment: Fragment): MutedFragment
Inherited from:
FragmentsDsl
final implicit def PropOps[T](p: Prop[T, T]): PropOps[T]
Inherited from:
PropSyntax
implicit def anyAsResultIsInterpolatedFragment(r: => Function0Result): InterpolatedFragment
Inherited from:
S2StringContext
implicit def anyCellableSeq[T : ToCell](seq: Seq[T]): Seq[Cell]

any seq of object convertible to cells

any seq of object convertible to cells

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
final implicit def appendFormToArguments(args: Arguments): appendFormToArguments
Inherited from:
FormDsl
final implicit def appendFormToFragment(f: Fragment): appendFormToFragment
Inherited from:
FormDsl
final implicit def appendFormToFragments(fs: Fragments): appendFormToFragments
Inherited from:
FormDsl
final implicit def appendFormToSpecHeader(header: SpecHeader): appendFormToSpecHeader
Inherited from:
FormDsl
final implicit def appendFormToSpecStructure(structure: SpecStructure): appendFormToSpecStructure
Inherited from:
FormDsl
final implicit def appendFormToString(s: String): appendFormToString
Inherited from:
FormDsl
final implicit def appendSpecStructureToFragment(f: Fragment): appendSpecStructureToFragment
Inherited from:
SpecStructureDsl
final implicit def appendSpecStructureToFragments(fs: => Fragments): appendSpecStructureToFragments
Inherited from:
SpecStructureDslLowImplicits
final implicit def appendSpecStructureToSpecHeader(header: SpecHeader): appendSpecStructureToSpecHeader
Inherited from:
SpecStructureDsl
final implicit def appendSpecStructureToSpecStructure(structure: SpecStructure): appendSpecStructureToSpecStructure
Inherited from:
SpecStructureDsl
final implicit def appendSpecStructureToString(s: String): appendSpecStructureToString
Inherited from:
SpecStructureDsl
final implicit def appendToArguments(args: Arguments): appendToArguments
Inherited from:
SpecStructureDsl1
final implicit def appendToFragment(f: Fragment): appendToFragment
Inherited from:
FragmentsDsl
final implicit def appendToFragments(fs: Fragments): appendToFragments
Inherited from:
FragmentsDsl
final implicit def appendToString(s: String): appendToString
Inherited from:
FragmentsDsl
implicit def asExecutionIsInterpolatedFragment[R : AsExecution](e: => R): InterpolatedFragment
Inherited from:
S2StringContext
implicit def asResultIsInterpolatedFragment[R : AsResult](r: => R): InterpolatedFragment
Inherited from:
S2StringContext1
implicit def descriptionToFragmentsIsInterpolatedFragment(fragments: String => Fragments): InterpolatedFragment
Inherited from:
S2StringContext
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

Inherited from:
FormsBuilder
implicit def executionIsInterpolatedFragment(execution: Execution): InterpolatedFragment
Inherited from:
S2StringContext
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

Inherited from:
FormsBuilder
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

Inherited from:
FormsBuilder
implicit def formIsExecutable(f: Form): Result

a Form can be implicitly executed if necessary

a Form can be implicitly executed if necessary

Inherited from:
FormsBuilder
implicit def formIsInterpolatedFragment(f: => Form): InterpolatedFragment
Inherited from:
FormS2StringContext
implicit def fragmentAsSpecStructure(f: Fragment): SpecStructure
Inherited from:
SpecStructureDsl
implicit def fragmentIsInterpolatedFragment(f: => Fragment): InterpolatedFragment
Inherited from:
S2StringContext1
implicit def fragmentToFragments(f: Fragment): Fragments
Inherited from:
FragmentsDsl
implicit def fragmentsAsSpecStructure(fs: => Fragments): SpecStructure
Inherited from:
SpecStructureDsl1
implicit def fragmentsIsInterpolatedFragment(fragments: Fragments): InterpolatedFragment
Inherited from:
S2StringContext
implicit def propIsCell(t: Prop[_, _]): PropCell

a Prop can be added on a Form row as a PropCell

a Prop can be added on a Form row as a PropCell

Inherited from:
FormsBuilder
implicit def resultAsSpecStructure[R : AsResult](r: => R): SpecStructure
Inherited from:
SpecStructureDslLowImplicits
implicit def specHeaderAsStructure(header: SpecHeader): SpecStructure
Inherited from:
SpecStructureDsl
implicit def specStructureAsFragments(spec: SpecStructure): Fragments
Inherited from:
SpecStructureDsl
implicit def specStructureIsInterpolatedFragment(s: SpecStructure): InterpolatedFragment
Inherited from:
S2StringContext
final implicit def specificationInStringContext(sc: StringContext): specificationInStringContext
Inherited from:
S2StringContextCreation
implicit def specificationRefIsInterpolatedFragment(ref: SpecificationRef): InterpolatedFragment
Inherited from:
S2StringContext
implicit def specificationStructureIsInterpolatedFragment(s: SpecificationStructure): InterpolatedFragment
Inherited from:
S2StringContext
implicit def stepParserIsInterpolatedFragment[R : AsResult](f: StepParser[R]): InterpolatedFragment
Inherited from:
S2StringContext
implicit def stringAsSpecStructure(s: String): SpecStructure
Inherited from:
SpecStructureDsl
implicit def stringFunctionIsInterpolatedFragment[R : AsResult](f: String => R): InterpolatedFragment
Inherited from:
S2StringContext
implicit def stringIsInterpolatedFragment(s: => String): InterpolatedFragment
Inherited from:
S2StringContext
implicit def toDecorated[T <: DecoratedProperty[LazyRef(...)]](d: T): Decorated[T]
Inherited from:
DecoratedProperties
implicit def toFormIsInterpolatedFragment[T : HasForm](f: T): InterpolatedFragment
Inherited from:
FormS2StringContext
implicit def xmlIsACell[T](xml: => NodeSeq): XmlCell

any xml can be injected as a cell

any xml can be injected as a cell

Inherited from:
FormsBuilder