9 Controlling Page Layout and User Interface

Button Template

Template Name identifies the name that identifies the template. Use the Translatable check box to indicate if the template contains text strings which require translation. Theme indicates the theme to which the template is a member.

Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Template Text

Defines the button template that displays. You have the option of including standard application substitutions. For example, &ITEM_NAME values can be substituted at rendering time. Button templates support the following substitution strings:

• #LABEL# is replaced with a button label.

• #LINK# is replaced with a URL. The URL then calls a #doSubmit# or a redirect JavaScript which submits the page (that is, setting the request value), or simply redirects it to the supplied URL.

Comments

Use this attribute to record developer comments.

Calendar Template Identification

Name identifies the name that identifies the template. Theme indicates the theme to which the template is a member.

Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Month Attributes

Enter formats for the month title, day of the week, month open, and month close.

Week Attributes

Enter HTML to open and close a week.

Day Attributes

Enter HTML to format the days which occur during the work week (that is, Monday through Friday).

Non-Day Attributes

A non-day is not part of the current month. For example, suppose the first of a month is a Monday, but the week starts on a Sunday. Since Sunday is not be part of the current month, Sunday would be a non-day. Use these attributes to format a non-days.

Weekend Attributes

Enter HTML used to format days which occur on the weekend.

Label Template Attributes

Template Name identifies the name that identifies the template. Use the Translatable check box to indicate that the template contains text strings which require translation. Theme indicates the theme to which the template is a member.

Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Template Definition (normal display)

In Before Label enter HTML to display before the item label. Before Label supports the substitution strings #CURRENT_FORM_ELEMENT#; #CURRENT_FORM_ID#, and #CURRENT_ITEM_NAME#.

In After Label, enter HTML to display after the item label.

Label Template Attributes (error display)

In On Error Before Label enter HTML to precede the item label when a application displays an inline validation error message for the item.

In On Error After Label enter HTML to be appended to the item label when a application displays an inline validation error message for the item. This attribute supports the substitution strings #CURRENT_FORM_ELEMENT#, #CURRENT_FORM_ID#, and #CURRENT_ITEM_NAME#.

Template Comments

Use this attribute to record developer comments.

Template Identification

Name identifies the name that identifies the template. Use the Translatable check box to indicate that the template contains text strings which require translation. Theme indicates the theme to which the template is a member.

Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Before List Elements

Enter HTML that displays before any list elements. You can use this attribute to open an HTML table or HTML table row.

List Element Display

Defines current and noncurrent list templates.

• List Template Current. Enter HTML or text to be substituted for the selected (or current) list template.

• List Template Noncurrent. Enter HTML or text to be substituted for the unselected (or noncurrent) list template.

After List Elements

Enter HTML that displays after displaying all list elements. You can use this attribute to close a HTML table opened in the Before List Elements attribute.

Comments

Use this attribute to record developer comments.

Menu Template Identification

Name identifies the name that identifies the template. Use the Translatable check box to indicate that the template contains text strings which require translation. Theme indicates the theme to which the template is a member.

Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Menu Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Menu Template Style)

Select one of the following menu template styles:

• Parent to Leaf (breadcrumb style) displays the current page menu option, its parent to the left, and so on until the root node is reached.

• Parent Menu displays all menu options for the current pages parent menu (that is, one level up from current menu).

• Current Menu displays all menu options in sequence with a common parent.

• Child Menu displays all menu options that are children of the current page parent menu (that is, peers of the current menu).

Menu Option Control

Table 9-6 describes available Menu Option Control attributes.

Template Attributes

Use Menu Link Attributes to specify hypertext link attributes for a menu option.

Use Between Levels to specify text that displays between each level of a breadcrumb menu. For example, suppose your breadcrumb menus has three levels this text would be displayed at the "X" in the example that follows:

main X cars X porsche X 911

In Max Levels specify the number of levels when displaying menus in a breadcrumb style.

Comments

Use this attribute to record developer comments.

Template Identification

Name identifies the name that identifies the template. Use the Translatable check box to indicate that the template contains text strings which require translation. Theme indicates the theme to which the template is a member.

Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, select Refresh.

Header, Body, and Footer Definitions

Each template consists of a header, a body, a footer, and subtemplate definitions. Use substitution strings to include dynamic content. All template substitution strings must be in upper case and begin and end with a pound sign (#). See online help for specific information as to which substitution strings are supported.

Header is the first section of the page template. Enter HTML that defines the <Head> section of the HTML document. Regions that display or processes and computations that execute AFTER HEADER, will display or execute immediately after this section in the template is rendered.

Body is the second section in the page template and is rendered after the header and before the footer section. Enter HTML that defines the <Body> section of the HTML document. At a minimum, you must include the #BOX_BODY# substitution string.It is strongly recommended you also include #FORM_OPEN# and #FORM_CLOSE#.

Footer is the third section in the page template that displays after the body.

Default Display Points

Breadcrumb Display Point applies to generated components that use Breadcrumb style menus and defines where these Breadcrumb style menus are placed on the page. Sidebar Display Point applies to generated components that use Sidebars and defines where Sidebars are placed on the page.

Subtemplate Definitions

Use Subtemplate Definitions to specify how a component should display. Available subtemplate definitions include:

• Success Message. Expands the #SUCCESS_MESSAGE# substitution string. You can define a success message either programmatically, or as an attribute of a process. If a success message exists and if the page template includes the #SUCCESS_MESSAGE# substitution string, then this subtemplate is used to render the message.

• Navigation Bar. Controls the display of navigation bar icons. Enter HTML or text that to be substituted when the #NAVIGATION_BAR# substitution string is referenced in the template header, body or footer. Use the #BAR_BODY# substitution string to identify where each navigation bar icon should display.

• Navigation Bar. Entry Enter HTML or text that to be substituted into the navigation bar #BAR_BODY# substitution string for each navigation bar entry. Use the following substitution strings to compose the navigation bar entry sub template.

• Notification. Enter HTML or text that to be substituted when the #NOTIFICATION_MESSAGE# substitution string is referenced in the template header, body or footer. Use the substitution string #MESSAGE# to indicate where in the Notification Message the body of the message will appear.

Standard Tab Attributes

You must populate this attribute if your application includes standard tabs. Standard tabs may be placed in the header, body, or footer sections of the page template using the #TAB_CELLS# substitution string. The page template Header/Body/Footer defines the HTML table and rows. This subtemplate defines how these tabs display by defining the specific cell. Available attributes include:

• Current Tab. Enter HTML or text that to be substituted for the currently selected standard tab. Whether or not a tab is current is determined by standard tab attributes. Use the #TAB_TEXT# substitution string to position a tab's label and link within the template.

• Non Current Standard Tab. Enter HTML or text that will be substituted for the unselected standard tabs. Use #TAB_TEXT# to position a tab's label and link within the template.

• Non Current Tab Font Attributes. This attribute is part of the Standard Tab subtemplate. This value replaces the #TAB_FONT_ATTRIBUTES# substitution string.

Parent Tab Attributes

You must populate this attribute if your application includes two levels of tabs. Enter HTML or text that will be substituted for the selected parent tabs. Parent tabs may be placed in the header, body, or footer section of the page template using the #PARENT_TAB_CELLS# substitution string. Parent tabs only display in conjunction with standard tabs. Available attributes include:

• Current Parent Tab. Enter HTML or text that will be substituted for the selected parent tabs. Whether or not a tab is current is determined by the page that displays and the standard tab set the page uses. Use #TAB_TEXT# to position a tab's label and link within the template.

• Parent Current Tab Font Attributes. This attribute is part of the Parent Tab subtemplate and expands the #PARENT_TAB_CELLS# substitution string. A "current tab" is a tab that is current for the current page. This attribute controls the font used to display the parent tab text.

• Non Current Parent Tab. Enter HTML or text that will be substituted for the unselected parent tabs. Use #TAB_TEXT# to position a tab's label and link within the template.

• Parent Non Current Tab Font Attributes. This attribute is part of the Parent Tab subtemplate and expands the #PARENT_TAB_CELLS# substitution string. A "non current tab" is a tab that is not current for the current page. This attribute controls the font used to display the parent tab text.

Image Based Tab Attributes

Use this subtemplate for tabs that are entirely based on images. Available attributes include:

• Current Image Tab. Enter HTML to be used to indicate that an image based tab is currently selected. Include the #TAB_TEXT# substitution string to show the displayed name of the tab.

• Non Current Image Tab. Enter the HTML to be used to indicate that an image tab is not currently selected. Include the #TAB_TEXT# substitution string to show the displayed name of the tab.

Multi Column Region Table Attribute

If the HTML DB engine displays regions in multiple columns in the same region position then HTML DB will render an HTML table. This attribute enables you to control the attributes of the <table> tag.

Error Page Template Control

Use this attribute only when a page template will be designated as an error template. Use #MESSAGE# to place the error message and #BACK_LINK# to display a link back to the previous page. A template can be designated as an error template by editing the application attributes. For example:

#MESSAGE#

<br>

<a href="#BACK_LINK#">back</a>

Configuration Management

You can use build options to enable or disable functionality. Most application attributes have a build option attribute.

Build Options have two possible values: INCLUDE and EXCLUDE. A component that is excluded is not considered part of the application definition at runtime.

Comments

Use this attribute to record developer comments.

Application Identification

Theme indicates the theme to which the template is a member. Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class. Use the Translatable check box to indicate that the template contains text strings which require translation.

Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Form Icon

Use Popup Icon to specify an icon to display to the right of a form field for items of type POPUP. By default, the HTML DB engine uses a list.gif image. Use Popup Icon Attr to defines image attributes (such as height and width) for the Popup Icon

Search Field

Use these attributes to specify how a Search field displays. Table 9-8 describes available Search Field attributes.

Buttons

Use these attributes to define the button name and attributes for Find, Close, Next, and Previous button.

Window

Popup lists of values are executed using JavaScript. Use these attribute to control the values of scrollbars=, resizable=, width=, and height=. For more information on default values see online help.

Pagination

Defines how row count results display.

Result Set

Use these attributes to define text or HTML to display before and after a result set.

Page Attributes

Use these attributes to define popup pages. For more information see online help.

Region Template Identification

Name identifies the name that identifies the template. Use the Translatable check box to indicate that the template contains text strings which require translation. Theme indicates the theme to which the template is a member.

Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Region Template

##BODY# is the only required substitution string. It identifies where the source of the region should be placed. All other substitution strings are optional. The following are valid substitution strings:

• #TITLE#

• #EXPAND#

• #CHANGE#

• #BODY#

• #FORM_OPEN#

• #FORM_CLOSE#

When you create a button in a region position, the positions you have defined will appear in a select list. Use the following substitution strings to define positions for placement of buttons in a region:

• #EDIT#

• #CLOSE#

• #CREATE#

• #EXPAND#

• #HELP#

• #DELETE#

• #COPY#

• #NEXT#

• #PREVIOUS#

Form Table Attributes

Page items display within regions. Items are rendered as HTML form elements in an HTML table. With this template property, you can define attributes that will be placed in the <table> tag. For example:

class="instructiontext"

Comments

Use this attribute to record developer comments.

Generic Column Templates

A generic column template determines the appearance of a report by defining the look of the column once. This look is then repeated as many times as is necessary based on the number of columns specified in the report's definition. This type of templates is limited to reports that have a standard row and column structure. Additional style may be applied to a report using this type of template through use of conditions.

The following example demonstrates how to have each column use a specific style:

<td class="tabledata" align="#ALIGN#">#COLUMN_VALUE#</td>

This example assumes your page template includes a CSS containing the class tabledata. This example also demonstrates the use the substitution strings #ALIGN# and #COLUMN_VALUE#. If you actually ran this report, these substitution strings would be replaced with values generated by the results of a SQL query.

If your query uses an expression in the select list, it is a good idea to create an alias for the columns to avoid runtime errors. For example, suppose your query was as follows:

SELECT ename, (sal + comm) * 12 FROM emp

You could rewrite the query to alias the columns as follows:

SELECT ename, (sal + comm) * 12 yearly_comp FROM emp

Named Column Templates

Named column templates allow for more flexibility in report design. However, because they reference columns by name, they can only be used by reports that are based on those columns. For example:

<tr><td>#ENAME#</td><td>#SAL#</td></tr>

Although named column templates offer a great deal of flexibility, you may need to create a new template for each query. You can also include a position notation. The following example demonstrates how to use following HTML and substitution strings:

<tr><td>#ENAME#</td><td>#SAL#</td></tr>

<tr><td>#1#</td><td>#2#</td></tr>

Report Template Identification

Template Name identifies the name of the template. Use the Translatable check box to indicate the template contains text strings which require translation. Template Type indicates the type of template. Named Column templates reference column names in the template. Generic Column Templates reference #COLUMN_VALUE# in the template.

Theme indicates the theme to which the template is a member. Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Template Subscription

Use Template Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Before Rows

In Before Rows enter HTML that displays once at the beginning of a report template. Opening an HTML table is a common use of this attribute as shown in the following example:

<table>

You can identify column headers using the syntax #1#, #2#, #3#. For example:

<th>#1#</th><th>#2#</th><th>#3#</th>

You can include pagination above a report by including the substitution string #TOP_PAGINATION#. This substitution string generates HTML which starts with an opening <tr> tag and ends with a closing </tr> tag. For example, to include an open table tag and #TOP_PAGINATION# substitution string you would enter the following:

<table>#TOP_PAGINATION#

You can also include the substitution string #CSV_LINK# to include support for exporting your report to CSV format, a format compatible with most spreadsheet programs.

Column Headings

Use Column Heading Template to colorize each column header cell. Note that the text of this attribute must indicate where the cell heading text will be colorized. For example:

<th #ALIGNMENT#>#COLUMN_HEADER#</th>

If you do not want any column headings, enter the following:

OMIT

If you do use this attribute, HTML DB engine applies the default column heading template.

Before Each Row

In Before Each Row enter text to display before all columns in the report. Use this attribute to open a new HTML row. Before Each Row supports the following substitution strings:

• #ROWNUM#

  Use this substitution strings to specify the current row

• #COLCOUNT#

  Use this substitution strings to specify the number of columns

• #HIGHLIGHT_ROW#

  Use this substitution strings to specify the number of highlighted rows.

Column Templates

Column templates define the look of each column. You can define up to four column templates, each of which can conditional. For example, you can have different background colors for even and odd rows, or highlight rows which meet a PL/SQL defined condition.

In each Column Template, you define the look of each column. Column Templates support the substitution strings described in Table 9-9.

Consider the following example:

<td #ALIGNMENT#>#COLUMN_VALUE#</td>

If you actually ran this report, these substitution strings would be replaced with values generated by the results of a SQL query.

By creating conditions, you can create a report that displays columns differently depending on whether the specified condition is met. To specify a column template be used conditionally, select a condition type from the Column Template Condition list. Valid values include:

• Use Based on PL/SQL Expression. Conditionally format columns based on data in that row.

• Use for Even Numbered Rows. Conditionally format even numbered rows.

• Use for Odd Numbered Rows. Conditionally format odd numbered row.

If you select Use Based on PL/SQL Expression, the next step is to enter a PL/SQL expression in Column Template Expression field. For example, the following expression displays a value in bold if the value is greater than 2000:

#SAL# > 2000

Note that you could also use the substitution string #ROWNUM#. For example:

#ROWNUM# > 2000

After Each Row

In After Each Row enter HTML that displays after all columns in the report display. This attribute is often used to close an HTML table row. For example:

</tr>

After Rows

Use After Rows to specify text that should display after the last row. A common use of this attribute is to close the HTML table tag. For example:

</table>

The After Rows attribute supports the following substitution strings:

• #PAGINATION#

  Replaced with a pagination attribute.

• #COLCOUNT#

  Substituted at runtime with the number of columns defined in the report.

Row Highlighting

Use Background color for checked row to control the background color of a report row when the row selector is checked. Use Background color for current row to control the background color of a report row when the user moves the mouse over the row.

Pagination Subtemplate

The Pagination Subtemplate section contains attributes for editing the Pagination Template, Next Page Template, Previous Page Template, Next Set Template, and Previous Template. Pagination Subtemplates support the substitution strings #PAGINATION_NEXT#, #PAGINATION_NEXT_SET#, #PAGINATION_PREVIOUS# and #PAGINATION_PREVIOUS_SET#. Table 9-12 describes these templates.

<span class="instructiontext">#TEXT#</span>

<a href="#LINK#">next</a>

<a href="#LINK#">previous</a>

<a href="#LINK#">next set</a>

<a href="#LINK#">previous set</a>

Comments

Use this attribute to record developer comments.

Identification

Template Name identifies the name of the template. Use the Translatable check box to indicate the template contains text strings which require translation. Template Type indicates the type of template. Named Column templates reference column names in the template. Generic Column Templates reference #COLUMN_VALUE# in the template.

Theme indicates the theme to which the template is a member. Template Class identifies a specific usage for the template. When you switch to a new theme, all templates in one theme are mapped to corresponding templates in another theme. Application Builder accomplishes this template mapping through the assignment of a template class.

Subscription

Use Subscription to apply an existing template to the current application. When you select an existing template, you become a subscriber to that template.

To load a new copy of a master template, click Refresh Template.

Row Templates

Row templates define the look of each column. You can define up to four row templates, each of which can conditional.

In each Row Template, you define the look of each row. Row Templates support the substitution strings described in Table 9-11.

By creating conditions, you can create a report that displays rows differently depending on whether the specified condition is met. To specify a row template be used conditionally, select a condition type from the Column Template Condition list. Valid values include:

• Use Based on PL/SQL Expression. Conditionally format columns based on data in that row.

• Use for Even Numbered Rows. Conditionally format even numbered rows.

• Use for Odd Numbered Rows. Conditionally format odd numbered row.

If you select Use Based on PL/SQL Expression, the next step is to enter a PL/SQL expression in Column Template Expression field. For example, the following expression displays a value in bold if the value is greater than 2000:

#SAL# > 2000

Note that you could also use the substitution string #ROWNUM#. For example:

#ROWNUM# > 2000

Column Headings

Use this template to colorize each column header cell. The text of this attribute must include help to indicate where the cell heading text should be colorized. If you do not enter a Column Heading Template, then a default column header template is applied. If you do not want any column headings, then enter OMIT. For example:

<th #ALIGNMENT#>#COLUMN_HEADER#</th>

Before first and after last row text

In Before Rows enter HTML that displays once at the beginning of a report template. Opening an HTML table is a common use of this attribute as shown in the following example:

<table>

You can identify column headers using the syntax #1#, #2#, #3#. For example:

<th>#1#</th><th>#2#</th><th>#3#</th>

You can include pagination above a report by including the substitution string #TOP_PAGINATION#. This substitution string generates HTML which starts with an opening <tr> tag and ends with a closing </tr> tag. For example, to include an open table tag and #TOP_PAGINATION# substitution string you would enter the following:

<table>#TOP_PAGINATION#

You can also include the substitution string #CSV_LINK# to include support for exporting your report to CSV format, a format compatible with most spreadsheet programs.

Use After Rows to specify text that should display after the last row. A common use of this attribute is to close the HTML table tag. For example:

</table>

The After Rows attribute supports the following substitution strings:

• #PAGINATION#

  Replaced with a pagination attribute.

• #COLCOUNT#

  Substituted at runtime with the number of columns defined in the report.

Row Highlighting

Use Background color for checked row to control the background color of a report row when the row selector is checked. Use Background color for current row to control the background color of a report row when the user moves the mouse over the row.

Pagination

The Pagination section contains attributes for editing the Pagination Template, Next Page Template, Previous Page Template, Next Set Template, and Previous Template. Pagination Subtemplates support the substitution strings #PAGINATION_NEXT#, #PAGINATION_NEXT_SET#, #PAGINATION_PREVIOUS# and #PAGINATION_PREVIOUS_SET#. Table 9-12 describes these templates.

<span class="instructiontext">#TEXT#</span>

<a href="#LINK#">next</a>

<a href="#LINK#">previous</a>

<a href="#LINK#">next set</a>

<a href="#LINK#">previous set</a>

Comments

Use this attribute to record developer comments.