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 java.lang.String ACTION_ID
      The ID of the action as specified when the action was configured in the framework.
      static java.lang.String ACTION_NAME
      The name of the action as specified when the action was configured in the framework.
      static java.lang.String DESCRIPTION
      A short description for the action.
      static java.lang.String LARGE_ICON_PATH
      The path for a large icon associated with the action.
      static java.lang.String SMALL_ICON_PATH
      The absolute path for a small icon associated with the action.

    • Field Detail

      • ACTION_ID

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

      • ACTION_NAME

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

      • SMALL_ICON_PATH

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

      • LARGE_ICON_PATH

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

      • DESCRIPTION

        static final java.lang.String DESCRIPTION
        A short description for the action.
        See Also:
        Constant Field Values

    • Method Detail

      • getValue

        java.lang.Object getValue​(java.lang.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.