Oxygen XML Editor, Version ${standalone-version-number}

ro.sync.exml
Class ComponentsValidator

java.lang.Object
  extended by ro.sync.exml.ComponentsValidator

public abstract class ComponentsValidator
extends Object

Validator interface for menus, toolbars and their actions.


Field Summary
static String SEP
          Separator for menus and actions.
 
Constructor Summary
ComponentsValidator()
           
 
Method Summary
 String canonicalize(String[] path)
          Get a path from all the tags.
abstract  boolean isDebuggerPerspectiveAllowed()
          Check if the debugger perspective is allowed in the current distribution.
abstract  boolean validateAccelAction(String category, String tag)
          Check if the given accel action is allowed.
abstract  boolean validateComponent(String key)
          Check if the given component is allowed.
abstract  boolean validateContentType(String contentType)
          Validate the given content type.
abstract  boolean validateLibrary(String library)
          Validate the given library.
abstract  boolean validateMenuOrTaggedAction(String[] menuOrActionPath)
          Check if an menu or a tag action from a menu is allowed.
abstract  boolean validateNewEditorTemplate(EditorTemplate editorTemplate)
          Validate the given template for a new editor in the current distribution.
abstract  boolean validateOption(String optionKey)
          Validate the given option.
abstract  boolean validateOptionPane(String optionPaneKey)
          Validate the given option pane.
abstract  boolean validateSHMarker(String marker)
          Check if this marker is allowed in the current distribution.
abstract  boolean validateToolbarTaggedAction(String[] toolbarOrAction)
          Check if an action from a toolbar is allowed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEP

public static final String SEP
Separator for menus and actions.

See Also:
Constant Field Values
Constructor Detail

ComponentsValidator

public ComponentsValidator()
Method Detail

validateMenuOrTaggedAction

public abstract boolean validateMenuOrTaggedAction(String[] menuOrActionPath)
Check if an menu or a tag action from a menu is allowed.

Parameters:
menuOrActionPath - The tag of the menu/action and the tags of its parent menus if any.
Returns:
true if the action is allowed.

validateToolbarTaggedAction

public abstract boolean validateToolbarTaggedAction(String[] toolbarOrAction)
Check if an action from a toolbar is allowed.

Parameters:
toolbarOrAction - The tag of the action from a toolbar and the tag of its parent toolbar if any.
Returns:
true if the action is allowed.

validateComponent

public abstract boolean validateComponent(String key)
Check if the given component is allowed.

Parameters:
key - Tag identifying the view. Usually one of the constants from MainFrameComponentProvider
Returns:
true if the view is allowed.

validateAccelAction

public abstract boolean validateAccelAction(String category,
                                            String tag)
Check if the given accel action is allowed. An accel action can be uniquely identified so it doesn't matter if it is from a toolbar or menu.

Parameters:
category - The category of the action.
tag - The tag of the action.
Returns:
true if the action is allowed.

validateContentType

public abstract boolean validateContentType(String contentType)
Validate the given content type.

Parameters:
contentType - The content type. A constant from ContentTypes interface.
Returns:
true if in the current distribution we support the given content type.

validateOptionPane

public abstract boolean validateOptionPane(String optionPaneKey)
Validate the given option pane.

Parameters:
optionPaneKey - The option pane key. A constant defined in OptionTags.
Returns:
true if in the current distribution we should add the given option pane in the option tree.

validateOption

public abstract boolean validateOption(String optionKey)
Validate the given option.

Parameters:
optionKey - The option key. A constant defined in OptionTags.
Returns:
true if in the current distribution we should add the given option in the option page.

validateLibrary

public abstract boolean validateLibrary(String library)
Validate the given library.

Parameters:
library - The library.
Returns:
true if in the current distribution we should add the given library in the about dialog.

validateNewEditorTemplate

public abstract boolean validateNewEditorTemplate(EditorTemplate editorTemplate)
Validate the given template for a new editor in the current distribution.

Parameters:
editorTemplate - The editor template.
Returns:
true if it is allowed.

isDebuggerPerspectiveAllowed

public abstract boolean isDebuggerPerspectiveAllowed()
Check if the debugger perspective is allowed in the current distribution.

Returns:
true if the debugger functionality is allowed.

validateSHMarker

public abstract boolean validateSHMarker(String marker)
Check if this marker is allowed in the current distribution.

Parameters:
marker - The marker to be checked. A constant from SHMarker class.
Returns:
true if the marker is allowed.

canonicalize

public String canonicalize(String[] path)
Get a path from all the tags.

Parameters:
path - The tags for the action/menu/toolbar and its menu/toolbar ancestors.
Returns:
A path that can be used to identify it.

Oxygen XML Editor, Version ${standalone-version-number}

© Copyright Syncro Soft SRL 2002 - 2010.