org.specs2.form

This trait defines a simple tab with a title and some text.

The text will be interpreted as Markdown text when rendered as html

A set of tabs with a title, where each tab simply contains some text

A Cell is the Textual or Xml representation of a Form element: Field, Prop or Form. A more general XmlCell is also available to be able to input any kind of Xml inside a Form

A Cell can be executed by executing the underlying element but also by setting the cell to a specific result (success or failure). This feature is used to display rows of values with were expected and found ok in Forms.

Base class for constraints executed on an optional expected value.

A DecoratedLabel holds a decorator and delegates decoration and styling operations to that Decorator

A DecoratedLabel holds a decorator and delegates decoration and styling operations for values and labels to that Decorator

This class contains functions to decorate and style a label and a value:

• with a function taking the xml for the label/value and returning some xml
• with some xml attributes "name":"value" to style those labels/values

The methods of that class allow to stack new decoration, new styling attributes but also define standard decoration and styles for bold / italic / centered ... text.

An Effect is a property which is used to display names corresponding to side-effects.

If the side effect throws an exception, the Effect will display it alongside to the label. Otherwise only the label is displayed.

The apply method can be used to execute the Effect effect and possibly get a value out of it (but usually not displayed): Effect(label, 1).apply() must ===(1)

The value is stored in a Property object so it will not be evaluated until explicitly queried.

Factory methods for creating Effects. Effects values can also be concatenated to produce "summary" effects.

val e1 = Effect("hello", print("hello")) val e2 = Effect("world", print("world")) val concatenatedEffects = Effect(e1, e2) concatenatedEffects.toString == hello/world

val concatenatedEffect = Effect(", ", e1, e2) concatenatedEffects2.toString == hello, world

Cell embedding a Eff

A Field is a property which is used only to display input values or output values.

The apply method can be used to retrieve the Field value: Field(label, 1).apply() must ===(1)

The value is stored in a Property object so it will not be evaluated until explicitly queried

Factory methods for creating Fields. Fields values can also be concatenated to produce "summary" fields.

val f1 = Field(label, "hello") val f2 = Field(label, "world") val concatenatedFields = Field(label, f1, f2) concatenatedFields.toString == label: hello/world

val concatenatedFields2 = Field(label, ", ", f1, f2) concatenatedFields2.toString == label: hello, world

Cell embedding a Field

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.

Companion object of a Form to create:

• an empty Form
• a Form with no rows but a title
• a Form with no title but one row

Cell embedding a Form

This general constraint uses a function taking an actual value and an expected value to do the match.

generic trait for anything having a label, to unify Props and Forms

This Form overrides the toXml and text methods so that it appears seamlessly included in another Form.

Proxy to a cell that's not evaluated right away when added to a row

The Prop class is a named property which holds:

• an actual value
• an expected value
• a constraint to check if the actual value conforms to the expected one

This property can be executed and can be inserted in a Form.

A Prop is meant to be declared as "bound" to an actual value:

val customerName = Prop("Customer name", person.name)

[the actual value is not evaluated until the Prop is executed]

Then it can be associated an expected value with the apply method (usually in a Form declaration):

customerName("Bill")

The actual and the expected values can have different types and the constraint which is applied to them can be anything returning a result.

However the Prop companion object provides a method to create a Property with a constraint using a beEqualTo matcher:

Prop("Name", "Eric")("Eric") must ===(Success("'Eric' is equal to 'Eric'"))

Companion object with factory methods

Cell embedding a Prop

A Row is a non-empty list of Cells

A Row can be executed by executing each Cell and collecting the results.

Companion object of a Row to create a Row with at least one cell

Class representing an individual tab

This class allows the creation of tabs to embed several forms at once on a limited html space

Base type for anything returning some text

Simple Cell embedding an arbitrary String

Base type for anything returning some xml

utility functions for creating xml for Cells

This cell can contain any xml