AEM コンポーネントの開発(クラシック UI)

クラシック UI では、ExtJS を使用して、コンポーネントのルックアンドフィールを提供するウィジェットを作成します。このウィジェットの性質により、クラシック UI とタッチ操作対応 UI では、コンポーネントとのやり取りにいくつかの相違点があります。

メモ

コンポーネント開発の多くの側面はクラシック UI とタッチ操作向け UI に共通なので、このページを使用する](/docs/experience-manager-65/developing/components/components-basics.html?lang=ja)前に​**、AEM コンポーネント - 基本**​を必ずお読みください[。クラシック UI の詳細が記載されています。

メモ

クラシック UI 用のコンポーネントの開発には HTML テンプレート言語(HTL)と JSP のどちらも使用できますが、このページでは JSP を使用した開発について説明します。これは単に、クラシック UI 内では JSP が使用されてきたからです。

現在では、HTL が AEM の推奨スクリプティング言語とされています。手法を比較するには、HTL および AEM コンポーネントの開発を参照してください。

構造

コンポーネントの基本構造については、タッチ操作対応 UI とクラシック UI の両方に適用される AEM コンポーネント - 基本ページで説明しています。新しいコンポーネントでタッチ操作対応 UI の設定を使用する必要がない場合でも、この情報は既存のコンポーネントを継承する際に設定を把握するのに役立ちます。

JSP スクリプト

コンポーネントをレンダリングするには JSP スクリプトまたはサーブレットを使用します。Sling のリクエスト処理規則に従って、デフォルトスクリプトの名前は、

<*componentname*>.jsp

global.jsp

JSP スクリプトファイルの global.jsp は、コンポーネントのレンダリングに使用される任意の JSP スクリプトの特定オブジェクト(コンテンツ)にすばやくアクセスするために使用されます。

したがって、global.jsp で提供される 1 つ以上のオブジェクトを使用する場合は、JSP スクリプトをレンダリングするすべてのコンポーネントに global.jsp を含める必要があります。

デフォルトの global.jsp は次の場所にあります。

/libs/foundation/global.jsp

メモ

CQ 5.3 以前のバージョンで使用されたパス /libs/wcm/global.jsp は、現在廃止されています。

global.jsp、使用される API および Taglib の機能

デフォルトの global.jsp から提供される最も重要なオブジェクトを次に示します。

概要:

  • <cq:defineObjects />

    • slingRequest - ラップされたリクエストオブジェクト(SlingHttpServletRequest)。
    • slingResponse - ラップされた応答オブジェクト(SlingHttpServletResponse)。
    • resource - Sling リソースオブジェクト(slingRequest.getResource();)。
    • resourceResolver - Sling リソースリゾルバーオブジェクト(slingRequest.getResoucreResolver();)。
    • currentNode - リクエストに対して解決された JCR ノード。
    • log - デフォルトの logger ()。
    • sling - Sling スクリプトヘルパー。
    • properties - 指定されたリソースのプロパティ(resource.adaptTo(ValueMap.class);)。
    • pageProperties - 指定されたリソースのページのプロパティ。
    • pageManager - AEM コンテンツページにアクセスするためのページマネージャー(resourceResolver.adaptTo(PageManager.class);)。
    • component - 現在の AEM コンポーネントのコンポーネントオブジェクト。
    • designer - デザイン情報を取得するためのデザイナーオブジェクト(resourceResolver.adaptTo(Designer.class);)。
    • currentDesign - 指定されたリソースのデザイン。
    • currentStyle - 指定されたリソースのスタイル。

コンテンツへのアクセス

AEM WCM のコンテンツにアクセスするには、3 つの方法があります。

  • global.jsp に設定されているプロパティオブジェクト経由:

    プロパティオブジェクトは、ValueMap のインスタンス(Sling API を参照)で、現在のリソースのプロパティがすべて含まれています。

    例:ページコンポーネントのレンダリングスクリプト内で使用される String pageTitle = properties.get("jcr:title", "no title");

    例:標準の段落コンポーネントのレンダリングスクリプト内で使用される String paragraphTitle = properties.get("jcr:title", "no title");

  • global.jsp に設定されている currentPage オブジェクト経由:

    currentPage オブジェクトは、ページのインスタンスです(AEM API を参照)。ページクラスには、コンテンツにアクセスするためのメソッドがいくつかあります。

    例:String pageTitle = currentPage.getTitle();

  • global.jsp に導入されている currentNode オブジェクト経由:

    currentNode オブジェクトは、ノードのインスタンスです(JCR API を参照)。ノードのプロパティには、getProperty() メソッドによってアクセスできます。

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

JSP タグライブラリ

CQ と Sling のタグライブラリを使用すると、テンプレートやコンポーネントの JSP スクリプトで使用する特定の機能にアクセスできます。

詳しくは、タグライブラリドキュメントを参照してください。

クライアント側 HTML ライブラリの使用

最近の Web サイトは、複雑な JavaScript や CSS コードを利用したクライアント側の処理に大きく依存しています。このコードの提供を編成および最適化することが厄介な問題となることがあります。

この問題への対処に役立つように、AEM では、クライアント側ライブラリフォルダー​が提供されています。これにより、クライアント側コードをリポジトリに格納し、カテゴリ別に整理して、それぞれのカテゴリのコードをクライアントに提供するタイミングと方法を定義することができます。その後、クライアントサイドライブラリシステムにより、最終的な web ページで、正しいコードを読み込むための正しいリンクが作成されます。

詳しくは、クライアントサイド HTML ライブラリの使用ドキュメントを参照してください。

ダイアログ

コンポーネントのコンテンツを作成者が追加したり設定できるようにするには、ダイアログが必要です。

詳しくは、AEM コンポーネント - 基本を参照してください。

編集動作の設定

コンポーネントの編集動作を設定できます。これには、コンポーネントに対して使用可能なアクションなどの属性、インプレースエディターの特性、コンポーネントに対するイベントに関連するリスナーも含まれます。固有の相違点は多少ありますが、設定はタッチ操作対応 UI とクラシック UI の両方に共通です。

コンポーネントの編集動作は、タイプ cq:EditConfigcq:editConfig ノードをコンポーネントノード(タイプ cq:Component)の下に追加し、特定のプロパティと子ノードを追加して設定します。

ExtJS ウィジェットの使用と拡張

詳しくは、ExtJS ウィジェットの使用と拡張を参照してください。

ExtJS ウィジェットに xtype を使用

詳しくは、xtype の使用を参照してください。

新しいコンポーネントの開発

この節では、独自のコンポーネントを作成し、それを段落システムに追加する方法について説明します。

既存のコンポーネントをコピーし、必要な変更をおこなうことが、開発を始めるうえで最も簡単な方法です。

コンポーネントの開発方法の例について詳しくは、テキストコンポーネントと画像コンポーネントの拡張 - 例を参照してください。

新しいコンポーネントの開発(既存のコンポーネントの利用)

既存のコンポーネントをベースに新しい AEM コンポーネントを開発するには、既存のコンポーネントをコピーし、新しいコンポーネント用の JavaScript ファイルを作成して、AEM からアクセスできる場所に保存します(「コンポーネントおよびその他の要素のカスタマイズ」も参照してください)。

  1. CRXDE Lite を使用して、新しいコンポーネントフォルダーを以下の場所に作成します。

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

    libs 内にあるものと同じノード構造を再作成してから、テキストコンポーネントなどの既存のコンポーネントの定義をコピーします。例えば、テキストコンポーネントをカスタマイズするには、次のようにコピーします。

    • コピー元:/libs/foundation/components/text
    • コピー先:/apps/myProject/components/text
  2. jcr:title を変更して新しい名前を反映させます。

  3. 新しいコンポーネントフォルダーを開き、必要な変更をおこないます。また、フォルダー内にある不要な情報を削除します。

    例えば、次のような変更をおこなうことができます。

    • ダイアログボックスへの新しいフィールドの追加

      • cq:dialog - タッチ操作対応 UI 用ダイアログ
      • dialog - クラシック UI 用ダイアログ
    • .jsp ファイルの置換(新しいコンポーネントの作成後に名前を付けます)

    • または、コンポーネント全体の作成し直し(必要な場合)

    例えば、標準テキストコンポーネントのコピーを作成した場合は、ダイアログボックスにフィールドを追加して、.jsp を更新し、そこに追加された情報を処理します。

    メモ

    使用するコンポーネント:

    メモ

    クラシック UI 用に定義したダイアログは、タッチ操作対応 UI 内で動作します。

    タッチ操作対応 UI 用に定義したダイアログは、クラシック UI 内では動作しません。

    インスタンスとオーサー環境によっては、コンポーネント用に両方のタイプのダイアログを定義する必要が生じる場合があります。

  4. 新しいコンポーネントを表示するには、次のいずれかのノードが存在し、適切に初期化されている必要があります。

    • cq:dialog - タッチ操作対応 UI 用ダイアログ
    • dialog - クラシック UI 用ダイアログ
    • cq:editConfig - 編集環境でのコンポーネントの動作(ドラッグ&ドロップなど)
    • design_dialog - デザインモード用ダイアログ(クラシック UI のみ)
  5. 次のどちらかの方法で、段落システムで新しいコンポーネントを利用できるようにします。

    • CRXDE Lite を使用して、ノード /etc/designs/geometrixx/jcr:content/contentpage/par の適切なコンポーネントに、値 <path-to-component>/apps/geometrixx/components/myComponent など)を追加します。
    • 段落システムへの新しいコンポーネントの追加」の手順を実行します。
  6. AEM WCM で、Web サイトのページを開き、作成した新しいタイプの段落を挿入してコンポーネントが正常に動作することを確認します。

メモ

ページ読み込みのタイミングの統計を確認するには、Ctrl + Shift + U キーを、URL で設定されている ?debugClientLibs=true と共に使用します。

段落システムへの新しいコンポーネントの追加(デザインモード)

コンポーネントを開発したら、段落システムに追加します。この操作により、ページの編集時に、作成者がコンポーネントを選択して使用できるようになります。

  1. 段落システムを使用するオーサリング環境でページにアクセスします(例:<contentPath>/Test.html)。

  2. 次のどちらかの方法でデザインモードに切り替えます。

    • 以下の例のように、URL の最後に ?wcmmode=design を追加し、再度アクセスします。

      <contextPath>/ Test.html?wcmmode=design

    • サイドキックで「デザイン」をクリックします。

    デザインモードになり、段落システムを編集できるようになります。

  3. 「編集」をクリックします。

    その段落システムに所属するコンポーネントのリストが一覧表示されます。新しいコンポーネントも一覧に表示されます。

    これらのコンポーネントをアクティブ化または非アクティブ化することで、ページの編集時に作成者に提供するコンポーネントを決定できます。

  4. コンポーネントをアクティブ化したら、標準編集モードに戻り、利用可能かどうかを確認します。

テキストコンポーネントと画像コンポーネントの拡張 - 例

この節では、広く利用されているテキストと画像の標準コンポーネントを、設定可能な画像配置機能を使用して拡張する方法について説明します。

テキストコンポーネントと画像コンポーネントの拡張により、エディターは、コンポーネントのすべての既存機能を使用できるだけでなく、次のどちらかの方法で画像の配置を指定できる追加のオプションも利用できます。

  • テキストの左側(現在の動作および新しいデフォルト)
  • テキストの右側

このコンポーネントを拡張したら、コンポーネントのダイアログボックスを使用して画像の配置を設定できます。

この演習では、以下の方法を説明します。

  • 既存のコンポーネントノードのコピーとメタデータの変更
  • コンポーネントのダイアログの変更(親ダイアログボックスからのウィジェットの継承を含む)
  • 新機能を実装するためのコンポーネントのスクリプトの変更
メモ

この例は、クラシック UI を対象としています。

メモ

この例は、Geometrixx サンプルコンテンツに基づいています。これは、AEM に付属されなくなり、We.Retail に置き換えられました。Geometrixx のダウンロードおよびインストール方法については、We.Retail 参照実装を参照してください。

既存の textimage コンポーネントの拡張

新しいコンポーネントを作成するには、標準の textimage コンポーネントをベースとして使用し、それに変更を加えます。ここでは、Geometrixx AEM WCM の例のアプリケーションに新しいコンポーネントを保存します。

  1. 標準の textimage コンポーネントを /libs/foundation/components/textimage から Geometrixx のコンポーネントフォルダー(/apps/geometrixx/components)に、ターゲットノードの名前として textimage を使用してコピーします(コンポーネントに移動し、右クリックして「コピー」を選択し、ターゲットディレクトリをブラウジングすることでコンポーネントをコピーします)。

    chlimage_1-59

  2. この例ではシンプルに保つために、コピーしたコンポーネントに移動し、新しい textimage ノードから、以下に示すサブノードを除く、すべてのサブノードを削除してください。

    • ダイアログの定義:textimage/dialog
    • コンポーネントのスクリプト:textimage/textimage.jsp
    • 設定の編集ノード(アセットのドラッグ&ドロップの許可):textimage/cq:editConfig
    メモ

    ダイアログの定義は、UI に依存します。

    • タッチ操作対応 UI:textimage/cq:dialog
    • クラシック UI:textimage/dialog
  3. コンポーネントのメタデータを編集します。

    • コンポーネント名

      • jcr:descriptionText Image Component (Extended) に設定
      • jcr:titleText Image (Extended) に設定
    • サイドキック内でコンポーネントが一覧表示されるグループ(修正しない)

      • componentGroupGeneral に設定したままにする
    • 新しいコンポーネントの親コンポーネント(標準の textimage コンポーネント)

      • sling:resourceSuperTypefoundation/components/textimage に設定

    この手順を終えると、コンポーネントのノードは以下のようになります。

    chlimage_1-60

  4. 画像の編集設定ノードの sling:resourceType プロパティ(プロパティ:textimage/cq:editConfig/cq:dropTargets/image/parameters/sling:resourceType)を geometrixx/components/textimage. に変更する

    これで、画像がページ上のコンポーネントにドロップされると、拡張された textimage コンポーネントの sling:resourceType プロパティが geometrixx/components/textimage. に設定されます。

  5. コンポーネントのダイアログボックスを変更して新しいオプションを含めます。新しいコンポーネントは元のコンポーネントと同じダイアログボックスのパーツを継承します。「詳細」タブを拡張するために、「」と「」のオプションのある「画像の位置」ドロップダウンリストだけを追加します。

    • textimage/dialog プロパティは変更しません。

    textimage/dialog/items に、textimage ダイアログボックスの 4 つのタブを表す 4 つのサブノード(tab1 から tab4)があることを確認します。

    • 最初の 2 つのタブ(tab1 および tab2):

      • xtype を cqinclude に変更します(標準コンポーネントから継承するため)。
      • /libs/foundation/components/textimage/dialog/items/tab1.infinity.json 値および /libs/foundation/components/textimage/dialog/items/tab2.infinity.json 値を持つパスプロパティをそれぞれ追加します。
      • その他のすべてのプロパティとサブネットを削除します。
    • tab3:

      • プロパティとサブノードは変更せずに保持します。

      • 新しいフィールドの定義として、cq:Widget タイプのノードの場所を tab3/items に追加します。

      • 新しい tab3/items/position ノードに以下のプロパティ(String タイプ)を設定します。

        • name./imagePosition
        • xtypeselection
        • fieldLabelImage Position
        • typeselect
      • 画像の配置の選択肢を 2 つ表すために、cq:WidgetCollection タイプのサブノード position/options を追加し、その下に、nt:unstructured タイプの 2 つのノード(o1 および o2)を作成します。

      • position/options/o1 ノードの場合、text プロパティを Left に設定して、value プロパティを left. に設定します。

      • position/options/o2 ノードの場合 、プロパティ textRight に設定し、プロパティ valueright に設定します。

    • tab4 を削除します。

    画像の位置は、textimage の段落を表すノードの imagePosition プロパティとしてコンテンツ内で保持されます。これらの手順を終えると、コンポーネントのダイアログボックスは以下のようになります。

    chlimage_1-61

  6. コンポーネントのスクリプト、textimage.jsp を拡張し、新しいパラメーターの処理を追加します。

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

    強調表示したコードのフラグメント %/div class="image"/% は、このタグのカスタムスタイルを生成する新しいコードで置き換える予定です。

    // 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. コンポーネントをリポジトリに保存します。コンポーネントをテストする準備ができました。

新しいコンポーネントの確認

コンポーネントを開発したら、段落システムに追加します。この操作により、ページの編集時に、作成者がコンポーネントを選択して使用できるようになります。コンポーネントをテストするには、以下の手順を実行します。

  1. Geometrixx でページを開きます(例:English/Company)。
  2. サイドキックで「デザイン」をクリックし、デザインモードに切り替えます。
  3. ページの中央の段落システムで、「編集」をクリックし、段落システムのデザインを編集します。段落システムに配置できるコンポーネントの一覧が表示されます。一覧には、新しく開発した Text Image (Extended) コンポーネントも含まれます。コンポーネントを選択し、「OK」をクリックして、段落システムに対してコンポーネントをアクティブ化します。
  4. 編集モードに戻します。
  5. Text Image (Extended) 段落を段落システムに追加し、サンプルコンテンツでテキストと画像を初期化します。変更内容を保存します。
  6. テキストと画像の段落のダイアログを開き、「詳細」タブで画像の位置を「右」に変更し、「OK」をクリックして変更を保存します。
  7. 段落の右側に画像がレンダリングされます。
  8. コンポーネントを使用する準備ができました。

コンポーネントには、Company ページの段落のコンテンツが格納されます。

画像コンポーネントのアップロード機能の無効化

アップロード機能を無効にするには、標準の画像コンポーネントをベースとして使用し、それに変更を加えます。Geometrixx の例のアプリケーションに新しいコンポーネントを保存します。

  1. ターゲットノードの名前として画像を使用して、/libs/foundation/components/image から Geometrixx コンポーネントフォルダー(/apps/geometrixx/components)に標準の画像コンポーネントをコピーします。

    chlimage_1-62

  2. コンポーネントのメタデータを編集します。

    • jcr:titleImage (Extended) に設定します。
  3. /apps/geometrixx/components/image/dialog/items/imageに移動します。

  4. 新しいプロパティを追加します。

    • 名前allowUpload
    • String
    • false

    chlimage_1-63

  5. すべて保存」をクリックします。コンポーネントをテストする準備ができました。

  6. Geometrixx でページを開きます(例:English/Company)。

  7. デザインモードに切り替え、Image (Extended) をアクティブ化します。

  8. 編集モードに切り替え、画像を段落システムに追加します。次の画像で、元の画像コンポーネントと先ほど作成したコンポーネントの違いを確認できます。

    元の画像コンポーネント:

    chlimage_1-64

    新しい画像コンポーネント:

    chlimage_1-65

  9. コンポーネントを使用する準備ができました。

このページ