List Templates

Control the appearance of a list using list templates.

About Hierarchical Lists

Learn about hierarchical lists.

A list is a shared collection of links. Oracle APEX supports hierarchical lists. To create a hierarchical list, you must:

• Select a list template that supports hierarchical lists. To determine which list templates support hierarchical lists, look for templates having the naming convention “with Sublist.”

  Tip: To determine which list templates support hierarchical lists, look for templates having the naming convention “with Sublist.”

• Select a Parent List Entry when you create each list entry. See Also: Creating Lists

List Template Attributes

Learn about list template attributes.

To learn more about a specific attribute, see field-level Help.

Name

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

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

Before List Entry

Enter HTML that displays before any list elements. You can use this attribute to open an HTML table or HTML table row. The #COMPONENT_CSS_CLASSES# substitution string must be included in the List Template Before Rows attribute for templates that have template options defined.

Template Definition

Defines current and noncurrent list templates. Supported substitution strings include #LINK#, #TEXT#, #TEXT_ESC_SC#, #ICON_CSS_CLASSES#, #APEX_FILES#, #IMAGE#, #IMAGE_ATTR#, and #A01#...#A10#.

Template Definition attributes include:

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

• List Template Current with Sub List Items. Enter HTML or text to be substituted for the selected (or current) list template when an item has sublist items. If not specified, the current list item template is used.

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

• List Template Noncurrent with Sub List Items. Enter HTML or text to be substituted for the unselected (or noncurrent) list template used when an item has sublist items. If not specified, the current list item template is used.

• Between List Elements. Enter HTML that displays between list elements. This attribute is ignored if no HTML is specified.

Template Definitions for First Entry

Available attributes include:

• List Template Current (First). If defined, this is used for the first list item. Enter HTML or text to be substituted for the selected (or current) list template.

• List Template Current with Sub List Items (First). If defined, this is used for the first list item. HTML or text to be substituted for the selected (or current) list template used when item has sub list items.

• List Template Noncurrent (First). If defined, this is used for the first list item. Enter HTML or text to be substituted for the unselected (or noncurrent) list template.

• List Template Noncurrent with Sub List Items (First). If defined, this is used for the first list item. HTML or text to be substituted for the unselected (or noncurrent) list template used when item has sub list items.

Before Sublist Entry

Enter HTML that displays before any sublist elements.

Sublist Entry

Defines current and noncurrent list templates. Supported substitution strings include #LINK#, #TEXT#, #ICON_CSS_CLASSES#, #APP_FILES#, #IMAGE#, #IMAGE_ATTR#, #ICON_CSS_CLASSES#, #A01#…#A10#, #LIST_ITEM_ID#, and #PARENT_LIST_ITEM_ID#.

Sub List Entry attributes include:

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

• Sub List Template Current with Sub List Items. Enter HTML or text to be substituted for the selected (or current) list template when an item has sublist items. If not specified, the current list item template is used.

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

• Sub List Template Noncurrent with Sub List Items. Enter HTML or text to be substituted for the unselected (or noncurrent) list template used when an item has sublist items. If not specified, the current list item template is used.

• Between Sub List Items. Enter HTML that displays between list elements. This attribute is ignored if no HTML is specified.

After Sub List Entry

Enter HTML that displays after displaying sublist elements.

After List Entry

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

Substitution Strings

Note: Template directives are supported by specific attributes of list templates. See Using Template Directives.

Substitution strings are used within templates to reference component values. To view the most current list supported substitution strings for a given template, view the template and find the Substitution Strings report.

Tip: All template substitution strings must be in uppercase letters and begin and end with a number sign (#).