Field

case class Field[T](label: String, value: Property[T], decorator: Decorator) extends Executable with DecoratedProperty[Field[T]]

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

Companion:
object
trait Serializable
trait Product
trait Equals
trait Executable
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply(v: => T): Field[T]

set a new value on the field.

set a new value on the field.

set a new Decorator

set a new Decorator

override def equals(a: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters:
that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Equals -> Any
override def execute: Result

executing a field execute the value and returns success unless there is an Error

executing a field execute the value and returns success unless there is an Error

Definition Classes
Executable
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Returns:

the hash code value for this object.

Definition Classes
Any
def header: Field[T]

use this Field as a header in a table

use this Field as a header in a table

def optionalValue: Option[T]
Returns:

the field value as an Option

def toOption: Option[T]
Returns:

the field value as an Option

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Returns:

a string representation of the object.

Definition Classes
Any
def toStringField: Field[String]

transforms this typed Field as a Field containing the toString value of the Fields value

transforms this typed Field as a Field containing the toString value of the Fields value

Inherited methods

def decorateLabel(ns: Any): Any

do the decoration

do the decoration

Inherited from:
DecoratedLabel
def decorateLabelWith(f: Any => Any): T

set a new Decorator for the label

set a new Decorator for the label

Inherited from:
DecoratedLabel
def decorateValue(ns: Any): Any

do the decoration

do the decoration

Inherited from:
DecoratedProperty
def decorateValueWith(f: Any => Any): T

set a new Decorator for the value

set a new Decorator for the value

Inherited from:
DecoratedProperty
def decorateWith(f: Any => Any): T

set a new Decorator

set a new Decorator

Inherited from:
DecoratedProperty
def labelStyles: String

return the label styles

return the label styles

Inherited from:
DecoratedLabel
def map(f: Result => Result): Executable

modify the result to return

modify the result to return

Inherited from:
Executable
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def styleLabelWith(s: (String, String)): T

set a new style for the label

set a new style for the label

Inherited from:
DecoratedLabel
def styleValueWith(s: (String, String)): T

set a new style for the value

set a new style for the value

Inherited from:
DecoratedProperty
def styleWith(s: (String, String)): T

set a new style

set a new style

Inherited from:
DecoratedProperty
def valueStyles: String
Inherited from:
DecoratedProperty

Concrete fields

lazy val valueOrResult: Either[Result, T]