Bibliotecas de etiquetas

Las bibliotecas de etiquetas Granite, CQ y Sling le proporcionan acceso a funciones específicas para utilizarlas en la secuencia de comandos JSP de sus plantillas y componentes.

Biblioteca de etiquetas Granite

La biblioteca de etiquetas Granite contiene funciones útiles.

Al desarrollar la secuencia de comandos jsp de un componente de la interfaz de usuario Granite, se recomienda incluir el siguiente código en la parte superior de la secuencia de comandos:

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

El global también declara la biblioteca Sling.

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

ui:includeClientLib

La etiqueta <ui:includeClientLib> incluye una biblioteca de cliente HTML AEM, que puede ser un js, un css o una biblioteca de temas. Para varias inclusiones de diferentes tipos, por ejemplo js y css, esta etiqueta debe usarse varias veces en el jsp. Esta etiqueta es un envoltorio práctico alrededor de la interfaz de servicio [com.adobe.granite.ui.clientlibs.HtmlLibraryManager](https://helpx.adobe.com/es/experience-manager/6-5/sites/developing/using/reference-materials/javadoc/com/adobe/granite/ui/clientlibs/HtmlLibraryManager.html).

Tiene los atributos siguientes:

categorías : lista de categorías de biblioteca de cliente separadas por coma. Esto incluirá todas las bibliotecas Javascript y CSS de las categorías determinadas. El nombre del tema se extrae de la solicitud.

Equivale a: com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeIncludes

tema : lista de categorías de biblioteca de cliente separadas por coma. Esto incluirá todas las bibliotecas relacionadas con el tema (CSS y JS) para las categorías dadas. El nombre del tema se extrae de la solicitud.

Equivale a: com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeThemeInclude

js : lista de categorías de biblioteca de cliente separadas por coma. Esto incluirá todas las bibliotecas Javascript de las categorías dadas.

Equivale a: com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeJsInclude

css : lista de categorías de biblioteca de cliente separadas por coma. Esto incluirá todas las bibliotecas CSS de las categorías dadas.

Equivale a: com.adobe.granite.ui.clientlibs.HtmlLibraryManager#writeCssInclude

themed : se debe incluir un indicador que indique únicamente bibliotecas temáticas o no temáticas. Si se omite, se incluyen ambos conjuntos. Solo se aplica a las inclusiones JS o CSS puras (no para categorías o temas incluidos).

La etiqueta <ui:includeClientLib> se puede usar de la siguiente manera en un 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" />

Biblioteca de etiquetas CQ

La biblioteca de etiquetas CQ contiene funciones útiles.

Para utilizar la biblioteca de etiquetas CQ en la secuencia de comandos, la secuencia de comandos debe tener en inicio el siguiente código:

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

Al desarrollar la secuencia de comandos jsp de un componente AEM, se recomienda incluir el siguiente código en la parte superior de la secuencia de comandos:

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

Declara los taglibs sling, CQ y jstl y expone los objetos de secuencias de comandos utilizados habitualmente definidos por la etiqueta <cq:defineObjects />. Esto acorta y simplifica el código jsp del componente.

cq:text

La etiqueta <cq:text> es una etiqueta de conveniencia que genera texto de componente en un JSP.

Tiene los siguientes atributos opcionales:

propiedad : nombre de la propiedad que se va a utilizar. El nombre es relativo al recurso actual.

valor : valor que se va a utilizar para la salida. Si este atributo está presente, sobrescribe el uso del atributo de propiedad.

oldValue - Valor que se usará para la salida diff. Si este atributo está presente, sobrescribe el uso del atributo de propiedad.

escapeXml : define si los caracteres <>, &, ' y " de la cadena resultante deben convertirse a sus códigos de entidad de carácter correspondientes. El valor predeterminado es false. Tenga en cuenta que el carácter de escape se aplica después del formato opcional.

format - Java.text.Format opcional que se utiliza para dar formato al texto.

noDiff - Suprime el cálculo de una salida de diferencia, aunque haya una información de diferencia.

tagClass : nombre de clase CSS de un elemento que rodeará una salida no vacía. Si está vacío, no se agrega ningún elemento.

tagName : nombre del elemento que rodeará una salida no vacía. El valor predeterminado es DIV.

marcador de posición: valor predeterminado que se usará para texto nulo o vacío en el modo de edición, es decir, el marcador de posición. Tenga en cuenta que la comprobación predeterminada se realiza después del formato opcional y de los caracteres de escape, es decir, se escribe tal cual en la salida. El valor predeterminado es:

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

default - Valor predeterminado que se usará para texto nulo o vacío. Tenga en cuenta que la comprobación predeterminada se realiza después del formato opcional y el escape, es decir, se escribe tal cual en la salida.

Algunos ejemplos de cómo se puede utilizar la etiqueta <cq:text> en un 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

La etiqueta <cq:setContentBundle> crea un contexto de localización i18n y lo almacena en la variable de configuración javax.servlet.jsp.jstl.fmt.localizationContext.

Tiene los atributos siguientes:

idioma : el idioma de la configuración regional para la que se recupera el paquete de recursos.

source : la fuente desde la que se debe extraer la configuración regional. Se puede establecer en uno de los siguientes valores:

• static : la configuración regional se toma del language atributo, si está disponible, en caso contrario, de la configuración regional predeterminada del servidor.

• page : la configuración regional se toma del idioma de la página actual o del recurso, si está disponible; de lo contrario, se toma del language atributo si está disponible, en caso contrario, de la configuración regional predeterminada del servidor.

• solicitud : la configuración regional se toma de la configuración regional de la solicitud ( request.getLocale()).

• auto : la configuración regional se toma del language atributo si está disponible, de lo contrario del idioma de la página actual o del recurso si está disponible, de lo contrario de la solicitud.

Si el atributo source no está establecido:

• Si se establece el atributo language, el atributo source tiene el valor predeterminado "static.

• Si no se establece el atributo language, el atributo source tiene el valor predeterminado auto.

El "paquete de contenido" se puede utilizar simplemente con etiquetas JSTL <fmt:message> estándar. La búsqueda de mensajes por claves es doble:

1. En primer lugar, se buscan traducciones en las propiedades JCR del recurso subyacente que se procesa actualmente. Esto le permite definir un cuadro de diálogo de componentes sencillo para editar esos valores.
2. Si el nodo no contiene una propiedad con el mismo nombre que la clave, la alternativa es cargar un paquete de recursos desde la solicitud de sling ( SlingHttpServletRequest.getResourceBundle(Locale)). El idioma o la configuración regional de este paquete está definido por los atributos de idioma y origen de la etiqueta <cq:setContentBundle>.

La etiqueta <cq:setContentBundle> se puede usar de la siguiente manera en un jsp.

Para las páginas que definen su idioma:

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

Para páginas personalizadas del usuario:

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

cq:include

La etiqueta <cq:include> incluye un recurso en la página actual.

Tiene los atributos siguientes:

vaciar

• Un booleano que define si se debe vaciar la salida antes de incluir el destinatario.

path

• Ruta al objeto de recurso que se incluirá en el procesamiento de la solicitud actual. Si esta ruta es relativa, se anexa a la ruta del recurso actual cuya secuencia de comandos incluye el recurso dado. Se deben especificar path y resourceType o script.

resourceType

• Tipo de recurso del recurso que se va a incluir. Si se establece el tipo de recurso, la ruta debe ser la ruta exacta a un objeto de recurso: en este caso, no se admite la adición de parámetros, selectores y extensiones a la ruta.
• Si el recurso que se va a incluir se especifica con el atributo path que no se puede resolver en un recurso, la etiqueta puede crear un objeto de recurso sintético fuera de la ruta y de este tipo de recurso.
• Se deben especificar path y resourceType o script.

script

• Secuencia de comandos jsp que se va a incluir. Se deben especificar path y resourceType o script.

ignoreComponentHierarchy

• Un booleano que controla si se debe ignorar la jerarquía de componentes para la resolución de secuencias de comandos. Si es true, solo se respetan las rutas de búsqueda.

Ejemplo:

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

¿Debe utilizar <%@ include file="myScript.jsp" %> o <cq:include script="myScript.jsp" %> para incluir una secuencia de comandos?

• La directiva <%@ include file="myScript.jsp" %> informa al compilador JSP de que incluya un archivo completo en el archivo actual. Es como si el contenido del archivo incluido se hubiera pegado directamente en el archivo original.
• Con la etiqueta <cq:include script="myScript.jsp">, el archivo se incluye en tiempo de ejecución.

¿Debe utilizar <cq:include> o <sling:include>?

• Al desarrollar componentes de AEM, Adobe recomienda utilizar <cq:include>.
• <cq:include> permite incluir directamente los archivos de secuencias de comandos por su nombre al utilizar el atributo de secuencia de comandos. Esto tiene en cuenta la herencia de componentes y tipos de recursos, y a menudo es más simple que el cumplimiento estricto de la resolución de secuencias de comandos de Sling mediante selectores y extensiones.

cq:includeClientLib

La etiqueta <cq:includeClientLib> incluye una biblioteca de cliente HTML AEM, que puede ser un js, un css o una biblioteca de temas. Para varias inclusiones de diferentes tipos, por ejemplo js y css, esta etiqueta debe usarse varias veces en el jsp. Esta etiqueta es un envoltorio práctico alrededor de la interfaz de servicio com.day.cq.widget.HtmlLibraryManager.

Tiene los atributos siguientes:

categorías : lista de categorías de biblioteca de cliente separadas por coma. Esto incluirá todas las bibliotecas Javascript y CSS de las categorías determinadas. El nombre del tema se extrae de la solicitud.

Equivale a: com.day.cq.widget.HtmlLibraryManager#writeIncludes

tema : lista de categorías de biblioteca de cliente separadas por coma. Esto incluirá todas las bibliotecas relacionadas con el tema (CSS y JS) para las categorías dadas. El nombre del tema se extrae de la solicitud.

Equivalente a: com.day.cq.widget.HtmlLibraryManager#writeThemeInclude

js : lista de categorías de biblioteca de cliente separadas por coma. Esto incluirá todas las bibliotecas Javascript de las categorías dadas.

Equivale a: com.day.cq.widget.HtmlLibraryManager#writeJsInclude

css : lista de categorías de biblioteca de cliente separadas por coma. Esto incluirá todas las bibliotecas CSS de las categorías dadas.

Equivale a: com.day.cq.widget.HtmlLibraryManager#writeCssInclude

themed : se debe incluir un indicador que indique únicamente bibliotecas temáticas o no temáticas. Si se omite, se incluyen ambos conjuntos. Solo se aplica a las inclusiones JS o CSS puras (no para categorías o temas incluidos).

La etiqueta <cq:includeClientLib> se puede usar de la siguiente manera en un 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

La etiqueta <cq:defineObjects> expone los siguientes objetos de secuencias de comandos, que se utilizan con regularidad, a los que el desarrollador puede hacer referencia. También expone los objetos definidos por la etiqueta <sling:defineObjects>.

componentContext

• el objeto de contexto de componente actual de la solicitud (interfaz com.day.cq.wcm.api.components.ComponentContext).

componente

• el objeto de componente AEM actual del recurso actual (com.day.cq.wcm.api.components.Component).

currentDesign

• objeto de diseño actual de la página actual (com.day.cq.wcm.api.designer.Design).

currentPage

• el objeto de página WCM AEM actual (interfaz com.day.cq.wcm.api.Page).

currentStyle

• el objeto de estilo actual de la celda actual (interfaz com.day.cq.wcm.api.designer.Style).

designer

• el objeto de diseñador utilizado para acceder a la información de diseño (com.day.cq.wcm.api.designer.Designer).

editContext

• el objeto de contexto de edición del componente AEM (interfaz com.day.cq.wcm.api.components.EditContext).

pageManager

• el objeto del administrador de páginas para las operaciones de nivel de página (interfaz com.day.cq.wcm.api.PageManager).

pageProperties

• el objeto de propiedades de página de la página actual (org.apache.sling.api.resource.ValueMap).

propiedades

• el objeto properties del recurso actual (org.apache.sling.api.resource.ValueMap).

resourceDesign

• el objeto de diseño de la página de recursos (com.day.cq.wcm.api.designer.Design).

resourcePage

• el objeto de página de recursos (interfaz com.day.cq.wcm.api.Page).
• Tiene los atributos siguientes:

requestName

• heredado de sling

responseName

• heredado de sling

resourceName

• heredado de sling

nodeName

• heredado de sling

logName

• heredado de sling

resourceResolverName

• heredado de sling

slingName

• heredado de sling

componentContextName

• específico a wcm

editContextName

• específico a wcm

propertiesName

• específico a wcm

pageManagerName

• específico a wcm

currentPageName

• específico a wcm

resourcePageName

• específico a wcm

pagePropertiesName

• específico a wcm

componentName

• específico a wcm

designerName

• específico a wcm

currentDesignName

• específico a wcm

resourceDesignName

• específico a wcm

currentStyleName

• específico a wcm

Ejemplo

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

La etiqueta <cq:requestURL> escribe la dirección URL de solicitud actual en JspWriter. Las dos etiquetas <cq:addParam> y <cq:removeParam> y pueden utilizarse dentro del cuerpo de esta etiqueta para modificar la dirección URL de solicitud actual antes de que se escriba.

Permite crear vínculos a la página actual con parámetros variables. Por ejemplo, permite transformar la solicitud:

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

El uso de addParam o removeParam sólo cambia la incidencia del parámetro dado, el resto de los parámetros no se ven afectados.

<cq:requestURL> no tiene ningún atributo.

Ejemplos:

<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

La etiqueta <cq:addParam> agrega un parámetro de solicitud con el nombre y el valor dados a la etiqueta <cq:requestURL> que lo rodea.

Tiene los atributos siguientes:

name

• nombre del parámetro que se va a agregar

seleccionado

• valor del parámetro que se va a añadir

Ejemplo:

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

cq:removeParam

La etiqueta <cq:removeParam> elimina un parámetro de solicitud con el nombre y valor dados de la etiqueta <cq:requestURL> que lo rodea. Si no se proporciona ningún valor, se eliminan todos los parámetros con el nombre dado.

Tiene los atributos siguientes:

name

• nombre del parámetro que se va a eliminar

Ejemplo:

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

Biblioteca de etiquetas Sling

La biblioteca de etiquetas Sling contiene funciones Sling útiles.

Cuando se utiliza la biblioteca de etiquetas Sling en la secuencia de comandos, la secuencia de comandos debe tener en inicio el siguiente código:

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

sling:include

La etiqueta <sling:include> incluye un recurso en la página actual.

Tiene los atributos siguientes:

vaciar

• Un booleano que define si se debe vaciar la salida antes de incluir el destinatario.

medio

• El objeto de recurso que se va a incluir en el procesamiento de la solicitud actual. Se debe especificar el recurso o la ruta. Si se especifican ambos, el recurso tiene prioridad.

path

• Ruta al objeto de recurso que se incluirá en el procesamiento de la solicitud actual. Si esta ruta es relativa, se anexa a la ruta del recurso actual cuya secuencia de comandos incluye el recurso dado. Se debe especificar el recurso o la ruta. Si se especifican ambos, el recurso tiene prioridad.

resourceType

• Tipo de recurso del recurso que se va a incluir. Si se establece el tipo de recurso, la ruta debe ser la ruta exacta a un objeto de recurso: en este caso, no se admite la adición de parámetros, selectores y extensiones a la ruta.
• Si el recurso que se va a incluir se especifica con el atributo path que no se puede resolver en un recurso, la etiqueta puede crear un objeto de recurso sintético fuera de la ruta y de este tipo de recurso.

replaceSelectors

• Al enviar, los selectores se sustituyen por el valor de este atributo.

addSelectors

• Al enviar, el valor de este atributo se agrega a los selectores.

replaceSuffix

• Al enviar, el sufijo se sustituye por el valor de este atributo.

Ejemplos:

<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

La etiqueta <sling:defineObjects> expone los siguientes objetos de secuencias de comandos, que se utilizan con regularidad, a los que el desarrollador puede hacer referencia:

slingRequest

• El objeto SlingHttpServletRequest, que proporciona acceso a la información del encabezado de la solicitud HTTP, amplía el HttpServletRequest estándar y proporciona acceso a elementos específicos de Sling como recurso, información de ruta, selector, etc.

slingResponse

• Objeto SlingHttpServletResponse, que proporciona acceso a la respuesta HTTP creada por el servidor. Actualmente es el mismo que HttpServletResponse desde el que se extiende.solicitud
• El objeto de solicitud JSP estándar que es un HttpServletRequest puro.response
• El objeto de respuesta JSP estándar que es un HttpServletResponse puro.

resourceResolver

• El objeto ResourceResolver actual. Es lo mismo que slingRequest.getResourceResolver()

.sling

• Un objeto SlingScriptHelper, que contiene métodos de conveniencia para secuencias de comandos, principalmente sling.include('/some/other/resource') para incluir las respuestas de otros recursos dentro de esta respuesta (por ejemplo, incrustar fragmentos de código html de encabezado) y sling.getService(foo.bar.Service.class) para recuperar los servicios OSGi disponibles en Sling (notación de clase según el lenguaje de secuencias de comandos).

medio

• el objeto Resource actual que se va a gestionar, según la dirección URL de la solicitud. Es lo mismo que slingRequest.getResource().

currentNode

• Si el recurso actual apunta a un nodo JCR (que suele ser el caso en Sling), se proporciona acceso directo al objeto Node. De lo contrario, este objeto no está definido.

registro

• Proporciona un registrador SLF4J para iniciar sesión en el sistema de registro Sling desde scripts, por ejemplo. log.info("Ejecutando mi script").

• Tiene los atributos siguientes:

requestName

responseName

nodeName

l ogName resourceResolverName

slingName

Ejemplo:

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

Biblioteca de etiquetas JSTL

La biblioteca de etiquetas estándar de páginas JavaServer contiene muchas etiquetas útiles y estándar. Los taglibs de núcleo, formato y funciones se definen mediante /libs/foundation/global.jsp como se muestra en el siguiente fragmento de código.

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

Después de importar el archivo /libs/foundation/global.jsp como se ha descrito anteriormente, puede utilizar los prefijos c, fmt y fn para acceder a esos taglibs. La documentación oficial del JSTL está disponible en Tutorial de Java EE 5 - JavaServer Pages Standard Tag Library.