文件AEM 6.5使用手冊

標籤庫

最後更新： 2024年7月14日
  • 適用對象：
  • Experience Manager 6.5
  • 主題：

建立對象：

  • 開發人員

Granite、CQ和Sling標籤程式庫可讓您存取特定函式，以便在範本和元件的JSP指令碼中使用。

Granite標籤庫

Granite標籤庫包含有用的函式。

當您開發Granite UI元件的jsp指令碼時，建議在指令碼頂部包含以下程式碼：

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

全域也會宣告Sling程式庫。

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

<ui：includeClientLib>

<ui:includeClientLib>標籤包含AEM html使用者端資料庫，可以是js、css或主題資料庫。 對於不同型別的多個包含專案（例如js和css），此標籤必須在jsp中多次使用。 此標籤是 [com.adobe.granite.ui.clientlibs.HtmlLibraryManager](https://helpx.adobe.com/experience-manager/6-5/sites/developing/using/reference-materials/javadoc/com/adobe/granite/ui/clientlibs/HtmlLibraryManager.html)服務介面的便利包裝函式。

它具有下列屬性：

類別 — 逗號分隔的使用者端程式庫類別清單。 這包括指定類別的所有JavaScript和CSS資料庫。 主題名稱會從請求中擷取。

相當於： com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeIncludes

佈景主題 — 逗號分隔的使用者端程式庫類別清單。 這包括指定類別的所有主題相關資料庫（CSS和JS）。 主題名稱會從請求中擷取。

相當於： com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeThemeInclude

js — 逗號分隔的使用者端程式庫類別清單。 這包含指定類別的所有JavaScript資料庫。

相當於： com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeJsInclude

css — 以逗號分隔的使用者端程式庫類別清單。 這包括指定類別的所有CSS資料庫。

相當於： com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeCssInclude

主題化 — 僅指示主題化或非主題化資料庫的標幟應包含在內。 如果省略，則包含兩個集合。 僅適用於純JS或CSS includes （不適用於類別或主題包含）。

<ui:includeClientLib>標籤可在jsp中使用，如下所示：

<%-- 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標籤庫

CQ標籤庫包含有用的函式。

若要在指令碼中使用CQ標籤庫，指令碼必須以下列程式碼開頭：

<%@taglib prefix="cq" uri="https://www.day.com/taglibs/cq/1.0" %>
NOTE
當/libs/foundation/global.jsp檔案包含在指令碼中時，會自動宣告taglib。

開發AEM元件的jsp指令碼時，建議在指令碼頂端包含下列程式碼：

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

它會宣告sling、CQ和jstl taglibs，並公開<cq:defineObjects />標籤所定義的定期使用指令碼物件。 這縮短並簡化元件的jsp程式碼。

<cq：text>

<cq:text>標籤是便利的標籤，可在JSP中輸出元件文字。

它具有下列選擇性屬性：

屬性 — 要使用的屬性名稱。 此名稱是相對於目前資源的名稱。

value — 要用於輸出的值。 如果此屬性存在，則會覆寫屬性屬性的使用。

oldValue — 要用於diff輸出的值。 如果此屬性存在，則會覆寫屬性屬性的使用。

escapeXml — 定義是否應將結果字串中的字元<、>、&、'和''轉換為對應的字元實體代碼。 預設值為false。 逸出套用在選擇性格式之後。

format — 用於格式化文字的可選java.text.Format。

noDiff — 即使存在diff資訊，也會抑制差異輸出的計算。

tagClass — 將包圍非空白輸出的專案的CSS類別名稱。 如果留空，則不會新增任何元素。

tagName — 將包圍非空白輸出的元素名稱。 其預設值為DIV。

預留位置 — 在編輯模式下用於空值或空白文字的預設值，也就是預留位置。 預設檢查會在選擇性格式化和逸出之後執行，即依照原樣寫入輸出。 其預設值為：

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

預設 — 要用於Null或空白文字的預設值。 預設檢查會在選擇性格式化和逸出之後執行，也就是說，會依原樣寫入輸出。

如何在JSP中使用<cq:text>標籤的一些範例：

<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>標籤會建立i18n本地化內容，並將其儲存在javax.servlet.jsp.jstl.fmt.localizationContext設定變數中。

它具有下列屬性：

語言 — 要擷取資源套件的地區設定的語言。

source — 地區設定應該取用的來源。 它可以設定為下列其中一個值：

  • 靜態 — 地區設定是從language屬性取得（如果有的話），否則是從伺服器預設地區設定取得。

  • page — 地區設定是取自目前頁面的語言或資源（如果有的話），否則取自language屬性（如果有的話），否則取自伺服器預設地區設定。

  • 要求 — 地區設定取自要求地區設定( request.getLocale())。

  • auto — 地區設定會取自language屬性（如果有的話），否則會取自目前頁面或資源的語言（如果有的話），否則會取自要求。

如果未設定source屬性：

  • 如果已設定language屬性，source屬性會預設為" static。

  • 如果未設定language屬性，source屬性會預設為auto。

「內容組合」可供標準JSTL <fmt:message>標籤使用。 依索引鍵查詢訊息有兩個方面：

  1. 首先，系統搜尋轉譯之基礎資源的JCR屬性以取得翻譯。 這可讓您定義簡單元件對話方塊以編輯這些值。
  2. 如果節點未包含名稱與索引鍵完全相同的屬性，則備援是從Sling要求( SlingHttpServletRequest.getResourceBundle(Locale))載入資源組合。 此組合語言或地區設定是由<cq:setContentBundle>標籤的語言和來源屬性所定義。

<cq:setContentBundle>標籤可在jsp中使用，如下所示。

對於定義其語言的頁面：

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

針對使用者個人化頁面：

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

<cq：include>

<cq:include>標籤包含進入目前頁面的資源。

它具有下列屬性：

排清

  • 布林值，定義在包含目標之前是否清除輸出。

path

  • 要包含在目前要求處理中的資源物件的路徑。 如果此路徑是相對路徑，則會附加至目前資源的路徑，其指令碼包含指定的資源。 必須指定path和resourceType或指令碼。

resourceType

  • 要包含的資源的資源型別。 如果設定了資源型別，路徑必須是資源物件的確切路徑：在這種情況下，不支援在路徑中新增引數、選擇器和副檔名。
  • 如果要包含的資源是以無法解析為資源的路徑屬性指定的，則標籤可能會建立路徑及此資源型別之外的合成資源物件。
  • 必須指定path和resourceType或指令碼。

指令碼

  • 要包含的jsp指令碼。 必須指定path和resourceType或指令碼。

ignoreComponentHierarchy

  • 此布林值會控制是否應忽略元件階層以進行指令碼解析。 如果為true，則僅遵循搜尋路徑。

範例：

<%@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>

您應該使用<%@ include file="myScript.jsp" %>或<cq:include script="myScript.jsp" %>來包含指令碼？

  • <%@ include file="myScript.jsp" %>指示詞會通知JSP編譯器將完整的檔案加入目前的檔案中。 就好像所包含檔案的內容直接貼到原始檔案中一樣。
  • 使用<cq:include script="myScript.jsp">標籤時，會在執行階段包含檔案。

您應該使用<cq:include>或<sling:include>嗎？

  • 開發AEM元件時，Adobe建議您使用<cq:include>。
  • <cq:include>可讓您在使用script屬性時，直接依名稱包含指令碼檔案。 這會將元件和資源型別繼承列入考量，且通常比使用選擇器和擴充功能嚴格遵守Sling的指令碼解析更簡單。

<cq：includeClientLib>

CAUTION
<cq:includeClientLib>自AEM 5.6起已過時。應改用<ui:includeClientLib>。

<cq:includeClientLib>標籤包含AEM html使用者端資料庫，可以是js、css或主題資料庫。 對於不同型別的多個包含專案（例如js和css），此標籤必須在jsp中多次使用。 此標籤是com.day.cq.widget.HtmlLibraryManager服務介面的便利包裝函式。

它具有下列屬性：

類別 — 逗號分隔的使用者端程式庫類別清單。 這包括指定類別的所有JavaScript和CSS資料庫。 主題名稱會從請求中擷取。

相當於： com.day.cq.widget.HtmlLibraryManager#writeIncludes

佈景主題 — 逗號分隔的使用者端程式庫類別清單。 這包括指定類別的所有主題相關資料庫（CSS和JS）。 主題名稱會從請求中擷取。

相當於： com.day.cq.widget.HtmlLibraryManager#writeThemeInclude

js — 逗號分隔的使用者端程式庫類別清單。 這包含指定類別的所有JavaScript資料庫。

相當於： com.day.cq.widget.HtmlLibraryManager#writeJsInclude

css — 以逗號分隔的使用者端程式庫類別清單。 這包括指定類別的所有CSS資料庫。

相當於： com.day.cq.widget.HtmlLibraryManager#writeCssInclude

主題化 — 僅指示主題化或非主題化資料庫的標幟應包含在內。 如果省略，則包含兩個集合。 僅適用於純JS或CSS includes （不適用於類別或主題包含）。

<cq:includeClientLib>標籤可在jsp中使用，如下所示：

<%-- 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>標籤會公開下列定期使用的指令碼物件，以供開發人員參考。 它也會公開<sling:defineObjects>標籤所定義的物件。

componentContext

  • 請求的目前元件內容物件(com.day.cq.wcm.api.components.ComponentContext介面)。

元件

  • 目前資源的目前AEM元件物件(com.day.cq.wcm.api.components.Component interface)。

currentDesign

  • 目前頁面的目前設計物件(com.day.cq.wcm.api.designer.Design介面)。

currentPage

  • 目前的AEM WCM頁面物件(com.day.cq.wcm.api.Page介面)。

currentStyle

  • 目前儲存格的目前樣式物件(com.day.cq.wcm.api.designer.Style介面)。

設計工具

  • 用來存取設計資訊的設計工具物件(com.day.cq.wcm.api.designer.Designer介面)。

editContext

  • AEM元件的編輯內容物件(com.day.cq.wcm.api.components.EditContext介面)。

pageManager

  • 頁面層級作業的頁面管理員物件(com.day.cq.wcm.api.PageManager介面)。

pageProperties

  • 目前頁面的頁面屬性物件(org.apache.sling.api.resource.ValueMap)。

屬性

  • 目前資源的屬性物件(org.apache.sling.api.resource.ValueMap)。

resourceDesign

  • 資源頁面的設計物件(com.day.cq.wcm.api.designer.Design介面)。

resourcePage

  • 資源頁面物件(com.day.cq.wcm.api.Page介面)。
  • 它具有下列屬性：

requestName

  • 繼承自sling

responseName

  • 繼承自sling

resourceName

  • 繼承自sling

nodeName

  • 繼承自sling

logName

  • 繼承自sling

resourceResolverName

  • 繼承自sling

slingName

  • 繼承自sling

componentContextName

  • 特定於wcm

editContextName

  • 特定於wcm

屬性名稱

  • 特定於wcm

pageManagerName

  • 特定於wcm

currentPageName

  • 特定於wcm

resourcePageName

  • 特定於wcm

pagePropertiesName

  • 特定於wcm

componentName

  • 特定於wcm

designerName

  • 特定於wcm

currentDesignName

  • 特定於wcm

resourceDesignName

  • 特定於wcm

currentStyleName

  • 特定於wcm

範例

<%@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/>
NOTE
當/libs/foundation/global.jsp檔案包含在指令碼中時，會自動包含<cq:defineObjects />標籤。

<cq：requestURL>

<cq:requestURL>標籤會將目前的請求URL寫入JspWriter。 兩個標籤<cq:addParam>和<cq:removeParam>和可以在此標籤內文中使用，以便在寫入前修改目前的要求URL。

它可讓您使用各種引數建立目前頁面的連結。 例如，這可讓您轉換請求：

mypage.html?mode=view&query=something到mypage.html?query=something。

使用addParam或removeParam只會變更指定引數的發生次數，所有其他引數則不受影響。

<cq:requestURL>沒有任何屬性。

範例：

<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>標籤會將具有指定名稱和值的要求引數新增至結尾的<cq:requestURL>標籤。

它具有下列屬性：

名稱

  • 要新增的引數名稱

值

  • 要新增之引數的值

範例：

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

<cq：removeParam>

<cq:removeParam>標籤會從封閉<cq:requestURL>標籤中移除具有指定名稱和值的要求引數。 如果未提供值，則會移除具有指定名稱的所有引數。

它具有下列屬性：

名稱

  • 要移除的引數名稱

範例：

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

Sling標籤庫

Sling標籤資料庫包含實用的Sling函式。

您在指令碼中使用Sling標籤庫時，指令碼必須以下列程式碼開頭：

<%@ taglib prefix="sling" uri="https://sling.apache.org/taglibs/sling/1.0" %>
NOTE
當/libs/foundation/global.jsp檔案包含在指令碼中時，會自動宣告sling taglib。

<sling：include>

<sling:include>標籤包含進入目前頁面的資源。

它具有下列屬性：

排清

  • 布林值，定義在包含目標之前是否清除輸出。

資源

  • 要包含在目前要求處理中的資源物件。 必須指定資源或路徑。 如果同時指定兩者，則資源優先。

path

  • 要包含在目前要求處理中的資源物件的路徑。 如果此路徑是相對路徑，則會附加至目前資源的路徑，其指令碼包含指定的資源。 必須指定資源或路徑。 如果同時指定兩者，則資源優先。

resourceType

  • 要包含的資源的資源型別。 如果設定了資源型別，路徑必須是資源物件的確切路徑：在這種情況下，不支援在路徑中新增引數、選擇器和副檔名。
  • 如果要包含的資源是以無法解析為資源的路徑屬性指定的，則標籤可能會建立路徑及此資源型別之外的合成資源物件。

replaceSelectors

  • 分派時，選取器會取代為此屬性的值。

addSelectors

  • 分派時，會將此屬性的值新增至選取器。

replaceSuffix

  • 分派時，尾碼會由這個屬性的值取代。
NOTE
<sling:include>標籤所包含的資源與指令碼的解析度與一般的Sling URL解析度相同。 依預設，也會將目前請求中的選取器、擴充功能等用於包含的指令碼。 它們可以透過標籤屬性進行修改：例如，replaceSelectors="foo.bar"可讓您覆寫選取器。

範例：

<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>標籤會公開下列定期使用的指令碼物件，以供開發人員參考：

slingRequest

  • SlingHttpServletRequest物件，可存取HTTP要求標題資訊（擴充標準HttpServletRequest），並可存取Sling特有專案，例如資源、路徑資訊和選取器。

slingResponse

  • SlingHttpServletResponse物件，可存取伺服器所建立的HTTP回應。 這與它延伸的HttpServletResponse相同。要求
  • 純HttpServletRequest的標準JSP要求物件。回應
  • 標準JSP回應物件，純HttpServletResponse。

resourceResolver

  • 目前的ResourceResolver物件。 它與slingRequest.getResourceResolver()相同

.sling

  • SlingScriptHelper物件，包含方便使用的指令碼方法，主要是sling.include('/some/other/resource')，用於將其他資源的回應包含在此回應中（例如內嵌標題html片段）和sling.getService(foo.bar.Service.class)，以擷取Sling中可用的OSGi服務（類別標籤法取決於指令碼語言）。

資源

  • 目前要處理的資源物件，視請求的URL而定。 它與slingRequest.getResource()相同。

currentNode

  • 如果目前資源指向JCR節點（這通常是Sling中的情況），這可提供對Node物件的直接存取。 否則不會定義此物件。

記錄

  • 提供SLF4J記錄器，用於從指令碼內登入Sling記錄系統，例如log.info（「執行我的指令碼」）。

  • 它具有下列屬性：

requestName

responseName

nodeName

l ogName resourceResolverName

slingName

範例：

<%@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標籤庫

JavaServer Pages標準標籤庫包含許多有用的標準標籤。 核心、格式和函式taglibs由/libs/foundation/global.jsp定義，如下列程式碼片段所示。

/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" %>

依照之前的說明匯入/libs/foundation/global.jsp檔案後，您可以使用c、fmt和fn首碼來存取這些taglibs。 您可以在Java™ EE 5教學課程 — JavaServer Pages Standard Tag Library取得JSTL的官方檔案。

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2