Desarrollo de componentes AEM (IU clásica)

La IU clásica utiliza ExtJS para crear utilidades que proporcionen la apariencia de los componentes. Debido a la naturaleza de estas utilidades, hay algunas diferencias entre la forma en que los componentes interactúan con la IU clásica y la IU táctil.

Estructura

La estructura básica de un componente se cubre en la página Componentes AEM: conceptos básicos, que aplica tanto las IU táctiles como las clásicas. Incluso si no necesita utilizar la configuración de la IU táctil en su nuevo componente, puede ser útil que los conozca al heredar de componentes existentes.

Scripts JSP

Los scripts o servlets JSP se pueden utilizar para procesar componentes. Según las reglas de procesamiento de solicitudes de Sling, el nombre del script predeterminado es:

<*componentname*>.jsp

global.jsp

El archivo de script JSP global.jsp se utiliza para proporcionar acceso rápido a objetos específicos (es decir, para acceder al contenido) a cualquier archivo de script JSP utilizado para procesar un componente.

Por lo tanto, global.jsp debe incluirse en todos los componentes que procesen secuencias de comandos JSP donde uno o más de los objetos proporcionados en global.jsp se utilizan.

La ubicación del valor predeterminado global.jsp es:

/libs/foundation/global.jsp

Función de global.jsp, API usadas y Taglibs

A continuación se enumeran los objetos más importantes proporcionados de la opción predeterminada global.jsp:

Resumen:

• <cq:defineObjects />

  • slingRequest - El objeto de solicitud ajustado ( SlingHttpServletRequest).
  • slingResponse - El objeto de respuesta ajustado ( SlingHttpServletResponse).
  • resource - El Objeto De Recurso Sling ( slingRequest.getResource();).
  • resourceResolver - El Objeto Sling Resource Resolver ( slingRequest.getResoucreResolver();).
  • currentNode - El nodo JCR resuelto para la solicitud.
  • log - El registrador predeterminado ().
  • sling - El ayudante del script de Sling.
  • properties - Las propiedades del recurso dirigido ( resource.adaptTo(ValueMap.class);).
  • pageProperties - Las propiedades de la página del recurso dirigido.
  • pageManager - El administrador de páginas para acceder AEM páginas de contenido ( resourceResolver.adaptTo(PageManager.class);).
  • component - El objeto de componente del componente de AEM actual.
  • designer - El objeto de diseñador para recuperar información de diseño ( resourceResolver.adaptTo(Designer.class);).
  • currentDesign - El diseño del recurso dirigido.
  • currentStyle - El estilo del recurso dirigido.

Acceso al contenido

Existen tres métodos para acceder al contenido en AEM WCM:

• Mediante el objeto de propiedades introducido en global.jsp:

  El objeto properties es una instancia de un ValueMap (consulte API de Sling) y contiene todas las propiedades del recurso actual.

  Ejemplo: String pageTitle = properties.get("jcr:title", "no title"); se utiliza en la secuencia de comandos de renderización de un componente de página.

  Ejemplo: String paragraphTitle = properties.get("jcr:title", "no title"); se utiliza en la secuencia de comandos de renderización de un componente de párrafo estándar.

• A través de la función currentPage objeto introducido en global.jsp:

  La variable currentPage es una instancia de una página (consulte API de AEM). La clase page proporciona algunos métodos para acceder al contenido.

  Ejemplo: String pageTitle = currentPage.getTitle();

• Via currentNode objeto introducido en global.jsp:

  La variable currentNode es una instancia de un nodo (consulte API de JCR). Se puede acceder a las propiedades de un nodo mediante la variable getProperty() método.

  Ejemplo: String pageTitle = currentNode.getProperty("jcr:title");

Bibliotecas de etiquetas JSP

Las bibliotecas de etiquetas CQ y Sling le proporcionan acceso a funciones específicas para su uso en el script JSP de sus plantillas y componentes.

Para obtener más información, consulte el documento Bibliotecas de etiquetas.

Uso de bibliotecas de HTML del lado del cliente

Los sitios web modernos dependen en gran medida del procesamiento del lado del cliente impulsado por código CSS y JavaScript complejo. Organizar y optimizar el servicio de este código puede ser un problema complicado.

Para ayudar a resolver este problema, AEM proporciona Carpetas de biblioteca del lado del cliente, que le permiten almacenar el código del lado del cliente en el repositorio, organizarlo en categorías y definir cuándo y cómo se debe servir cada categoría de código al cliente. A continuación, el sistema de biblioteca del lado del cliente se encarga de producir los vínculos correctos en la página web final para cargar el código correcto.

Consulte el documento Uso de bibliotecas de HTML del lado del cliente para obtener más información.

Cuadro de diálogo

El componente necesitará un cuadro de diálogo para que los autores añadan y configuren el contenido.

Consulte Componentes AEM: conceptos básicos para obtener más información.

Configuración del comportamiento de edición

Puede configurar el comportamiento de edición de un componente. Esto incluye atributos como acciones disponibles para el componente, características del editor in situ y oyentes relacionados con eventos en el componente. La configuración es común a las IU táctiles y clásicas, aunque con ciertas diferencias específicas.

La variable el comportamiento de edición de un componente está configurado añadiendo un cq:editConfig nodo de tipo cq:EditConfig debajo del nodo del componente (de tipo cq:Component) y añadiendo propiedades específicas y nodos secundarios.

Uso y ampliación de utilidades de ExtJS

Consulte Uso y ampliación de utilidades de ExtJS para obtener más información.

Uso de xtypes para los widgets de ExtJS

Consulte Uso de xtype para obtener más información.

Desarrollo de nuevos componentes

En esta sección se describe cómo crear sus propios componentes y agregarlos al sistema de párrafos.

Una forma rápida de empezar es copiar un componente existente y luego realizar los cambios que desee.

Un ejemplo de cómo desarrollar un componente se describe detalladamente en Ampliación del componente de texto e imagen: un ejemplo.

Desarrollar un nuevo componente (adaptar componente existente)

Para desarrollar nuevos componentes para AEM basados en un componente existente, puede copiar el componente, crear un archivo javascript para el nuevo componente y almacenarlo en una ubicación accesible para AEM (consulte también Personalización de componentes y otros elementos):

1. Con CRXDE Lite, cree una nueva carpeta de componentes en:

   / apps/<myProject>/components/<myComponent>

   Vuelva a crear la estructura de nodos como en las bibliotecas y, a continuación, copie la definición de un componente existente, como el componente Texto . Por ejemplo, para personalizar la copia del componente Texto :

   • de /libs/foundation/components/text
   • hasta /apps/myProject/components/text

2. Modifique el jcr:title para reflejar su nuevo nombre.

3. Abra la nueva carpeta de componentes y realice los cambios que necesite. Elimine también cualquier información superflua de la carpeta.

   Puede realizar cambios como:

   • adición de un nuevo campo en el cuadro de diálogo

     • cq:dialog - cuadro de diálogo para la IU táctil
     • dialog - cuadro de diálogo para la IU clásica

   • reemplazando a .jsp (asígnele el nombre de su nuevo componente)

   • o retrabajando completamente todo el componente si lo desea

   Por ejemplo, si toma una copia del componente Texto estándar, puede agregar un campo adicional al cuadro de diálogo y, a continuación, actualizar el .jsp para procesar los datos introducidos allí.

   NOTA

   Un componente para:

   • IU táctil Granite componentes
   • Uso de la IU clásica Widgets de ExtJS
   NOTA

   Un cuadro de diálogo definido para la IU clásica funcionará dentro de la IU táctil.

   Un cuadro de diálogo definido para la IU táctil no funcionará dentro de la IU clásica.

   Según la instancia y el entorno de creación, es posible que desee definir ambos tipos de diálogo para el componente.

4. Uno de los siguientes nodos debe estar presente y adecuadamente inicializado para que aparezca el nuevo componente:

   • cq:dialog - cuadro de diálogo para la IU táctil
   • dialog - cuadro de diálogo para la IU clásica
   • cq:editConfig - cómo se comportan los componentes en el entorno de edición (por ejemplo, arrastrar y soltar)
   • design_dialog - cuadro de diálogo para el modo de diseño (solo IU clásica)

5. Active el nuevo componente en el sistema de párrafos mediante:

   • uso del CRXDE Lite para agregar el valor <path-to-component> (por ejemplo, /apps/geometrixx/components/myComponent) a los componentes de propiedad del nodo /etc/designs/geometrixx/jcr:content/contentpage/par
   • siga las instrucciones indicadas en Adición de nuevos componentes a sistemas de párrafos

6. En AEM WCM, abra una página de su sitio web e inserte un nuevo párrafo del tipo que acaba de crear para asegurarse de que el componente funciona correctamente.

Adición de un nuevo componente al sistema de párrafos (modo de diseño)

Una vez desarrollado el componente, lo agrega al sistema de párrafos, que permite a los autores seleccionar y utilizar el componente al editar una página.

1. Acceda a una página del entorno de creación que utilice el sistema de párrafos, por ejemplo <contentPath>/Test.html.

2. Cambie al modo Diseño mediante:

   • adición ?wcmmode=design hasta el final de la dirección URL y volver a acceder, por ejemplo:

     <contextPath>/ Test.html?wcmmode=design

   • hacer clic en Diseño en la barra de tareas

   Ahora está en modo de diseño y puede editar el sistema de párrafos.

3. Haga clic en Editar.

   Se muestra una lista de los componentes pertenecientes al sistema de párrafos. El nuevo componente también aparece en la lista.

   Los componentes se pueden activar (o desactivar) para determinar cuáles se ofrecen al autor al editar una página.

4. Active el componente y, a continuación, vuelva al modo de edición normal para confirmar que está disponible para su uso.

Ampliación del componente de texto e imagen: un ejemplo

Esta sección proporciona un ejemplo sobre cómo ampliar el componente estándar de texto e imagen que se utiliza ampliamente con una función de colocación de imagen configurable.

La extensión del componente de texto e imagen permite a los editores utilizar toda la funcionalidad existente del componente, además de tener una opción adicional para especificar la colocación de la imagen:

• En el lado izquierdo del texto (comportamiento actual y el nuevo valor predeterminado)
• Así como en el lado derecho

Después de ampliar este componente, puede configurar la colocación de la imagen a través del cuadro de diálogo del componente.

En este ejercicio se describen las siguientes técnicas:

• Copia del nodo de componente existente y modificación de sus metadatos
• Modificación del cuadro de diálogo del componente, incluida la herencia de widgets de los cuadros de diálogo principales
• Modificación del script del componente para implementar la nueva funcionalidad

Ampliación del componente textimage existente

Para crear el nuevo componente, utilizamos el componente textimage estándar como base y lo modificamos. Almacenamos el nuevo componente en la aplicación de ejemplo AEM WCM de Geometrixx.

1. Copiar el componente de textimage estándar de /libs/foundation/components/textimage en la carpeta de componentes de Geometrixx, /apps/geometrixx/components, usando textimage como nombre de nodo de destino. (Copie el componente navegando hasta él, haciendo clic con el botón derecho y seleccionando Copiar y navegando hasta el directorio de destino).

   

2. Para que este ejemplo sea sencillo, vaya al componente que ha copiado y elimine todos los subnodos del nuevo nodo de textimage, excepto los siguientes:

   • definición de cuadro de diálogo: textimage/dialog
   • script de componente: textimage/textimage.jsp
   • editar nodo de configuración (que permite arrastrar y soltar recursos): textimage/cq:editConfig
   NOTA

   La definición del cuadro de diálogo depende de la IU:

   • IU táctil: textimage/cq:dialog
   • IU clásica: textimage/dialog

3. Edite los metadatos del componente:

   • Nombre del componente

     • Establezca jcr:description a Text Image Component (Extended)
     • Establezca jcr:title a Text Image (Extended)

   • Grupo, donde el componente aparece en la barra de tareas (deje tal cual)

     • Leave componentGroup configure como General

   • Componente principal para el nuevo componente (el componente de textimage estándar)

     • Establezca sling:resourceSuperType a foundation/components/textimage

   Después de este paso, el nodo de componente tiene este aspecto:

   

4. Cambie el sling:resourceType propiedad del nodo de configuración de edición de la imagen (propiedad: textimage/cq:editConfig/cq:dropTargets/image/parameters/sling:resourceType) a geometrixx/components/textimage.

   De este modo, cuando se suelta una imagen en el componente de la página, la variable sling:resourceType la propiedad del componente de textimage extendido se establece en: geometrixx/components/textimage.

5. Modifique el cuadro de diálogo del componente para incluir la nueva opción. El nuevo componente hereda las partes del cuadro de diálogo que son iguales a las del original. La única adición que hacemos es ampliar el Avanzadas , agregar Posición de la imagen lista desplegable, con opciones Left y Right:

   • Deje el textimage/dialogpropiedades sin modificar.

   Tenga en cuenta cómo textimage/dialog/items tiene cuatro subnodos, tab1 a tab4, que representan las cuatro pestañas del cuadro de diálogo textimage.

   • Para las dos primeras pestañas (pestaña 1 y pestaña 2):

     • Cambie xtype por cqinclude (para heredar del componente estándar).
     • Agregar una propiedad de ruta con valores /libs/foundation/components/textimage/dialog/items/tab1.infinity.jsony /libs/foundation/components/textimage/dialog/items/tab2.infinity.json, respectivamente.
     • Elimine todas las demás propiedades o subnodos.

   • Para la pestaña 3:

     • Deje las propiedades y los subnodos sin cambios

     • Agregue una nueva definición de campo a tab3/items, posición del nodo del tipo cq:Widget

     • Establezca las siguientes propiedades (de tipo String) para la nueva tab3/items/positionnodo:

       • name: ./imagePosition
       • xtype: selection
       • fieldLabel: Image Position
       • type: select

     • Añadir subnodo position/options de tipo cq:WidgetCollection para representar las dos opciones de colocación de imagen y, en él, cree dos nodos, o1 y o2 de tipo nt:unstructured.

     • Para el nodo position/options/o1 defina las propiedades: text a Left y value a left.

     • Para el nodo position/options/o2 defina las propiedades: text a Right y value a right.

   • Eliminar ficha4.

   La posición de la imagen se mantiene en el contenido como el imagePositionpropiedad del nodo que representa textimage párrafo. Después de estos pasos, el cuadro de diálogo del componente tiene este aspecto:

   

6. Amplíe el script de componente, textimage.jsp, con gestión adicional del nuevo parámetro:

   Image image = new Image(resource, "image");
   
   if (image.hasContent() || WCMMode.fromRequest(request) == WCMMode.EDIT) {
        image.loadStyleData(currentStyle);
   

   Vamos a reemplazar el fragmento de código enfatizado %><div class="image"><% con el nuevo código que genera un estilo personalizado para esta etiqueta.

   // todo: add new CSS class for the 'right image' instead of using
   // the style attribute
   String style="";
        if (properties.get("imagePosition", "left").equals("right")) {
             style = "style=\"float:right\"";
        }
        %><div <%= style %> class="image"><%
   

7. Guarde el componente en el repositorio. El componente está listo para probarse.

Comprobación del nuevo componente

Una vez desarrollado el componente, puede agregarlo al sistema de párrafos, que permite a los autores seleccionar y utilizar el componente al editar una página. Estos pasos le permiten probar el componente.

1. Abra una página en Geometrixx como Inglés/Empresa.
2. Cambie al modo de diseño haciendo clic en Diseño en la barra de tareas.
3. Edite el diseño del sistema de párrafos haciendo clic en Editar en el sistema de párrafos en medio de la página. Se muestra una lista de componentes, que se pueden colocar en el sistema de párrafos, y debe incluir su componente recién desarrollado, Imagen de texto (extendido) . Para activarlo en el sistema de párrafos, selecciónelo y haga clic en Aceptar .
4. Vuelva al modo de edición.
5. Agregue el párrafo Imagen de texto (extendido) al sistema de párrafos, inicialice el texto y la imagen con contenido de ejemplo. Guarde los cambios.
6. Abra el cuadro de diálogo del párrafo de texto y de imagen, cambie la Posición de la imagen en la ficha Avanzado a la derecha y haga clic en Aceptar para guardar los cambios.
7. El párrafo se representa con la imagen a la derecha.
8. El componente ya está listo para utilizarse.

El componente almacena su contenido en un párrafo en la página Empresa.

Desactivar la capacidad de carga del componente de imagen

Para deshabilitar esta capacidad, utilizamos el componente de imagen estándar como base y lo modificamos. Almacenamos el nuevo componente en la aplicación de ejemplo de Geometrixx.

1. Copiar el componente de imagen estándar de /libs/foundation/components/image en la carpeta de componentes de Geometrixx, /apps/geometrixx/components, usando image como nombre de nodo de destino.

   

2. Edite los metadatos del componente:

   • Establezca jcr:title a Image (Extended)

3. Vaya a /apps/geometrixx/components/image/dialog/items/image.

4. Añadir una nueva propiedad:

   • Nombre: allowUpload
   • Tipo: String
   • Valor: false

   

5. Haga clic en Guardar todo. El componente está listo para probarse.

6. Abra una página en Geometrixx como Inglés/Empresa.

7. Cambie al modo de diseño y active Image (Extended).

8. Vuelva al modo de edición y agréguelo al sistema de párrafos. En las siguientes imágenes, puede ver las diferencias entre el componente de imagen original y el que acaba de crear.

   Componente de imagen original:

   

   El nuevo componente de imagen:

   

9. El componente ya está listo para utilizarse.

Recursos de Business.Adobe.com

Style System Personalized Experiences Personalized Communications Web Content Management Content Management Digital Asset Management