org.openide.nodes
Class FilterNode

java.lang.Object
  |
  +--java.beans.FeatureDescriptor
        |
        +--org.openide.nodes.Node
              |
              +--org.openide.nodes.FilterNode

Direct Known Subclasses:

DataShadow.ShadowNode

public class FilterNode

extends Node

A proxy for another node. Unless otherwise mentioned, all methods of the original node are delegated to. If desired, you can disable delegation of certain methods which are concrete in Node by calling disableDelegation(int).

Note: it is fine to subclass this class and use it to filter things. But please do not ever try to cast a node to FilterNode: it probably means you are doing something wrong. Instead, ask whatever Node you have for a proper kind of cookie (e.g. DataObject).

Inner Class Summary

static class	FilterNode.Children Children for a filter node.
protected static class	FilterNode.NodeAdapter Adapter that listens on changes in an original node and refires them in a proxy.
protected static class	FilterNode.PropertyChangeAdapter Adapter that listens on changes in an original node and refires them in a proxy.

Inner classes inherited from class org.openide.nodes.Node

Node.Cookie, Node.Handle, Node.IndexedProperty, Node.Property, Node.PropertySet

Field Summary

protected static int	DELEGATE_DESTROY Whether to delegate destroy.
protected static int	DELEGATE_GET_ACTIONS Whether to delegate getActions.
protected static int	DELEGATE_GET_CONTEXT_ACTIONS Whether to delegate getContextActions.
protected static int	DELEGATE_GET_DISPLAY_NAME Whether to delegate getDisplayName.
protected static int	DELEGATE_GET_NAME Whether to delegate getName.
protected static int	DELEGATE_GET_SHORT_DESCRIPTION Whether to delegate getShortDescription.
protected static int	DELEGATE_SET_DISPLAY_NAME Whether to delegate setDisplayName.
protected static int	DELEGATE_SET_NAME Whether to delegate setName.
protected static int	DELEGATE_SET_SHORT_DESCRIPTION Whether to delegate setShortDescription.

Fields inherited from class org.openide.nodes.Node

EMPTY, PROP_COOKIE, PROP_DISPLAY_NAME, PROP_ICON, PROP_NAME, PROP_OPENED_ICON, PROP_PARENT_NODE, PROP_PROPERTY_SETS, PROP_SHORT_DESCRIPTION

Constructor Summary

FilterNode(Node original)
Create proxy.

FilterNode(Node original, Children children)
Create proxy with a different set of children.

Method Summary

boolean	canCopy() Test whether this node permits copying.
boolean	canCut() Test whether this node permits cutting.
boolean	canDestroy() Test whether this node can be deleted.
boolean	canRename() Test whether this node can be renamed.
protected void	changeOriginal(Node original, boolean changeChildren) Changes the original node for this node.
Transferable	clipboardCopy() Called when a node is to be copied to the clipboard.
Transferable	clipboardCut() Called when a node is to be cut to the clipboard.
Node	cloneNode() Create new filter node for the original.
protected NodeListener	createNodeListener() Creates a node listener that allows listening on the original node and propagating events to the proxy.
protected PropertyChangeListener	createPropertyChangeListener() Create a property change listener that allows listening on the original node properties (contained in property sets) and propagating them to the proxy.
void	destroy() Remove the node from its parent and deletes it.
protected void	disableDelegation(int mask) Disable delegation of a set of methods.
Transferable	drag() Called when a drag is started with this node.
protected void	enableDelegation(int mask) Enable delegation of a set of methods.
boolean	equals(Object o) Test equality of original nodes.
protected void	finalize() Removes all listeners (property and node) on the original node.
SystemAction[]	getActions() Get the set of actions associated with this node.
SystemAction[]	getContextActions() Get a special set of actions for situations when this node is displayed as a context.
Node.Cookie	getCookie(Class type) Get a cookie for this node.
Component	getCustomizer() Get the customizer component.
SystemAction	getDefaultAction() Get the default action for this node.
String	getDisplayName()
PasteType	getDropType(Transferable t, int action, int index) Determine if there is a paste operation that can be performed on provided transferable.
Node.Handle	getHandle() If this is FilterNode without any changes (subclassed, changed children) and the original provides handle, stores them and returns a new handle for the proxy.
HelpCtx	getHelpCtx() Get context help associated with this node.
Image	getIcon(int type) Find an icon for this node (in the closed state).
String	getName()
NewType[]	getNewTypes() Get the new types that can be created in this node.
Image	getOpenedIcon(int type) Find an icon for this node (in the open state).
protected Node	getOriginal() Get the original node.
PasteType[]	getPasteTypes(Transferable t) Determine which paste operations are allowed when a given transferable is in the clipboard.
Node.PropertySet[]	getPropertySets() Get the list of property sets for this node.
String	getShortDescription()
boolean	hasCustomizer() Test whether there is a customizer for this node.
int	hashCode() Hash by original nodes.
void	setDisplayName(String s) Set the display name.
void	setName(String s) Set the system name.
void	setShortDescription(String s) Set the short description of the node.

Methods inherited from class org.openide.nodes.Node

addNodeListener, addPropertyChangeListener, clone, fireCookieChange, fireDisplayNameChange, fireIconChange, fireNameChange, fireNodeDestroyed, fireOpenedIconChange, firePropertyChange, firePropertySetsChange, fireShortDescriptionChange, getChildren, getContextMenu, getParentNode, hasPropertyChangeListener, isLeaf, removeNodeListener, removePropertyChangeListener, toString

Methods inherited from class java.beans.FeatureDescriptor

attributeNames, getValue, isExpert, isHidden, isPreferred, setExpert, setHidden, setPreferred, setValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DELEGATE_SET_NAME

protected static final int DELEGATE_SET_NAME

Whether to delegate setName.

DELEGATE_GET_NAME

protected static final int DELEGATE_GET_NAME

Whether to delegate getName.

DELEGATE_SET_DISPLAY_NAME

protected static final int DELEGATE_SET_DISPLAY_NAME

Whether to delegate setDisplayName.

DELEGATE_GET_DISPLAY_NAME

protected static final int DELEGATE_GET_DISPLAY_NAME

Whether to delegate getDisplayName.

DELEGATE_SET_SHORT_DESCRIPTION

protected static final int DELEGATE_SET_SHORT_DESCRIPTION

Whether to delegate setShortDescription.

DELEGATE_GET_SHORT_DESCRIPTION

protected static final int DELEGATE_GET_SHORT_DESCRIPTION

Whether to delegate getShortDescription.

DELEGATE_DESTROY

protected static final int DELEGATE_DESTROY

Whether to delegate destroy.

DELEGATE_GET_ACTIONS

protected static final int DELEGATE_GET_ACTIONS

Whether to delegate getActions.

DELEGATE_GET_CONTEXT_ACTIONS

protected static final int DELEGATE_GET_CONTEXT_ACTIONS

Whether to delegate getContextActions.

Constructor Detail

FilterNode

public FilterNode(Node original)

Create proxy.

Parameters:

original - the node to delegate to

FilterNode

public FilterNode(Node original,
                  Children children)

Create proxy with a different set of children.

Parameters:

original - the node to delegate to

children - a set of children for this node

Method Detail

finalize

protected void finalize()

Removes all listeners (property and node) on the original node. Called from NodeListener.nodeDestroyed(org.openide.nodes.NodeEvent), but can be called by any subclass to stop reflecting changes in the original node.

Overrides:

finalize in class Object

enableDelegation

protected final void enableDelegation(int mask)

Enable delegation of a set of methods. These will be delegated to the original node. Since all available methods are delegated by default, normally you will not need to call this.

Parameters:

mask - bitwise disjunction of DELEGATE_XXX constants

Throws:

IllegalArgumentException - if the mask is invalid

disableDelegation

protected final void disableDelegation(int mask)

Disable delegation of a set of methods. The methods will retain their behavior from Node.

For example, if you wish to subclass FilterNode, giving your node a distinctive display name and tooltip, and performing some special action upon deletion, you may do so without risk of affecting the original node as follows:

 public MyNode extends FilterNode {
   public MyNode (Node orig) {
     super (orig, new MyChildren (orig));
     disableDelegation (DELEGATE_GET_DISPLAY_NAME | DELEGATE_SET_DISPLAY_NAME |
                        DELEGATE_GET_SHORT_DESCRIPTION | DELEGATE_SET_SHORT_DESCRIPTION |
                        DELEGATE_DESTROY);
     // these will affect only the filter node:
     setDisplayName ("Linking -> " + orig.getDisplayName ());
     setShortDescription ("Something different.");
   }
   public boolean canRename () { return false; }
   public void destroy () throws IOException {
     doMyCleanup ();
     super.destroy (); // calls Node.destroy(), not orig.destroy()
   }
 }
 

You may still manually delegate where desired using getOriginal(). Other methods abstract in Node may simply be overridden without any special handling.

Parameters:

mask - bitwise disjunction of DELEGATE_XXX constants

Throws:

IllegalArgumentException - if the mask is invalid

cloneNode

public Node cloneNode()

Create new filter node for the original. Subclasses do not have to override this, but if they do not, the default implementation will filter the subclass filter, which is not very efficient.

Overrides:

cloneNode in class Node

Returns:

copy of this node

changeOriginal

protected final void changeOriginal(Node original,
                                    boolean changeChildren)

Changes the original node for this node.

Parameters:

original - The new original node.

changeChildren - If set to true changes children of this node according to the new original node. If you pass children which are not instance of class FilterNode.Children into the constructor set this parameter to false.

Throws:

IllegalStateException - if children which are not instance of FilterNode.Children were passed into the constructor and the method was called with the parameter changeChildren set to true.

Since:

1.39

setName

public void setName(String s)

Description copied from class: Node

Set the system name. Fires a property change event.

Overrides:

setName in class Node

Following copied from class: org.openide.nodes.Node

Parameters:

s - the new name

Throws:

IllegalArgumentException - if the new name cannot represent a valid node name

getName

public String getName()

Overrides:

getName in class FeatureDescriptor

setDisplayName

public void setDisplayName(String s)

Description copied from class: Node

Set the display name. Fires a property change event.

Overrides:

setDisplayName in class Node

Following copied from class: org.openide.nodes.Node

Parameters:

s - the new name

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class FeatureDescriptor

setShortDescription

public void setShortDescription(String s)

Description copied from class: Node

Set the short description of the node. Fires a property change event.

This description may be used for tool tips, etc.

Overrides:

setShortDescription in class Node

Following copied from class: org.openide.nodes.Node

Parameters:

s - the new description

getShortDescription

public String getShortDescription()

Overrides:

getShortDescription in class FeatureDescriptor

getIcon

public Image getIcon(int type)

Description copied from class: Node

Find an icon for this node (in the closed state).

Overrides:

getIcon in class Node

Following copied from class: org.openide.nodes.Node

Parameters:

type - constant from BeanInfo

Returns:

icon to use to represent the node

getOpenedIcon

public Image getOpenedIcon(int type)

Description copied from class: Node

Find an icon for this node (in the open state). This icon is used when the node may have children and is expanded.

Overrides:

getOpenedIcon in class Node

Following copied from class: org.openide.nodes.Node

Parameters:

type - constant from BeanInfo

Returns:

icon to use to represent the node when open

getHelpCtx

public HelpCtx getHelpCtx()

Description copied from class: Node

Get context help associated with this node.

Overrides:

getHelpCtx in class Node

Following copied from class: org.openide.nodes.Node

Returns:

the context help object (could be null or HelpCtx.DEFAULT_HELP)

canRename

public boolean canRename()

Description copied from class: Node

Test whether this node can be renamed. If true, one can use FeatureDescriptor.getName() to obtain the current name and Node.setName(java.lang.String) to change it.

Overrides:

canRename in class Node

Following copied from class: org.openide.nodes.Node

Returns:

true if the node can be renamed

canDestroy

public boolean canDestroy()

Description copied from class: Node

Test whether this node can be deleted.

Overrides:

canDestroy in class Node

Following copied from class: org.openide.nodes.Node

Returns:

true if can

destroy

public void destroy()
             throws IOException

Description copied from class: Node

Remove the node from its parent and deletes it. The default implementation obtains write access to the children's lock, and removes the node from its parent (if any). Also fires a property change.

This may be overridden by subclasses to do any additional cleanup.

Overrides:

destroy in class Node

Following copied from class: org.openide.nodes.Node

Throws:

IOException - if something fails

getPropertySets

public Node.PropertySet[] getPropertySets()

Description copied from class: Node

Get the list of property sets for this node. E.g. typically there may be one for normal Bean properties, one for expert properties, and one for hidden properties.

Overrides:

getPropertySets in class Node

Following copied from class: org.openide.nodes.Node

Returns:

the property sets

clipboardCopy

public Transferable clipboardCopy()
                           throws IOException

Description copied from class: Node

Called when a node is to be copied to the clipboard.

Overrides:

clipboardCopy in class Node

Following copied from class: org.openide.nodes.Node

Returns:

the transferable object representing the content of the clipboard

Throws:

IOException - when the copy cannot be performed

clipboardCut

public Transferable clipboardCut()
                          throws IOException

Description copied from class: Node

Called when a node is to be cut to the clipboard.

Overrides:

clipboardCut in class Node

Following copied from class: org.openide.nodes.Node

Returns:

the transferable object representing the content of the clipboard

Throws:

IOException - when the cut cannot be performed

canCopy

public boolean canCopy()

Description copied from class: Node

Test whether this node permits copying.

Overrides:

canCopy in class Node

Following copied from class: org.openide.nodes.Node

Returns:

true if so

canCut

public boolean canCut()

Description copied from class: Node

Test whether this node permits cutting.

Overrides:

canCut in class Node

Following copied from class: org.openide.nodes.Node

Returns:

true if so

drag

public Transferable drag()
                  throws IOException

Description copied from class: Node

Called when a drag is started with this node. The node can attach a transfer listener to ExTransferable and will be then notified about progress of the drag (accept/reject).

Overrides:

drag in class Node

Following copied from class: org.openide.nodes.Node

Returns:

transferable to represent this node during a drag

Throws:

IOException - if a drag cannot be started

getDropType

public PasteType getDropType(Transferable t,
                             int action,
                             int index)

Description copied from class: Node

Determine if there is a paste operation that can be performed on provided transferable. Used by drag'n'drop code to check whether the drop is possible.

Overrides:

getDropType in class Node

Following copied from class: org.openide.nodes.Node

Parameters:

t - the transferable

action - the drag'n'drop action to do DnDConstants.ACTION_MOVE, ACTION_COPY, ACTION_LINK

index - index between children the drop occured at or -1 if not specified

Returns:

null if the transferable cannot be accepted or the paste type to execute when the drop occures

getPasteTypes

public PasteType[] getPasteTypes(Transferable t)

Description copied from class: Node

Determine which paste operations are allowed when a given transferable is in the clipboard. For example, a node representing a Java package will permit classes to be pasted into it.

Overrides:

getPasteTypes in class Node

Following copied from class: org.openide.nodes.Node

Parameters:

t - the transferable in the clipboard

Returns:

array of operations that are allowed

getNewTypes

public NewType[] getNewTypes()

Description copied from class: Node

Get the new types that can be created in this node. For example, a node representing a Java package will permit classes to be added.

Overrides:

getNewTypes in class Node

Following copied from class: org.openide.nodes.Node

Returns:

array of new type operations that are allowed

getActions

public SystemAction[] getActions()

Description copied from class: Node

Get the set of actions associated with this node. This may be used e.g. in constructing a context menu.

By default returns the actions in NodeOp.getDefaultActions().

Overrides:

getActions in class Node

Following copied from class: org.openide.nodes.Node

Returns:

system actions appropriate to the node

getContextActions

public SystemAction[] getContextActions()

Description copied from class: Node

Get a special set of actions for situations when this node is displayed as a context.

For example, right-clicking on a parent node in a hierarchical view (such as the normal Explorer) should use getActions. However, if this node is serving as the parent of a (say) a window tab full of icons (e.g., in IconView), and the users right-clicks on the empty space in this pane, then this method should be used to get the appropriate actions for a popup menu.

Note that in the Windows UI system, e.g., these action sets are quite different.

Overrides:

getContextActions in class Node

Following copied from class: org.openide.nodes.Node

Returns:

actions for a context. In the default implementation, same as Node.getActions().

getDefaultAction

public SystemAction getDefaultAction()

Description copied from class: Node

Get the default action for this node. This action can but need not be one from the list returned from Node.getActions(). If so, the popup menu returned from Node.getContextMenu() is encouraged to highlight the action.

Overrides:

getDefaultAction in class Node

Following copied from class: org.openide.nodes.Node

Returns:

default action, or null if there should be none

hasCustomizer

public boolean hasCustomizer()

Description copied from class: Node

Test whether there is a customizer for this node. If true, the customizer can be obtained via Node.getCustomizer().

Overrides:

hasCustomizer in class Node

Following copied from class: org.openide.nodes.Node

Returns:

true if there is a customizer

getCustomizer

public Component getCustomizer()

Description copied from class: Node

Get the customizer component.

Overrides:

getCustomizer in class Node

Following copied from class: org.openide.nodes.Node

Returns:

the component, or null if there is no customizer

getCookie

public Node.Cookie getCookie(Class type)

Description copied from class: Node

Get a cookie for this node.

The set of cookies can change. If a node changes its set of cookies, it fires a property change event with Node.PROP_COOKIE.

Overrides:

getCookie in class Node

Following copied from class: org.openide.nodes.Node

Parameters:

type - the representation class of the cookie

Returns:

a cookie assignable to that class, or null if this node has no such cookie

getHandle

public Node.Handle getHandle()

If this is FilterNode without any changes (subclassed, changed children) and the original provides handle, stores them and returns a new handle for the proxy.

Subclasses must override this if they wish for their nodes to be properly serializable.

Overrides:

getHandle in class Node

Returns:

the handle, or null if this node is subclassed or uses changed children

equals

public boolean equals(Object o)

Test equality of original nodes. Note that for subclasses of FilterNode, or filter nodes with non-default children, the test reverts to object identity. Note: if you wish that the Index cookie works correctly on filtered nodes and their subnodes, and you are subclassing FilterNode or using non-default children, you will probably want to override this method to test equality of the specified node with this filter node's original node; otherwise Move Up and Move Down actions may be disabled.

Note though that it is often better to provide your own index cookie from a filter node. Only then it is possible to change the number of children relative to the original. And in many cases this is easier anyway, as for example with data folders.

Overrides:

equals in class Object

Parameters:

o - something to compare to, presumably a node or FilterNode of one

Returns:

true if this node's original node is the same as the parameter (or original node of parameter)

hashCode

public int hashCode()

Hash by original nodes. Note that for subclasses of FilterNode, or filter nodes with non-default children, the hash reverts to the identity hash code.

Overrides:

hashCode in class Object

Returns:

the delegated hash code

getOriginal

protected Node getOriginal()

Get the original node.

Yes this is supposed to be protected! If you are not subclassing FilterNode yourself, you should not be calling it (nor casting to FilterNode). Use cookies instead.

Returns:

the node proxied to

createPropertyChangeListener

protected PropertyChangeListener createPropertyChangeListener()

Create a property change listener that allows listening on the original node properties (contained in property sets) and propagating them to the proxy.

This method is called during initialization and allows subclasses to modify the default behaviour.

Returns:

a FilterNode.PropertyChangeAdapter in the default implementation

createNodeListener

protected NodeListener createNodeListener()

Creates a node listener that allows listening on the original node and propagating events to the proxy.

Intended for overriding by subclasses, as with createPropertyChangeListener().

Returns:

a FilterNode.NodeAdapter in the default implementation