新しい Granite UI フィールドコンポーネントの作成

Granite UI には、フォームで使用するようにデザインされた幅広いコンポーネントが用意されています。これらを Granite の UI 用語では「フィールド」と呼びます。**​標準の Granite フォームコンポーネントは、次の場所にあります。

/libs/granite/ui/components/foundation/form/*

メモ

これらの Granite UI フォームフィールドが特に注目されるのは、これらがコンポーネントダイアログで使用されるからです。

メモ

フィールドについて詳しくは、Granite UI に関するドキュメントを参照してください。

Granite コンポーネントを開発または拡張するには、Granite UI の基盤フレームワークを使用します。このフレームワークには次の 2 つの要素があります。

  • サーバー側:

    • 基盤コンポーネントのコレクション

      • 基盤 - モジュール式、組み立て可能、階層化可能、再利用可能
      • コンポーネント - Sling コンポーネント
    • アプリケーション開発を支援するためのヘルパー

  • クライアント側:

    • ハイパーメディア駆動型 UI を使用して一般的なインタラクションパターンを実現するための語彙(HTML 言語の拡張)を提供するクライアントライブラリのコレクション

汎用のGranite UIコンポーネントfieldは、次の2つの対象ファイルで構成されています。

  • init.jsp:ラベル付けや説明などの一般的な処理を扱い、フィールドをレンダリングする際に必要になるフォーム値を提供します。
  • render.jsp:フィールドの実際のレンダリングを実行します。カスタムフィールドに対してはオーバーライドされます。init.jsp にインクルードされます。

詳しくは、Granite UI に関するドキュメント - フィールドを参照してください。

詳しくは、例えば、以下を参照してください。

  • cqgems/customizingfield/components/colorpicker

  • granite/ui/components/foundation/form

メモ

このメカニズムは JSP を使用しているので、i18n および XSS はデフォルトでは提供されません。つまり、文字列を国際化およびエスケープする必要があります。以下のディレクトリには、標準インスタンスの一般的なフィールドが含まれています。これらをリファレンスとして使用できます。

/libs/granite/ui/components/foundation/form

コンポーネント用のサーバー側スクリプトの作成

カスタマイズしたフィールドは、render.jsp スクリプトのみをオーバーライドする必要があります。このスクリプトは、コンポーネントのマークアップを提供します。この JSP(レンダリングスクリプト)は、マークアップのラッパーと見なすことができます。

  1. sling:resourceSuperType プロパティを使用して、以下から継承する新しいコンポーネントを作成します。

    /libs/granite/ui/components/foundation/form/field

  2. 次のスクリプトをオーバーライドします。

    render.jsp

    このスクリプトでは、クライアントが生成された要素とやり取りする方法を理解できるように、ハイパーメディアマークアップ(ハイパーメディアアフォーダンスを含む、拡張されたマークアップ)を生成する必要があります。Granite UI のサーバー側コーディングスタイルに従ってください。

    カスタマイズする際に守るべき唯一の決まり事は​**、以下を使用して、リクエストからフォーム値(init.jsp で初期化)を読み取ることです。

    // Delivers the value of the field (read from the content)
    ValueMap vm = (ValueMap) request.getAttribute(Field.class.getName());
    vm.get("value, String.class");
    

    詳しくは、標準搭載のGranite UIフィールドの実装を参照してください。例: /libs/granite/ui/components/foundation/form/textfield

    メモ

    現時点では、HTL ではコンポーネント間の情報の受け渡し(フォーム/フィールドのコンテキストでは非常に頻繁におこなわれます)を簡単には実現できないので、スクリプティングメソッドとして JSP が推奨されます。

コンポーネント用のクライアントライブラリの作成

特定のクライアント側動作をコンポーネントに追加するには:

  1. カテゴリ cq.authoring.dialog のクライアントライブラリを作成します。

  2. カテゴリcq.authoring.dialogのclientlibを作成し、その中にJS/ CSSを定義します。

    クライアントライブラリ内にJS/ CSSを定義します。

    メモ

    現時点では、Granite UI には、JS 動作を追加するために直接使用できるデフォルトのリスナーやフックはありません。そのため、JS 動作をコンポーネントに追加するには、JS フックをカスタムクラスに実装して、マークアップの生成時にコンポーネントに割り当てる必要があります。

このページ