ro.sync.exml.workspace.api.standalone

Interface ToolbarComponentsCustomizer

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface ToolbarComponentsCustomizer

Customizes components for the toolbar

Since:

11.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOM Deprecated. Since Oxygen 12.2 toolbar IDs are defined in the "plugin.xml".

Method Summary

Modifier and Type	Method and Description
void	customizeToolbar(ToolbarInfo toolbarInfo) Customize the components which get displayed on a certain toolbar.

Field Detail

CUSTOM

@Deprecated
static final java.lang.String CUSTOM

Deprecated. Since Oxygen 12.2 toolbar IDs are defined in the "plugin.xml".

The reserved plugins toolbar ID

See Also:

Constant Field Values

Method Detail

customizeToolbar

void customizeToolbar(ToolbarInfo toolbarInfo)

Customize the components which get displayed on a certain toolbar.
NOTICE You will also receive notification for the Author extension toolbars (which are dynamically constructed based on the document type of the current selected XML file). The notifications will be received before the toolbars are constructed after an XML editor which is opened in the Author page was selected. Such toolbar IDs have the prefix "Author_custom_actions" and the suffix is a number depending on how many toolbars were created for that specific document type. In this way you can dynamically filter or add to toolbar buttons already declared in the document type associated to the XML editor.
NOTICE Notifications will arrive for the Dita Map Manager toolbars too. These toolbars have the IDs:

• MainFrameComponentsConstants.TOOLBAR_DITA_MAP_GLOBAL
• MainFrameComponentsConstants.TOOLBAR_DITA_MAP_EXTEND
• MainFrameComponentsConstants.TOOLBAR_DITA_MAP_CUSTOM

Parameters:

toolbarInfo - Information about the toolbar (id, default components to add, title). The toolbar ID is either the ID of an existing Oxygen toolbar or the reserved CUSTOM toolbar. All Oxygen toolbars IDs are found in MainFrameComponentsConstants and begin with TOOLBAR_ prefix. You can set new components in the toolbar and change its title.