Package ro.sync.ecss.extensions.api.editor

Interface IAuthorExtensionAction

All Known Subinterfaces:
AuthorExtensionAskAction
@API(type=EXTENDABLE, src=PUBLIC) public interface IAuthorExtensionAction
An author action created over an author operation. These actions are configured in the associated document type of the current document.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ACTION_ID
    The ID of the action as specified when the action was configured in the framework.
    static final String
    ACTION_NAME
    The name of the action as specified when the action was configured in the framework.
    static final String
    DESCRIPTION
    A short description for the action.
    static final String
    LARGE_ICON_PATH
    The path for a large icon associated with the action.
    static final String
    SMALL_ICON_PATH
    The absolute path for a small icon associated with the action.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getValue(String property)
    Gets the value for the given property.
    void
    performAction()
    Perform the action.
    void
    performAction(int imposedActionOffset)
    Perform the action.

  • Field Details

    • ACTION_ID

      static final String ACTION_ID
      The ID of the action as specified when the action was configured in the framework.
      See Also:

    • ACTION_NAME

      static final String ACTION_NAME
      The name of the action as specified when the action was configured in the framework.
      See Also:

    • SMALL_ICON_PATH

      static final String SMALL_ICON_PATH
      The absolute path for a small icon associated with the action. Can contain editor variables.
      See Also:

    • LARGE_ICON_PATH

      static final String LARGE_ICON_PATH
      The path for a large icon associated with the action. can contain editor variables.
      See Also:

    • DESCRIPTION

      static final String DESCRIPTION
      A short description for the action.
      See Also:

  • Method Details

    • getValue

      Object getValue(String property)
      Gets the value for the given property.
      Parameters:
      property - The property to get the value.
      Returns:
      The value for the property.

    • performAction

      void performAction()
      Perform the action.

    • performAction

      void performAction(int imposedActionOffset)
      Perform the action.
      Parameters:
      imposedActionOffset - The imposed offset where the action should take place.