8 APEX_UI_DEFAULT_UPDATE

The APEX_UI_DEFAULT_UPDATE package provides procedures to access user interface defaults from within SQL Developer or SQL*Plus.

You can use this package to set the user interface defaults associated with a table within a schema. The package must be called from within the schema that owns the table you are updating.

User interface defaults enable you to assign default user interface properties to a table, column, or view within a specified schema. When you create a form or report using a wizard, the wizard uses this information to create default values for region and item properties. Utilizing user interface defaults can save valuable development time and has the added benefit of providing consistency across multiple pages in an application.

Topics in this section include:

UPD_FORM_REGION_TITLE Procedure
UPD_REPORT_REGION_TITLE Procedure
UPD_ITEM_LABEL Procedure
UPD_ITEM_HELP Procedure
UPD_DISPLAY_IN_FORM Procedure
UPD_DISPLAY_IN_REPORT Procedure
UPD_ITEM_DISPLAY_WIDTH Procedure
UPD_ITEM_DISPLAY_HEIGHT Procedure
UPD_REPORT_ALIGNMENT Procedure
UPD_ITEM_FORMAT_MASK Procedure
UPD_REPORT_FORMAT_MASK Procedure

UPD_FORM_REGION_TITLE Procedure

The UPD_FORM_REGION_TITLE procedure updates the Form Region Title user interface default. User interface defaults are used in wizards when you create a form based upon the specified table.

Syntax

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

Parameters

Table 8-1 describes the parameters available in the UPD_FORM_REGION_TITLE procedure.

Table 8-1 APEX_UI_DEFAULT_UPDATE Parameters

Parameter	Description
`p_table_name`	Table name
`p_form_region_title`	Desired form region title

Example

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

UPD_REPORT_REGION_TITLE Procedure

The UPD_REPORT_REGION_TITLE procedure sets the Report Region Title. User interface defaults are used in wizards when a report is created on a table.

Syntax

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

Parameters

Table 8-2 describes the parameters available in the UPD_REPORT_REGION_TITLE procedure.

Table 8-2 UPD_REPORT_REGION_TITLE Parameters

Parameter	Description
`p_table_name`	Table name
`p_report_region_title`	Desired report region title

Example

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

UPD_ITEM_LABEL Procedure

The UPD_ITEM_LABEL procedure sets the label used for items. 'This user interface default will be used when you create a form based on the specified table and include a specific column.

Syntax

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

Parameters

Table 8-3 describes the parameters available in the UPD_ITEM_LABEL procedure.

Table 8-3 UPD_ITEM_LABEL Parameters

Parameter	Description
`p_table_name`	Table name
`p_column_name`	Column name
`p_label`	Desired item label

Example

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

UPD_ITEM_HELP Procedure

The UPD_ITEM_HELP procedure updates the help text for the specified table and column. This user interface default will be used when you create a form based upon the table and select to include the specified column.

Syntax

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

Parameters

Table 8-4 describes the parameters available in the UPD_ITEM_HELP procedure.

Table 8-4 UPD_ITEM_HELP Parameters

Parameter	Description
`p_table_name`	Table name
`p_column_name`	Column name
`p_help_text`	Desired help text

Example

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_DISPLAY_IN_FORM Procedure

The UPD_DISPLAY_IN_FORM procedure sets the display in form user interface defaults. 'This user interface default will be used by wizards when you select to create a form based upon the table. It controls whether the column will be included by default or not.

Syntax

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

Parameters

Table 8-5 describes the parameters available in the UPD_DISPLAY_IN_FORM procedure.

Table 8-5 UPD_DISPLAY_IN_FORM Parameters

Parameter	Description
`p_table_name`	Table name
`p_column_name`	Column name
`p_display_in_form`	Determines whether or not to display in the form by default, valid values are `Y` and `N`

Example

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 Procedure

The UPD_DISPLAY_IN_REPORT procedure sets the display in report user interface default. This user interface default will be used by wizards when you select to create a report based upon the table and controls whether the column will be included by default or not.

Syntax

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

Parameters

Table 8-6 describes the parameters available in the UPD_DISPLAY_IN_REPORT procedure.

Table 8-6 UPD_DISPLAY_IN_REPORT Parameters

Parameter	Description
`p_table_name`	Table name
`p_column_name`	Column name
`p_display_in_report`	Determines whether or not to display in the report by default, valid values are `Y` and `N`

Example

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

UPD_ITEM_DISPLAY_WIDTH Procedure

'The UPD_ITEM_DISPLAY_WIDTH procedure sets the item display width user interface default. This user interface default will be used by wizards when you select to create a form based upon the table and include the specified column.n.

Syntax

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

Parameters

Table 8-7 describes the parameters available in the UPD_ITEM_DISPLAY_WIDTH procedure.

Table 8-7 UPD_ITEM_DISPLAY_WIDTH Parameters

Parameter	Description
`p_table_name`	Table name
`p_column_name`	Column name
`p_display_width`	Display width of any items created based upon this column

Example

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

UPD_ITEM_DISPLAY_HEIGHT Procedure

'The UPD_ITEM_DISPLAY_HEIGHT procedure sets the item display height user interface default. This user interface default will be used by wizards when you select to create a form based upon the table and include the specified column. Display height controls if the item will be a text box or a text area.

Syntax

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

Parameters

Table 8-8 describes the parameters available in the UPD_ITEM_DISPLAY_HEIGHT procedure.

Table 8-8 UPD_ITEM_DISPLAY_HEIGHT Parameters

Parameter	Description
`p_table_name`	Table name
`p_column_name`	Column name
`p_display_height`	Display height of any items created based upon this column

Example

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

UPD_REPORT_ALIGNMENT Procedure

'The UPD_REPORT_ALIGNMENT procedure sets the report alignment user interface default. This user interface default will be used by wizards when you select to create a report based upon the table and include the specified column and determines if the report column should be left, center, or right justified.

Syntax

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

Parameters

Table 8-9 describes the parameters available in the UPD_REPORT_ALIGNMENT procedure.

Table 8-9 UPD_REPORT_ALIGNMENT Parameters

Parameter	Description
`p_table_name`	Table name.
`p_column_name`	Column name.
`p_report_alignment`	Defines the alignment of the column in a report. Valid values are L (left), C (center) and R (right).

Example

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

UPD_ITEM_FORMAT_MASK Procedure

'The UPD_ITEM_FORMAT_MASK procedure sets the item format mask user interface default. This user interface default will be used by wizards when you select to create a form based upon the table and include the specified column. Item format mask is typically used to format numbers and dates.

Syntax

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
   );

Parameters

Table 8-10 describes the parameters available in the UPD_ITEM_FORMAT_MASK procedure.

Table 8-10 UPD_ITEM_FORMAT_MASK Parameters

Parameter	Description
`p_table_name`	Table name
`p_column_name`	Column name
`p_format_mask`	Format mask to be associated with the column

Example

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

UPD_REPORT_FORMAT_MASK Procedure

'The UPD_REPORT_FORMAT_MASK procedure sets the report format mask user interface default. This user interface default will be used by wizards when you select to create a report based upon the table and include the specified column. Report format mask is typically used to format numbers and dates.

Syntax

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
   );

Parameters

Table 8-11 describes the parameters available in the UPD_REPORT_FORMAT_MASK procedure.

Table 8-11 UPD_REPORT_FORMAT_MASK Parameters

Parameter	Description
`p_table_name`	Table name
`p_column_name`	Column name
`p_format_mask`	Format mask to be associated with the column whenever it is included in a report

Example

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