Startseite / Vorlagenentwicklung / ContentCreator / JavaScript-API / Allgemeine Funktionen

JavaScript-API: Allgemeine Funktionalität

JavaScript-Objekt: top.WE_API.Common
Developer-API-Dokumentation: Common

Das Common-Objekt der JavaScript-API ermöglicht allgemeine Interaktionen mit der Benutzeroberfläche des ContentCreators:

Anzeige von Informationen
Navigation in der Vorschau
Ausführen von Java-Code

Anzeige von Informationen

Message-Boxes

Eine einfache Message-Box

void showMessage(String text) zeigt eine simple Message-Box mit einem "OK"-Button.

Der Text der Message-Box ist konfigurierbar; weitere Konfigurationsmöglichkeiten werden nicht bereitgestellt. Die Message-Box wird immer als Informationsnachricht dargestellt. Die Button-Konfiguration kann nicht verändert werden.

<script type="text/javascript">

        top.WE_API.Common.showMessage("I am a sample message box.");

</script>

Dialoge

Ein Dialog

Dialoge ermöglichen die Darstellung von frei definierbarem HTML und interaktiven Web-Applikationen und stellen so flexible Möglichkeiten zur Interaktion zur Verfügung.

Dialog createDialog() liefert ein konfigurierbares Dialog-Objekt, das standardmäßig versteckt ist.

<script type="text/javascript">

        var myDialog = top.WE_API.Common.createDialog();

        // The dialog is still hidden.
        // Configuration and display is described in the section "Dialogs".

</script>

Das in diesem Code-Segment eingeholte Dialog-Objekt kann konfiguriert und letztendlich angezeigt werden. Eine weitere Beschreibung erfolgt im Abschnitt Dialoge.

Das aktuelle Vorschau-Element erfragen

FSID getPreviewElement() liefert das Store-Element zurück, das mit der aktuellen Vorschau assoziiert ist. Dieses Element ist zumeist ein Objekt vom Typ PageRef oder Dataset.

<script type="text/javascript">

    var previewElement = top.WE_API.Common.getPreviewElement();

</script>

Navigation in der Vorschau

Zwei Funktionen erlauben das Auslösen einer Navigation in der Vorschau:

void jumpTo(FSID fsid) erlaubt anhand eines FSID-Objekts (welches mit der Funktion getPreviewElement() erfragt werden kann) die Navigation zu diesem Objekt.

void jumpTo(JavaScriptObject fsid) akzeptiert ein Objekt im JSON-Format, um zum gewünschten Element zu navigieren:

<script type="text/javascript">

    // Jump to a store element, in this case, a site store element with ID 47.
    top.WE_API.Common.jumpTo({"id":47, "store":"SITESTORE"});

    // Jump to a dataset with the content ID 128, using a page reference with ID 47.
    top.WE_API.Common.jumpTo({"contentId":128, "pageref":47});

    // Jump to a dataset with the content ID 128, using the preview page reference of a Content2 node with ID 243.
    top.WE_API.Common.jumpTo({"contentId":128, "content2":243});

    // Jump to a dataset with the content ID 128, using the preview page reference of a template with ID 17.
    top.WE_API.Common.jumpTo({"contentId":128, "template":17});

</script>

Das JavaScript-Objekt spezifiziert immer zwei Schlüssel/Wert-Paare.

Diese Kombination definiert entweder das Store-Element oder den Datensatz, das/der in der Vorschau angezeigt werden soll. Ist dieses Element ein Datensatz, so muss die ID der Seitenreferenz angegeben werden, in dessen Vorschau der Datensatz dargestellt werden soll.

Store-Elemente

Benötigte Schlüssel:

id gibt die ID des Ziel-Elements als long-Wert an
store gibt die Verwaltung des Ziel-Elements in Großbuchstaben an (siehe Store.Type)

Datensätze

Benötigter Schlüssel:

contentId gibt die ID des Datensatzes an

Zusätzlich muss einer der folgenden Schlüssel angegeben werden:

content2 definiert eine Datenquelle, von der die Vorschauseitenreferenz ermittelt wird
pageref gibt die ID einer Seitenreferenz an, auf der der Datensatz angezeigt werden soll
template gibt die ID einer Tabellenvorlage an, deren Vorschauseite zur Anzeige des Datensatzes verwendet werden soll

Druckversion | Seitenanfang