Cloud Software Group, Inc. EBX®
TIBCO EBX® Documentation
Navigation mode TIBCO EBX® Documentation

# Toolbars

## Definition

A toolbar allows to customize the buttons and menus that are displayed when viewing tables or records in a dataset. The customization of toolbars can be performed in the data model via the 'Configuration' section.

Add a toolbar from the Toolbars section of the navigation pane, by clicking on the arrow located to the right of [ All elements ], then selecting the Create toolbar option. Follow the creation wizard to create a toolbar. A toolbar defines the following information:

Name | Toolbar's name. The name of the toolbar must be unique in the context of the data model. That is, it is not allowed to create several toolbars with the same name.
Label and description | Internationalized labels and descriptions to be displayed to end users.
Default template | Allows to create a toolbar with the structure of a default toolbar.
Locations | Specifies the locations where the toolbar can be used in associated datasets. Tabular view top: Defines the toolbar to use on top of the default table view. Tabular view row: Defines the toolbar to use on each row of the default table view. Tile view item: Defines the toolbar to use on each item of the tile view. Record top: Defines the toolbar to use in the record form. Hierarchy top: Defines the toolbar to use in the default hierarchy view of the table. Known limitations A toolbar defined to be used as "Tile view item" cannot have more than six items and it can only define action items. The display of those action buttons are always in mode "Icon only".

### Defining the structure of a toolbar

A toolbar can define the following elements:

- Action button

- Menu button

- Separator

- Menu group

- Action menu item

- Sub menu item

Add one of these elements under a toolbar or to an existing element by clicking on the arrow located to the right of the existing element, and by selecting a creation option in the menu. Then, follow the creation wizard to create an element.

#### Action button

This type of element allows to associate an action to a button in a toolbar. The action will be triggered when the user clicks on the associated button in one of the toolbars. A Action button type element defines the following information:

Target | Defines if the service is executed in the current context or in a web component. A service executed in a web component has no access to the current selection, but it is possible to specify a selection and specific parameters.
Service | Defines the service that will be executed when the user clicks on the button. It is possible to select a built-in service, or a user service defined in a module or in the current data model. If the 'Web component' target is selected, the service will have to be declared as available as a web component for toolbars. ##### See also `WebComponentDeclarationContext.setAvailableAsToolbarAction`
Modal size | Size of the modal window containing the web component.
Resizable | Indicates if the modal window can be resized.
Parameters | Service parameters. Those can be specified only if the target is set to 'Web component'. The following special values are also accepted and will be interpreted depending on the context while launching the service: ${current}, ${currentDataspaceOrSnapshot}, ${currentDataspace}, ${currentSnapshot}, ${currentDataset}, ${currentXpath}, ${currentNode} and ${currentPredicate}.
Label and description | Internationalized labels and descriptions to be displayed to end users.
Layout | Defines how this element will be displayed in datasets using the toolbar. It is possible to display: the icon only, the text only, text with the icon to the left or text with the icon to the right.
Icon | Icon to display. It is possible to use an icon to choose from a set of suggested icons, or to refer to an icon using a URL.
Is highlighted | Indicates if the button should be highlighted by default.

##### Note

A Action button type element can only be created under a toolbar type element.

#### Menu button

This type of element allows to define a menu that will be displayed when the user clicks on the associated button in a toolbar. An element of the Menu button type defines the following information:

Label and description | Internationalized labels and descriptions to be displayed to end users.
Layout | Defines how this element will be displayed in datasets using the toolbar. It is possible to display: the icon only, the text only, text with the icon to the left or text with the icon to the right.
Icon | Icon to display. It is possible to use an icon to choose from a set of suggested icons, or to refer to an icon using a URL.
Is highlighted | Indicates if the button should be highlighted by default.

##### Note

An element of the Menu button type can only be created under an element of the toolbar type.

#### Separator

This type of element allows to insert a separator in the form of spacing between two elements of a toolbar.

##### Note

An element of the Separator type can only be created under an element of the toolbar type.

#### Menu group

This type of element allows to define a group of elements in a menu. An element of the Menu group type defines the following information:

Label and description | Internationalized labels and descriptions to be displayed to end users.
Group type | Specifies the type of menu group to create: - 'Local' allows to create an empty fully customizable menu group. - 'Service group' allows to assign an existing service group to this menu group. - 'Menu builder' allows to assign a predefined menu content to this menu group. Once created, it is not possible to change the type of this menu group.
Service group name | Specifies an existing group of services to reuse. A group is declared in a module and can include other groups of services. All services contained in this group will be displayed to end users in associated datasets.
Menu builder name | Specifies the predefined menu content to assign to this menu group: - 'Default menu "Actions"' has the same content as the default toolbar 'Actions' menu. Standard and custom services are displayed without distinction. - 'Default menu "Actions" (with separator)' has the same menu content as above, but displays differently since standard and custom services are separated (standard services first, then custom services).
Excluded services | Indicates the services to exclude from the group of reused services. These services will not be displayed to end users in associated datasets.
Excluded service groups | Indicates the groups to exclude from the group of services to reuse. Services in excluded groups will not be displayed to end users in associated datasets.
Filtering policy | In case of "Smart filtering", services that are configured in direct access, i.e. via an action button or an action menu item, will be removed from the automatic generation of this group.

##### Note

An element of the Menu group type can only be created under the following elements:

- Menu button

- Sub menu item

#### Action menu item

This type of element allows to associate an action to a menu item in a toolbar. The action will be triggered when the user clicks on the corresponding item in a menu. An element of the Action menu item type defines the following information:

Label and description | Internationalized labels and descriptions to be displayed to end users.
Target | Defines if the service is executed in the current context or in a web component. A service executed in a web component has no access to the current selection, but it is possible to specify a selection and specific parameters.
Service | Defines the service that will be executed when the user clicks on the button. It is possible to select a built-in service, or a user service defined in a module or in the current data model. If the 'Web component' target is selected, the service will have to be declared as available as a web component for toolbars. ##### See also `WebComponentDeclarationContext.setAvailableAsToolbarAction`
Modal size | Size of the modal window containing the web component.
Resizable | Indicates if the modal window can be resized.
Parameters | Service parameters. Those can be specified only if the target is set to 'Web component'. The following special values are also accepted and will be interpreted depending on the context while launching the service: ${current}, ${currentDataspaceOrSnapshot}, ${currentDataspace}, ${currentSnapshot}, ${currentDataset}, ${currentXpath}, ${currentNode} and ${currentPredicate}.

##### Note

An element of the Action menu item type can only be created under a Menu group type element.

#### Sub menu item

This type of element allows to add a sub menu to a toolbar menu. Un Sub menu item defines the following information:

Label and description | Internationalized labels and descriptions to be displayed to end users.

##### Note

An element of the Sub menu item type can only be created under an element of the Menu group type.

### Deleting elements

All the elements of a toolbar can be deleted from it by using the arrow located to the right of the element to be deleted.

If an element containing other elements is deleted, then the deletion is recursively performed on all elements located below the deleted element.

### Duplicating existing elements

To duplicate an element, click on the arrow located to the right of the element to duplicate. Specify the name and properties of the duplicated element. All the source element properties are duplicated.

The duplicated element is added on the same level than the original element, in the final position. When an element containing other elements is duplicated, all the sub-elements are duplicated with their properties.

### Moving elements

In order to move an element, click on the arrow and select the moving option to be used.

### Associate with existing tables

To associate a toolbar with existing tables, click on the arrow located to the right of the toolbar and select the option Associate to tables. This service allows to set the toolbar has the default toolbar of several tables in one shot. To do so, specify the target locations of the toolbar and select the tables or complex data types, that define table properties, to be associated with the toolbar.

### Exporting the toolbars

It is possible to export the toolbars defined in the model into an XML document. To do so, select the XML export option available in the Actions menu of the 'Toolbars' section. Follow the wizard to export the toolbars.

##### Note

A selection of toolbars can be exported by selecting in the 'Toolbars' section the toolbars to be exported and then by selecting the XML export option available in the Actions menu. The toolbars can also be exported by using the data model export service. It can be found in the Data model 'Actions' menu in the navigation pane.

##### See also

- Data model import and export

### Importing toolbars

It is possible to import existing toolbars from an XML document. To do so, select the XML import option available in the Actions menu of the 'Toolbars' section. Then follow the wizard to import the toolbars.

##### Note

The toolbars can also be imported by using the data model import service accessible via the Data model 'Actions' menu in the navigation pane.

##### See also

- Data model import and export

##### See also

- Use of toolbars

User guide table of contents

TIBCO EBX® Documentation