ヘッダーをスキップ
Oracle® Application Express APIリファレンス
リリース4.2 for Oracle Database 12c
B71340-03
  目次へ移動
目次
索引へ移動
索引

前
 
次
 

20 APEX_UI_DEFAULT_UPDATE

APEX_UI_DEFAULT_UPDATEパッケージは、SQL DeveloperまたはSQL*Plusからユーザー・インタフェースのデフォルト値にアクセスするためのプロシージャを提供します。

このパッケージを使用すると、ユーザー・インタフェースのデフォルト値を設定して、スキーマ内の表に関連付けることができます。このパッケージは、更新する表を所有しているスキーマ内からコールする必要があります。

ユーザー・インタフェースのデフォルト値を使用して、指定したスキーマ内の表、列またはビューにデフォルトのユーザー・インタフェースのプロパティを割り当てることができます。ウィザードを使用してフォームまたはレポートを作成する場合、ウィザードはこの情報を使用してリージョン・プロパティおよびアイテム・プロパティのデフォルト値を作成します。ユーザー・インタフェースのデフォルト値を使用すると、貴重な開発時間を節約でき、さらにアプリケーション内の複数のページで一貫性を保つことができるという利点もあります。

トピック:


参照:

『Oracle Application Express SQLワークショップ・ガイド』の「ユーザー・インタフェースのデフォルト値の管理」

ADD_AD_COLUMNプロシージャ

指定された定義で、ユーザー・インタフェースのデフォルト値の属性ディクショナリのエントリを追加します。作成時には、最大3つのシノニムを指定できます。作成後に、apex_ui_default_update.add_ad_synonymを使用して追加のシノニムを追加できます。シノニムはそのベース列の列定義を共有します。

構文

APEX_UI_DEFAULT_UPDATE.ADD_AD_COLUMN (
    p_column_name           IN  VARCHAR2,
    p_label                 IN  VARCHAR2  DEFAULT NULL,
    p_help_text             IN  VARCHAR2  DEFAULT NULL,
    p_format_mask           IN  VARCHAR2  DEFAULT NULL,
    p_default_value         IN  VARCHAR2  DEFAULT NULL,
    p_form_format_mask      IN  VARCHAR2  DEFAULT NULL,
    p_form_display_width    IN  VARCHAR2  DEFAULT NULL,
    p_form_display_height   IN  VARCHAR2  DEFAULT NULL,
    p_form_data_type        IN  VARCHAR2  DEFAULT NULL,
    p_report_format_mask    IN  VARCHAR2  DEFAULT NULL,
    p_report_col_alignment  IN  VARCHAR2  DEFAULT NULL,
    p_syn_name1             IN  VARCHAR2  DEFAULT NULL,
    p_syn_name2             IN  VARCHAR2  DEFAULT NULL,
    p_syn_name3             IN  VARCHAR2  DEFAULT NULL); 

パラメータ

表20-5では、ADD_AD_COLUMNプロシージャで使用可能なパラメータについて説明します。

表20-1 ADD_AD_COLUMNのパラメータ

パラメータ 説明

p_column_name

作成する列の名前。

p_label

アイテム・ラベルおよびレポートの列ヘッダーに使用されます。

p_help_text

アイテムおよび対話モード・レポート列のヘルプ・テキストに使用されます。

p_format_mask

アイテムおよびレポート列の書式マスクとして使用されます。フォーム固有の書式マスクのレポートで上書きできます。

p_default_value

アイテムのデフォルト値として使用されます。

p_form_format_mask

指定した場合、アイテムの書式マスクとして使用されます。一般的な書式マスクの値をオーバーライドします。

p_form_display_width

この属性定義を使用するすべてのアイテムの幅として使用されます。

p_form_display_height

この属性定義を使用するすべてのアイテムの高さとして使用されます(テキスト領域、シャトルなどのアイテム・タイプでのみ使用されます)。

p_form_data_type

アイテムのデータ型として使用されます(自動検証になります)。有効な値は、VARCHAR、NUMBERおよびDATEです。

p_report_format_mask

指定した場合、レポート列の書式マスクとして使用されます。一般的な書式マスクの値をオーバーライドします。

p_report_col_alignment

レポート列のデータの位置合せに使用されます(たとえば数値は、一般に右揃えにします)。有効な値は、LEFTCENTERおよびRIGHTです。

p_syn_name1

この列とともに作成するシノニムの名前。4つ目以上は、APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYMを使用します。

p_syn_name2

この列とともに作成する2つ目のシノニムの名前。4つ目以上は、APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYMを使用します。

p_syn_name3

この列とともに作成する3つ目のシノニムの名前。4つ目以上は、APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYMを使用します。


次の例では、現在のスキーマに関連付けられているワークスペース内のUIのデフォルト値の属性ディクショナリに、新しい属性を作成します。また、その属性のシノニムも作成します。

BEGIN
    apex_ui_default_update.add_ad_column (
       p_column_name          => 'CREATED_BY',
       p_label                => 'Created By',
       p_help_text            => 'User that created the record.',
       p_form_display_width   => 30,
       p_form_data_type       => 'VARCHAR',
       p_report_col_alignment => 'LEFT',
       p_syn_name1            => 'CREATED_BY_USER' );
END;

ADD_AD_SYNONYMプロシージャ

列名がユーザー・インタフェースのデフォルト値の属性ディクショナリに見つかると、指定したシノニムが作成され、その列に関連付けられます。シノニムはそのベース列の列定義を共有します。

構文

APEX_UI_DEFAULT_UPDATE.ADD_AD_SYNONYM (
    p_column_name           IN VARCHAR2,
    p_syn_name              IN VARCHAR2);

パラメータ

表20-2では、ADD_AD_SYNONYMプロシージャで使用可能なパラメータについて説明します。

表20-2 ADD_AD_SYNONYMのパラメータ

パラメータ 説明

p_column_name

属性ディクショナリを持つ、シノニムの作成先の列の名前。

p_syn_name

作成するシノニムの名前。


次の例では、現在のスキーマに関連付けられているワークスペース内のUIのデフォルト値の属性ディクショナリで、CREATED_BY属性にシノニムCREATED_BY_USERを追加します。

BEGIN
    apex_ui_default_update.add_ad_synonym (
       p_column_name => 'CREATED_BY',
       p_syn_name    => 'CREATED_BY_USER' );
END;

DEL_AD_COLUMNプロシージャ

列名がユーザー・インタフェースのデフォルト値の属性ディクショナリで見つかると、その列は関連するすべてのシノニムとともに削除されます。

構文

APEX_UI_DEFAULT_UPDATE.DEL_AD_COLUMN (
    p_column_name           IN VARCHAR2);

パラメータ

表20-3では、DEL_AD_COLUMNプロシージャで使用可能なパラメータについて説明します。

表20-3 DEL_AD_COLUMNのパラメータ

パラメータ 説明

p_column_name

削除する列の名前


次の例では、現在のスキーマに関連付けられているワークスペース内のUIのデフォルト値の属性ディクショナリから、属性CREATED_BYを削除します。

BEGIN
    apex_ui_default_update.del_ad_column (
       p_column_name => 'CREATED_BY' );
END;

DEL_AD_SYNONYMプロシージャ

シノニム名がユーザー・インタフェースのデフォルト値の属性ディクショナリで見つかると、そのシノニム名は削除されます。

構文

APEX_UI_DEFAULT_UPDATE.DEL_AD_SYNONYM (
    p_syn_name           IN VARCHAR2);

パラメータ

表20-4では、DEL_AD_SYNONYMプロシージャで使用可能なパラメータについて説明します。

表20-4 DEL_AD_SYNONYMのパラメータ

パラメータ 説明

p_syn_name

削除するシノニムの名前


次の例では、現在のスキーマに関連付けられているワークスペース内のUIのデフォルト値の属性ディクショナリから、シノニムCREATED_BY_USERを削除します。

BEGIN
    apex_ui_default_update.del_ad_synonym (
       p_syn_name    => 'CREATED_BY_USER' );
END;

DEL_COLUMNプロシージャ

指定した表および列が、ユーザー・インタフェースのデフォルト値に基づくユーザーのスキーマの表に存在する場合、そのUIのデフォルト値は削除されます。

構文

APEX_UI_DEFAULT_UPDATE.DEL_COLUMN (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2);

パラメータ

表20-5では、DEL_COLUMNプロシージャで使用可能なパラメータについて説明します。

表20-5 DEL_COLUMNのパラメータ

パラメータ 説明

p_table_name

列のUIのデフォルト値を削除する表の名前。

p_column_name

UIのデフォルト値を削除する列の名前。


次の例では、現在のスキーマに含まれるUIのデフォルト値の表ディクショナリ内のEMP表定義から、列CREATED_BYを削除します。

BEGIN
    apex_ui_default_update.del_column (
       p_table_name  => 'EMP',
       p_column_name => 'CREATED_BY' );
END;

DEL_GROUPプロシージャ

指定した表およびグループが、ユーザー・インタフェースのデフォルト値に基づくユーザーのスキーマの表内に存在する場合、そのグループのUIのデフォルト値は削除され、そのグループを参照する表の列のgroup_idはnullに設定されます。

構文

APEX_UI_DEFAULT_UPDATE.DEL_GROUP (
    p_table_name            IN VARCHAR2,
    p_group_name            IN VARCHAR2);

パラメータ

表20-6に、DEL_GROUPプロシージャで使用可能なパラメータを示します。

表20-6 DEL_GROUPのパラメータ

パラメータ 説明

p_table_name

グループのUIのデフォルト値を削除する表の名前

p_group_name

UIのデフォルト値を削除するグループの名前


次の例では、現在のスキーマに含まれるUIのデフォルト値の表ディクショナリのEMP表定義から、グループAUDIT_INFOを削除します。

BEGIN
    apex_ui_default_update.del_group (
       p_table_name => 'EMP',
       p_group_name => 'AUDIT_INFO' );
END;

DEL_TABLEプロシージャ

指定した表が、ユーザー・インタフェースのデフォルト値に基づくユーザーのスキーマの表内に存在する場合、そのUIのデフォルト値は削除されます。これには、その表で定義されていたグループも、表に関連付けられた列もすべて削除されます。

構文

APEX_UI_DEFAULT_UPDATE.DEL_TABLE (
    p_table_name            IN VARCHAR2);

パラメータ

表20-7では、DEL_TABLEプロシージャで使用可能なパラメータについて説明します。

表20-7 DEL_TABLEのパラメータ

パラメータ 説明

p_table_name

表名


次の例では、現在のスキーマに関連付けられているEMP表のUIのデフォルト値を削除します。

begin
    apex_ui_default_update.del_table (
       p_table_name => 'EMP' );
end;
/

SYNCH_TABLEプロシージャ

表に対して、表ベースのユーザー・インタフェースのデフォルト値がユーザーのスキーマにまだ存在しない場合は、デフォルトに設定されます。存在する場合は、同期化されます(つまり、表の列は、UIのデフォルト値の表定義の列に対して一致させられます)。一致させるために追加と削除が使用されます。

構文

APEX_UI_DEFAULT_UPDATE.SYNCH_TABLE (
    p_table_name            IN VARCHAR2);

パラメータ

表20-8では、SYNCH_TABLEプロシージャで使用可能なパラメータについて説明します。

表20-8 SYNCH_TABLEのパラメータ

パラメータ 説明

p_table_name

表名


次の例では、現在のスキーマに関連付けられているEMP表のUIのデフォルト値を同期化します。

BEGIN
    apex_ui_default_update.synch_table (
       p_table_name => 'EMP' );
END;

UPD_AD_COLUMNプロシージャ

列名がユーザー・インタフェースのデフォルト値の属性ディクショナリで見つかると、その列エントリは、指定したパラメータを使用して更新されます。null%'が渡されると、関連付けられたパラメータの値はnullに設定されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_AD_COLUMN (
    p_column_name           IN  VARCHAR2,
    p_new_column_name       IN  VARCHAR2  DEFAULT NULL,
    p_label                 IN  VARCHAR2  DEFAULT NULL,
    p_help_text             IN  VARCHAR2  DEFAULT NULL,
    p_format_mask           IN  VARCHAR2  DEFAULT NULL,
    p_default_value         IN  VARCHAR2  DEFAULT NULL,
    p_form_format_mask      IN  VARCHAR2  DEFAULT NULL,
    p_form_display_width    IN  VARCHAR2  DEFAULT NULL,
    p_form_display_height   IN  VARCHAR2  DEFAULT NULL,
    p_form_data_type        IN  VARCHAR2  DEFAULT NULL,
    p_report_format_mask    IN  VARCHAR2  DEFAULT NULL,
    p_report_col_alignment  IN  VARCHAR2  DEFAULT NULL);

パラメータ

表20-9では、UPD_AD_COLUMNプロシージャで使用可能なパラメータについて説明します。

表20-9 UPD_AD_COLUMNのパラメータ

パラメータ 説明

p_column_name

更新する列の名前

p_new_column_name

列の名前を変更する場合、列の新しい名前

p_label

アイテム・ラベルおよびレポートの列ヘッダーに使用されます。

p_help_text

アイテムおよび対話モード・レポート列のヘルプ・テキストに使用されます。

p_format_mask

アイテムおよびレポート列の書式マスクとして使用されます。フォーム固有の書式マスクのレポートで上書きできます。

p_default_value

アイテムのデフォルト値として使用されます。

p_form_format_mask

指定した場合、アイテムの書式マスクとして使用されます。一般的な書式マスクの値をオーバーライドします。

p_form_display_width

この属性定義を使用するすべてのアイテムの幅として使用されます。

p_form_display_height

この属性定義を使用するすべてのアイテムの高さとして使用されます(テキスト領域、シャトルなどのアイテム・タイプでのみ使用されます)。

p_form_data_type

アイテムのデータ型として使用されます(自動検証になります)。有効な値は、VARCHARNUMBERおよびDATEです。

p_report_format_mask

指定した場合、レポート列の書式マスクとして使用されます。一般的な書式マスクの値をオーバーライドします。

p_report_col_alignment

レポート列のデータの位置合せに使用されます(たとえば数値は、一般に右揃えにします)。有効な値は、LEFT、CENTERおよびRIGHTです。



注意:

p_labelからp_report_col_alignmentに'null%'を設定すると、値は無効になります。値が渡されない場合、その列は更新されません。

次の例では、form_format_maskにnullを設定して、現在のスキーマに関連付けられているワークスペース内で、UIのデフォルト値の属性ディクショナリのCREATED_BY列を更新します。

BEGIN
    apex_ui_default_update.upd_ad_column (
       p_column_name      => 'CREATED_BY',
       p_form_format_mask => 'null%');
END;

UPD_AD_SYNONYMプロシージャ

シノニム名がユーザー・インタフェースのデフォルト値の属性ディクショナリで見つかると、そのシノニム名は更新されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_AD_SYNONYM (
    p_syn_name           IN VARCHAR2,
    p_new_syn_name       IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-10では、UPD_AD_SYNONYMプロシージャで使用可能なパラメータについて説明します。

表20-10 UPD_AD_SYNONYMのパラメータ

パラメータ 説明

p_syn_name

更新するシノニムの名前

p_new_syn_name

シノニムの新しい名前


次の例では、現在のスキーマに関連付けられているワークスペース内で、UIのデフォルト値の属性ディクショナリのCREATED_BY_USERシノニムを更新します。

BEGIN             
    apex_ui_default_update.upd_ad_synonym (
       p_syn_name     => 'CREATED_BY_USER',
       p_new_syn_name => 'USER_CREATED_BY');
END;

UPD_COLUMNプロシージャ

指定した表および列が、ユーザー・インタフェースのデフォルト値に基づくユーザーのスキーマの表内に存在する場合、指定したパラメータが更新されます。'null%'が渡されると、関連付けられたパラメータの値はnullに設定されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_COLUMN (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_group_id              IN VARCHAR2  DEFAULT NULL,
    p_label                 IN VARCHAR2  DEFAULT NULL,
    p_help_text             IN VARCHAR2  DEFAULT NULL,
    p_display_in_form       IN VARCHAR2  DEFAULT NULL,
    p_display_seq_form      IN VARCHAR2  DEFAULT NULL,
    p_mask_form             IN VARCHAR2  DEFAULT NULL,
    p_default_value         IN VARCHAR2  DEFAULT NULL,
    p_required              IN VARCHAR2  DEFAULT NULL,
    p_display_width         IN VARCHAR2  DEFAULT NULL,
    p_max_width             IN VARCHAR2  DEFAULT NULL,
    p_height                IN VARCHAR2  DEFAULT NULL,
    p_display_in_report     IN VARCHAR2  DEFAULT NULL,
    p_display_seq_report    IN VARCHAR2  DEFAULT NULL,
    p_mask_report           IN VARCHAR2  DEFAULT NULL,
    p_alignment             IN VARCHAR2  DEFAULT NULL);

パラメータ

表20-11では、UPD_COLUMNプロシージャで使用可能なパラメータについて説明します。

表20-11 UPD_COLUMNのパラメータ

パラメータ 説明

p_table_name

列のUIのデフォルト値を更新する表の名前

p_column_name

UIのデフォルト値を更新する列の名前

p_group_id

列に関連付けられているグループのID

p_label

この表またはビューに対してフォームを作成する場合に、この列が含まれていると、これがアイテムのラベルとして使用されます。レポートまたは表形式フォームを作成する場合に、この列が含まれていると、これが列ヘッダーとして使用されます。

p_help_text

この表またはビューに対してフォームを作成する場合、これは作成されるアイテムのヘルプ・テキストになります。

p_display_in_form

この表またはビューに対してフォームを作成する場合、これによって、作成されるフォーム・ページにこの列が表示されるかどうかが決定されます。有効な値は、YおよびNです。

p_display_seq_form

この表またはビューに対してフォームを作成する場合、これによって、作成されるフォーム・ページに表示される列の順序が決定されます。

p_mask_form

この表またはビューに対してフォームを作成する場合、これによって、アイテムに適用されるマスク(999-99-9999など)が指定されます。これは、キャラクタ・ベースのアイテムには使用されません。

p_default_value

この表またはビューに対してフォームを作成する場合、これによって、この列から作成されるアイテムのデフォルト値が指定されます。

p_required

この表またはビューに対してフォームを作成する場合、これによって、アイテムが必ずNOT NULLになるような検証を生成することが指定されます。有効な値は、YおよびNです。

p_display_width

この表またはビューに対してフォームを作成する場合、これによって、この列から作成されるアイテムの表示幅が指定されます。

p_max_width

この表またはビューに対してフォームを作成する場合、これによって、この列から作成されるアイテムにユーザーが入力できる文字列の最大長が指定されます。

p_height

この表またはビューに対してフォームを作成する場合、これによって、この列から作成されるアイテムの表示の高さが指定されます。

p_display_in_report

この表またはビューに対してレポートを作成する場合、これによって、作成されるレポートにこの列が表示されるかどうかが決定されます。有効な値は、YおよびNです。

p_display_seq_report

この表またはビューに対してレポートを作成する場合、これによって、作成されるレポートに表示される列の順序が決定されます。

p_mask_report

この表またはビューに対してレポートを作成する場合、これによって、データに対して適用されるマスク(999-99-9999など)が指定されます。これは、キャラクタ・ベースのアイテムには使用されません。

p_alignment

この表またはビューに対してレポートを作成する場合、これによって、作成されるレポート列の位置合せが決定されます。有効な値は、L(左)、C(中央)およびR(右)です。



注意:

p_group_idからp_alignmentに'null%'を設定すると、値は無効になります。値が渡されない場合、その列は更新されません。

次の例では、現在のスキーマに含まれるUIのデフォルト値の表ディクショナリ内のEMP表定義で、列DEPT_NOを更新します。また、group_idをnullに設定します。

BEGIN
    apex_ui_default_update.upd_column (
       p_table_name    => 'EMP',
       p_column_name   => 'DEPT_NO',
       p_group_id      => 'null%' );
END;

UPD_DISPLAY_IN_FORMプロシージャ

UPD_DISPLAY_IN_FORMプロシージャは、ユーザー・インタフェースのフォーム内の表示に関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成する場合に、ウィザードで使用されます。また、指定の列をデフォルトで含めるかどうかを制御します。

構文

APEX_UI_DEFAULT_UPDATE.UPD_DISPLAY_IN_FORM (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_display_in_form       IN VARCHAR2);

パラメータ

表20-12では、UPD_DISPLAY_IN_FORMプロシージャで使用可能なパラメータについて説明します。

表20-12 UPD_DISPLAY_IN_FORMのパラメータ

パラメータ 説明

p_table_name

表名

p_column_name

列名

p_display_in_form

フォーム内にデフォルトで表示するかどうかを指定します(有効な値はYおよびNです)。


次の例では、DEPT表に対してフォームを作成する際に、DEPTNO列に対する表示オプションがデフォルトで「No」になるように設定します。

APEX_UI_DEFAULT_UPDATE.UPD_DISPLAY_IN_FORM(
    p_table_name => 'DEPT',
    p_column_name => 'DEPTNO',
    p_display_in_form => 'N');

UPD_DISPLAY_IN_REPORTプロシージャ

UPD_DISPLAY_IN_REPORTプロシージャは、ユーザー・インタフェースのレポート内の表示に関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてレポートを作成する場合に、ウィザードで使用されます。また、指定の列をデフォルトで含めるかどうかを制御します。

構文

APEX_UI_DEFAULT_UPDATE.UPD_DISPLAY_IN_REPORT (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_display_in_report     IN VARCHAR2);

パラメータ

表20-13では、UPD_DISPLAY_IN_REPORTプロシージャで使用可能なパラメータについて説明します。

表20-13 UPD_DISPLAY_IN_REPORTのパラメータ

パラメータ 説明

p_table_name

表名

p_column_name

列名

p_display_in_report

レポート内にデフォルトで表示するかどうかを指定します(有効な値はYおよびNです)。


次の例では、DEPT表に対してレポートを作成する際に、DEPTNO列に対する表示オプションがデフォルトで「No」になるように設定します。

APEX_UI_DEFAULT_UPDATE.UPD_DISPLAY_IN_REPORT(
    p_table_name => 'DEPT',
    p_column_name => 'DEPTNO',
    p_display_in_report => 'N');

UPD_FORM_REGION_TITLEプロシージャ

UPD_FORM_REGION_TITLEプロシージャは、フォーム・リージョン・タイトルのユーザー・インタフェースのデフォルト値を更新します。ユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成するときに、ウィザードで使用されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_FORM_REGION_TITLE (
    p_table_name            IN VARCHAR2,
    p_form_region_title     IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-14では、UPD_FORM_REGION_TITLEプロシージャで使用可能なパラメータについて説明します。

表20-14 UPDATE_FORM_REGION_TITLEのパラメータ

パラメータ 説明

p_table_name

表名

p_form_region_title

希望するフォーム・リージョン・タイトル


次の例に、DEPT表にフォーム・リージョン・タイトルのユーザー・インタフェースのデフォルト値を設定する方法を示します。

APEX_UI_DEFAULT_UPDATE.UPD_FORM_REGION_TITLE (
    p_table_name         => 'DEPT',
    p_form_region_title  => 'Deptartment Details');

UPD_GROUPプロシージャ

指定した表およびグループが、ユーザー・インタフェースのデフォルト値に基づくユーザーのスキーマの表内に存在する場合、グループ名、説明およびグループの表示順序が更新されます。'null%'がp_descriptionまたはp_display_sequenceに渡されると、値はnullに設定されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_GROUP (
    p_table_name            IN VARCHAR2,
    p_group_name            IN VARCHAR2,
    p_new_group_name        IN VARCHAR2 DEFAULT NULL,
    p_description           IN VARCHAR2 DEFAULT NULL,
    p_display_sequence      IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-15では、UPD_GROUPプロシージャで使用可能なパラメータについて説明します。

表20-15 UPD_GROUPのパラメータ

パラメータ 説明

p_table_name

更新するグループを含む表の名前。

p_group_name

更新するグループ

p_new_group_name

グループの名前を変更する場合、グループの新しい名前

p_description

グループの説明

p_display_sequence

グループの表示順序



注意:

p_descriptionまたはp_display_sequenceに'null%'を設定すると、値は無効になります。値が渡されない場合、その列は更新されません。

次の例では、現在のスキーマに含まれるUIのデフォルト値の表ディクショナリのEMP表定義で、グループAUDIT_INFOの説明を更新します。

BEGIN
    apex_ui_default_update.upd_group (
       p_table_name  => 'EMP',
       p_group_name  => 'AUDIT_INFO',
       p_description => 'Audit columns' );
END;

UPD_ITEM_DISPLAY_HEIGHTプロシージャ

UPD_ITEM_DISPLAY_HEIGHTプロシージャは、ユーザー・インタフェースのアイテム表示の高さに関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成する場合に指定の列を含めるようにすると、ウィザードで使用されます。表示の高さでは、アイテムをテキスト・ボックスまたはテキスト領域にするかどうかを制御します。

構文

APEX_UI_DEFAULT_UPDATE.UPD_ITEM_DISPLAY_HEIGHT (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_display_height        IN NUMBER);

パラメータ

表20-16に、UPD_ITEM_DISPLAY_HEIGHTプロシージャで使用可能なパラメータを示します。

表20-16 UPD_ITEM_DISPLAY_HEIGHTのパラメータ

パラメータ 説明

p_table_name

表名

p_column_name

列名

p_display_height

この列に基づいて作成されるすべてのアイテムの表示の高さ


次の例では、DEPT表に対してDNAME列にアイテムを作成する際に、デフォルトのアイテムの高さを3に設定します。

APEX_UI_DEFAULT_UPDATE.UPD_ITEM_DISPLAY_HEIGHT(
   p_table_name => 'DEPT',
   p_column_name => 'DNAME',
   p_display_height => 3);

UPD_ITEM_DISPLAY_WIDTHプロシージャ

UPD_ITEM_DISPLAY_WIDTHプロシージャは、ユーザー・インタフェースのアイテム表示幅に関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成する場合に指定の列を含めるようにすると、ウィザードで使用されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_ITEM_DISPLAY_WIDTH (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_display_width         IN NUMBER);

パラメータ

表20-17では、UPD_ITEM_DISPLAY_WIDTHプロシージャで使用可能なパラメータについて説明します。

表20-17 UPD_ITEM_DISPLAY_WIDTHのパラメータ

パラメータ 説明

p_table_name

表名

p_column_name

列名

p_display_width

この列に基づいて作成されるすべてのアイテムの表示幅


次の例では、DEPT表に対してDEPTNO列にアイテムを作成する際に、デフォルトのアイテムの幅を5に設定します。

APEX_UI_DEFAULT_UPDATE.UPD_ITEM_DISPLAY_WIDTH(
   p_table_name => 'DEPT',
   p_column_name => 'DEPTNO',
   p_display_width => 5);

UPD_ITEM_FORMAT_MASKプロシージャ

UPD_ITEM_FORMAT_MASKプロシージャは、ユーザー・インタフェースのアイテム書式マスクに関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成する場合に指定の列を含めるようにすると、ウィザードで使用されます。アイテムの書式マスクは、通常、数字と日付を書式化するために使用します。

構文

APEX_UI_DEFAULT_UPDATE.UPD_ITEM_FORMAT_MASK (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_format_mask           IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-18では、UPD_ITEM_FORMAT_MASKプロシージャで使用可能なパラメータについて説明します。

表20-18 UPD_ITEM_FORMAT_MASKのパラメータ

パラメータ 説明

p_table_name

表名

p_column_name

列名

p_format_mask

列に関連付ける書式マスク


次の例では、EMP表に対してフォームを作成する際に、HIREDATE列に対するデフォルトのアイテム書式マスクが'DD-MON-YYYY'に設定されています。

APEX_UI_DEFAULT_UPDATE.UPD_ITEM_FORMAT_MASK(
    p_table_name => 'EMP',
    p_column_name => 'HIREDATE',
    p_format_mask=> 'DD-MON-YYYY');

UPD_ITEM_HELPプロシージャ

UPD_ITEM_HELPプロシージャは、指定された表および列のヘルプ・テキストを更新します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成する場合に、指定の列を含むようにすると使用されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_ITEM_HELP (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_help_text             IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-19では、UPD_ITEM_HELPプロシージャで使用可能なパラメータについて説明します。

表20-19 UPD_ITEM_HELPのパラメータ

パラメータ 説明

p_table_name

表名

p_column_name

列名

p_help_text

希望するヘルプ・テキスト


次の例に、DEPT表のDEPTNO列にユーザー・インタフェースのアイテム・ヘルプ・テキストのデフォルト値を設定する方法を示します。

APEX_UI_DEFAULT_UPDATE.UPD_ITEM_HELP(
   p_table_name => 'DEPT',
   p_column_name => 'DEPTNO',
   p_help_text => 'The number assigned to the department.');

UPD_LABELプロシージャ

UPD_LABELプロシージャは、アイテムに使用されるラベルを設定します。このユーザー・インタフェースのデフォルト値は、指定された表に基づいてフォームまたはレポートを作成し、特定の列を含めるときに使用されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_LABEL (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_label                 IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-20では、UPD_LABELプロシージャで使用可能なパラメータについて説明します。

表20-20 UPD__LABELのパラメータ

パラメータ 説明

p_table_name

表名

p_column_name

列名

p_label

希望するアイテム・ラベル


次の例に、DEPT表のDEPTNO列にユーザー・インタフェースのアイテム・ラベルのデフォルト値を設定する方法を示します。

APEX_UI_DEFAULT_UPDATE.UPD_LABEL(
   p_table_name => 'DEPT',
   p_column_name => 'DEPTNO',
   p_label => 'Department Number');

UPD_REPORT_ALIGNMENTプロシージャ

UPD_REPORT_ALIGNMENTプロシージャは、ユーザー・インタフェースのレポート位置に関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値がウィザードで使用されるのは、指定の表に基づいてレポートを作成し、指定の列を含むようにしたときに、レポートの列の位置を左、中央または右に調節するかどうかを決定する場合です。

構文

APEX_UI_DEFAULT_UPDATE.UPD_REPORT_ALIGNMENT (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_report_alignment      IN VARCHAR2);

パラメータ

表20-21では、UPD_REPORT_ALIGNMENTプロシージャで使用可能なパラメータについて説明します。

表20-21 UPD_REPORT_ALIGNMENTのパラメータ

パラメータ 説明

p_table_name

表名。

p_column_name

列名。

p_report_alignment

レポート内の列の位置を定義します。有効な値は、L (左)、C (中央)およびR (右)です。


次の例では、DEPT表に対してレポートを作成する際に、DEPTNO列に対するデフォルトの列の位置合せが右揃えに設定されています。

APEX_UI_DEFAULT_UPDATE.UPD_REPORT_ALIGNMENT(
    p_table_name => 'DEPT',
    p_column_name => 'DEPTNO',
    p_report_alignment => 'R');

UPD_REPORT_FORMAT_MASKプロシージャ

UPD_REPORT_FORMAT_MASKプロシージャは、ユーザー・インタフェースのレポート書式マスクに関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてレポートを作成する場合に指定の列を含めるようにすると、ウィザードで使用されます。レポートの書式マスクは、通常、数字と日付を書式化するために使用します。

構文

APEX_UI_DEFAULT_UPDATE.UPD_REPORT_FORMAT_MASK (
    p_table_name            IN VARCHAR2,
    p_column_name           IN VARCHAR2,
    p_format_mask           IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-22では、UPD_REPORT_FORMAT_MASKプロシージャで使用可能なパラメータについて説明します。

表20-22 UPD_REPORT_FORMAT_MASKのパラメータ

パラメータ 説明

p_table_name

表名

p_column_name

列名

p_format_mask

レポートに指定の列が含まれる場合に、その列に常に関連付ける書式マスク


次の例では、EMP表に対してレポートを作成する際に、HIREDATE列に対するデフォルトの書式マスクが'DD-MON-YYYY'に設定されています。

APEX_UI_DEFAULT_UPDATE.UPD_REPORT_FORMAT_MASK(
    p_table_name => 'EMP',
    p_column_name => 'HIREDATE',
    p_format_mask=> 'DD-MON-YYYY');

UPD_REPORT_REGION_TITLEプロシージャ

UPD_REPORT_REGION_TITLEプロシージャは、レポート・リージョン・タイトルを設定します。ユーザー・インタフェースのデフォルト値は、表に関するレポートを作成するときに、ウィザードで使用されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_REPORT_REGION_TITLE (
    p_table_name            IN VARCHAR2,
    p_report_region_title   IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-23では、UPD_REPORT_REGION_TITLEプロシージャで使用可能なパラメータについて説明します。

表20-23 UPD_REPORT_REGION_TITLEのパラメータ

パラメータ 説明

p_table_name

表名

p_report_region_title

希望するレポート・リージョン・タイトル


次の例に、DEPT表にレポート・リージョン・タイトルのユーザー・インタフェースのデフォルト値を設定する方法を示します。

APEX_UI_DEFAULT_UPDATE.UPD_REPORT_REGION_TITLE (
    p_table_name            => 'DEPT',
    p_report_region_title   => 'Departments');

UPD_TABLEプロシージャ

指定した表が、ユーザー・インタフェースのデフォルト値に基づくユーザーのスキーマの表内に存在する場合、フォーム・リージョン・タイトルおよびレポート・リージョン・タイトルがこれらと一致するように更新されます。'null%'がp_form_region_titleまたはp_report_region_titleに渡されると、値はnullに設定されます。

構文

APEX_UI_DEFAULT_UPDATE.UPD_TABLE (
    p_table_name            IN VARCHAR2,
    p_form_region_title     IN VARCHAR2 DEFAULT NULL,
    p_report_region_title   IN VARCHAR2 DEFAULT NULL);

パラメータ

表20-24では、UPD_TABLEプロシージャで使用可能なパラメータについて説明します。

表20-24 UPD_TABLEのパラメータ

パラメータ 説明

p_table_name

更新する表の名前。

p_form_region_title

フォームに使用されるリージョン・タイトル。

p_report_region_title

レポートおよび表形式フォームに使用されるリージョン・タイトル。



注意:

'null%'がp_form_region_titleまたはp_report_region_titleに渡されると、値はnullに設定されます。値が渡されない場合、その列は更新されません。

次の例では、現在のスキーマに含まれるUIのデフォルト値の表ディクショナリ内のEMP表定義を更新します。

begin
    apex_ui_default_update.upd_table (
       p_table_name          => 'EMP',
       p_form_region_title   => 'Employee Details',
       p_report_region_title => 'Employees' );
end;
/