public class FilterNode extends Node
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).
| Modifier and Type | Class and Description |
|---|---|
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.
|
Node.Cookie, Node.Handle, Node.IndexedProperty<T,E>, Node.Property<T>, Node.PropertySet| Modifier and Type | Field and Description |
|---|---|
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_GET_VALUE
Whether to delegate
getValue. |
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. |
protected static int |
DELEGATE_SET_VALUE
Whether to delegate
setValue. |
EMPTY, PROP_COOKIE, PROP_DISPLAY_NAME, PROP_ICON, PROP_LEAF, PROP_NAME, PROP_OPENED_ICON, PROP_PARENT_NODE, PROP_PROPERTY_SETS, PROP_SHORT_DESCRIPTION| Constructor and Description |
|---|
FilterNode(Node original)
Create proxy.
|
FilterNode(Node original,
Children children)
Create proxy with a different set of children.
|
FilterNode(Node original,
Children children,
Lookup lookup)
Constructs new filter node with a provided children and lookup.
|
| Modifier and Type | Method and Description |
|---|---|
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()
Called when a node is deleted.
|
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()
Deprecated.
|
Action[] |
getActions(boolean context)
Get the set of actions that are associated with this node.
|
SystemAction[] |
getContextActions()
Deprecated.
|
<T extends Node.Cookie> |
getCookie(Class<T> type)
Delegates to original, if no special lookup provided in constructor,
Otherwise it delegates to the lookup.
|
Component |
getCustomizer()
Get the customizer component.
|
SystemAction |
getDefaultAction()
Deprecated.
|
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.
|
String |
getHtmlDisplayName()
Get a display name containing HTML markup.
|
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.
|
Action |
getPreferredAction()
Gets the preferred action for this node.
|
Node.PropertySet[] |
getPropertySets()
Get the list of property sets for this node.
|
String |
getShortDescription() |
Object |
getValue(String attributeName) |
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.
|
void |
setValue(String attributeName,
Object value) |
addNodeListener, addPropertyChangeListener, clone, fireCookieChange, fireDisplayNameChange, fireIconChange, fireNameChange, fireNodeDestroyed, fireOpenedIconChange, firePropertyChange, firePropertySetsChange, fireShortDescriptionChange, getChildren, getContextMenu, getLookup, getParentNode, hasPropertyChangeListener, isLeaf, removeNodeListener, removePropertyChangeListener, setChildren, setHidden, toStringattributeNames, isExpert, isHidden, isPreferred, setExpert, setPreferredprotected static final int DELEGATE_SET_NAME
setName.protected static final int DELEGATE_GET_NAME
getName.protected static final int DELEGATE_SET_DISPLAY_NAME
setDisplayName.protected static final int DELEGATE_GET_DISPLAY_NAME
getDisplayName.protected static final int DELEGATE_SET_SHORT_DESCRIPTION
setShortDescription.protected static final int DELEGATE_GET_SHORT_DESCRIPTION
getShortDescription.protected static final int DELEGATE_DESTROY
destroy.protected static final int DELEGATE_GET_ACTIONS
getActions.protected static final int DELEGATE_GET_CONTEXT_ACTIONS
getContextActions.protected static final int DELEGATE_SET_VALUE
setValue.protected static final int DELEGATE_GET_VALUE
getValue.public FilterNode(Node original)
original - the node to delegate topublic FilterNode(Node original, Children children)
original - the node to delegate tochildren - a set of children for this nodepublic FilterNode(Node original, Children children, Lookup lookup)
getCookie(java.lang.Class<T>) calls that just call
lookup.lookup(clazz). If this constructor is used,
the code shall not override getCookie(java.lang.Class<T>) method, but do all
its state manipulation in the lookup. Look at Node.Node(org.openide.nodes.Children, org.openide.util.Lookup)
constructor for best practices usage of this constructor.original - the node we delegate tochildren - the children to use for the filter node or null if
default children should be providedlookup - lookup to use. Do not pass orginal.getLookup() into this parameter.
In such case use the FilterNode(Node, Children) constructor.protected void finalize()
NodeListener.nodeDestroyed(org.openide.nodes.NodeEvent),
but can be called by any subclass to stop reflecting changes
in the original node.protected final void enableDelegation(int mask)
mask - bitwise disjunction of DELEGATE_XXX constantsIllegalArgumentException - if the mask is invalidprotected final void disableDelegation(int mask)
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.
mask - bitwise disjunction of DELEGATE_XXX constantsIllegalArgumentException - if the mask is invalidpublic Node cloneNode()
protected final void changeOriginal(Node original, boolean changeChildren)
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. Be aware
that this method aquires
write lock on the nodes hierarchy (Children.MUTEX). Take care not to call this method
under read lock.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.public void setValue(String attributeName, Object value)
setValue in class FeatureDescriptorpublic Object getValue(String attributeName)
getValue in class FeatureDescriptorpublic void setName(String s)
Nodepublic String getName()
getName in class FeatureDescriptorpublic void setDisplayName(String s)
NodesetDisplayName in class Nodes - the new namepublic String getDisplayName()
getDisplayName in class FeatureDescriptorpublic void setShortDescription(String s)
NodeThis description may be used for tool tips, etc.
setShortDescription in class Nodes - the new descriptionpublic String getShortDescription()
getShortDescription in class FeatureDescriptorpublic Image getIcon(int type)
Nodepublic Image getOpenedIcon(int type)
NodegetOpenedIcon in class Nodetype - constant from BeanInfopublic HelpCtx getHelpCtx()
NodegetHelpCtx in interface HelpCtx.ProvidergetHelpCtx in class Nodenull or HelpCtx.DEFAULT_HELP)public boolean canRename()
NodeFeatureDescriptor.getName() to obtain the current name and
Node.setName(java.lang.String) to change it.public boolean canDestroy()
NodecanDestroy in class Nodetrue if canpublic void destroy()
throws IOException
Node
The default
implementation obtains write access to
Children.MUTEX, and removes
the node from its parent (if any). Also fires a property change.
Subclasses which return true from Node.canDestroy() should override
this method to remove the associated model object from its parent. There
is no need to call the super method in this case.
There is no guarantee that after this method has been called, other
methods such as Node.getIcon(int) will not also be called for a little while.
destroy in class NodeIOException - if something failspublic Node.PropertySet[] getPropertySets()
NodegetPropertySets in class Nodepublic Transferable clipboardCopy() throws IOException
NodeclipboardCopy in class NodeIOException - when the
copy cannot be performedpublic Transferable clipboardCut() throws IOException
NodeclipboardCut in class NodeIOException - when the
cut cannot be performedpublic boolean canCopy()
Nodepublic boolean canCut()
Nodepublic Transferable drag() throws IOException
Nodedrag in class NodeIOException - if a drag cannot be startedpublic PasteType getDropType(Transferable t, int action, int index)
NodegetDropType in class Nodet - the transferableaction - the drag'n'drop action to do DnDConstants.ACTION_MOVE, ACTION_COPY, ACTION_LINKindex - index between children the drop occurred at or -1 if not specifiedpublic PasteType[] getPasteTypes(Transferable t)
NodegetPasteTypes in class Nodet - the transferable in the clipboardpublic NewType[] getNewTypes()
NodegetNewTypes in class Node@Deprecated public SystemAction[] getActions()
Nodecontext menu.
By default returns the actions in NodeOp.getDefaultActions().
getActions in class Node@Deprecated public SystemAction[] getContextActions()
NodeFor 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 context menu.
Note that in the Windows UI system, e.g., these action sets are quite different.
getContextActions in class NodeNode.getActions(boolean).@Deprecated public SystemAction getDefaultAction()
NodegetDefaultAction in class Nodenull indicating there should be none default actionpublic Action[] getActions(boolean context)
NodeBy default this method delegates to the deprecated getActions or getContextActions method depending on the value of supplied argument.
It is supposed to be overridden by subclasses accordingly.
getActions in class Nodecontext - whether to find actions for context meaning or for the
node itselfpublic Action getPreferredAction()
NodeNode.getActions(boolean).
In case it is, the context menu created from those actions
is encouraged to highlight the preferred action.
Override in subclasses accordingly.getPreferredAction in class Nodenull if there is nonepublic String getHtmlDisplayName()
getDisplayName(), this method will
always return null unless you override it as well (assuming that if you're
changing the display name, you don't want an HTML display name constructed
from the original node's display name to be what shows up in views of
this node). If getDisplayName() is not overridden,
this method will return whatever the original node returns from this
method.
Note that if you do override getDisplayName, you should also override
this method to return null.
getHtmlDisplayName in class NodeNode.getHtmlDisplayName()public boolean hasCustomizer()
NodeNode.getCustomizer().hasCustomizer in class Nodetrue if there is a customizerpublic Component getCustomizer()
NodegetCustomizer in class Nodenull if there is no customizerpublic <T extends Node.Cookie> T getCookie(Class<T> type)
getCookie in class Nodetype - the class to look forNode.getCookie(java.lang.Class<T>)public Node.Handle getHandle()
Subclasses must override this if they wish for their nodes to be properly serializable.
public boolean equals(Object o)
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
DataFolder.Index for data folders.
public int hashCode()
FilterNode, or filter nodes with non-default children,
the hash reverts to the identity hash code.protected Node getOriginal()
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.
protected PropertyChangeListener createPropertyChangeListener()
This method is called during initialization and allows subclasses to modify the default behaviour.
FilterNode.PropertyChangeAdapter in the default implementationprotected NodeListener createNodeListener()
Intended for overriding by subclasses, as with createPropertyChangeListener().
FilterNode.NodeAdapter in the default implementationBuilt on August 24 2014. | Portions Copyright 1997-2014 Sun Microsystems, Inc. All rights reserved.