Class Actions


  • public class Actions
    extends java.lang.Object
    Provides a fluent interface for constructing actions.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Actions.Style
      Style enum for various kinds of IAction.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String UC_ARROW_DOWN  
      static java.lang.String UC_ARROW_LEFT  
      static java.lang.String UC_ARROW_RIGHT  
      static java.lang.String UC_ARROW_UP
      Unicode for arrows.
      static java.lang.String UC_CMD
      Unicode for the Mac cmd icon.
    • Method Detail

      • create

        public static IAction create​(java.lang.String text,
                                     java.lang.Runnable action)
        Concise method for creating a push action.
      • create

        public static IAction create​(java.lang.String text,
                                     ImageDescriptor image,
                                     java.lang.Runnable action)
        Concise method for creating a push action.
      • create

        public static IAction create​(java.lang.String text,
                                     ImageDescriptor image,
                                     int accelerator,
                                     java.lang.Runnable action)
        Concise method for creating a push action.
      • create

        public static IAction create​(java.lang.String text,
                                     Listener listener)
        Concise method for creating a push action.
      • create

        public static IAction create​(java.lang.String text,
                                     ImageDescriptor image,
                                     Listener listener)
        Concise method for creating a push action.
      • create

        public static IAction create​(java.lang.String text,
                                     ImageDescriptor image,
                                     int accelerator,
                                     Listener listener)
        Concise method for creating a push action.
      • builder

        public static Actions builder()
        Defaults to a push style with no text, accelerator, or action.
      • builderCopy

        public static Actions builderCopy​(IAction action)
        Copies all behavior from the given action.
      • setText

        public Actions setText​(java.lang.String text)
        Sets the text and tooltip.
      • setTooltip

        public Actions setTooltip​(java.lang.String tooltip)
        Sets the tooltip.
      • setRunnable

        public Actions setRunnable​(java.lang.Runnable run)
        Sets the callback to be the given Runnable.
      • setListener

        public Actions setListener​(Listener listener)
        Sets the callback to be the given Listener. It may receive a null event.
      • setCallback

        public Actions setCallback​(java.util.function.BiConsumer<IAction,​Event> callback)
        Sets the callback to be the given BiConsumer. Action will definitely be present, but event might be missing.
      • setAccelerator

        public Actions setAccelerator​(int accelerator)
        Sets the keyboard accelerator.
      • build

        public IAction build()
        Returns an action with the specified properties.
      • setToolTipAccelAware

        public static void setToolTipAccelAware​(IAction action,
                                                java.lang.String tooltip)
        Sets the tooltip text for the given action while remaing aware of its accelerator.
      • getAcceleratorString

        public static java.lang.String getAcceleratorString​(int accelerator)
        Returns the given key accelerator as a string (including shift, control, command, etc).
      • run

        public static void run​(IAction action)
        Updates the `isChecked()` property of the given IAction (if necessary), then calls IAction::run.
      • run

        public static void run​(IAction action,
                               Event e)
        Updates the `isChecked()` property of the given IAction (if necessary), then calls IAction::runWithEvent.