19.2.2 プラグインの作成

「共有コンポーネント」にナビゲートし、プラグインの作成ウィザードを実行してプラグインを作成します。

19.2.2.1 プラグインを最初から作成

プラグインの作成ウィザードを実行して、プラグインを最初から作成します。

ヒント:

この項で説明する属性についてさらに学習するには、フィールドレベル・ヘルプを参照してください。

プラグインを最初から作成するには:

  1. 共有コンポーネント・ページにナビゲートします。
    1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。
    2. アプリケーションを選択します。
    3. アプリケーションのホームページで、「共有コンポーネント」をクリックします。

      共有コンポーネント・ページが表示されます。

  2. 「他のコンポーネント」で、「プラグイン」をクリックします。
  3. 「作成」をクリックします。

    プラグインの作成ウィザードが表示されます。

  4. プラグインの作成 - 「最初から」を選択して「次」をクリックします。
  5. 名前:
    1. 名前 - プラグインの名前を入力します。
    2. 内部名 - プラグインの内部名を入力します。この名前は、現在のアプリケーション内で一意である必要があります。

      内部名をワールドワイドでグローバルな一意名とするために、組織のドメイン名を内部プラグイン名の接頭辞として使用することをお薦めします。たとえば、ドメイン名example.com.comSliderという名前のプラグインに接頭辞として付けると、内部名はCOM.EXAMPLE.SLIDERとなります。

      テーマの一部としてテンプレート・コンポーネント・タイプ・プラグインの内部名には、常にTHEME$という接頭辞が付きます(例: THEME$COM.MYCOMPANY.BADGE)。この内部名を使用して、サーバー側のテンプレート・ディレクティブがサポートされているテンプレート・コンポーネントを手動で適用します。

    3. タイプ - このプラグインを使用するコンポーネントのタイプを選択します。オプションは次のとおりです。
      • 認証スキーム・タイプ - アプリケーションにアクセスする前に各ユーザーのアイデンティティを確立する方法を決定します。
      • 承認スキーム・タイプ - ユーザーがページ、プロセスまたはコンポーネントにアクセスできるかどうかを確認します。

      • 動的アクション - クライアント側で動的に呼び出せる新しいアクションや機能を追加します。

      • アイテム - 新しいアイテム・タイプをAPEXに追加します。

      • プロセス - アプリケーションまたはページ・プロセス(あるいはその両方)を追加します。

      • RESTデータ・ソース - 追加の構成やプログラミングを行わずに、特定のRESTデータ・ソースに使用されます。

      • リージョン - APEXに新しいリージョン・タイプを追加するために使用するプラグイン。
      • テンプレート・コンポーネント - テンプレート・ディレクティブをサポートするHTMLテンプレートに基づくプラグイン。「テンプレート・ディレクティブ」を参照してください。

        PL/SQLに基づいていない新しいリージョン・タイプをAPEXに追加するためのサポートを有効にします。これらの新しいリージョン・タイプは、リージョン、レポートまたは対話モード・レポートの列として使用できます。

      選択したプラグイン・タイプに応じて、UIが変更されます。たとえば、「コールバック」と「標準属性」に表示されるオプションは異なる場合があります。

    4. カテゴリ - 選択したタイプが「動的アクション」の場合にのみ表示されます。ユーザー・インタフェースでプラグインが表示されるカテゴリを選択します。
  6. ソース:
    1. PL/SQLコード - このプラグインのレンダリング、検証、実行およびAJAXコールバックの実行用のプロシージャを含むコードのPL/SQL無名ブロックを入力します。パフォーマンス上の理由から、このコードはデータベース内のPL/SQLパッケージに格納することもできます。
    2. PL/SQLコードを検証しない(実行時にのみPL/SQLコードを解析)。 - PL/SQLコードを実行時にのみ解析する場合は、このオプションを選択します。選択しない場合、コードはプラグインが作成されるときに解析されます。
  7. コールバック - 該当する属性を構成します。表示される属性はプラグイン・タイプに応じて決まります。属性についてさらに学習したり、例を確認するには、フィールドレベル・ヘルプを参照してください。

    ヒント:

    すべてのコールバック・ファンクション名は、無名PL/SQLコード・ブロックのファンクション、パッケージ内のファンクションまたはデータベース内のスタンドアロン・ファンクションを参照できます。

  8. 標準属性 - このプラグインに適用する属性を選択します。「標準属性」は、一部のプラグインには表示されません。

    アイテム・タイプ・プラグインのみに適用される標準属性の詳細は、「アイテム・タイプ・プラグインの標準属性」を参照してください。

  9. 情報:
    1. バージョン - プラグインのバージョンを識別する文字列を入力します。
    2. URL情報 - プラグイン作成者のホームページのURL、またはプラグインに関する追加情報のURLです。
  10. 「ヘルプ・テキスト」に、ユーザーがプラグインの機能を理解するのに使用するヘルプ・テキストを入力します。
  11. 「コメント」に、アプリケーションが実行されているときに表示されないコメントおよびノートを入力します。

    各オプションについてさらに学習するには、フィールドレベル・ヘルプを参照してください。

  12. 「プラグインの作成」をクリックします。

    プラグインが作成されたら、それを編集して追加のカスタム属性の指定、プラグインと関連付けるイメージ、CSSおよびJavaScriptファイルなどのファイルのアップロードおよびイベントの追加を実行できます。

19.2.2.2 アイテム・タイプ・プラグインの標準属性

アイテム・タイプ・プラグインの標準属性を確認します。

アイテム・タイプの標準属性 説明

ウィジェットの表示

ウィジェットが表示されます。

標準のフォーム要素

ウィジェットはHTMLフォーム要素(入力、選択、テキスト領域など)としてレンダリングされます。チェックしない場合、APEX_PLUGIN_UTIL.GET_ELEMENT_ATTRIBUTESは自動的にARIA-LABELLEDBYを追加して、スクリーン・リーダーがアクセスできるように、非標準フォーム要素に適切なラベルを付けることができます。

ノート: これは、アイテムの対応するラベル・テンプレートで定義されている#LABEL_ID#置換に依存します。「ウィジェットの表示」属性も選択されている必要があります。

セッション・ステート変更可能

アイテムの値はセッション・ステート中に変更できます。「ウィジェットの表示」属性が選択されている必要があります。

読取り専用属性を指定

ユーザーはアイテムの「読取り専用」条件を指定できます。この属性を有効にするには「ウィジェットの表示」属性が選択されている必要があります

「特殊文字をエスケープ」属性がある

アイテムの編集時に、「セキュリティ」セクションに「特殊文字をエスケープ」フィールドが存在します。「ウィジェットの表示」属性が選択されている必要があります。

クイック選択属性を指定

アイテムにクイック選択属性があります。「ウィジェットの表示」属性が選択されている必要があります。

ソース属性を指定

アイテムには、「使用されるソース」「ソース・タイプ」「書式マスク」などのソースに関連する属性があります。

日付のみの書式マスク

日付情報を処理するアイテムについて、「書式マスク」フィールド・ポップアップで選択する日付値を表示することによって日付の選択を制限します。「ソース属性を指定」が選択されている必要があります。

数値のみの書式マスク

数値情報を処理するアイテムについて、「書式マスク」フィールド・ポップアップで選択する数値値を表示することによって数値の選択を制限します。

要素属性を指定

アイテムには、「横/縦の位置合せ」「HTMLフォームの要素属性」「要素の前のテキスト」、「要素の後のテキスト」などの要素属性が存在します。

幅属性を指定

アイテムの幅を制御できます。

高さ属性を指定

アイテムの高さを制御できます。

要素オプション属性を指定

チェック・ボックスのラジオ・グループなどの複数の選択要素をレンダリングするときに、アイテムで追加のオプション属性を指定できます。

プレースホルダ属性を指定

アイテムで、要素に表示されるプレースホルダ・テキストの仕様をサポートします。

アイコン属性がある

ユーザーは、ページ・デザイナでアイテム・プラグインのアイコンを選択できます。このアイコンは、実行時にアイテムに表示されます。

暗号化セッション・ステート属性を指定

アイテムを編集するとき、「セキュリティ」リージョンの下に「セッション・ステートに暗号化された値を保存」が表示されます。

LOVを指定

アイテムに関連付けられたLOVがあることを示します「ウィジェットの表示」属性が選択されている必要があります。

LOVが必須

LOVを処理するアイテムで、LOVを定義する必要があります。「LOVを指定」属性が選択されている必要があります。

LOVのNULL表示属性を指定

アイテムは、null値を含むことが可能なLOVに関連付けられます。「LOVを指定」属性が選択されている必要があります。

カスケードLOV属性を指定

アイテムにカスケードLOV関連の属性があります。「LOVを指定」属性が選択されている必要があります。

列表示のための結合LOV

アイテムは、LOVソースの結合文の一部にすることができます。「LOVを指定」属性が選択されている必要があります。

オプションの複数の値

(オプション)複数の値が開発者の判断下にあるアイテムに適用されます。

常に複数の値

(常に)シャトルやチェックボックスなどのアイテム用に設計され、本質的に複数の値をサポートします。

フィルタあり

ページ・デザイナで対話グリッド列の「列フィルタ」 - 「有効」属性を表示するかどうかを制御します。

リンクあり

ページ・デザイナで対話グリッド列の「リンク」 - 「ターゲット」属性を表示するかどうかを制御します。

「初期化JavaScriptコード」属性がある

コンポーネント構成は、提供されたJavaScript関数によって制御できます。

セッション・ステートはCLOBをサポートします

特定のアイテムのセッション・ステート・グループをページ・デザイナに表示するかどうかを制御します。

19.2.2.3 プラグインのコピー

別のアプリケーションから既存のプラグインをコピーして、プラグインを作成します。

ヒント:

プラグイン属性についてさらに学習するには、フィールドレベルのヘルプを参照してください。

プラグインをコピーするには:

  1. 共有コンポーネント・ページにナビゲートします。
    1. ワークスペースのホームページで、「アプリケーション・ビルダー」をクリックします。
    2. アプリケーションを選択します。
    3. アプリケーションのホームページで、「共有コンポーネント」をクリックします。

      共有コンポーネント・ページが表示されます。

  2. 「他のコンポーネント」で、「プラグイン」をクリックします。
  3. 「作成」をクリックします。

    プラグインの作成ウィザードが表示されます。

  4. 「プラグインの作成」 - 「既存のプラグインのコピーとして」を選択し、「次」をクリックします。
  5. コピー元:
    1. 「アプリケーションからコピー」 - プラグインのコピー元のアプリケーションを選択します。
    2. 「テーマ」 - テンプレートのコピー元のテーマを示します。
    3. 「次」をクリックします。
  6. コピー:
    1. コピーするプラグインを識別し、コピー・オプションを選択します。オプションは次のとおりです。
      • はい - プラグインをコピーします。
      • いいえ - このプラグインはコピーしません。
      • コピーおよびサブスクライブ - プラグインをサブスクライブすると、そのコピーがアプリケーションに配置され、プラグイン・マスター参照が設定されます。
  7. 「プラグインのコピー」をクリックします。

    プラグインが作成されたら、それを編集して追加のカスタム属性の指定、プラグインと関連付けるイメージ、CSSおよびJavaScriptファイルなどのファイルのアップロードおよびイベントの追加を実行できます。