CookieAction (Nodes API)

java.lang.Object
- org.openide.util.SharedClassObject
- - org.openide.util.actions.SystemAction
  - - org.openide.util.actions.CallableSystemAction
    - - org.openide.util.actions.NodeAction
      - org.openide.util.actions.CookieAction

public abstract class CookieAction
extends NodeAction

Not the preferred solution anymore, rather use Actions.context. To replace your action layer definition use more delarative way:

 <file name="action-pkg-ClassName.instance">
   <attr name="type" stringvalue="org.netbeans.api.actions.Openable"/>
   <attr name="delegate" methodvalue="org.openide.awt.Action.inject"/>
   <attr name="selectionType" stringvalue="ANY"/>
   <attr name="injectable" stringvalue="pkg.YourClass"/>
   <attr name="displayName" bundlevalue="your.pkg.Bundle#key"/>
   <attr name="iconBase" stringvalue="your/pkg/YourImage.png"/>
   <!-- if desired: <attr name="noIconInMenu" boolvalue="false"/> -->
 </file>

See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.openide.util.actions.Presenter
  org.openide.util.actions.Presenter.Menu, org.openide.util.actions.Presenter.Popup, org.openide.util.actions.Presenter.Toolbar

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`MODE_ALL`	Action will be enabled if there are one or more selected nodes and all of them support the given cookies.
`static int`	`MODE_ANY`	Action will be enabled if there are one or more selected nodes and any of them (one, all, or some) support the given cookies.
`static int`	`MODE_EXACTLY_ONE`	Action will be enabled if there is exactly one selected node and it supports the given cookies.
`static int`	`MODE_ONE`	Action will be enabled if there are one or more selected nodes and there is exactly one node which supports the given cookies.
`static int`	`MODE_SOME`	Action will be enabled if there are several selected nodes and some of them (at least one, but not all) support the given cookies.

Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Fields inherited from class org.openide.util.actions.SystemAction
PROP_ENABLED, PROP_ICON

Constructor Summary

Constructors
Constructor Description

CookieAction()

Constructors
Constructor	Description
`CookieAction()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract java.lang.Class<?>[]`	`cookieClasses()`	Get the cookies that this action requires.
`javax.swing.Action`	`createContextAwareInstance(org.openide.util.Lookup actionContext)`	Implements `ContextAwareAction` interface method.
`protected boolean`	`enable(Node[] activatedNodes)`	Test for enablement based on the cookies of selected nodes.
`protected abstract int`	`mode()`	Get the mode of the action: how strict it should be about cookie support.

Methods inherited from interface javax.swing.Action
accept, addPropertyChangeListener, getValue, putValue, removePropertyChangeListener

Methods inherited from class org.openide.util.actions.CallableSystemAction
asynchronous, getMenuPresenter, getPopupPresenter, getToolbarPresenter

Methods inherited from class org.openide.util.actions.NodeAction
actionPerformed, addNotify, getActivatedNodes, initialize, isEnabled, performAction, performAction, removeNotify, setEnabled, surviveFocusChange

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.openide.util.SharedClassObject
addPropertyChangeListener, equals, finalize, findObject, findObject, firePropertyChange, getLock, getProperty, hashCode, putProperty, putProperty, readExternal, removePropertyChangeListener, reset, writeExternal, writeReplace

Methods inherited from class org.openide.util.actions.SystemAction
clearSharedData, createPopupMenu, createToolbarPresenter, get, getHelpCtx, getIcon, getIcon, getName, getValue, iconResource, linkActions, putValue, setIcon

- Field Detail
  - MODE_ONE
```
public static final int MODE_ONE
```
    Action will be enabled if there are one or more selected nodes and there is exactly one node which supports the given cookies.
    
    See Also:
    
    Constant Field Values
  - MODE_SOME
```
public static final int MODE_SOME
```
    Action will be enabled if there are several selected nodes and some of them (at least one, but not all) support the given cookies.
    
    See Also:
    
    Constant Field Values
  - MODE_ALL
```
public static final int MODE_ALL
```
    Action will be enabled if there are one or more selected nodes and all of them support the given cookies.
    
    See Also:
    
    Constant Field Values
  - MODE_EXACTLY_ONE
```
public static final int MODE_EXACTLY_ONE
```
    Action will be enabled if there is exactly one selected node and it supports the given cookies.
    
    See Also:
    
    Constant Field Values
  - MODE_ANY
```
public static final int MODE_ANY
```
    Action will be enabled if there are one or more selected nodes and any of them (one, all, or some) support the given cookies.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CookieAction
```
public CookieAction()
```
- Method Detail
  - mode
```
protected abstract int mode()
```
    Get the mode of the action: how strict it should be about cookie support.
    
    Returns:
    
    the mode of the action. Possible values are disjunctions of the MODE_XXX constants.
  - cookieClasses
```
protected abstract java.lang.Class<?>[] cookieClasses()
```
    Get the cookies that this action requires. The cookies are disjunctive, i.e. a node must support AT LEAST ONE of the cookies specified by this method.
    
    Returns:
    
    a list of cookies
  - enable
```
protected boolean enable(Node[] activatedNodes)
```
    Test for enablement based on the cookies of selected nodes. Generally subclasses should not override this except for strange purposes, and then only calling the super method and adding a check. Just use cookieClasses() and mode() to specify the enablement logic.
    
    Specified by:
    
    enable in class NodeAction
    
    Parameters:
    
    activatedNodes - the set of activated nodes
    
    Returns:
    
    true to enable
  - createContextAwareInstance
```
public javax.swing.Action createContextAwareInstance(org.openide.util.Lookup actionContext)
```
    Implements ContextAwareAction interface method.
    
    Overrides:
    
    createContextAwareInstance in class NodeAction
    
    Parameters:
    
    actionContext - a lookup contains action context, cannot be null
    
    Returns:
    
    a delegate action

Class CookieAction

Nested Class Summary

Nested classes/interfaces inherited from interface org.openide.util.actions.Presenter

Field Summary

Fields inherited from interface javax.swing.Action

Fields inherited from class org.openide.util.actions.SystemAction

Constructor Summary

Method Summary

Methods inherited from interface javax.swing.Action

Methods inherited from class org.openide.util.actions.CallableSystemAction

Methods inherited from class org.openide.util.actions.NodeAction

Methods inherited from class java.lang.Object

Methods inherited from class org.openide.util.SharedClassObject

Methods inherited from class org.openide.util.actions.SystemAction

Field Detail

MODE_ONE

MODE_SOME

MODE_ALL

MODE_EXACTLY_ONE

MODE_ANY

Constructor Detail

CookieAction

Method Detail

mode

cookieClasses

enable

createContextAwareInstance