public abstract class AbstractAction extends java.lang.Object implements Action
Action.ActionPerformedEvent, Action.BeforeActionPerformedHandler, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction, Action.Status
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
caption |
protected java.lang.String |
description |
protected boolean |
enabled |
protected EventHub |
eventHub |
protected java.lang.String |
icon |
protected java.lang.String |
id |
protected java.util.List<ActionOwner> |
owners |
protected boolean |
primary |
protected KeyCombination |
shortcut |
protected boolean |
visible |
PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE
Modifier | Constructor and Description |
---|---|
protected |
AbstractAction() |
protected |
AbstractAction(java.lang.String id) |
protected |
AbstractAction(java.lang.String id,
Action.Status status) |
protected |
AbstractAction(java.lang.String id,
java.lang.String shortcut) |
Modifier and Type | Method and Description |
---|---|
void |
addOwner(ActionOwner actionOwner)
Add an owner component.
|
void |
addPropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent> listener)
Adds a listener to be notified about Enabled, Caption or Icon property changes.
|
protected void |
firePropertyChange(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue) |
java.lang.String |
getCaption() |
protected java.lang.String |
getDefaultCaption() |
java.lang.String |
getDescription() |
protected EventHub |
getEventHub() |
java.lang.String |
getIcon() |
java.lang.String |
getId() |
ActionOwner |
getOwner() |
java.util.Collection<ActionOwner> |
getOwners() |
KeyCombination |
getShortcutCombination() |
protected boolean |
hasSubscriptions(java.lang.Class<?> eventClass) |
boolean |
isEnabled() |
boolean |
isPrimary() |
boolean |
isVisible() |
void |
refreshState()
Refresh internal state of the action to initialize enabled, visible, caption, icon, etc.
|
void |
removeOwner(ActionOwner actionOwner)
Remove an owner component.
|
void |
removePropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent> listener)
Removes a listener.
|
void |
setCaption(java.lang.String caption) |
void |
setDescription(java.lang.String description) |
void |
setEnabled(boolean enabled) |
void |
setIcon(java.lang.String icon) |
void |
setIconFromSet(Icons.Icon icon)
Set an icon from an icon set.
|
void |
setPrimary(boolean primary)
Sets whether action is primary or not.
|
void |
setShortcut(java.lang.String shortcut)
Set shortcut from string representation.
|
void |
setShortcutCombination(KeyCombination shortcut) |
void |
setVisible(boolean visible) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
actionPerform
protected java.lang.String id
protected java.lang.String caption
protected java.lang.String description
protected java.lang.String icon
protected boolean enabled
protected boolean visible
protected java.util.List<ActionOwner> owners
protected KeyCombination shortcut
protected boolean primary
protected EventHub eventHub
protected AbstractAction()
protected AbstractAction(java.lang.String id)
protected AbstractAction(java.lang.String id, @Nullable java.lang.String shortcut)
protected AbstractAction(java.lang.String id, Action.Status status)
protected EventHub getEventHub()
protected boolean hasSubscriptions(java.lang.Class<?> eventClass)
public java.lang.String getId()
public java.lang.String getCaption()
getCaption
in interface Action
protected java.lang.String getDefaultCaption()
public void setCaption(java.lang.String caption)
setCaption
in interface Action
public java.lang.String getDescription()
getDescription
in interface Action
public void setDescription(java.lang.String description)
setDescription
in interface Action
public KeyCombination getShortcutCombination()
getShortcutCombination
in interface Action
public void setShortcutCombination(KeyCombination shortcut)
setShortcutCombination
in interface Action
public void setShortcut(java.lang.String shortcut)
Action
setShortcut
in interface Action
shortcut
- string of type "Modifiers-Key", e.g. "Alt-N". Case-insensitive.public java.lang.String getIcon()
public void setIconFromSet(Icons.Icon icon)
Action
setIconFromSet
in interface Action
public boolean isEnabled()
public void setEnabled(boolean enabled)
setEnabled
in interface Action
public boolean isVisible()
public void setVisible(boolean visible)
setVisible
in interface Action
public java.util.Collection<ActionOwner> getOwners()
public ActionOwner getOwner()
public void addOwner(ActionOwner actionOwner)
Action
public void removeOwner(ActionOwner actionOwner)
Action
removeOwner
in interface Action
actionOwner
- owner componentpublic void addPropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent> listener)
Action
addPropertyChangeListener
in interface Action
listener
- a listener objectpublic void removePropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent> listener)
Action
removePropertyChangeListener
in interface Action
listener
- a listener objectAction.addPropertyChangeListener(java.util.function.Consumer<java.beans.PropertyChangeEvent>)
protected void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
public void refreshState()
Action
refreshState
in interface Action
public boolean isPrimary()
public void setPrimary(boolean primary)
primary
- primary