Interface ActionBindingsDescriptor

public interface ActionBindingsDescriptor
An interface that allows the KeyBindingsModel API to provide key and mouse binding information to clients, without having to have a registered action to provide the information. Action descriptions will be loaded from the saved tool options. If no plugin has registered an action for the current tool session, then the an unregistered action descriptor will get created when editing key and mouse bindings via the options UI.

  • Method Details

    • getName

      String getName()
      Returns the action name without the owner.
      Returns:
      the action name without the owner

    • getFullName

      String getFullName()
      Returns the full action name in the format: 'Name (Owner)'.
      Returns:
      the full action name in the format: 'Name (Owner)'

    • getOwnerDescription

      String getOwnerDescription()
      Returns the owner name(s) of the action.
      Returns:
      the owner name(s) of the action

    • getDescription

      String getDescription()
      Returns the action description or a blank string.
      Returns:
      the action description or a blank string

    • getBindingText

      String getBindingText()
      Returns a string that shows all key and mouse binding info for the action.
      Returns:
      a string that shows all key and mouse binding info for the action

    • getRepresentativeAction

      DockingActionIf getRepresentativeAction()
      The action for the binding. This will be an arbitrary action for shared bindings. This will be null if this class represents an unregistered action.
      Returns:
      an action or null

    • isRegistered

      boolean isRegistered()
      Returns true if a plugin has registered an action for this descriptor; false is no action has been registered.
      Returns:
      true if a plugin has registered an action for this descriptor; false is no action has been registered