11.3.6.2 Managing Template Options

Template options enable developers to declaratively apply CSS modifiers to the templates they have chosen for pages, regions, reports, lists, breadcrumbs, items and buttons.

Tip:

In order to add or edit template options, you must be the theme owner. See Unsubscribing to a Theme.

• Creating Template Options
  Create a template option by declaratively modifying a template.
• Editing Template Options
  Edit an existing template option on the Templates page.
• Creating a Template Option Group
  Define the purpose of related template options by creating template option groups.
• Editing Template Option Groups
  Edit template option groups by navigating to the Templates page.
• Using Quick Edit to Modify Live Template Options
  Using the Live Template Options dialog to alter a component's template options without refreshing the page.

See Also:

Understanding Template Options

11.3.6.2.1 Creating Template Options

Create a template option by declaratively modifying a template.

To create a template option:

1. Navigate to the Templates page:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Click Shared Components.
   4. Under User Interface, select Templates.
   The Templates page appears.
2. Select a template.
3. Under Template Options, click Add Template Option.
   A new row appears.
4. Edit the appropriate attributes:
   1. Group - Select a group name. Group names enable you to group template options and avoid the selection of conflicting option. See .
   2. Name - Enter a name for the template option.
   3. Identifier - Enter an alphanumeric, upper case identifier for the template option. Identifiers map a template option to a corresponding template option when switching themes.
   4. Sequence - Specify the sequence for this option.
   5. Classes - Enter one or more CSS classes that define this template option.
   6. Help Text - Enter a description of the template option.
5. Click Save.

11.3.6.2.2 Editing Template Options

Edit an existing template option on the Templates page.

To edit a template option:

1. Navigate to the Templates page:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Click Shared Components.
   4. Under User Interface, select Templates.
   The Templates page appears.
2. Select a template.
3. Select Template Options.
4. To edit a template option:
   1. Select the row containing the template option.
      The row becomes hightlighted.
   2. Edit the appropriate attributes.
      • Group - Select a group name. Group names enable you to group template options and avoid the selection of conflicting option.
      • Name - Enter a name for the template option.
      • Identifier - Enter an alphanumeric, upper case identifier for the template option. Identifiers map a template option to a corresponding template option when switching themes.
      • Sequence - Specify the sequence for this option.
      • Classes - Enter one or more CSS classes that define this template option.
      • Help Text - Enter a description of the template option.

   Tip:

   If you edit the name of a CSS class, all components that reference that CSS class name must be updated manually. The Option Identifier cannot be modified since it is needed for mapping purposes.

5. Click Save.
6. To delete a template option:
   • Click the Row Actions menu and select Delete Row.

   Tip:

   To learn more about the Row Actions menu, see About the Row Actions Menu in an Interactive Grid in Oracle APEX End User’s Guide
7. To view global template options, expand Global Template Options.

11.3.6.2.3 Creating a Template Option Group

Define the purpose of related template options by creating template option groups.

To create a template option group:

1. Navigate to the Templates page:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Click Shared Components.
   4. Under User Interface, select Templates.
   The Templates page appears.
2. Select a template.
3. Locate Template Options and click Template Options Groups..
   The Template Options Groups window appears.
4. To create a new group:
   1. Click Add Template Option Group.
      A new row appears.
   2. Edit the appropriate attributes:
      • Template Type - Specify the type of template for this template option group.
      • Name - Enter a display name for the template option group.
      • Identifier - Defines the internal name of the template option group.
      • Sequence - Specify the sequence for this template option group.
      • Null Text - Default value for the template option group if a user does not select any template option in that group.
      • Help Text - Enter a description of the template option group.
      • Advanced - Determines if the template option group belongs in the Basic or Advanced category of template options. Select Yes or No.
   3. Click Save.

11.3.6.2.4 Editing Template Option Groups

Edit template option groups by navigating to the Templates page.

To edit template option groups:

1. Navigate to the Templates page:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Click Shared Components.
   4. Under User Interface, select Templates.
   The Templates page appears.
2. Select a template.
3. Locate Template Options and click Template Options Groups..
   The Template Options Groups window appears.
4. To edit a template option group:
   1. Select the row containing the template option group.
      The row becomes hightlighted.
   2. Edit the appropriate attributes.
      • Template Type - Specifies the type of template for this template option group.
      • Name - Dsplay name for the template option group.
      • Identifier - Defines the internal name of the template option group.
      • Sequence - Specify the sequence for this template option group.
      • Null Text - Default value for the template option group if a user does not select any template option in that group.
      • Help Text - Enter a description of the template option group.
      • Advanced - Determines if the template option group belongs in the Basic or Advanced category of template options. Select Yes or No.
   3. Click Save.
5. To delete a template option group:
   • Click the Row Actions menu and select Delete Row.

   Tip:

   To learn more about the Row Actions menu, see About the Row Actions Menu in an Interactive Grid in Oracle APEX End User’s Guide

11.3.6.2.5 Using Quick Edit to Modify Live Template Options

Using the Live Template Options dialog to alter a component's template options without refreshing the page.

Developers can also use Quick Edit on the Runtime Developer toolbar to access the Live Template Options dialog. Using the Live Template Options dialog, developers can alter component's template options without refreshing the page.

To access the Live Template Options:

1. Run the page.
2. From the Runtime Developer toolbar, click Quick Edit.
3. Move the mouse over the component for which you want to modify template options. Click the Wrench icon in the upper right corner.
   
   Description of the illustration wrench_icon.png

   The Live Template Options dialog appears. For region-based components, such as lists and classic reports, the dialog includes an Attributes tab.

   
   Description of the illustration live_template_options.png
4. Select the appropriate tab, edit the appropriate attributes, and click Save.

See Also:

Runtime Developer Toolbar