Home > APEX_UI_DEFAU...
Previous |
Next |
The APEX_UI_DEFAULT_UPDATE
package provides procedures to access user interface defaults from within SQL Developer or SQL*Plus.
Topics:
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);
Parameters
Table: UPD_DISPLAY_IN_FORM Parameters describes the parameters available in the UPD_DISPLAY_IN_FORM
procedure.
UPD_DISPLAY_IN_FORM Parameters
Parameter | Description |
---|---|
|
Table name |
|
Column name |
|
Determines whether or not to display in the form by default, valid values are |
Example
In the following example, when creating a Form against the DEPT table, the display option on the DEPTNO column would default to 'No'.
APEX_UI_DEFAULT_UPDATE.UPD_DISPLAY_IN_FORM( p_table_name => 'DEPT', p_column_name => 'DEPTNO', p_display_in_form => 'N');
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: UPD_DISPLAY_IN_REPORT Parameters describes the parameters available in the UPD_DISPLAY_IN_REPORT
procedure.
UPD_DISPLAY_IN_REPORT Parameters
Parameter | Description |
---|---|
|
Table name |
|
Column name |
|
Determines whether or not to display in the report by default, valid values are |
Example
In the following example, when creating a Report against the DEPT table, the display option on the DEPTNO column would default to 'No'.
APEX_UI_DEFAULT_UPDATE.UPD_DISPLAY_IN_REPORT( p_table_name => 'DEPT', p_column_name => 'DEPTNO', p_display_in_report => 'N');
The UPD_FORM_REGION_TITLE
procedure updates the Form Region Title . 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: APEX_UI_DEFAULT_UPDATE Parameters describes the parameters available in the UPD_FORM_REGION_TITLE
procedure.
APEX_UI_DEFAULT_UPDATE Parameters
Parameter | Description |
---|---|
|
Table name |
|
Desired form region title |
Example
This example demonstrates how to set the Forms Region Title user interface default on the DEPT table.
APEX_UI_DEFAULT_UPDATE.UPD_FORM_REGION_TITLE ( p_table_name => 'DEPT', p_form_region_title => 'Deptartment Details');
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: UPD_ITEM_DISPLAY_HEIGHT Parameters describes the parameters available in the UPD_ITEM_DISPLAY_HEIGHT
procedure.
UPD_ITEM_DISPLAY_HEIGHT Parameters
Parameter | Description |
---|---|
|
Table name |
|
Column name |
|
Display height of any items created based upon this column |
Example
The following example sets a default item height of 3 when creating an item on the DNAME column against the DEPT table.
APEX_UI_DEFAULT_UPDATE.UPD_ITEM_DISPLAY_HEIGHT( p_table_name => 'DEPT', p_column_name => 'DNAME', p_display_height => 3);
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: UPD_ITEM_DISPLAY_WIDTH Parameters describes the parameters available in the UPD_ITEM_DISPLAY_WIDTH
procedure.
UPD_ITEM_DISPLAY_WIDTH Parameters
Parameter | Description |
---|---|
|
Table name |
|
Column name |
|
Display width of any items created based upon this column |
Example
The following example sets a default item width of 5 when creating an item on the DEPTNO column against the DEPT table.
APEX_UI_DEFAULT_UPDATE.UPD_ITEM_DISPLAY_WIDTH( p_table_name => 'DEPT', p_column_name => 'DEPTNO', p_display_width => 5);
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: UPD_ITEM_FORMAT_MASK Parameters describes the parameters available in the UPD_ITEM_FORMAT_MASK
procedure.
UPD_ITEM_FORMAT_MASK Parameters
Parameter | Description |
---|---|
|
Table name |
|
Column name |
|
Format mask to be associated with the column |
Example
In the following example, when creating a Form against the EMP table, the default item format mask on the HIREDATE column is set to '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');
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: UPD_ITEM_HELP Parameters describes the parameters available in the UPD_ITEM_HELP
procedure.
UPD_ITEM_HELP Parameters
Parameter | Description |
---|---|
|
Table name |
|
Column name |
|
Desired help text |
Example
This example demonstrates how to set the User Interface Item Help Text default for the DEPTNO column in the DEPT table.
APEX_UI_DEFAULT_UPDATE.UPD_ITEM_HELP( p_table_name => 'DEPT', p_column_name => 'DEPTNO', p_help_text => 'The number assigned to the department.');
The UPD_LABEL
procedure sets the label used for items. This user interface default will be used when you create a form or report 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: UPD__LABEL Parameters describes the parameters available in the UPD_LABEL
procedure.
UPD__LABEL Parameters
Parameter | Description |
---|---|
|
Table name |
|
Column name |
|
Desired item label |
Example
This example demonstrates how to set the User Interface Item Label default for the DEPTNO column in the DEPT table.
APEX_UI_DEFAULT_UPDATE.UPD_LABEL( p_table_name => 'DEPT', p_column_name => 'DEPTNO', p_label => 'Department Number');
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: UPD_REPORT_ALIGNMENT Parameters describes the parameters available in the UPD_REPORT_ALIGNMENT
procedure.
UPD_REPORT_ALIGNMENT Parameters
Parameter | Description |
---|---|
|
Table name. |
|
Column name. |
|
Defines the alignment of the column in a report. Valid values are L (left), C (center) and R (right). |
Example
In the following example, when creating a Report against the DEPT table, the default column alignment on the DEPTNO column is set to Right justified.
APEX_UI_DEFAULT_UPDATE.UPD_REPORT_ALIGNMENT( p_table_name => 'DEPT', p_column_name => 'DEPTNO', p_report_alignment => 'R');
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: UPD_REPORT_FORMAT_MASK Parameters describes the parameters available in the UPD_REPORT_FORMAT_MASK
procedure.
UPD_REPORT_FORMAT_MASK Parameters
Parameter | Description |
---|---|
|
Table name |
|
Column name |
|
Format mask to be associated with the column whenever it is included in a report |
Example
In the following example, when creating a Report against the EMP table, the default format mask on the HIREDATE column is set to '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');
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: UPD_REPORT_REGION_TITLE Parameters describes the parameters available in the UPD_REPORT_REGION_TITLE
procedure.
UPD_REPORT_REGION_TITLE Parameters
Parameter | Description |
---|---|
|
Table name |
|
Desired report region title |
Example
This example demonstrates how to set the Reports Region Title user interface default on the DEPT table.
APEX_UI_DEFAULT_UPDATE.UPD_REPORT_REGION_TITLE ( p_table_name => 'DEPT', p_report_region_title => 'Deptartments');