Link data type

Value range of the Link data type

FirstSpirit provides the data type Link for the processing/editing of values which represent a link within or outside the project.

For further information about links and link templates in FirstSpirit please see Chapter Link templates.

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 Link or a list of Link objects;

• CMS_INPUT_LINK

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

$CMS_VALUE(IDENTIFIER.METHOD)$

Methods on link objects

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

compareTo(Comparable)

Overview

equals(Object)

Overview

findReferences(Language)

Overview

get(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

getContentID

Overview

getFormData

Overview

getLinkLanguage

Overview

getNode

Overview

getSectiontemplate

Overview

getTemplate

Overview

getText

The method getText returns the content of the input component of a link which is selected in the drop down box "Link text" on the tab "Properties. (See also Chapter Link templates).

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

isSet(Object)

Overview

print

Overview

set(String, Object)

Overview

setFormData(FormData)

Overview

setTemplate(LinkTemplate)

Overview

setText(String)

Overview

toJson

Overview

toString

Overview

type

Overview