|
Oxygen XML Editor, Version ${standalone-version-number} | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.exml.ComponentsValidator
public abstract class ComponentsValidator
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 |
---|
public static final String SEP
Constructor Detail |
---|
public ComponentsValidator()
Method Detail |
---|
public abstract boolean validateMenuOrTaggedAction(String[] menuOrActionPath)
menuOrActionPath
- The tag of the menu/action and the tags of its parent menus if any.
true
if the action is allowed.public abstract boolean validateToolbarTaggedAction(String[] toolbarOrAction)
toolbarOrAction
- The tag of the action from a toolbar and the tag of
its parent toolbar if any.
true
if the action is allowed.public abstract boolean validateComponent(String key)
key
- Tag identifying the view. Usually one of the constants from MainFrameComponentProvider
true
if the view is allowed.public abstract boolean validateAccelAction(String category, String tag)
category
- The category of the action.tag
- The tag of the action.
true
if the action is allowed.public abstract boolean validateContentType(String contentType)
contentType
- The content type. A constant from ContentTypes interface.
true
if in the current distribution we support the given content type.public abstract boolean validateOptionPane(String optionPaneKey)
optionPaneKey
- The option pane key. A constant defined in OptionTags.
true
if in the current distribution we should add the given option pane
in the option tree.public abstract boolean validateOption(String optionKey)
optionKey
- The option key. A constant defined in OptionTags.
true
if in the current distribution we should add the given option
in the option page.public abstract boolean validateLibrary(String library)
library
- The library.
true
if in the current distribution we should add the given library
in the about dialog.public abstract boolean validateNewEditorTemplate(EditorTemplate editorTemplate)
editorTemplate
- The editor template.
true
if it is allowed.public abstract boolean isDebuggerPerspectiveAllowed()
true
if the debugger functionality is allowed.public abstract boolean validateSHMarker(String marker)
marker
- The marker to be checked. A constant from SHMarker class.
true
if the marker is allowed.public String canonicalize(String[] path)
path
- The tags for the action/menu/toolbar and its menu/toolbar ancestors.
|
Oxygen XML Editor, Version ${standalone-version-number} | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |