Tag-Bibliotheken tag-libraries

Die Tag-Bibliotheken von Granite, CQ und Sling bieten Zugriff auf bestimmte Funktionen, die im JSP-Skript Ihrer Vorlagen und Komponenten verwendet werden können.

Granite-Tag-Bibliothek granite-tag-library

Die Tag-Bibliothek von Granite enthält hilfreiche Funktionen.

Wenn Sie das JSP-Skript einer Granite-UI-Komponente entwickeln, wird empfohlen, folgenden Code am Anfang des Skripts einzufügen:

<%@include file="/libs/granite/ui/global.jsp"%>

Die globale Seite deklariert auch die Sling-Bibliothek.

<%@taglib prefix="sling" uri="https://sling.apache.org/taglibs/sling" %>

<ui:includeClientLib> ui-includeclientlib

Das Tag <ui:includeClientLib> enthält eine AEM-HTML-Client-Bibliothek, bei der es sich um eine JS-, CSS- oder Design-Bibliothek handeln kann. Wenn mehrere verschiedene Typen enthalten sind, wie etwa JS und CSS, verwenden Sie dieses Tag mehrere Male in JSP. Dieses Tag ist ein praktischer Wrapper für die Service-Schnittstelle [com.adobe.granite.ui.clientlibs.HtmlLibraryManager](https://helpx.adobe.com/experience-manager/6-4/sites/developing/using/reference-materials/javadoc/com/adobe/granite/ui/clientlibs/HtmlLibraryManager.html).

Es weist folgende Attribute auf:

categories: Eine durch Kommas getrennte Liste der Client-Bibliothekskategorien. Dies bezieht alle Javascript-Dateien und CSS-Bibliotheken für die betreffenden Kategorien mit ein. Der Designname wird aus der Abfrage extrahiert.

Entspricht: com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeIncludes

theme: Eine durch Kommas getrennte Liste der Client-Bibliothekskategorien. Dies beinhaltet alle designbezogenen Bibliotheken (CSS und JS) für die entsprechenden Kategorien. Der Designname wird aus der Abfrage extrahiert.

Entspricht: com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeThemeInclude

js: Eine durch Kommas getrennte Liste der Client-Bibliothekskategorien. Dies bezieht alle Javascript-Bibliotheken für die betreffenden Kategorien mit ein.

Entspricht: com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeJsInclude

css: Eine durch Kommas getrennte Liste der Client-Bibliothekskategorien. Dies bezieht alle CSS-Bibliotheken für die betreffenden Kategorien mit ein.

Entspricht: com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeCssInclude

themed: Ein Flag, das angibt, ob nur designbezogene oder nicht designbezogene Bibliotheken enthalten sein sollen. Wenn ausgelassen, sind beide Sätze enthalten. Gilt nur, wenn nur JS oder nur CSS enthalten ist (nicht wenn Kategorien oder Designs enthalten sind).

Das Tag <ui:includeClientLib> kann in einem JSP-Code wie folgt verwendet werden:

<%-- all: js + theme (theme-js + css) --%>
<ui:includeClientLib categories="cq.wcm.edit" />

<%-- only js libs --%>
<ui:includeClientLib js="cq.collab.calendar, cq.security" />

<%-- theme only (theme-js + css) --%>
<ui:includeClientLib theme="cq.collab.calendar, cq.security" />

<%-- css only --%>
<ui:includeClientLib css="cq.collab.calendar, cq.security" />

CQ-Tag-Bibliothek cq-tag-library

Die Tag-Bibliothek von CQ enthält hilfreiche Funktionen.

Um die CQ-Tag-Bibliothek in Ihrem Skript zu verwenden, muss das Skript mit dem folgenden Code beginnen:

<%@taglib prefix="cq" uri="https://www.day.com/taglibs/cq/1.0" %>

Wenn Sie das JSP-Skript einer AEM-Komponente entwickeln, sollten Sie folgenden Code am Anfang des Skripts einfügen:

<%@include file="/libs/foundation/global.jsp"%>

Er deklariert die Tag-Bibliotheken Sling, CQ und JSTL und macht die regelmäßig genutzten Skriptobjekte verfügbar, die durch das Tag <cq:defineObjects /> definiert sind. Dies verkürzt und vereinfacht den JSP-Code der Komponente.

<cq:text> cq-text

Bei dem Tag <cq:text> handelt es sich um ein Hilfe-Tag, das Komponententext in JSP ausgibt.

Es weist die folgenden optionalen Attribute auf:

property: Name der zu verwendenden Eigenschaft. Der Name steht im Bezug zur aktuellen Ressource.

value: Der für die Ausgabe zu verwendende Wert. Falls dieses Attribut vorhanden ist, wird die Nutzung des Attributs „property“ außer Kraft gesetzt.

oldValue: Der für die diff-Ausgabe zu verwendende Wert. Falls dieses Attribut vorhanden ist, wird die Nutzung des Attributs „property“ außer Kraft gesetzt.

escapeXml: Definiert, ob die Zeichen <, >, &, ' und " in der daraus entstehenden Zeichenfolge in ihre entsprechenden Zeichenentitäts-Codes umgewandelt werden sollen. Der Standardwert lautet „false“. Beachten Sie, dass der Escape-Vorgang nach der optionalen Formatierung angewendet wird.

format: Optionales java.text.Format für die Formatierung des Texts.

noDiff: Unterdrückt die Berechnung einer diff-Ausgabe, auch wenn eine diff-Information vorhanden ist.

tagClass: CSS-Klassenname eines Elements, das eine nicht leere Ausgabe umgibt. Wenn leer, wird kein Element hinzugefügt.

tagName: Name des Elements, das eine nicht leere Ausgabe umgibt. Standardmäßig ist DIV eingestellt.

placeholder: Standardwert, der im Bearbeitungsmodus für null oder leeren Text verwendet wird, z. B. der Platzhalter. Beachten Sie, dass die Standardprüfung nach der optionalen Formatierung und dem Escapen durchgeführt wird, d. h. nach der Ausgabe unverändert geschrieben wird. Standardwert ist:

<div><span class="cq-text-placeholder">&para;</span></div>

default: Zu verwendender Standardwert für null oder leeren Text. Beachten Sie, dass nach der optionalen Formatierung und dem Escape-Vorgang die standardmäßige Prüfung ausgeführt wird, d. h. er wird im vorliegenden Format in die Ausgabe geschrieben.

Beispiele einer möglichen Verwendung des Tags <cq:text> in JSP:

<cq:text property="jcr:title" tagName="h2"/>
<cq:text property="jcr:description" tagName="p"/>

<cq:text value="<%= listItem.getTitle() %>" tagName="h4" placeholder="" />
<cq:text value="<%= listItem.getDescription() %>" tagName="p" placeholder=""/>

<cq:text property="jcr:title" value="<%= title %>" tagName="h3"/><%
    } else if (type.equals("link")) {
        %><cq:text property="jcr:title" value="<%= "\u00bb " + title %>" tagName="p" tagClass="link"/><%
    } else if (type.equals("extralarge")) {
        %><cq:text property="jcr:title" value="<%= title %>" tagName="h1"/><%
    } else {
        %><cq:text property="jcr:title" value="<%= title %>" tagName="h2"/><%

<cq:text property="jcr:description" placeholder="" tagName="small"/>

<cq:text property="tableData"
               escapeXml="false"
               placeholder="<img src=\"/libs/cq/ui/resources/0.gif\" class=\"cq-table-placeholder\" alt=\"\">"
    />

<cq:text property="text"/>

<cq:text property="image/jcr:description" placeholder="" tagName="small"/>
<cq:text property="text" tagClass="text"/>

<cq:setContentBundle> cq-setcontentbundle

Das Tag <cq:setContentBundle> erstellt einen i18n-Lokalisierungskontext und speichert ihn in der Konfigurationsvariablen javax.servlet.jsp.jstl.fmt.localizationContext.

Es weist folgende Attribute auf:

language: Die Sprache des Gebietsschemas, für das das Ressourcenpaket abgerufen werden soll.

source: Die Quelle, aus der das Gebietsschema übernommen werden soll. Sie können sie auf einen der folgenden Werte einstellen:

Falls das Attribut source nicht festgelegt ist:

Das „Inhaltspaket“ kann einfach mit standardmäßigen JSTL-<fmt:message>-Tags verwendet werden. Die Suche von Nachrichten anhand von Schlüsseln erfolgt in zweifacher Hinsicht:

Das Tag <cq:setContentBundle> kann in einem JSP-Code wie folgt verwendet werden.

Für Seiten, die ihre Sprache definieren:

... %><cq:setContentBundle source="page"/><%  %>
<div class="error"><fmt:message key="Hello"/>
</div> ...

Für von Benutzern personalisierte Seiten:

... %><cq:setContentBundle scope="request"/><% %>
<div class="error"><fmt:message key="Hello"/>
</div> ...

<cq:include> cq-include

Das Tag <cq:include> fügt eine Ressource in die aktuelle Seite ein.

Es weist folgende Attribute auf:

flush

path

resourceType

script

ignoreComponentHierarchy

Beispiel:

<%@taglib prefix="cq" uri="https://www.day.com/taglibs/cq/1.0" %><%
%><div class="center">
    <cq:include path="trail" resourceType="foundation/components/breadcrumb" />
    <cq:include path="title" resourceType="foundation/components/title" />
    <cq:include script="redirect.jsp"/>
    <cq:include path="par" resourceType="foundation/components/parsys" />
</div>

Verwenden Sie <%@ include file="myScript.jsp" %> oder <cq:include script="myScript.jsp" %>, um ein Skript einzufügen?

Sollten Sie <cq:include> oder <sling:include> verwenden?

<cq:includeClientLib> cq-includeclientlib

Das Tag <cq:includeClientLib> enthält eine AEM-HTML-Client-Bibliothek, bei der es sich um eine JS-, CSS- oder Design-Bibliothek handeln kann. Wenn mehrere verschiedene Typen enthalten sind, wie etwa JS und CSS, verwenden Sie dieses Tag mehrere Male in JSP. Dieses Tag ist ein praktischer Wrapper für die Service-Schnittstelle com.day.cq.widget.HtmlLibraryManager.

Es weist folgende Attribute auf:

categories: Eine durch Kommas getrennte Liste der Client-Bibliothekskategorien. Dies bezieht alle Javascript-Dateien und CSS-Bibliotheken für die betreffenden Kategorien mit ein. Der Designname wird aus der Abfrage extrahiert.

Entspricht: com.day.cq.widget.HtmlLibraryManager#writeIncludes

theme: Eine durch Kommas getrennte Liste der Client-Bibliothekskategorien. Dies beinhaltet alle designbezogenen Bibliotheken (CSS und JS) für die entsprechenden Kategorien. Der Designname wird aus der Abfrage extrahiert.

Entspricht: com.day.cq.widget.HtmlLibraryManager#writeThemeInclude

js: Eine durch Kommas getrennte Liste der Client-Bibliothekskategorien. Dies bezieht alle Javascript-Bibliotheken für die betreffenden Kategorien mit ein.

Entspricht: com.day.cq.widget.HtmlLibraryManager#writeJsInclude

css: Eine durch Kommas getrennte Liste der Client-Bibliothekskategorien. Dies bezieht alle CSS-Bibliotheken für die betreffenden Kategorien mit ein.

Entspricht: com.day.cq.widget.HtmlLibraryManager#writeCssInclude

themed: Ein Flag, das angibt, ob nur designbezogene oder nicht designbezogene Bibliotheken enthalten sein sollen. Wenn ausgelassen, sind beide Sätze enthalten. Gilt nur, wenn nur JS oder nur CSS enthalten ist (nicht wenn Kategorien oder Designs enthalten sind).

Das Tag <cq:includeClientLib> kann in einem JSP-Code wie folgt verwendet werden:

<%-- all: js + theme (theme-js + css) --%>
<cq:includeClientLib categories="cq.wcm.edit" />

<%-- only js libs --%>
<cq:includeClientLib js="cq.collab.calendar, cq.security" />

<%-- theme only (theme-js + css) --%>
<cq:includeClientLib theme="cq.collab.calendar, cq.security" />

<%-- css only --%>
<cq:includeClientLib css="cq.collab.calendar, cq.security" />

<cq:defineObjects> cq-defineobjects

Das Tag <cq:defineObjects> macht die folgenden, regelmäßig verwendeten Skriptobjekte verfügbar, auf die der Entwickler verweisen kann. Darüber hinaus werden die Objekte verfügbar gemacht, die durch das Tag <sling:defineObjects> definiert sind.

componentContext

Komponente

currentDesign

currentPage

currentStyle

designer

editContext

pageManager

pageProperties

Eigenschaften

resourceDesign

resourcePage

requestName

responseName

resourceName

nodeName

logName

resourceResolverName

slingName

componentContextName

editContextName

propertiesName

pageManagerName

currentPageName

resourcePageName

pagePropertiesName

componentName

designerName

currentDesignName

resourceDesignName

currentStyleName

Beispiel

<%@page session="false" contentType="text/html; charset=utf-8" %><%
%><%@ page import="com.day.cq.wcm.api.WCMMode" %><%
%><%@taglib prefix="cq" uri="https://www.day.com/taglibs/cq/1.0" %><%
%><cq:defineObjects/>

<cq:requestURL> cq-requesturl

Das Tag <cq:requestURL> schreibt die aktuelle Anforderungs-URL in JspWriter. Die beiden Tags <cq:addParam> und <cq:removeParam> können innerhalb dieses Tags verwendet werden, um die aktuelle Anforderungs-URL zu bearbeiten, bevor sie geschrieben wird.

Dadurch können Sie Links zur aktuellen Seite mit variierenden Parametern erstellen. So können Sie beispielsweise die Anforderung umwandeln:

mypage.html?mode=view&query=something in mypage.html?query=something.

Mit addParam oder removeParam wird nur das Auftreten des angegebenen Parameters verändert, alle anderen Parameter sind nicht betroffen.

<cq:requestURL> weist kein Attribut auf.

Beispiele:

<a href="<cq:requestURL><cq:removeParam name="language"/></cq:requestURL>">remove filter</a>

<a title="filter results" href="<cq:requestURL><cq:addParam name="language" value="${bucket.value}"/></cq:requestURL>">${label} (${bucket.count})</a>

<cq:addParam> cq-addparam

Das Tag <cq:addParam> fügt einen Anforderungsparameter mit dem angegebenen Namen und Wert zum umschließenden Tag <cq:requestURL> hinzu.

Es weist folgende Attribute auf:

name

value

Beispiel:

<a title="filter results" href="<cq:requestURL><cq:addParam name="language" value="${bucket.value}"/></cq:requestURL>">${label} (${bucket.count})</a>

<cq:removeParam> cq-removeparam

Das Tag <cq:removeParam> entfernt einen Anforderungsparameter mit dem angegebenen Namen und Wert aus dem umschließenden Tag <cq:requestURL>. Wenn kein Wert angegeben wird, werden alle Parameter mit dem angegebenen Namen entfernt.

Es weist folgende Attribute auf:

name

Beispiel:

<a href="<cq:requestURL><cq:removeParam name="language"/></cq:requestURL>">remove filter</a>

Sling Tag Library sling-tag-library

Die Sling-Tag-Bibliothek enthält hilfreiche Sling-Funktionen.

Wenn Sie die Sling-Tag-Bibliothek in Ihrem Skript verwenden, muss das Skript mit dem folgenden Code beginnen:

<%@ taglib prefix="sling" uri="https://sling.apache.org/taglibs/sling/1.0" %>

<sling:include> sling-include

Das Tag <sling:include> fügt eine Ressource in die aktuelle Seite ein.

Es weist folgende Attribute auf:

flush

Ressource

path

resourceType

replaceSelectors

addSelectors

replaceSuffix

Beispiele:

<div class="item"><sling:include path="<%= pathtoinclude %>"/></div>

<sling:include resource="<%= par %>"/>

<sling:include addSelectors="spool"/>

<sling:include resource="<%= par %>" resourceType="<%= newType %>"/>

<sling:include resource="<%= par %>" resourceType="<%= newType %>"/>

<sling:include replaceSelectors="content" />

<sling:defineObjects> sling-defineobjects

Das Tag <sling:defineObjects> macht die folgenden, regelmäßig verwendeten Skriptobjekte verfügbar, auf die der Entwickler verweisen kann:

slingRequest

slingResponse

resourceResolver

.sling

Ressource

currentNode

log

requestName

responseName

nodeName

l ogName resourceResolverName

slingName

Beispiel:

<%@page session="false" %><%
%><%@page import="com.day.cq.wcm.foundation.forms.ValidationHelper"%><%
%><%@taglib prefix="sling" uri="https://sling.apache.org/taglibs/sling/1.0" %><%
%><sling:defineObjects/>

JSTL-Tag-Bibliothek jstl-tag-library

Die standardmäßige Tag-Bibliothek JavaServer Pages enthält viele hilfreiche und standardmäßige Tags. Die Tag-Bibliotheken für Kern, Formatierung und Funktionen werden anhand von /libs/foundation/global.jsp wie im folgenden Ausschnitt gezeigt definiert.

Auszug aus /libs/foundation/global.jsp extract-of-libs-foundation-global-jsp

<%@taglib prefix="c" uri="https://java.sun.com/jsp/jstl/core" %>
<%@taglib prefix="fmt" uri="https://java.sun.com/jsp/jstl/fmt" %>
<%@taglib prefix="fn" uri="https://java.sun.com/jsp/jstl/functions" %>

Nach dem Importieren der Datei /libs/foundation/global.jsp wie zuvor beschrieben können Sie die Präfixe c, fmt und fn verwenden, um auf diese Tag-Bibliotheken zuzugreifen. Die offizielle Dokumentation der JSTL ist verfügbar unter Das Java EE 5-Tutorial – standardmäßige Tag-Bibliothek JavaServer Pages.