Uso e extensão de widgets (interface clássica)

A interface baseada na Web da Adobe Experience Manager usa AJAX e outras tecnologias modernas de navegador para permitir a edição e formatação WYSIWYG de conteúdo pelos autores diretamente na página da Web.

A Adobe Experience Manager (AEM) usa a biblioteca de widgets ExtJS, que fornece os elementos altamente refinados da interface do usuário que funcionam em todos os navegadores mais importantes e permitem a criação de experiências de interface de nível de desktop.

Esses widgets são incluídos no AEM e, além de serem usados pelo próprio AEM, podem ser usados por qualquer site criado usando AEM.

Para obter uma referência completa de todos os widgets disponíveis no AEM, consulte a documentação da API do widget ou a lista de xtypes existentes. Além disso, muitos exemplos que mostram como usar a estrutura ExtJS estão disponíveis no site Sencha, o proprietário da estrutura.

Esta página fornece algumas informações sobre como usar e estender widgets. Primeiro, descreve como incluir o código do lado do cliente em uma página. Em seguida, ele descreve alguns componentes de amostra que foram criados para ilustrar algumas extensões e usos básicos. Esses componentes estão disponíveis no pacote Usando widgets ExtJS em Compartilhamento de pacotes.

O pacote inclui exemplos de:

• Diálogos básicos criados com widgets predefinidos.
• Diálogos dinâmicos criados com widgets predefinidos e lógica javascript personalizada.
• Diálogos com base em widgets personalizados.
• Um painel de árvore exibindo uma árvore JCR abaixo de um determinado caminho.
• Um painel de grade exibindo dados em formato tabular.

Incluir o código do lado do cliente em uma página

O javascript do lado do cliente e o código da folha de estilos devem ser colocados em uma biblioteca do cliente.

Para criar uma biblioteca de cliente:

1. Crie um nó abaixo de /apps/<project> com as seguintes propriedades:

   • name="clientlib"
   • jcr:mixinTypes="[mix:lockable]"
   • jcr:PrimaryType="cq:ClientLibraryFolder"
   • sling:resourceType="widgets/clientlib"
   • categoria="[<categoria-name>]"
   • dependências="[cq.widgets]"

   Note: <category-name> is the name of the custom library (e.g. "cq.extjstraining") and is used to include the library on the page.

2. Abaixo de clientlib crie as pastas css e js (nt:folder).

3. Abaixo de clientlib crie os arquivos css.txt e js.txt (nt:files). Esses arquivos .txt listas os arquivos que estão incluídos na biblioteca.

4. Editar js.txt: é necessário start com ' #base=js' seguido pela lista dos arquivos que serão agregados pelo serviço de biblioteca do cliente CQ, por exemplo:

   #base=js
    components.js
    exercises.js
    CustomWidget.js
    CustomBrowseField.js
    InsertTextPlugin.js
   

5. Editar css.txt: é necessário start com ' #base=css' seguido pela lista dos arquivos que serão agregados pelo serviço de biblioteca do cliente CQ, por exemplo:

   #base=css
    components.css
   

6. Abaixo da pasta js, posicione os arquivos javascript que pertencem à biblioteca.

7. Abaixo da pasta css, posicione os arquivos .css e os recursos usados pelos arquivos css (por exemplo, my_icon.png).

Para incluir a biblioteca do cliente no componente de página jsp:

• para incluir código javascript e folhas de estilo:
  <ui:includeClientLib categories="<category-name1>, <category-name2>, ..."/>
  em que
  <category-nameX> é o nome da biblioteca do lado do cliente.

• para incluir somente código javascript:
  <ui:includeClientLib js="<category-name>"/>

Para obter mais detalhes, consulte a descrição da tag <ui:includeClientLib>.

Em alguns casos, uma biblioteca de cliente deve estar disponível somente no modo de autor e deve ser excluída no modo de publicação. Pode ser obtido da seguinte forma:

    if (WCMMode.fromRequest(request) != WCMMode.DISABLED) {
        %><ui:includeClientLib categories="cq.collab.blog"/><%
    }

Introdução às amostras

Para seguir os tutoriais desta página, instale o pacote chamado Usando widgets ExtJS em uma instância de AEM local e crie uma página de amostra na qual os componentes serão incluídos. Para isso:

1. Em sua instância AEM, baixe o pacote chamado Usando widgets ExtJS (v01) do Compartilhamento de pacotes e instale o pacote. Ele cria o projeto extjstraining abaixo de /apps no repositório.
2. Inclua a biblioteca do cliente que contém os scripts (js) e a folha de estilo (css) na tag head da página jsp do geometrixx, já que você incluirá os componentes de amostra em uma nova página da ramificação Geometrixx:
   em CRXDE Lite abra o arquivo /apps/geometrixx/components/page/headlibs.jsp e adicione a categoria cq.extjstraining à tag <ui:includeClientLib> existente da seguinte forma:
   %><ui:includeClientLib categories="apps.geometrixx-main, cq.extjstraining"/><%
3. Crie uma nova página na ramificação Geometrixx abaixo de /content/geometrixx/en/products e chame-a de Usando widgets ExtJS.
4. Vá para o modo de design e adicione todos os componentes do grupo chamados Usando widgets ExtJS ao design do Geometrixx
5. Voltar no modo de edição: os componentes do grupo Usando widgets ExtJS estão disponíveis no Sidekick.

Diálogos básicos

Normalmente, as caixas de diálogo são usadas para editar conteúdo, mas também podem exibir informações. Uma maneira fácil de visualização uma caixa de diálogo completa é acessar sua representação em formato json. Para fazer isso, aponte o navegador para:

https://localhost:4502/<path-to-dialog>.-1.json

O primeiro componente do grupo Usando widgets ExtJS no Sidekick é chamado de 1. Conceitos básicos da caixa de diálogo e inclui quatro diálogos básicos que são criados com widgets prontos e sem lógica javascript personalizada. As caixas de diálogo são armazenadas abaixo de /apps/extjstraining/components/dialogbasics. Os diálogos básicos são:

• a caixa de diálogo Completo ( full nó): exibe uma janela com 3 guias, cada uma com 2 campos de texto.
• a caixa de diálogo Painel único (nó singlepanel): exibe uma janela com 1 guia que tem 2 campos de texto.
• a caixa de diálogo Vários painéis (nó multipanel): sua exibição é igual à caixa de diálogo Completo, mas é criada de forma diferente.
• a caixa de diálogo Design (nó design): ela exibe uma janela com 2 guias. A primeira guia tem um campo de texto, um menu suspenso e uma área de texto flexível. A segunda guia tem um conjunto de campos com 4 campos de texto e um conjunto de campos que pode ser recolhido com 2 campos de texto.

Inclua 1. Componente Informações básicas da caixa de diálogo na página de amostra:

1. Adicione o 1. Noções básicas da caixa de diálogo para a página de amostra da guia Usando widgets ExtJS no Sidekick.
2. O componente exibe um título, um texto e um link PROPERTIES: clique no link para exibir as propriedades do parágrafo armazenado no repositório. Clique novamente no link para ocultar as propriedades.

O componente é exibido da seguinte maneira:

Exemplo 1: Caixa de diálogo completa

A caixa de diálogo Completo exibe uma janela com três guias, cada uma com dois campos de texto. É a caixa de diálogo padrão do componente Noções básicas da caixa de diálogo. As suas características são:

• É definido por um nó: tipo de nó = cq:Dialog, xtype = [dialog](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialog).
• Exibe 3 guias (tipo de nó = cq:Panel).
• Cada guia tem dois campos de texto (tipo de nó = cq:Widget, xtype = [textfield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textfield)).
• É definido pelo nó:
  /apps/extjstraining/components/dialogbasics/full
• É renderizado no formato JSON solicitando:
  https://localhost:4502/apps/extjstraining/components/dialogbasics/full.-1.json

A caixa de diálogo é exibida da seguinte maneira:

Exemplo 2: Caixa de diálogo do painel único

A caixa de diálogo Painel único exibe uma janela com uma guia que tem dois campos de texto. As suas características são:

• Exibe 1 guia (tipo de nó = cq:Dialog, xtype = [panel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#panel))
• A guia tem dois campos de texto (tipo de nó = cq:Widget, xtype = [textfield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textfield))
• É definido pelo nó:
  /apps/extjstraining/components/dialogbasics/singlepanel
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/dialogbasics/singlepanel.-1.json
• Uma vantagem em relação à caixa de diálogo completa é que é necessária menos configuração.
• Uso recomendado: para caixas de diálogo simples que exibem informações ou têm apenas alguns campos.

Para usar a caixa de diálogo Painel único:

1. Substitua a caixa de diálogo do componente Conceitos básicos da caixa de diálogo pela caixa de diálogo Painel único:
   1. Em CRXDE Lite, exclua o nó: /apps/extjstraining/components/dialogbasics/dialog
   2. Clique em Salvar tudo para salvar as alterações.
   3. Copie o nó: /apps/extjstraining/components/dialogbasics/singlepanel
   4. Cole o nó copiado abaixo: /apps/extjstraining/components/dialogbasics
   5. Selecione o nó: /apps/extjstraining/components/dialogbasics/Copy of singlepanele renomeie-o dialog.
2. Edite o componente: a caixa de diálogo é exibida da seguinte maneira:

Exemplo 3: Caixa de diálogo de vários painéis

A caixa de diálogo Multi Panel tem a mesma exibição que a caixa de diálogo Full, mas foi criada de forma diferente. As suas características são:

• É definido por um nó (tipo de nó = cq:Dialog, xtype = [tabpanel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#tabpanel)).
• Exibe 3 guias (tipo de nó = cq:Panel).
• Cada guia tem dois campos de texto (tipo de nó = cq:Widget, xtype = [textfield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textfield)).
• É definido pelo nó:
  /apps/extjstraining/components/dialogbasics/multipanel
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/dialogbasics/multipanel.-1.json
• Uma vantagem em relação à caixa de diálogo completa é que ela tem uma estrutura simplificada.
• Uso recomendado: para caixas de diálogo de várias guias.

Para usar a caixa de diálogo Vários painéis:

1. Substitua a caixa de diálogo do componente Conceitos básicos da caixa de diálogo pela caixa de diálogo Vários painéis:
   siga as etapas descritas para o Exemplo 2: Caixa de diálogo de painel único
2. Edite o componente: a caixa de diálogo é exibida da seguinte maneira:

Exemplo 4: Diálogo avançado

A caixa de diálogo Rico exibe uma janela com duas guias. A primeira guia tem um campo de texto, um menu suspenso e uma área de texto flexível. A segunda guia tem um conjunto de campos com quatro campos de texto e um conjunto de campos que pode ser recolhido com dois campos de texto. As suas características são:

• É definido por um nó (tipo de nó = cq:Dialog, xtype = [dialog](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialog)).
• Exibe 2 guias (tipo de nó = cq:Panel).
• A primeira guia tem um [dialogfieldset](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialogfieldset) widget com um [textfield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textfield) e um [selection](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#selection) widget com 3 opções, e um [dialogfieldset](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialogfieldset) redutível com um [textarea](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textarea) widget.
• A segunda guia tem um [dialogfieldset](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialogfieldset) widget com 4 [textfield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textfield) widgets e um dialogfieldset redutível com 2 [textfield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textfield) widgets.
• É definido pelo nó:
  /apps/extjstraining/components/dialogbasics/rich
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/dialogbasics/rich.-1.json

Para usar a caixa de diálogo Rich:

1. Substitua a caixa de diálogo do componente Conceitos básicos da caixa de diálogo pela caixa de diálogo Rico:
   siga as etapas descritas para o Exemplo 2: Caixa de diálogo de painel único
2. Edite o componente: a caixa de diálogo é exibida da seguinte maneira:

Diálogos dinâmicos

O segundo componente do grupo Usando widgets ExtJS no Sidekick é chamado de 2. Diálogos dinâmicos e inclui três diálogos dinâmicos que são criados com widgets predefinidos e com lógica javascript personalizada. As caixas de diálogo são armazenadas abaixo de /apps/extjstraining/components/dynamicdialogs. As caixas de diálogo dinâmicas são:

• a caixa de diálogo Alternar guias (nó switchtabs): ela exibe uma janela com duas guias. A primeira guia tem uma seleção de rádio com três opções: quando uma opção é selecionada, uma guia relacionada à opção é exibida. A segunda guia tem dois campos de texto.
• a caixa de diálogo Arbitrário ( arbitrary nó): exibe uma janela com uma guia. A guia tem um campo para soltar ou fazer upload de um ativo e um campo que exibe algumas informações sobre a página que o contém e sobre o ativo, se houver referência a ele.
• a caixa de diálogo Alternar campos ( togglefield nó): exibe uma janela com uma guia. A guia tem uma caixa de seleção: quando estiver marcado, um conjunto de campos com dois campos de texto será exibido.

Para incluir 2. Componente Diálogos dinâmicos na página de amostra:

1. Adicione 2. O componente Diálogos dinâmicos para a página de amostra da guia Usando widgets ExtJS no Sidekick.
2. O componente exibe um título, um texto e um link PROPERTIES: clique em para exibir as propriedades do parágrafo armazenado no repositório. Clique novamente para ocultar as propriedades.

O componente é exibido da seguinte maneira:

Exemplo 1: Alternar caixa de diálogo de guias

A caixa de diálogo Alternar guias exibe uma janela com duas guias. A primeira guia tem uma seleção de rádio com três opções: quando uma opção é selecionada, uma guia relacionada à opção é exibida. A segunda guia tem dois campos de texto.

As suas principais características são:

• É definido por um nó (tipo de nó = cq:Dialog, xtype = [dialog](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialog)).
• Exibe 2 guias (tipo de nó = cq:Panel): 1 guia de seleção, a segunda guia depende da seleção na primeira guia (3 opções).
• Tem 3 guias opcionais (tipo de nó = cq:Panel), cada uma tem 2 campos de texto (tipo de nó = cq:Widget, xtype = [textfield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textfield)). Somente uma guia opcional é exibida por vez.
• É definido pelo nó switchtabs em:
  /apps/extjstraining/components/dynamicdialogs/switchtabs
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/dynamicdialogs/switchtabs.-1.json

A lógica é implementada por meio de ouvintes de evento e código javascript da seguinte maneira:

• O nó de diálogo tem um listener " beforeshow" que oculta todas as guias opcionais antes que a caixa de diálogo seja mostrada:
  beforeshow="function(dialog){Ejst.x2.manageTabs(dialog.items.get(0));}"

  dialog.items.get(0) obtém o painel de guias que contém o painel de seleção e os três painéis opcionais.

• O objeto Ejst.x2 é definido no arquivo exercises.js em:
  /apps/extjstraining/clientlib/js/exercises.js

• No método Ejst.x2.manageTabs(), como o valor de index é -1, todas as guias opcionais estão ocultas (i vai de 1 a 3).

• A guia de seleção tem dois ouvintes: uma que mostra a guia selecionada quando a caixa de diálogo é carregada (“evento loadcontent”) e outra que mostra a guia selecionada quando a seleção é alterada (" evento selectionchanged"):
  loadcontent="function(field,rec,path){Ejst.x2.showTab(field);}"

  selectionchanged="function(field,value){Ejst.x2.showTab(field);}"

• No método Ejst.x2.showTab():
  field.findParentByType('tabpanel') obtém o painel de guias que contém todas as guias ( field representa o widget de seleção)
  field.getValue() obtém o valor da seleção, por exemplo: tab2
  Ejst.x2.manageTabs() exibe a guia selecionada.

• Cada guia opcional tem um ouvinte que oculta a guia no evento " render":
  render="function(tab){Ejst.x2.hideTab(tab);}"

• No método Ejst.x2.hideTab():
  tabPanel é o painel de guias que contém todas as guias
  index é o índice da guia opcional
  tabPanel.hideTabStripItem(index) oculta a guia

Ele é exibido da seguinte maneira:

Exemplo 2: Diálogo Arbitrário

Muitas vezes, uma caixa de diálogo exibe o conteúdo do componente subjacente. A caixa de diálogo descrita aqui, chamada de caixa de diálogo Arbitrário, extrai o conteúdo de um componente diferente.

A caixa de diálogo Arbitrary exibe uma janela com uma guia. A guia tem dois campos: um para soltar ou carregar um ativo e outro que exibe algumas informações sobre a página que o contém e sobre o ativo, se houver uma referência.

As suas principais características são:

• É definido por um nó (tipo de nó = cq:Dialog, xtype = [dialog](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialog)).
• Exibe 1 widget do painel de tabulação (tipo de nó = cq:Widget, xtype = [tabpanel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#tabpanel)) com 1 painel (tipo de nó = cq:Panel)
• O painel tem um widget de arquivo inteligente (tipo de nó = cq:Widget, xtype = [smartfile](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#smartfile)) e um widget de desenho próprio (tipo de nó = cq:Widget, xtype = [ownerdraw](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#ownerdraw))
• É definido pelo nó arbitrary em:
  /apps/extjstraining/components/dynamicdialogs/arbitrary
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/dynamicdialogs/arbitrary.-1.json

A lógica é implementada por meio de ouvintes de evento e código javascript da seguinte maneira:

• O widget ownerdraw tem um listener " loadcontent" que mostra informações sobre a página que contém o componente e o ativo referenciado pelo widget smartfile quando o conteúdo é carregado:
  loadcontent="function(field,rec,path){Ejst.x2.showInfo(field,rec,path);}"

  field é definido com o objeto ownerdraw
  path é definida com o caminho de conteúdo do componente (por exemplo: /content/geometrixx/br/products/triangle/ui-tutorial/jcr:content/par/dynamicdialogs)

• O objeto Ejst.x2 é definido no arquivo exercises.js em:
  /apps/extjstraining/clientlib/js/exercises.js

• No método Ejst.x2.showInfo():
  pagePath é o caminho da página que contém o componente
  pageInfo representa as propriedades da página no formato json
  reference é o caminho do ativo referenciado
  metadata representa os metadados do ativo em formato json
  ownerdraw.getEl().update(html); exibe o html criado na caixa de diálogo

Para usar a caixa de diálogo Arbitrário:

1. Substitua a caixa de diálogo do componente Diálogo dinâmico pela caixa de diálogo Arbitrário:
   siga as etapas descritas para o Exemplo 2: Caixa de diálogo de painel único
2. Edite o componente: a caixa de diálogo é exibida da seguinte maneira:

Exemplo 3: Alternar caixa de diálogo Campos

A caixa de diálogo Alternar campos exibe uma janela com uma guia. A guia tem uma caixa de seleção: quando estiver marcado, um conjunto de campos com dois campos de texto será exibido.

As suas principais características são:

• É definido por um nó (tipo de nó = cq:Dialog, xtype = [dialog](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialog)).
• Exibe 1 widget do painel de guias (tipo de nó = cq:Widget, xtype = [tabpanel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textpanel)) com 1 painel (tipo de nó = cq:Panel).
• O painel tem um widget de seleção/caixa de seleção (tipo de nó = cq:Widget, xtype = [selection](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#selection), tipo = [checkbox](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#checkbox)) e um widget de conjunto de diálogo flexível (tipo de nó = cq:Widget, xtype = [dialogfieldset](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialogfieldset)) que está oculto por padrão, com 2 widgets de campo de texto (tipo de nó = cq:Widget, xtype = [textfield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#textfield)) …
• É definido pelo nó togglefields em:
  /apps/extjstraining/components/dynamicdialogs/togglefields
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/dynamicdialogs/togglefields.-1.json

A lógica é implementada por meio de ouvintes de evento e código javascript da seguinte maneira:

• a guia de seleção tem dois ouvintes: um que mostra o conjunto de diálogo quando o conteúdo é carregado (“evento loadcontent”) e outro que mostra o conjunto de diálogo quando a seleção é alterada (“evento selectionchanged”):
  loadcontent="function(field,rec,path){Ejst.x2.toggleFieldSet(field);}"

  selectionchanged="function(field,value){Ejst.x2.toggleFieldSet(field);}"

• O objeto Ejst.x2 é definido no arquivo exercises.js em:
  /apps/extjstraining/clientlib/js/exercises.js

• No método Ejst.x2.toggleFieldSet():
  box é o objeto de seleção
  panel é o painel que contém a seleção e os widgets dialogfieldset
  fieldSet é o objeto dialogfieldset
  show é o valor da seleção (true ou false) com base em ' show', o conjunto de diálogo é exibido ou não

Para usar a caixa de diálogo Alternar campos:

1. Substitua a caixa de diálogo do componente Diálogo dinâmico pela caixa de diálogo Alternar campos:
   siga as etapas descritas para o Exemplo 2: Caixa de diálogo de painel único
2. Edite o componente: a caixa de diálogo é exibida da seguinte maneira:

Widgets personalizados

Os widgets prontos fornecidos com AEM devem abranger a maioria dos casos de uso. No entanto, às vezes pode ser necessário criar um widget personalizado para cobrir um requisito específico do projeto. É possível criar widgets personalizados estendendo os existentes. Para ajudá-lo a começar a usar essa personalização, o pacote Usando widgets ExtJS inclui três caixas de diálogo que usam três widgets personalizados diferentes:

• a caixa de diálogo Vários campos ( multifield nó) exibe uma janela com uma guia. A guia tem um widget de vários campos personalizado que tem dois campos: um menu suspenso com duas opções e um campo de texto. Como se baseia no widget multifield predefinido (que tem apenas um campo de texto), ele tem todos os recursos do multifield widget.
• a caixa de diálogo Navegação em árvore ( treebrowse nó) exibe uma janela com uma guia que contém um widget de navegação em caminho: quando você clica na seta, uma janela é aberta na qual você pode navegar por uma hierarquia e selecionar um item. O caminho do item é então adicionado ao campo de caminho e persiste quando a caixa de diálogo é fechada.
• uma caixa de diálogo baseada no plug-in do Editor de Rich Text ( rteplugin nó) que adiciona um botão personalizado ao Editor de Rich Text para inserir algum texto personalizado ao texto principal. Ele consiste em um richtext widget (RTE) e de um recurso personalizado que é adicionado por meio do mecanismo de plug-in do RTE.

Os widgets personalizados e o plug-in são incluídos no componente chamado 3. Widgets personalizados do pacote Usando widgets ExtJS. Para incluir esse componente na página de amostra:

1. Adicione 3. Widgets personalizados para a página de amostra da guia Usando widgets ExtJS no Sidekick.
2. O componente exibe um título, um texto e, ao clicar no link PROPERTIES, as propriedades do parágrafo armazenadas no repositório. Clicar novamente oculta as propriedades.
   O componente é exibido da seguinte maneira:

Exemplo 1: Widget multicampo personalizado

A caixa de diálogo baseada no widget Multicampo personalizado exibe uma janela com uma guia. A guia tem um widget de vários campos personalizado que, ao contrário do widget padrão que tem um campo, tem dois campos: um menu suspenso com duas opções e um campo de texto.

A caixa de diálogo Multicampo Personalizado baseada no widget:

• É definido por um nó (tipo de nó = cq:Dialog, xtype = [dialog](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialog)).
• Exibe 1 widget do painel de guias (tipo de nó = cq:Widget, xtype = [tabpanel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#tabpanel)) contendo um painel (tipo de nó = cq:Widget, xtype = [panel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#panel)).
• O painel tem um widget multifield (tipo de nó = cq:Widget, xtype = [multifield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#multifield)).
• O widget multifield tem um fieldconfig (tipo de nó = nt:unstructured, xtype = ejstcustom, optionsProvider = Ejst.x3.provideOptions) que se baseia no xtype personalizado ' ejstcustom':

  • ' fieldconfig' é uma opção de configuração do objeto [CQ.form.MultiField](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.form.MultiField).

  • ' optionsProvider' é uma configuração do widget ejstcustom. É definido com o método Ejst.x3.provideOptions definido em exercises.js em:

    /apps/extjstraining/clientlib/js/exercises.js
    e retorna 2 opções.

• É definido pelo nó multifield em:
  /apps/extjstraining/components/customwidgets/multifield
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/customwidgets/multifield.-1.json

O widget multicampo personalizado (xtype = ejstcustom):

• É um objeto javascript chamado Ejst.CustomWidget.
• Está definido no arquivo javascript CustomWidget.js em:
  /apps/extjstraining/clientlib/js/CustomWidget.js
• Estende o widget [CQ.form.CompositeField](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.form.CompositeField).
• Tem 3 campos: hiddenField (Campo de texto), allowField (ComboBox) e otherField (Campo de texto)
• Substitui CQ.Ext.Component#initComponent para adicionar os 3 campos:
  • allowField é um objeto CQ.form. Selectionobject do tipo 'select'. optionsProvider é uma configuração do objeto Selection que é instanciada com a configuração optionsProvider do CustomWidget definido na caixa de diálogo
  • otherField é um objeto CQ.Ext.form. TextField
• Substitui os métodos setValue, getValue e getRawValue de CQ.form.CompositeField para definir e recuperar o valor de CustomWidget com o formato:
  <allowField value>/<otherField value>, e.g.: 'Bla1/hello'.
• Registra-se como xtype ’ ejstcustom’:
  CQ.Ext.reg('ejstcustom', Ejst.CustomWidget);

A caixa de diálogo baseada no widget Multicampo personalizado é exibida da seguinte maneira:

Exemplo 2: Widget personalizado Treebrowse

A caixa de diálogo personalizada com base no widget Treebrowse exibe uma janela com uma guia contendo um widget de navegação de caminho personalizado: quando você clica na seta, uma janela é aberta na qual você pode navegar por uma hierarquia e selecionar um item. O caminho do item é então adicionado ao campo de caminho e persiste quando a caixa de diálogo é fechada.

A caixa de diálogo personalizada de navegação por árvore:

• É definido por um nó (tipo de nó = cq:Dialog, xtype = [dialog](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#dialog)).
• Exibe 1 widget do painel de guias (tipo de nó = cq:Widget, xtype = [tabpanel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#tabpanel)) contendo um painel (tipo de nó = cq:Widget, xtype = [panel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#panel)).
• O painel tem um widget personalizado (tipo de nó = cq:Widget, xtype = ejstbrowse)
• É definido pelo nó treebrowse em:
  /apps/extjstraining/components/customwidgets/treebrowse
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/customwidgets/treebrowse.-1.json

O widget personalizado de navegadores terrestres (xtype = ejstbrowse):

• É um objeto javascript chamado Ejst.CustomWidget.
• Está definido no arquivo javascript CustomBrowseField.js em:
  /apps/extjstraining/clientlib/js/CustomBrowseField.js
• Estende [CQ.Ext.form.TriggerField](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.form.TriggerField).
• Define uma janela de navegação chamada browseWindow.
• Substitui [CQ.Ext.form.TriggerField](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.form.TriggerField)#onTriggerClick para mostrar a janela de navegação quando a seta é clicada.
• Define um objeto CQ.Ext.tree.TreePanel:
  • Ele obtém seus dados chamando o servlet registrado em /bin/wcm/siteadmin/tree.json.
  • Sua raiz é " apps/extjstraining".
• Define um objeto window ( [CQ.Ext.Window](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.Window)):
  • Baseado no painel predefinido.
  • Tem um botão OK que define o valor do caminho selecionado e oculta o painel.
• A janela está ancorada abaixo do campo Path.
• O caminho selecionado é transmitido do campo de navegação para a janela no evento show.
• Registra-se como xtype ’ ejstbrowse’:
  CQ.Ext.reg('ejstbrowse', Ejst.CustomBrowseField);

Para usar a caixa de diálogo baseada no widget Custom Treebrowse:

1. Substitua a caixa de diálogo do componente Widgets personalizados pela caixa de diálogo Custom Treebrowse:
   siga as etapas descritas para o Exemplo 2: Caixa de diálogo de painel único
2. Edite o componente: a caixa de diálogo é exibida da seguinte maneira:

Exemplo 3: Plug-in do Editor de Rich Text (RTE)

A caixa de diálogo baseada no plug-in Editor de Rich Text (RTE) é uma caixa de diálogo baseada no Editor de Rich Text que tem um botão personalizado para inserir algum texto personalizado entre colchetes. O texto personalizado pode ser analisado por alguma lógica do lado do servidor (não implementada neste exemplo), por exemplo, para adicionar algum texto definido no caminho especificado:

A caixa de diálogo ERT plugin baseada em:

• É definido pelo nó do plug-in em:
  /apps/extjstraining/components/customwidgets/rteplugin
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/customwidgets/rteplugin.-1.json
• O nó rtePlugins tem um nó filho inserttext (tipo de nó = nt:unstructured) nomeado após o plug-in. Ela tem uma propriedade chamada features, que define quais dos recursos de plug-in estão disponíveis para o RTE.

O plug-in RTE:

• É um objeto javascript chamado Ejst.InsertTextPlugin.
• Está definido no arquivo javascript InsertTextPlugin.js em:
  /apps/extjstraining/clientlib/js/InsertTextPlugin.js
• Estende o objeto [CQ.form.rte.plugins.Plugin](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.form.rte.plugins.Plugin).
• Os métodos a seguir definem o objeto [CQ.form.rte.plugins.Plugin](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.form.rte.plugins.Plugin) e são substituídos no plug-in de implementação:
  • getFeatures() retorna uma matriz de todos os recursos disponibilizados pelo plug-in.
  • initializeUI() adiciona o novo botão à barra de ferramentas RTE.
  • notifyPluginConfig() exibe o título e o texto quando o botão é posicionado com o cursor do mouse.
  • execute() é chamado quando o botão é clicado e executa a ação do plug-in: exibe uma janela que é usada para definir o texto a ser incluído.
• insertText() insere um texto usando o objeto de diálogo correspondente Ejst.InsertTextPlugin.Dialog (consulte a seguir).
• executeInsertText() é chamado pelo apply() método da caixa de diálogo, que é acionado quando o ​​botão OK é clicado.
• Registra-se como plug-in ’ inserttext’:
  CQ.form.rte.plugins.PluginRegistry.register("inserttext", Ejst.InsertTextPlugin);
• o objeto Ejst.InsertTextPlugin.Dialog define a caixa de diálogo que é aberta quando o botão do plug-in é clicado. A caixa de diálogo consiste em um painel, um formulário, um campo de texto e dois botões (OK e Cancelar).

Para usar a caixa de diálogo baseada no plug-in Editor de Rich Text (RTE):

1. Substitua a caixa de diálogo do componente Widgets personalizados pela caixa de diálogo Plug-in de Editor de Rich Text (RTE) baseada:
   siga as etapas descritas para o Exemplo 2: Caixa de diálogo de painel único
2. Edite o componente.
3. Clique no último ícone à direita (aquele com quatro setas). Insira um caminho e clique em OK:
   O caminho é exibido entre colchetes ([ ]).
4. Clique em OK para fechar o Editor de Rich Text.

A caixa de diálogo baseada no plug-in Editor de Rich Text (RTE) é exibida da seguinte maneira:

Visão geral da árvore

O objeto predefinido [CQ.Ext.tree.TreePanel](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.tree.TreePanel) oferece uma representação em árvore da interface do usuário de dados estruturados em árvore. O componente Visão geral da árvore incluído no pacote Usando widgets ExtJS mostra como usar o objeto TreePanel para exibir uma árvore JCR abaixo de um determinado caminho. A janela em si pode ser encaixada/desencaixada. Neste exemplo, a lógica da janela é incorporada no componente jsp entre as tags <script></script>.

Para incluir o componente Visão geral da árvore na página de amostra:

1. Adicione o 4. O componente Visão geral da árvore para a página de amostra da guia Usando widgets ExtJS na guia Sidekick.
2. O componente exibe:
   • um título, com algum texto
   • um link PROPERTIES: clique em para exibir as propriedades do parágrafo armazenado no repositório. Clique novamente para ocultar as propriedades.
   • uma janela flutuante com uma representação em árvore do repositório, que pode ser expandida.

O componente é exibido da seguinte maneira:

O componente Visão geral da árvore:

• Está definido em:
  /apps/extjstraining/components/treeoverview

• Sua caixa de diálogo permite definir o tamanho da janela e ancorar/desancorar a janela (veja os detalhes abaixo).

O componente jsp:

• Recupera a largura, a altura e as propriedades ancoradas do repositório.
• Exibe algum texto sobre o formato de dados de visão geral da árvore.
• Incorpora a lógica da janela no componente jsp entre tags javascript.
• Está definido em:
  apps/extjstraining/components/treeoverview/content.jsp

O código javascript incorporado no componente jsp:

• Define um objeto tree tentando recuperar uma janela de árvore da página.
• Se a janela que exibe a árvore não existir, treePanel (CQ.Ext.tree.TreePanel) será criado:

  • treePanel contém os dados usados para criar a janela.

  • Os dados são recuperados chamando o servlet registrado em:

    /bin/wcm/siteadmin/tree.json

• O listener beforeload verifica se o nó clicado está carregado.
• O objeto root define o caminho apps/extjstraining como a raiz da árvore.
• tree ( [CQ.Ext.Window](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.Window)) é definido com base no predefinido treePanel, e é exibido com:
  tree.show();
• Se a janela já existir, ela será exibida com base nas propriedades de largura, altura e ancoragem recuperadas do repositório.

A caixa de diálogo do componente:

• Exibe 1 guia com 2 campos para definir o tamanho (largura e altura) da janela de visão geral da árvore e 1 campo para ancorar/desancorar a janela
• É definido por um nó (tipo de nó = cq:Dialog, xtype = [panel](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#panel)).
• O painel tem um widget sizefield (tipo de nó = cq:Widget, xtype = [sizefield](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#sizefield)) e um widget de seleção (tipo de nó = cq:Widget, xtype = [selection](/docs/experience-manager-65/developing/components/classic-ui-components/xtypes.html?lang=pt-BR#selection), tipo = radio) com 2 opções (true/false)
• É definido pelo nó de diálogo em:
  /apps/extjstraining/components/treeoverview/dialog
• É renderizado no formato json solicitando:
  https://localhost:4502/apps/extjstraining/components/treeoverview/dialog.-1.json
• É exibido da seguinte forma:

Visão geral da grade

Um Painel de grade representa dados em um formato tabular de linhas e colunas. É composto pelos seguintes elementos:

• Loja : o modelo que contém os registros de dados (linhas).
• Modelo de coluna: a composição da coluna.
• Visualização: encapsula a interface do usuário.
• Modelo de seleção: o comportamento da seleção.

O componente Visão geral da grade incluído no pacote Usando widgets ExtJS mostra como exibir dados em um formato tabular:

• O exemplo 1 usa dados estáticos.
• O exemplo 2 usa dados recuperados do repositório.

Para incluir o componente Visão geral da grade à página de amostra:

1. Adicione o 5. Componente Visão geral da grade para a página de amostra da guia Usando widgets ExtJS no Sidekick.
2. O componente exibe:
   • um título com algum texto
   • um link PROPERTIES: clique em para exibir as propriedades do parágrafo armazenado no repositório. Clique novamente para ocultar as propriedades.
   • uma janela flutuante contendo dados em formato tabular.

O componente é exibido da seguinte maneira:

Exemplo 1: Grade Padrão

Em sua versão predefinida, o componente Visão geral da grade exibe uma janela com dados estáticos em um formato tabular. Neste exemplo, a lógica é incorporada no componente jsp de duas maneiras:

• a lógica genérica é definida entre as tags <script></script>
• a lógica específica está disponível em um arquivo .js separado e está vinculada ao jsp. Essa configuração permite alternar facilmente entre as duas lógicas (estáticas/dinâmicas) ao comentar as tags <script> desejadas.

O componente Visão geral da grade:

• Está definido em:
  /apps/extjstraining/components/gridoverview
• Sua caixa de diálogo permite definir o tamanho da janela e ancorar/desancorar a janela.

O componente jsp:

• Recupera a largura, a altura e as propriedades ancoradas do repositório.

• Exibe algum texto como introdução ao formato de dados de visão geral da grade.

• Refere o código javascript que define o objeto GridPanel:
  <script type="text/javascript" src="/apps/extjstraining/components/gridoverview/defaultgrid.js?lang=pt-BR"></script>

  defaultgrid.js define alguns dados estáticos como uma base para o objeto GridPanel.

• Incorpora código javascript entre tags javascript que definem o objeto Window que usa o objeto GridPanel.

• Está definido em:
  apps/extjstraining/components/gridoverview/content.jsp

O código javascript incorporado no componente jsp:

• Define o objeto grid tentando recuperar o componente de janela da página:
  var grid = CQ.Ext.getCmp("<%= node.getName() %>-grid");
• Se grid não existir, um objeto CQ.Ext.grid.GridPanel ( gridPanel) será definido chamando o método getGridPanel() (veja abaixo). Este método é definido em defaultgrid.js.
• grid é um [CQ.Ext.Window](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.Window) objeto, com base no GridPanel predefinido, e é exibido: grid.show();
• Se grid já existir, ele será exibido com base nas propriedades de largura, altura e ancoragem recuperadas do repositório.

O arquivo javascript ( defaultgrid.js) referenciado no componente jsp define o método getGridPanel() que é chamado pelo script incorporado no JSP e retorna um objeto [CQ.Ext.grid.GridPanel](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.grid.GridPanel), com base em dados estáticos. A lógica é a seguinte:

• myData é uma matriz de dados estáticos formatados como uma tabela de 5 colunas e 4 linhas.
• store é um CQ.Ext.data.Store objeto que consome myData.
• store é carregado na memória:
  store.load();
• gridPanel é um [CQ.Ext.grid.GridPanel](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.grid.GridPanel) objeto que consome store:

  • as larguras das colunas são sempre redistribuídas:

    forceFit: true

  • somente uma linha por vez pode ser selecionada:

    singleSelect:true

Exemplo 2: Grade de pesquisa de referência

Quando você instala o pacote, o content.jsp do componente Visão geral da grade exibe uma grade baseada em dados estáticos. É possível modificar o componente para exibir uma grade com as seguintes características:

• Tem três colunas.
• É baseado em dados recuperados do repositório chamando um servlet.
• As células da última coluna podem ser editadas. O valor é persistente em uma propriedade test abaixo do nó definido pelo caminho exibido na primeira coluna.

Conforme explicado na seção anterior, o objeto window obtém seu objeto [CQ.Ext.grid.GridPanel](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.grid.GridPanel) chamando o método getGridPanel() definido no arquivo defaultgrid.js em /apps/extjstraining/components/gridoverview/defaultgrid.js. O componente Grid Overview fornece uma implementação diferente para o método getGridPanel(), definido no arquivo referencesearch.js em /apps/extjstraining/components/gridoverview/referencesearch.js. Ao alternar o arquivo .js mencionado no componente jsp, a grade será baseada nos dados recuperados do repositório.

Alterne o arquivo .js mencionado no componente jsp:

1. Em CRXDE Lite, no arquivo content.jsp do componente, comente a linha que inclui o arquivo defaultgrid.js, para que ele tenha a seguinte aparência:
   <!-- script type="text/javascript" src="/apps/extjstraining/components/gridoverview/defaultgrid.js?lang=pt-BR"></script-->
2. Remova o comentário da linha que inclui o arquivo referencesearch.js, para que ele tenha a seguinte aparência:
   <script type="text/javascript" src="/apps/extjstraining/components/gridoverview/referencesearch.js?lang=pt-BR"></script>
3. Salve as alterações.
4. Atualize a página de amostra.

O componente é exibido da seguinte maneira:

O código javascript referenciado no componente jsp ( referencesearch.js) define o método getGridPanel() chamado a partir do componente jsp e retorna um objeto [CQ.Ext.grid.GridPanel](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.grid.GridPanel), com base em dados recuperados dinamicamente do repositório. A lógica em referencesearch.js define alguns dados dinâmicos como uma base para o GridPanel:

• reader é um [CQ.Ext.data.JsonReader](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.data.JsonReader)objeto que lê a resposta do servlet no formato json para 3 colunas.
• cm é um [CQ.Ext.grid.ColumnModel](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.grid.ColumnModel) objeto para 3 colunas.
  As células da coluna "Testar" podem ser editadas conforme são definidas com um editor:
  editor: new [CQ.Ext.form.TextField](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.form.TextField)({})
• as colunas são classificáveis:
  cm.defaultSortable = true;
• store é um [CQ.Ext.data.GroupingStore](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.data.GroupingStore) objeto:
  • ele obtém seus dados chamando o servlet registrado em " /bin/querybuilder.json" com alguns parâmetros usados para filtrar o query
  • é baseado em reader, definido antecipadamente
  • a tabela é classificada de acordo com a coluna 'jcr:path' em ordem crescente
• gridPanel é um [CQ.Ext.grid.EditorGridPanel](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.grid.EditorGridPanel) objeto que pode ser editado:

  • é baseado no store predefinido e no modelo de coluna cm

  • somente uma linha por vez pode ser selecionada:

    sm: new [CQ.Ext.grid.RowSelectionModel](https://helpx.adobe.com/br/experience-manager/6-5/sites/developing/using/reference-materials/widgets-api/index.html?class=CQ.Ext.grid.RowSelectionModel)({singleSelect:true})

  • o listener afteredit verifica se após uma célula na coluna "Test" foi editada:

    • a propriedade ' test' do nó no caminho definido pela coluna "jcr:path" está definida no repositório com o valor da célula
    • se o POST for bem-sucedido, o valor será adicionado ao objeto store; caso contrário, será rejeitado