Oxygen XML Editor 14.2 Author API

com.oxygenxml.editor.editors
Class ActionBarContributorCustomizer

java.lang.Object
  extended by com.oxygenxml.editor.editors.ActionBarContributorCustomizer

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

Abstract class allowed as an extension point to customize the menu and toolbar buttons added by our editors. In your plugin in the plugin.xml you should reference it like:

 
  <extension point="oxygen.plugin.id.actionBarContributorCustomizer">
     <implementation class="my.package.CustomActionBarContributorCustomizer"/>;
    </extension>

Since:
14.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.


Constructor Summary
ActionBarContributorCustomizer()
           
 
Method Summary
abstract  java.util.List<org.eclipse.jface.action.IAction> customizeActionsContributedToDocumentMenu(java.util.List<org.eclipse.jface.action.IAction> actions)
          Customize the actions before they are contributed to the main Document menu (XML or XSL, or XSD, etc).
abstract  java.util.List<org.eclipse.jface.action.IAction> customizeActionsContributedToDocumentToolbar(java.util.List<org.eclipse.jface.action.IAction> actions)
          Customize the actions before they are contributed to the main Document toolbar.
abstract  void customizeAuthorPageInternalCoolbar(org.eclipse.swt.widgets.CoolBar coolbar, WSAuthorEditorPage authorEditorPage)
          Customize an internal coolbar for a cetain author page.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActionBarContributorCustomizer

public ActionBarContributorCustomizer()
Method Detail

customizeActionsContributedToDocumentMenu

public abstract java.util.List<org.eclipse.jface.action.IAction> customizeActionsContributedToDocumentMenu(java.util.List<org.eclipse.jface.action.IAction> actions)
Customize the actions before they are contributed to the main Document menu (XML or XSL, or XSD, etc).

Parameters:
actions - The list of original actions.
Returns:
The list of modified actions.

customizeActionsContributedToDocumentToolbar

public abstract java.util.List<org.eclipse.jface.action.IAction> customizeActionsContributedToDocumentToolbar(java.util.List<org.eclipse.jface.action.IAction> actions)
Customize the actions before they are contributed to the main Document toolbar.

Parameters:
actions - The list of original actions.
Returns:
The list of modified actions.

customizeAuthorPageInternalCoolbar

public abstract void customizeAuthorPageInternalCoolbar(org.eclipse.swt.widgets.CoolBar coolbar,
                                                        WSAuthorEditorPage authorEditorPage)
Customize an internal coolbar for a cetain author page. This callback may be received more than once for the same document so please make sure that you do not add the same action twice.

Parameters:
coolbar - The internal coolbar after the fixed actions have been added.
authorEditorPage - The current author editor page.

Oxygen XML Editor 14.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.