org.gnu.gtk
public class Action extends GObject
Actions represent operations that the user can be perform, along with some information how it should be presented in the interface. Each action provides methods to create icons, menu items and toolbar items representing itself.
As well as the callback that is called when the action gets activated, the following also gets associated with the action:
a name (not translated, for path lookup)
a label (translated, for display)
an accelerator
whether label indicates a stock id
a tooltip (optional, translated)
a toolbar label (optional, shorter than label)
The action will also have some state information:
visible (shown/hidden)
sensitive (enabled/disabled)
Apart from regular actions, there are {@link ToggleAction}, which can be toggled between two states and {@link RadioAction}, of which only one in a group can be in the "active" state. Other actions can be implemented as {@link Action} subclasses.
Each action can have one or more proxy menu item, toolbar button or other proxy widgets. Proxies mirror the state of the action (text label, tooltip, icon, visible, sensitive, etc), and should change when the action's state changes. When the proxy is activated, it should activate its action.
Constructor Summary | |
---|---|
Action(String name, String label, String tooltip, String stockId)
Construct a new Action object. |
Method Summary | |
---|---|
void | activate()
Emits the "activate" signal on the specified action, if it isn't
insensitive. |
void | addListener(ActionListener listener)
Register an object to receive action activation event notification.
|
void | connectAccelerator()
Installs the accelerator for action if action has an accel path and
group. |
void | connectProxy(Widget proxy)
Connects a widget to an action object as a proxy. |
Widget | createIcon(IconSize iconSize)
This function is intended for use by action implementations to create
icons displayed in the proxy widgets.
|
Widget | createMenuItem()
Creates a menu item widget that proxies for the given action.
|
Widget | createToolItem()
Creates a toolbar item widget that proxies for the given action.
|
void | disconnectAccelerator()
Undoes the effect of one call to {@link Action#connectAccelerator()}. |
void | disconnectProxy(Widget proxy)
Disconnects a proxy widget from an action. |
String | getAcceleratorPath() |
String | getName()
Returns the name of the action.
|
List | getProxies()
Returns the proxy widgets for an action.
|
static Type | getType()
Retrieve the runtime type used by the GLib library. |
boolean | isSensitive() |
boolean | isVisible() |
void | removeListener(ActionListener listener)
Unregister an object that was receiving focus event notification.
|
void | setAccelGroup(AccelGroup group)
Sets the {@link org.gnu.gtk.AccelGroup} in which the accelerator for this
action will be installed.
|
void | setAccelPath(String path)
Sets the accel path for this action. |
void | setSensitive(boolean sensitive) |
void | setVisible(boolean visible) |
Parameters: listener The object that has implemented the ActionListener interface that is to receive the activation events.
Since: 2.8
Parameters: proxy the proxy widget
Parameters: iconSize the size of the icon that should be created
Returns: a widget that displays the icon for this action
Returns: a menu item connected to the action
Returns: a toolbar item connected to the action
Parameters: proxy the proxy widget
Returns: the name of the action
Returns: a List of proxy widgets
Parameters: listener The object that is to no longer receive focus events.
Since: 2.8
Parameters: group an AccelGroup or null
Since: 2.8
Parameters: path The accelerator path
Since: 2.8