Datentyp Area
Wertebereich des Datentyps Area
In FirstSpirit gibt es die Möglichkeit, verweissensitive Grafiken (sogenannte „Imagemaps“) zu erstellen. Eine verweissensitive Grafik verfügt über einen oder mehrere Bereiche, die mithilfe eines Eingabegeräts (z. B. Maus, Trackball) ausgewählt bzw. aufgerufen werden können. Beim Aufruf des Bereichs mit dem Eingabegerät wird der dem Bereich hinterlegte Verweis aufgerufen.
Für die Pflege von verweissensitiven Grafiken steht die Eingabekomponente IMAGEMAP zur Verfügung. Diese Eingabekomponente liefert ein Objekt vom Datentyp MappingMedium zurück.
Die verweissensitiven Bereiche werden über die Methode .getAreas() (in Bean-Syntax: .areas) ausgegeben. Diese liefert eine Liste von Objekten vom Datentyp Area zurück (List<Area>). Siehe dazu auch API-Dokumentation, Interface Area.
Da innerhalb einer CMS_INPUT_IMAGEMAP-Eingabekomponente mehrere verweissensitive Bereiche gepflegt sein können, wird die Anweisung $CMS_FOR(...)$ verwendet, um die Attribute jedes einzelnen Bereichs ausgeben zu können:
$CMS_FOR(BEREICH, st_imagemap.areas)
Da die einzelnen Bereiche üblicherweise drei unterschiedliche Formen haben (Rechteck, Kreis und Polygon), steht auch für jede Form ein eigenes Interface im Paket de.espirit.firstspirit.access.editor.value.imagemap zur Verfügung:
- Rechteck (siehe auch Interface RectArea)
- Kreis (siehe auch Interface CircleArea)
- Polygon (siehe auch Interface PolyArea)
In Abhängigkeit der vom Redakteur gewählten Form stehen unterschiedliche Methoden zur Verfügung. Die gewählte Form kann bei der Ausgabe vorab über eine $CMS_FOR(...)-Anweisung oder die if(...)-Methode in Kombination mit der Methode .getShape() (in Bean-Syntax: .shape) ermittelt werden, z. B.
$CMS_IF(BEREICH.shape=="CIRCLE")$
...
$CMS_END_IF$
Methoden auf Area-Objekten
In der unten angegebenen Tabelle werden alle Methoden aufgelistet, die auf Objekten vom Datentyp Area aufgerufen werden können:
compareTo(Comparable)
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
compareTo(Comparable) | int |
equals(Object)
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
equals(Object) | boolean |
getClass
Die Methode .getClass() (in Bean-Syntax: .class) liefert die Klasse des aufrufendes Objektes zurück (vgl. java.lang.Class).
Aufruf:
$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$
Ausgabe:
java.lang.String
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
getClass | Class |
getCoordinates
Die Methode .getCoordinates() (in Bean-Syntax: .coordinates) liefert – in Abhängigkeit der vom Redakteur gewählten Form – eine kommaseparierte Liste der Koordinaten der verweissensitiven Bereiche in Pixeln zurück, z. B.
$CMS_VALUE(BEREICH.coordinates)$
Rechteckige verweissensitive Bereiche
Handelt es sich bei dem verweissensitiven Bereich um ein Rechteck, werden die x- und y-Koordinaten des linken oberen und des rechten unteren Punkts ausgegeben, z. B.:
30,322,130,422
Die x- und y-Koordinate der linken oberen Ecke kann mit
$CMS_VALUE(BEREICH.leftTop)$
die x- und y-Koordinate der rechten unteren Ecke mit
$CMS_VALUE(BEREICH.rightBottom)$
ermittelt werden.
Siehe dazu auch Interface RectArea.
Kreisförmige verweissensitive Bereiche
Handelt es sich bei dem verweissensitiven Bereich um einen Kreis, werden die x- und y-Koordinaten des Mittelpunkts ausgegeben sowie der Radius, z. B.:
260,252,50
Die x- und y-Koordinate des Mittelpunkts kann mit
$CMS_VALUE(BEREICH.center)$
der Radius mit
$CMS_VALUE(BEREICH.radius)$
ermittelt werden.
Siehe dazu auch Interface CircleArea.
Vieleckige verweissensitive Bereiche
Handelt es sich bei dem verweissensitiven Bereich um ein Vieleck, werden die x- und y-Koordinaten aller Ecken ausgegeben, z. B.:
369,215,427,182,449,223,417,264,350,265
für ein Fünfeck.
Die x- und y-Koordinate der einzelnen Punkte kann mit
$CMS_VALUE(BEREICH.points)$
ermittelt werden.
Da ein Vieleck aus mehreren Ecken besteht, muss die $CMS_FOR(...)$-Anweisung verwendet werden, um die x- und y-Koordinaten aller Ecken auszugeben:
$CMS_FOR(point, BEREICH.points))$
x: $CMS_VALUE(point.x)$, y: $CMS_VALUE(point.y)$
$CMS_END_FOR$
Siehe dazu auch Interface PolyArea.
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
getCoordinates | String | 5.1.207 |
getLink
Die Methode .getLink() (in Bean-Syntax: .link) liefert den Verweis zurück, der mit dem verweissensitiven Bereich verknüpft ist.
Verweisziel und Verweistext können über
$CMS_VALUE(BEREICH.link.VERWEISZIEL)$
bzw.
$CMS_VALUE(BEREICH.link.VERWEISTEXT)$
aufgelöst werden, wobei VERWEISZIEL der Bezeichner der Eingabekomponente des Verweises ist, in der das Verweisziel gespeichert wird, und VERWEISTEXT der Bezeichner der Eingabekomponente des Verweises, in der der Verweistext gespeichert wird, z. B.:
<a title="$CMS_VALUE(BEREICH.link.lt_text)$" href="$CMS_VALUE(BEREICH.link.lt_reference)>
(vgl. dazu auch Kapitel Verweisvorlagen).
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
getLink | Link |
getShape
Die Methode .getShape() (in Bean-Syntax: .shape) liefert die Form des gewählten verweissensitiven Bereichs zurück:
- RECT (Rechteck)
- CIRCLE (Kreis)
- POLY (Vieleck)
Für jede dieser Formen gibt es spezifische Methoden, die fallbezogen verwendet werden müssen. Siehe dazu auch
- Interface RectArea
- Interface CircleArea
- Interface PolyArea
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
getShape | String | 5.1.207 |
isCase(Object)
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
isCase(Object) | boolean |
isNull
Die Methode .isNull() (in Bean-Syntax: .isNull) prüft, ob ein Ausdruck bzw. Objekt Null ist, z.B. storeElement.isNull(). Bei Objekten mit komplexen Werten oder Objekten entscheidet das Objekt wann es null ist. Der Datentyp DomElement enthält beispielsweise immer ein leeres Dokument, ist also nie null. Die Prüfung einer leeren DOM-Editor-Eingabekomponente mit der Methode .isNull() liefert daher den Wert false, während die Prüfung der Komponente auf .isEmpty() den Wert true liefern würde.
Die Methode .isNull() gibt einen booleschen Wert als Ergebnis der Prüfung zurück. true (=wahr) ist die Prüfung, wenn der Ausdruck bzw. das Objekt Null ist und false (=unwahr) wenn nicht.
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
isNull | boolean |
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
void |
receive(Area$Visitor)
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
receive(Area$Visitor) | Object |
set(String, Object)
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
set(String, Object) | Object |
toJson
Convert to JSON string representtion (only handles Maps, Collections, Arrays, Numbers, and Strings)Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
toJson | String | 4.2.14 |
toString
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
toString | String |
type
Methodenname | Rückgabetyp | Verfügbar seit |
---|---|---|
type | String |