specs2-form
API
Generated with
specs2-form/org.specs2/org.specs2.specification/Forms

Forms

org.specs2.specification.Forms
See theForms companion object
trait Forms extends FormFragmentsFactory, FormS2StringContext, FormDsl, PropSyntax

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

Attributes

Companion
object
Graph
Supertypes
trait PropSyntax
trait FormDsl
trait SpecStructureDsl
trait FragmentsDsl
trait ActionDsl
trait TagDsl
trait ReferenceCreation
trait S2StringContext
trait S2StringContextCreation
trait FragmentsFactory
class Object
trait Matchable
class Any
Show all
Known subtypes
object Forms.type

Members list

Type members

Inherited classlikes

class Decorated[T <: DecoratedProperty[T]](d: T)

Attributes

Inherited from:
DecoratedProperties (hidden)
Supertypes
class Object
trait Matchable
class Any
implicit class HiddenFragment(fragment: Fragment)

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
implicit class MutedFragment(fragment: Fragment)

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
implicit class PropOps[T](p: Prop[T, T])

Attributes

Inherited from:
PropSyntax
Supertypes
class Object
trait Matchable
class Any
object ToCell

Attributes

Inherited from:
FormsBuilder (hidden)
Supertypes
class Object
trait Matchable
class Any
trait ToCell[T]

Attributes

Inherited from:
FormsBuilder (hidden)
Supertypes
class Object
trait Matchable
class Any
implicit class appendFormToArguments(args: Arguments) extends appendToArguments

Attributes

Inherited from:
FormDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendFormToFragment(f: Fragment) extends appendToFragment

Attributes

Inherited from:
FormDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendFormToFragments(fs: Fragments) extends appendToFragments

Attributes

Inherited from:
FormDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendFormToSpecHeader(header: SpecHeader) extends appendSpecStructureToSpecHeader

Attributes

Inherited from:
FormDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendFormToSpecStructure(structure: SpecStructure) extends appendSpecStructureToSpecStructure

Attributes

Inherited from:
FormDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendFormToString(s: String) extends appendToString

Attributes

Inherited from:
FormDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendSpecStructureToFragment(f: Fragment)

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendSpecStructureToFragments(fs: => Fragments)

Attributes

Inherited from:
SpecStructureDslLowImplicits (hidden)
Supertypes
class Object
trait Matchable
class Any
implicit class appendSpecStructureToSpecHeader(header: SpecHeader)

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
Known subtypes
implicit class appendSpecStructureToSpecStructure(structure: SpecStructure)

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
Known subtypes
implicit class appendSpecStructureToString(s: String)

Attributes

Inherited from:
SpecStructureDsl
Supertypes
class Object
trait Matchable
class Any
implicit class appendToArguments(args: Arguments)

Attributes

Inherited from:
SpecStructureDsl1 (hidden)
Supertypes
class Object
trait Matchable
class Any
Known subtypes
implicit class appendToFragment(f: Fragment)

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
Known subtypes
implicit class appendToFragments(fs: Fragments)

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
Known subtypes
implicit class appendToString(s: String)

Attributes

Inherited from:
FragmentsDsl
Supertypes
class Object
trait Matchable
class Any
Known subtypes
implicit class specificationInStringContext(sc: StringContext)

Attributes

Inherited from:
S2StringContextCreation
Supertypes
class Object
trait Matchable
class Any

Value members

Inherited methods

def action(a: => Any): Fragment

Attributes

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

Attributes

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 (hidden)
def createExecutionInterpolatedFragment[R : AsExecution](execution: R): InterpolatedFragment

Attributes

Inherited from:
S2StringContextCreation
def effect[T](label: String, value: => T): Effect[T]

Attributes

Returns

a new Effect with a label and a value

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

Attributes

Returns

a new Field with a label and several values

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

Attributes

Returns

a new Field with a label and a value

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

Attributes

Returns

a new Field with no label and a value

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

Attributes

Returns

a new Form with the given title

Inherited from:
FormsBuilder (hidden)
protected def formFragmentFactory: FormFragmentFactory

Attributes

Inherited from:
FormFragmentsFactory
protected def fragmentFactory: FragmentFactory

Attributes

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

Attributes

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

Attributes

Inherited from:
FormsBuilder (hidden)
def prop[T, S](label: String, actual: => T, expected: => S, c: Matcher[T]): Prop[T, S]

Attributes

Returns

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

Inherited from:
FormsBuilder (hidden)
def prop[T](actual: => T, c: Matcher[T]): Prop[T, T]

Attributes

Returns

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

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

Attributes

Returns

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

Inherited from:
FormsBuilder (hidden)
def prop[T, S](label: String, actual: => T, c: S => Matcher[T]): Prop[T, S]

Attributes

Returns

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

Inherited from:
FormsBuilder (hidden)
def prop[T, S](label: String, actual: => T, c: (T, S) => Result): Prop[T, S]

Attributes

Returns

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

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

Attributes

Returns

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

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

Attributes

Returns

a new Prop with a label and an actual value only

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

Attributes

Returns

a new Prop with an actual value only

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

Attributes

Inherited from:
S2StringContextCreation
def section(tag: NamedTag): Fragment

Attributes

Inherited from:
TagDsl
def section(names: String*): Fragment

Attributes

Inherited from:
TagDsl
def see(s: => SpecificationStructure): Fragment

Attributes

Inherited from:
ReferenceCreation
def see(s: SpecStructure): Fragment

Attributes

Inherited from:
ReferenceCreation
def step(a: => Any, global: Boolean): Fragment

Attributes

Inherited from:
ActionDsl
def step(a: => Any): Fragment

Attributes

Inherited from:
ActionDsl
def tab(label: String, form: Form): Tabs

Attributes

Returns

a new Tabs object with a first tab

Inherited from:
FormsBuilder (hidden)
def tabs: Tabs

Attributes

Returns

a new Tabs object

Inherited from:
FormsBuilder (hidden)
def tag(tag: NamedTag): Fragment

Attributes

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

Attributes

Inherited from:
TagDsl

Implicits

Inherited implicits

final implicit def HiddenFragment(fragment: Fragment): HiddenFragment

Attributes

Inherited from:
FragmentsDsl
final implicit def MutedFragment(fragment: Fragment): MutedFragment

Attributes

Inherited from:
FragmentsDsl
final implicit def PropOps[T](p: Prop[T, T]): PropOps[T]

Attributes

Inherited from:
PropSyntax
implicit def anyAsResultIsInterpolatedFragment(r: => Function0Result): InterpolatedFragment

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
FormsBuilder (hidden)
final implicit def appendFormToArguments(args: Arguments): appendFormToArguments

Attributes

Inherited from:
FormDsl
final implicit def appendFormToFragment(f: Fragment): appendFormToFragment

Attributes

Inherited from:
FormDsl
final implicit def appendFormToFragments(fs: Fragments): appendFormToFragments

Attributes

Inherited from:
FormDsl
final implicit def appendFormToSpecHeader(header: SpecHeader): appendFormToSpecHeader

Attributes

Inherited from:
FormDsl
final implicit def appendFormToSpecStructure(structure: SpecStructure): appendFormToSpecStructure

Attributes

Inherited from:
FormDsl
final implicit def appendFormToString(s: String): appendFormToString

Attributes

Inherited from:
FormDsl
final implicit def appendSpecStructureToFragment(f: Fragment): appendSpecStructureToFragment

Attributes

Inherited from:
SpecStructureDsl
final implicit def appendSpecStructureToFragments(fs: => Fragments): appendSpecStructureToFragments

Attributes

Inherited from:
SpecStructureDslLowImplicits (hidden)
final implicit def appendSpecStructureToSpecHeader(header: SpecHeader): appendSpecStructureToSpecHeader

Attributes

Inherited from:
SpecStructureDsl
final implicit def appendSpecStructureToSpecStructure(structure: SpecStructure): appendSpecStructureToSpecStructure

Attributes

Inherited from:
SpecStructureDsl
final implicit def appendSpecStructureToString(s: String): appendSpecStructureToString

Attributes

Inherited from:
SpecStructureDsl
final implicit def appendToArguments(args: Arguments): appendToArguments

Attributes

Inherited from:
SpecStructureDsl1 (hidden)
final implicit def appendToFragment(f: Fragment): appendToFragment

Attributes

Inherited from:
FragmentsDsl
final implicit def appendToFragments(fs: Fragments): appendToFragments

Attributes

Inherited from:
FragmentsDsl
final implicit def appendToString(s: String): appendToString

Attributes

Inherited from:
FragmentsDsl
implicit def asExecutionIsInterpolatedFragment[R : AsExecution](e: => R): InterpolatedFragment

Attributes

Inherited from:
S2StringContext
implicit def asResultIsInterpolatedFragment[R : AsResult](r: => R): InterpolatedFragment

Attributes

Inherited from:
S2StringContext1 (hidden)
implicit def descriptionToFragmentsIsInterpolatedFragment(fragments: String => Fragments): InterpolatedFragment

Attributes

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

Attributes

Inherited from:
FormsBuilder (hidden)
implicit def executionIsInterpolatedFragment(execution: Execution): InterpolatedFragment

Attributes

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

Attributes

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

Attributes

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

a Form can be implicitly executed if necessary

a Form can be implicitly executed if necessary

Attributes

Inherited from:
FormsBuilder (hidden)
implicit def formIsInterpolatedFragment(f: => Form): InterpolatedFragment

Attributes

Inherited from:
FormS2StringContext
implicit def fragmentAsSpecStructure(f: Fragment): SpecStructure

Attributes

Inherited from:
SpecStructureDsl
implicit def fragmentIsInterpolatedFragment(f: => Fragment): InterpolatedFragment

Attributes

Inherited from:
S2StringContext1 (hidden)
implicit def fragmentToFragments(f: Fragment): Fragments

Attributes

Inherited from:
FragmentsDsl
implicit def fragmentsAsSpecStructure(fs: => Fragments): SpecStructure

Attributes

Inherited from:
SpecStructureDsl1 (hidden)
implicit def fragmentsIsInterpolatedFragment(fragments: Fragments): InterpolatedFragment

Attributes

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

Attributes

Inherited from:
FormsBuilder (hidden)
implicit def resultAsSpecStructure[R : AsResult](r: => R): SpecStructure

Attributes

Inherited from:
SpecStructureDslLowImplicits (hidden)
implicit def specHeaderAsStructure(header: SpecHeader): SpecStructure

Attributes

Inherited from:
SpecStructureDsl
implicit def specStructureAsFragments(spec: SpecStructure): Fragments

Attributes

Inherited from:
SpecStructureDsl
implicit def specStructureIsInterpolatedFragment(s: SpecStructure): InterpolatedFragment

Attributes

Inherited from:
S2StringContext
final implicit def specificationInStringContext(sc: StringContext): specificationInStringContext

Attributes

Inherited from:
S2StringContextCreation
implicit def specificationRefIsInterpolatedFragment(ref: SpecificationRef): InterpolatedFragment

Attributes

Inherited from:
S2StringContext
implicit def specificationStructureIsInterpolatedFragment(s: SpecificationStructure): InterpolatedFragment

Attributes

Inherited from:
S2StringContext
implicit def stepParserIsInterpolatedFragment[R : AsResult](f: StepParser[R]): InterpolatedFragment

Attributes

Inherited from:
S2StringContext
implicit def stringAsSpecStructure(s: String): SpecStructure

Attributes

Inherited from:
SpecStructureDsl
implicit def stringFunctionIsInterpolatedFragment[R : AsResult](f: String => R): InterpolatedFragment

Attributes

Inherited from:
S2StringContext
implicit def stringIsInterpolatedFragment(s: => String): InterpolatedFragment

Attributes

Inherited from:
S2StringContext
implicit def toDecorated[T <: DecoratedProperty[LazyRef(...)]](d: T): Decorated[T]

Attributes

Inherited from:
DecoratedProperties (hidden)
implicit def toFormIsInterpolatedFragment[T : HasForm](f: T): InterpolatedFragment

Attributes

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

Attributes

Inherited from:
FormsBuilder (hidden)
Generated with