public abstract class ChildFilter extends java.lang.Object implements Displayable
This interface intentionally does not offer any means of adding, removing, or searching for individual child Elements which is the responsibility of Container.
Element
Modifier and Type | Field and Description |
---|---|
static int |
NO_OPTIONS |
Constructor and Description |
---|
ChildFilter() |
Modifier and Type | Method and Description |
---|---|
void |
cache(TNode node)
This method will be called when the UI creates a TNode that is a descendant of a filtered node.
|
boolean |
canRefresh(TNode[] nodes)
This method will be called when the UI needs to determine the sensitivity of the Refresh menu item.
|
boolean |
canUpdate(TNode node, UpdateMessage change)
Call to determine if an update should be done due a property set notification.
|
TNode |
childrenAdded(UpdateMessage message, TNode parent, TreeExplorer tree)
The childrenAdded method is called when the UI is notified that an element has been added to the node that owns this filter.
|
TNode |
childrenRemoved(UpdateMessage message, TNode parent, TreeExplorer tree)
The childrenRemoved method is called when the UI is notified that an element has been removed from the node that owns this filter.
|
void |
closeChildren()
This method is called when a parent node is closed.
|
java.util.Iterator |
getChildren()
Get the filtered children list.
|
java.util.Comparator |
getComparator()
Returns the
Comparator that is used to sort the children of the owner TNode . |
javax.swing.Icon |
getIcon()
Returns an
Icon that can be shown in association with this Displayable . |
java.lang.String |
getLongLabel()
Returns a long label that can be displayed to the user.
|
int |
getOptions()
Accessors to filter options.
|
TNode |
getOwner() |
java.lang.String |
getShortLabel()
Returns a short label that can be displayed to the user.
|
java.lang.String |
getToolTipText()
Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this
Displayable . |
URLFilter |
getURLFilter() |
void |
refresh(TNode[] nodes)
This method will be called when the UI is requested to refresh.
|
void |
setOptions(int options) |
void |
setOwner(TNode owner)
Sets the node that owns this filter.
|
void |
setURLFilter(URLFilter filter)
Sets the file filter used to exclude specific files
|
java.lang.String |
toString()
Returns the Short Label displayed to a user.
|
void |
uncache(TNode node) |
TNode |
update(TNode node, UpdateMessage change)
This method will be called when the UI needs to tell a filter that a property set notification has happened.
|
public static final int NO_OPTIONS
public java.lang.String getShortLabel()
Displayable
String
is considered translatable and should therefore be placed in an appropriate resource file. When possible, the returned label should be reasonably short enough to show in the navigator or explorer windows but long enough to clearly identify and distinguish the Displayable
.getShortLabel
in interface Displayable
Displayable
that can be shown to the user.public java.lang.String getLongLabel()
Displayable
String
is considered translatable and should therefore be placed in an appropriate resource file. The long label differs from the short label essentially on length. Usually the long label will only be shown on-demand and in places where horizontal space is more available. Examples are the status bar and tooltips.getLongLabel
in interface Displayable
Displayable
that can be shown to the user.public javax.swing.Icon getIcon()
Displayable
Icon
that can be shown in association with this Displayable
. Typically the icon will be used in a tree control or list control. Therefore the icon must fit naturally within the space normally given to items within those controls. Such icons are usually 16x16 in size or, if there is a one-pixel transparent padding around the edge, 18x18 in size. It is strongly recommended that icons returned by this method be either 16x16 or 18x18 in size. If null
is returned, the control may show a default icon, or it may show no icon, whichever is appropriate.getIcon
in interface Displayable
Icon
to be displayed for the Displayable
.public java.lang.String getToolTipText()
Displayable
Displayable
. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel()
.getToolTipText
in interface Displayable
Displayable
.public java.lang.String toString()
Displayable
toString
method in java.lang.Object
.
Implementors of the Displayable
interface should override this as appropriate. The default implementation is the same as getShortLabel
toString
in interface Displayable
toString
in class java.lang.Object
Object.toString()
, Displayable.getShortLabel()
public java.util.Iterator getChildren()
public TNode childrenAdded(UpdateMessage message, TNode parent, TreeExplorer tree)
public TNode childrenRemoved(UpdateMessage message, TNode parent, TreeExplorer tree)
public void closeChildren()
public java.util.Comparator getComparator()
Comparator
that is used to sort the children of the owner TNode
.public int getOptions()
public void setOptions(int options)
public final TNode getOwner()
public void setOwner(TNode owner)
public URLFilter getURLFilter()
public void setURLFilter(URLFilter filter)
public void cache(TNode node)
public void uncache(TNode node)
public boolean canRefresh(TNode[] nodes)
public void refresh(TNode[] nodes)
public boolean canUpdate(TNode node, UpdateMessage change)
public TNode update(TNode node, UpdateMessage change)