ro.sync.exml.workspace.api.standalone.actions

Class MenusAndToolbarsContributorCustomizer

java.lang.Object

ro.sync.exml.workspace.api.standalone.actions.MenusAndToolbarsContributorCustomizer

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class MenusAndToolbarsContributorCustomizer
extends java.lang.Object

Abstract class allowed as an extension point to customize the menu and toolbar buttons added by our editors.

Since:

18

Constructor Summary

Constructors

Constructor and Description
MenusAndToolbarsContributorCustomizer()

Method Summary

Modifier and Type	Method and Description
void	customizeAuthorBreadcrumbPopUpMenu(javax.swing.JPopupMenu popUp, AuthorAccess authorAccess, AuthorNode currentNode) Customize a pop-up menu about to be shown in the Author page Breadcrumb (current elements path) toolbar.
void	customizeAuthorOutlinePopUpMenu(javax.swing.JPopupMenu popUp, AuthorAccess authorAccess) Customize a pop-up menu about to be shown in the Author page Outline view.
void	customizeAuthorPageExtensionMenu(javax.swing.JMenu extensionMenu, AuthorAccess authorAccess) Customize an extension main menu contributed by the Author page document type configuration.
void	customizeAuthorPageExtensionToolbar(ToolbarInfo toolbarInfo, AuthorAccess authorAccess) Customize an extension toolbar contributed by the Author page document type configuration.
void	customizeAuthorPopUpMenu(javax.swing.JPopupMenu popUp, AuthorAccess authorAccess) Customize a pop-up menu in the Author page before showing it.
void	customizeDITAMapPopUpMenu(javax.swing.JPopupMenu popUp, WSDITAMapEditorPage ditaMapEditorPage) Customize a pop-up menu in the DITA Maps Manager page before showing it.
void	customizeDITAMapsManagerExtendedToolbar(ToolbarInfo toolbarInfo) Customize the DITA Maps Manager extended toolbar.
void	customizeDITAMapsManagerMainToolbar(ToolbarInfo toolbarInfo) Customize the DITA Maps Manager main toolbar.
void	customizeEditorTabPopUpMenu(javax.swing.JPopupMenu popUpMenu, WSEditor editor) Customize the pop-up menu shown when right-clicking the tab of an editor (where the filename is presented).
void	customizeTextPopUpMenu(javax.swing.JPopupMenu popUp, WSTextEditorPage textPage) Customize a pop-up menu in the Text page before showing it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MenusAndToolbarsContributorCustomizer

public MenusAndToolbarsContributorCustomizer()

Method Detail

customizeAuthorPageExtensionMenu

public void customizeAuthorPageExtensionMenu(javax.swing.JMenu extensionMenu,
                                             AuthorAccess authorAccess)

Customize an extension main menu contributed by the Author page document type configuration. For example DITA, Docbook, etc...

Parameters:

extensionMenu - The extension menu.

authorAccess - Access class to the author functions.

customizeAuthorPageExtensionToolbar

public void customizeAuthorPageExtensionToolbar(ToolbarInfo toolbarInfo,
                                                AuthorAccess authorAccess)

Customize an extension toolbar contributed by the Author page document type configuration. The toolbar will be included in the Author-specific toolbar. An extension toolbar contains actions belonging to the specific support the application offers for a certain vocabulary.

Parameters:

toolbarInfo - Information about toolbar components.

authorAccess - Access class to the author functions.

customizeDITAMapsManagerExtendedToolbar

public void customizeDITAMapsManagerExtendedToolbar(ToolbarInfo toolbarInfo)

Customize the DITA Maps Manager extended toolbar.

Parameters:

toolbarInfo - The toolbar information.

customizeDITAMapsManagerMainToolbar

public void customizeDITAMapsManagerMainToolbar(ToolbarInfo toolbarInfo)

Customize the DITA Maps Manager main toolbar.

Parameters:

toolbarInfo - The toolbar components information.

customizeAuthorPopUpMenu

public void customizeAuthorPopUpMenu(javax.swing.JPopupMenu popUp,
                                     AuthorAccess authorAccess)

Customize a pop-up menu in the Author page before showing it. By default this method gets called for both the contextual menu shown in the main editing area, shown in the Outline view or shown in the Breadcrumb. If everything is removed then the menu will not be shown.

Parameters:

popUp - The pop-up Menu.

authorAccess - Access class to the author functions.

customizeAuthorOutlinePopUpMenu

public void customizeAuthorOutlinePopUpMenu(javax.swing.JPopupMenu popUp,
                                            AuthorAccess authorAccess)

Customize a pop-up menu about to be shown in the Author page Outline view. If everything is removed then the menu will not be shown.

Parameters:

popUp - The pop-up Menu.

authorAccess - Access class to the author functions.

Since:

18.1

customizeAuthorBreadcrumbPopUpMenu

public void customizeAuthorBreadcrumbPopUpMenu(javax.swing.JPopupMenu popUp,
                                               AuthorAccess authorAccess,
                                               AuthorNode currentNode)

Customize a pop-up menu about to be shown in the Author page Breadcrumb (current elements path) toolbar. If everything is removed then the menu will not be shown.

Parameters:

popUp - The pop-up Menu.

authorAccess - Access class to the author functions.

currentNode - The current node on which the popup is shown.

Since:

18.1

customizeTextPopUpMenu

public void customizeTextPopUpMenu(javax.swing.JPopupMenu popUp,
                                   WSTextEditorPage textPage)

Customize a pop-up menu in the Text page before showing it. If everything is removed then the menu will not be shown.

Parameters:

popUp - The pop-up Menu.

textPage - The page over which the pop-up will be presented.

customizeDITAMapPopUpMenu

public void customizeDITAMapPopUpMenu(javax.swing.JPopupMenu popUp,
                                      WSDITAMapEditorPage ditaMapEditorPage)

Customize a pop-up menu in the DITA Maps Manager page before showing it. If everything is removed then the menu will not be shown.

Parameters:

popUp - The pop-up Menu.

ditaMapEditorPage - The DITA Map editor page access.

customizeEditorTabPopUpMenu

public void customizeEditorTabPopUpMenu(javax.swing.JPopupMenu popUpMenu,
                                        WSEditor editor)

Customize the pop-up menu shown when right-clicking the tab of an editor (where the filename is presented). Editor tabs from both the main editing area and the DITA Maps Manager are taken into account.

Parameters:

popUpMenu - The pop-up menu to customize.

editor - The current editor, on whose tab the pop-up menu has been invoked.

Since:

19.1