SectionListEntry data type

Value range of the SectionListEntry data type

The SECTIONLIST input component can be used to create a list of existing sections. The input component is used, e.g. to create a table of contents with jump labels to the sections.

As the input component returns a List of SectionListEntry objects, the individual section entries are output with a $CMS_FOR(...)$ instruction

<ul>
  $CMS_FOR(section, st_sectionlist)$
    <li><a href="#$CMS_VALUE(section.anchorName)$">$CMS_VALUE(section.text)$ -> Sectionname: $CMS_VALUE(section.sectionName)$</a></li>
  $CMS_END_FOR$
</ul>

For further information on the SectionListEntry data type, see API documentation:

de.espirit.firstspirit.access.editor.value.SectionListEntry

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 returns a List of objects of the data type SectionListEntry :

• CMS_INPUT_SECTIONLIST

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

$CMS_VALUE(IDENTIFIER.METHOD)$

Under IDENTIFIER, the loop variable of the $CMS_FOR(...)$ instruction used to iterate over the input component must be specified.

Methods on SectionListEntry objects

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

equals(Object)

Overview

getAnchorName

The .getAnchorName() (in Bean syntax: .anchorName) method returns the name of the anchor generated by the section in HTML syntax.

The returned object is a character string (see java.lang.String).

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

getSectionName

The .getSectionName() (in Bean syntax: .sectionName) method returns the reference name of the section.

The returned object is a character string (see java.lang.String).

Overview

getText

The .getText() (in Bean syntax: .text) method returns the label assigned to the section.

The returned object is a character string (see java.lang.String).

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

set(String, Object)

Overview

setSectionName(String)

The method .setSectionName(String) (in bean syntax: .sectionName(String)) changes the section's name ()in the sectionlist) to the passed value.

If the section itself is not renamed at the same time, the entry is no longer displayed.

Overview

setText(String)

The method setText(String) (in bean syntax: .text(string)) changes the label assigned to the section to the passed value.

Overview

toJSON

Overview

toString

Overview

toXml

The .toXML() (in Bean syntax: .xml) method returns a XML representation of the section.

The returned object is a character string (see java.lang.String).

Overview

type

Overview