| Oracle® Application Express APIリファレンス リリース3.2 B53798-03 |
|
 前 |
 次 |
APEX_UI_DEFAULT_UPDATEパッケージは、SQL DeveloperまたはSQL*Plusからユーザー・インタフェースのデフォルト値にアクセスするためのプロシージャを提供します。
このパッケージを使用すると、ユーザー・インタフェースのデフォルト値を設定して、スキーマ内の表に関連付けることができます。このパッケージは、更新する表を所有しているスキーマ内からコールする必要があります。
ユーザー・インタフェースのデフォルト値を使用して、指定したスキーマ内の表、列またはビューにデフォルトのユーザー・インタフェースのプロパティを割り当てることができます。ウィザードを使用してフォームまたはレポートを作成する場合、ウィザードはこの情報を使用してリージョン・プロパティおよびアイテム・プロパティのデフォルト値を作成します。ユーザー・インタフェースのデフォルト値を使用すると、貴重な開発時間を節約でき、さらにアプリケーション内の複数のページで一貫性を保つことができるという利点もあります。
このセクションの構成は次のとおりです。
|
参照: Oracle Application Expressアプリケーション・ビルダー・ユーザーズ・ガイドの「ユーザー・インタフェースのデフォルト値の管理」 |
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);
パラメータ
表8-1に、UPD_DISPLAY_IN_FORMプロシージャで使用可能なパラメータを示します。
表8-1 UPD_DISPLAY_IN_FORMのパラメータ
| パラメータ | 説明 |
|---|---|
|
|
表名 |
|
|
列名 |
|
|
フォーム内にデフォルトで表示するかどうかを指定します。有効な値は |
例
次の例では、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プロシージャは、ユーザー・インタフェースのレポート内の表示に関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてレポートを作成する場合に、ウィザードで使用されます。また、指定の列をデフォルトで含めるかどうかを制御します。
構文
APEX_UI_DEFAULT_UPDATE.UPD_DISPLAY_IN_REPORT (
p_table_name IN VARCHAR2,
p_column_name IN VARCHAR2,
p_display_in_report IN VARCHAR2);
パラメータ
表8-2に、UPD_DISPLAY_IN_REPORTプロシージャで使用可能なパラメータを示します。
表8-2 UPD_DISPLAY_IN_REPORTのパラメータ
| パラメータ | 説明 |
|---|---|
|
|
表名 |
|
|
列名 |
|
|
レポート内にデフォルトで表示するかどうかを指定します。有効な値は |
例
次の例では、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プロシージャは、フォーム・リージョン・タイトルのユーザー・インタフェースのデフォルト値を更新します。ユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成するときに、ウィザードで使用されます。
構文
APEX_UI_DEFAULT_UPDATE.UPD_FORM_REGION_TITLE (
p_table_name IN VARCHAR2,
p_form_region_title IN VARCHAR2 DEFAULT NULL);
パラメータ
表8-3に、UPD_FORM_REGION_TITLEプロシージャで使用可能なパラメータを示します。
例
次の例に、DEPT表にフォーム・リージョン・タイトルのユーザー・インタフェースのデフォルト値を設定する方法を示します。
APEX_UI_DEFAULT_UPDATE.UPD_FORM_REGION_TITLE (
p_table_name => 'DEPT',
p_form_region_title => 'Deptartment Details');
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);
パラメータ
表8-4に、UPD_ITEM_DISPLAY_HEIGHTプロシージャで使用可能なパラメータを示します。
表8-4 UPD_ITEM_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プロシージャは、ユーザー・インタフェースのアイテム表示幅に関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成する場合に指定の列を含めるようにすると、ウィザードで使用されます。
構文
APEX_UI_DEFAULT_UPDATE.UPD_ITEM_DISPLAY_WIDTH (
p_table_name IN VARCHAR2,
p_column_name IN VARCHAR2,
p_display_width IN NUMBER);
パラメータ
表8-5に、UPD_ITEM_DISPLAY_WIDTHプロシージャで使用可能なパラメータを示します。
表8-5 UPD_ITEM_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プロシージャは、ユーザー・インタフェースのアイテム書式マスクに関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成する場合に指定の列を含めるようにすると、ウィザードで使用されます。アイテムの書式マスクは、通常、数字と日付を書式化するために使用します。
構文
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);
パラメータ
表8-6に、UPD_ITEM_FORMAT_MASKプロシージャで使用可能なパラメータを示します。
表8-6 UPD_ITEM_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プロシージャは、指定された表および列のヘルプ・テキストを更新します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてフォームを作成する場合に、指定の列を含むようにすると使用されます。
構文
APEX_UI_DEFAULT_UPDATE.UPD_ITEM_HELP (
p_table_name IN VARCHAR2,
p_column_name IN VARCHAR2,
p_help_text IN VARCHAR2 DEFAULT NULL);
パラメータ
表8-7に、UPD_ITEM_HELPプロシージャで使用可能なパラメータを示します。
例
次の例に、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プロシージャは、アイテムに使用されるラベルを設定します。このユーザー・インタフェースのデフォルト値は、指定された表に基づいてフォームまたはレポートを作成し、特定の列を含めるときに使用されます。
構文
APEX_UI_DEFAULT_UPDATE.UPD_ITEM_LABEL (
p_table_name IN VARCHAR2,
p_column_name IN VARCHAR2,
p_label IN VARCHAR2 DEFAULT NULL);
パラメータ
表8-8に、UPD_LABELプロシージャで使用可能なパラメータを示します。
例
次の例に、DEPT表のDEPTNO列にユーザー・インタフェースのアイテム・ラベルのデフォルト値を設定する方法を示します。
APEX_UI_DEFAULT_UPDATE.UPD_LABEL( p_table_name => 'DEPT', p_column_name => 'DEPTNO', p_label => 'Department Number');
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);
パラメータ
表8-9に、UPD_REPORT_ALIGNMENTプロシージャで使用可能なパラメータを示します。
表8-9 UPD_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プロシージャは、ユーザー・インタフェースのレポート書式マスクに関するデフォルト値を設定します。このユーザー・インタフェースのデフォルト値は、指定の表に基づいてレポートを作成する場合に指定の列を含めるようにすると、ウィザードで使用されます。レポートの書式マスクは、通常、数字と日付を書式化するために使用します。
構文
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);
パラメータ
表8-10に、UPD_REPORT_FORMAT_MASKプロシージャで使用可能なパラメータを示します。
表8-10 UPD_REPORT_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プロシージャは、レポート・リージョン・タイトルを設定します。ユーザー・インタフェースのデフォルト値は、表に関するレポートを作成するときに、ウィザードで使用されます。
構文
APEX_UI_DEFAULT_UPDATE.UPD_REPORT_REGION_TITLE (
p_table_name IN VARCHAR2,
p_report_region_title IN VARCHAR2 DEFAULT NULL);
パラメータ
表8-11に、UPD_REPORT_REGION_TITLEプロシージャで使用可能なパラメータを示します。
表8-11 UPD_REPORT_REGION_TITLEのパラメータ
| パラメータ | 説明 |
|---|---|
|
|
表名 |
|
|
希望するレポート・リージョン・タイトル |
例
次の例に、DEPT表にレポート・リージョン・タイトルのユーザー・インタフェースのデフォルト値を設定する方法を示します。
APEX_UI_DEFAULT_UPDATE.UPD_REPORT_REGION_TITLE (
p_table_name => 'DEPT',
p_report_region_title => 'Deptartments');
