Option data type

Value range of the Option data type

In several set-valued input components, e.g. CHECKBOX, COMBOBOX, LIST and RADIOBUTTON, one or several entries can be selected.

An entry is represented in FirstSpirit by the data type Option .

If only one entry can be selected in the input component (e.g. COMBOBOX), an Option object is returned.

In the case of input components in which several entries can be selected (e.g. CHECKBOX), the input component returns a List of Option objects. Such a list can be output with the help of a $CMS_FOR(...)$ instruction.

Definition using the standard input components

Different input components can be defined in the form area of a page or section template. These form elements can then be used to insert the actual editorial contents into the page. The Standard input components supported by FirstSpirit return different data types.

The following standard input components return an object of data type Option :

• CMS_INPUT_CHECKBOX
• CMS_INPUT_COMBOBOX
• CMS_INPUT_LIST
• CMS_INPUT_RADIOBUTTON

Then, with the help of a $CMS_VALUE(...)$ instruction, methods can then be applied to this object:

$CMS_VALUE(IDENTIFIER.METHOD)$

Under IDENTIFIER, the resultname parameter, defined in the input component, must be specified.

Methods on Option objects

The table below lists all methods which can be invoked on objects of data type Option .

compareTo(Comparable)

Overview

compareTo(Object)

Overview

equals(CharSequence)

Overview

equals(Object)

Overview

getClass

The .getClass() (in Bean syntax: .class) method returns the class of the invoking object (cf. java.lang.Class).

Invocation:

$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$

Output:

java.lang.String

Overview

getKey

Overview

getLabel(String)

Overview

getLabel(Language)

Overview

getValue

The method getValue returns the selected option.

Overview

ignore(Language)

Overview

isCase(Object)

Overview

isNull

The .isNull() (in Bean syntax: .isNull) method checks whether an expression or object is null , e.g. storeElement.isNull(). In the case of objects with complex values or objects, the object decides when it is null. The data type DomElement for example always contains an empty document, thus it is never null. For this reason, checking an empty DOM editor input component by using the method .isNull() returns the value false, whereas checking the component with .isEmpty() would return the value true.

The method .isNull() returns a Boolean value as the check result. true is the check result if the expression or object is null and false if not.

Overview

print

Overview

putLabel(String, String)

Overview

putLabel(Language, String)

Overview

set(String, Object)

Overview

toJson

Overview

toString

Overview

type

Overview