public abstract class ToggleAction
extends javax.swing.AbstractAction
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACCELERATOR |
static java.lang.String |
ACTION
Deprecated.
|
static java.lang.String |
ACTION_MENU_ACTIONS |
static java.lang.String |
ACTION_MENU_HAS_DEFAULT_ACTION |
static java.lang.String |
BUTTON_GROUP_NAME |
static java.lang.String |
CAN_BE_PLACED_ON_MAIN_TOOLBAR
Key ("CanBePlacedOnMainToolbar") used to set whether or not an action can be added
to the Main Window toolbar where it is globally accessible.
|
static java.lang.String |
CATEGORY
The category is used in the shortcuts configuration panel to subdivide
the list of actions.
|
static java.lang.String |
CONTEXT_INDEPENDENT_NAME
The CONTEXT_INDEPENDENT_NAME should be used when the NAME property is
context dependent as "Build Project1.jpr".
|
static java.lang.String |
DISABLED_ICON |
static java.lang.String |
HIDDEN |
static java.lang.String |
MENU_WEIGHT |
static float |
MENU_WEIGHT_UNASSIGNED |
static java.lang.String |
MNEMONIC
Deprecated.
use
Action.MNEMONIC_KEY . |
protected static boolean |
PERFORM_ACTION_LATER
Deprecated.
since 11.1.1 with no replacement.
|
static java.lang.String |
RADIO |
static java.lang.String |
STATE |
static java.lang.String |
TOGGLES |
static java.lang.String |
USER_DATA |
Modifier | Constructor and Description |
---|---|
|
ToggleAction(java.lang.String name,
ArrayResourceBundle bundle,
int key)
Construct a ToggleAction with the specified description String whose Icon
can be lazily fetched from the specified ResourceBundle using the specified
key.
|
|
ToggleAction(java.lang.String name,
javax.swing.Icon icon)
Construct a ToggleAction with the specified description and Icon.
|
|
ToggleAction(java.lang.String name,
java.util.ResourceBundle bundle,
java.lang.String iconPath)
Construct a ToggleAction with the specified description String whose Icon
can be lazily fetched when needed from the specified ResourceBundle using
the specified key.
|
protected |
ToggleAction(ToggleAction action) |
Modifier and Type | Method and Description |
---|---|
void |
addPropertyResolver(PropertyResolver resolver)
Add a resolver for properties on this action.
|
protected static void |
freezeKeyboard(boolean freeze) |
protected boolean |
getBooleanValue(java.lang.String key) |
float |
getMenuWeight()
Returns the menu weight for this action.
|
boolean |
getState() |
java.lang.Object |
getValue(java.lang.String key) |
boolean |
isActionMenu() |
boolean |
isRadio() |
boolean |
isToggle() |
void |
listenForItemEvent(javax.swing.AbstractButton button) |
void |
putValue(java.lang.String key,
java.lang.Object newValue) |
void |
removePropertyResolver(PropertyResolver resolver)
Remove a resolver previously added to this action via
addPropertyResolver( PropertyResolver ) . |
protected void |
setBooleanValue(java.lang.String key,
boolean newValue) |
void |
setMenuWeight(float weight)
Sets the menu weight for this action.
|
void |
setName(java.lang.String name)
Sets the menu name (Action.NAME) strips out and sets the mnemonic key if
any mnemonics are defined in the name.
|
void |
setState(boolean b) |
java.lang.String |
toString() |
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, isEnabled, removePropertyChangeListener, setEnabled
@Deprecated public static final java.lang.String ACTION
@Deprecated public static final java.lang.String MNEMONIC
Action.MNEMONIC_KEY
.public static final java.lang.String ACCELERATOR
public static final java.lang.String USER_DATA
public static final java.lang.String DISABLED_ICON
public static final java.lang.String TOGGLES
public static final java.lang.String RADIO
public static final java.lang.String STATE
public static final java.lang.String HIDDEN
public static final java.lang.String BUTTON_GROUP_NAME
public static final java.lang.String ACTION_MENU_ACTIONS
public static final java.lang.String ACTION_MENU_HAS_DEFAULT_ACTION
public static final java.lang.String MENU_WEIGHT
public static final float MENU_WEIGHT_UNASSIGNED
public static final java.lang.String CATEGORY
public static final java.lang.String CONTEXT_INDEPENDENT_NAME
public static final java.lang.String CAN_BE_PLACED_ON_MAIN_TOOLBAR
Because NetBeans adds actions as standard buttons, non state-aware
buttons, actions for which isToggle()
is true, cannot be
added to the Customize Toolbar dialog even if this property
is true.
Note that an action that does not have an icon is not elligible to display on the main toolbar and will not appear in the Customize Toolbars dialog.
Usage:
putValue(CAN_BE_PLACED_ON_MAIN_TOOLBAR, Boolean.TRUE)
orputValue(CAN_BE_PLACED_ON_MAIN_TOOLBAR, Boolean.FALSE)
@Deprecated protected static final boolean PERFORM_ACTION_LATER
public ToggleAction(java.lang.String name, javax.swing.Icon icon)
name
- a name for the actionicon
- an icon for the actionpublic ToggleAction(java.lang.String name, java.util.ResourceBundle bundle, java.lang.String iconPath)
name
- a name for the actionbundle
- the ResourceBundle that defines the iconiconPath
- the path of the icon relative to the ResourceBundlepublic ToggleAction(java.lang.String name, ArrayResourceBundle bundle, int key)
name
- a name for the actionbundle
- the ArrayResourceBundle that defines the iconkey
- the index key of the icon in the resource bundleprotected ToggleAction(ToggleAction action)
public final void addPropertyResolver(PropertyResolver resolver)
getValue(String)
method and the value is null, all property resolvers will be given the
opportunity to resolve the value of the property, starting with the last
resolver that was added. If a non-null value is returned by any
resolver, then the resolved value is added to the property set for this
action an no further resolvers are queried.PropertyResolvers provide a mechanism whereby properties on an action can be resolved lazily.
resolver
- a resolver to add.public final void removePropertyResolver(PropertyResolver resolver)
addPropertyResolver( PropertyResolver )
.resolver
- a resolver to removepublic boolean getState()
public void setState(boolean b)
public void putValue(java.lang.String key, java.lang.Object newValue)
putValue
in interface javax.swing.Action
putValue
in class javax.swing.AbstractAction
public boolean isToggle()
public boolean isRadio()
public boolean isActionMenu()
public void setName(java.lang.String name)
name
- a name for the actionpublic void setMenuWeight(float weight)
weight
- the new menu weightgetMenuWeight()
,
MenuManager.createMenuItem(ToggleAction)
,
MenuManager.createMenuItem(ToggleAction, float)
public float getMenuWeight()
default menu weight
is returned.setMenuWeight(float)
protected boolean getBooleanValue(java.lang.String key)
protected void setBooleanValue(java.lang.String key, boolean newValue)
public void listenForItemEvent(javax.swing.AbstractButton button)
public java.lang.Object getValue(java.lang.String key)
getValue
in interface javax.swing.Action
getValue
in class javax.swing.AbstractAction
protected static final void freezeKeyboard(boolean freeze)
public java.lang.String toString()
toString
in class java.lang.Object