Package com.diffplug.common.swt.jface

Class Actions

java.lang.Object

com.diffplug.common.swt.jface.Actions

public class Actions
extends Object

Provides a fluent interface for constructing actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Actions.Style	Style enum for various kinds of IAction.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	UC_ARROW_DOWN
static final String	UC_ARROW_LEFT
static final String	UC_ARROW_RIGHT
static final String	UC_ARROW_UP	Unicode for arrows.
static final String	UC_CMD	Unicode for the Mac cmd icon.

Method Summary

Modifier and Type	Method	Description
IAction	build()	Returns an action with the specified properties.
static Actions	builder()	Defaults to a push style with no text, accelerator, or action.
static Actions	builderCopy(IAction action)	Copies all behavior from the given action.
static IAction	create(String text, Runnable action)	Concise method for creating a push action.
static IAction	create(String text, ImageDescriptor image, int accelerator, Runnable action)	Concise method for creating a push action.
static IAction	create(String text, ImageDescriptor image, int accelerator, Listener listener)	Concise method for creating a push action.
static IAction	create(String text, ImageDescriptor image, Runnable action)	Concise method for creating a push action.
static IAction	create(String text, ImageDescriptor image, Listener listener)	Concise method for creating a push action.
static IAction	create(String text, Listener listener)	Concise method for creating a push action.
static String	getAcceleratorString(int accelerator)	Returns the given key accelerator as a string (including shift, control, command, etc).
static void	run(IAction action)	Updates the `isChecked()` property of the given IAction (if necessary), then calls IAction::run.
static void	run(IAction action, Event e)	Updates the `isChecked()` property of the given IAction (if necessary), then calls IAction::runWithEvent.
Actions	setAccelerator(int accelerator)	Sets the keyboard accelerator.
Actions	setCallback(BiConsumer<IAction,Event> callback)	Sets the callback to be the given BiConsumer.
Actions	setImage(ImageDescriptor img)	Sets the runnable.
Actions	setListener(Listener listener)	Sets the callback to be the given Listener.
Actions	setRunnable(Runnable run)	Sets the callback to be the given Runnable.
Actions	setStyle(Actions.Style style)	Sets the style.
Actions	setText(String text)	Sets the text and tooltip.
Actions	setTooltip(String tooltip)	Sets the tooltip.
static void	setToolTipAccelAware(IAction action, String tooltip)	Sets the tooltip text for the given action while remaing aware of its accelerator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

UC_ARROW_UP

public static final String UC_ARROW_UP

Unicode for arrows.

See Also:

• Constant Field Values

UC_ARROW_DOWN

public static final String UC_ARROW_DOWN

See Also:

• Constant Field Values

UC_ARROW_LEFT

public static final String UC_ARROW_LEFT

See Also:

• Constant Field Values

UC_ARROW_RIGHT

public static final String UC_ARROW_RIGHT

See Also:

• Constant Field Values

UC_CMD

public static final String UC_CMD

Unicode for the Mac cmd icon.

See Also:

• Constant Field Values

Method Details

create

public static IAction create(String text,
 Runnable action)

Concise method for creating a push action.

create

public static IAction create(String text,
 ImageDescriptor image,
 Runnable action)

Concise method for creating a push action.

create

public static IAction create(String text,
 ImageDescriptor image,
 int accelerator,
 Runnable action)

Concise method for creating a push action.

create

public static IAction create(String text,
 Listener listener)

Concise method for creating a push action.

create

public static IAction create(String text,
 ImageDescriptor image,
 Listener listener)

Concise method for creating a push action.

create

public static IAction create(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(String text)

Sets the text and tooltip.

setTooltip

public Actions setTooltip(String tooltip)

Sets the tooltip.

setStyle

public Actions setStyle(Actions.Style style)

Sets the style.

setRunnable

public Actions setRunnable(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(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.

setImage

public Actions setImage(ImageDescriptor img)

Sets the runnable.

build

public IAction build()

Returns an action with the specified properties.

setToolTipAccelAware

public static void setToolTipAccelAware(IAction action,
 String tooltip)

Sets the tooltip text for the given action while remaing aware of its accelerator.

getAcceleratorString

public static 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.