Class ResourceAction

All Implemented Interfaces:
IAction
Direct Known Subclasses:
FindNextAction, FindReplaceAction, IncrementalFindAction, MarkerRulerAction, RetargetTextEditorAction, SelectMarkerRulerAction, TextEditorAction

public abstract class ResourceAction extends Action
An action which configures its label, image, tooltip, and description from a resource bundle using known keys.

Clients may subclass this abstract class to define new kinds of actions. As with Action, subclasses must implement the IAction.run method to carry out the action's semantics.

  • Constructor Details

    • ResourceAction

      public ResourceAction(ResourceBundle bundle, String prefix, int style)
      Creates a new action that configures itself from the given resource bundle.

      The following keys, prepended by the given option prefix, are used for retrieving resources from the given bundle:

      • "label" - setText
      • "tooltip" - setToolTipText
      • "image" - setImageDescriptor
      • "description" - setDescription
      Parameters:
      bundle - the resource bundle
      prefix - a prefix to be prepended to the various resource keys, or null if none
      style - one of IAction.AS_PUSH_BUTTON, IAction.AS_CHECK_BOX, and IAction.AS_RADIO_BUTTON.
      Since:
      2.1
      See Also:
    • ResourceAction

      public ResourceAction(ResourceBundle bundle, String prefix)
      Creates a new action that configures itself from the given resource bundle.

      The following keys, prepended by the given option prefix, are used for retrieving resources from the given bundle:

      • "label" - setText
      • "tooltip" - setToolTipText
      • "image" - setImageDescriptor
      • "description" - setDescription
      Parameters:
      bundle - the resource bundle
      prefix - a prefix to be prepended to the various resource keys, or null if none
  • Method Details

    • getString

      protected static String getString(ResourceBundle bundle, String key, String defaultValue)
      Retrieves and returns the value with the given key from the given resource bundle, or returns the given default value if there is no such resource. Convenience method for dealing gracefully with missing resources.
      Parameters:
      bundle - the resource bundle
      key - the resource key
      defaultValue - the default value, or null
      Returns:
      the resource value, or the given default value (which may be null)
    • setHelpContextId

      public final void setHelpContextId(String contextId)
      Sets the action's help context id.
      Parameters:
      contextId - the help context id
    • initialize

      protected void initialize(ResourceBundle bundle, String prefix)
      Initializes this action using the given bundle and prefix.
      Parameters:
      bundle - the resource bundle
      prefix - a prefix to be prepended to the various resource keys, or null if none
      Since:
      2.1