Package ro.sync.exml

Class ComponentsValidator

java.lang.Object
ro.sync.exml.ComponentsValidator
@API(type=EXTENDABLE, src=PUBLIC) public abstract class ComponentsValidator extends Object
Validator interface for menus, toolbars and their actions.

  • Field Details

  • Constructor Details

    • ComponentsValidator

      public ComponentsValidator()

  • Method Details

    • 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. The last component is the current one. A menu path is an array of Strings representing the Tags, ending with the current menu tag, or null.
      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.

    • validateToolbarComposite

      public boolean validateToolbarComposite(String toolbarCompositeTag)
      Checks if the toolbar composite is available. A toolbar composite is a toolbar component such as a drop-down list.
      Parameters:
      toolbarCompositeTag - The tag of the toolbar composite.
      Returns:
      true if the toolbar composite is allowed.
      Since:
      17

    • 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. Also see isPerspectiveAllowed(String).
      Returns:
      true if the debugger functionality is allowed.

    • isPerspectiveAllowed

      public boolean isPerspectiveAllowed(String perspID)
      Check if the perspective with the given ID is allowed. Also see isDebuggerPerspectiveAllowed().
      Parameters:
      perspID - Perspective ID. See the constants from UIPerspectives.
      Returns:
      true if the perspective is allowed.
      Since:
      22

    • 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.

    • validateEditorPage

      public boolean validateEditorPage(String pageID)
      Check if the page is available for a certain distribution
      Parameters:
      pageID - The page ID
      Returns:
      true if the editor page is available.
      Since:
      16

    • 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.

    • isMasterFilesSupportAvailable

      public boolean isMasterFilesSupportAvailable()
      Return true if main files support is available or not.
      Returns:
      Return true if main files support is available or not.

    • validateScenario

      public boolean validateScenario(String scenarioType)
      Validate scenario type for the current distribution.
      Parameters:
      scenarioType - The scenario type.
      Returns:
      true if the scenario is allowed, false otherwise.
      Since:
      26.1