|
Extension SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The ChildFilter interface defines an API for retrieving a structured collection of Element nodes. The nodes returned may include additional Elements, inserted for organizational purposes, which are not themselves children of the original Element. Additionally, the list may choose to exclude child Elements which are otherwise legitimate children of the original Element. For example; a 'Package' ChildFilter implementation may, when applied to a Project node, return a list containing artificial Elements representing java packages, each of which in turn would contain the legitimate Elements for the individual .java source files of the Project. This same filter might additionaly choose to exclude from its list any Elements which were not .java source files.
This interface intentionally does not offer any means of adding, removing, or searching for individual child Elements which is the responsibility of Container.
Element
,
Container
Field Summary | |
static int |
NO_OPTIONS
|
Method Summary | |
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. |
TNode |
childrenAdded(java.util.List children,
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(java.util.List children,
TNode parent,
TreeExplorer tree)
The childrenRemoved method is called when the UI is notified that an element has been added to the node that owns this filter. |
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 . |
int |
getOptions()
Accessors to filter options. |
TNode |
getOwner()
|
int |
getType()
This method should return bitfield specifying the filter type. |
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 |
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. |
Methods inherited from interface oracle.ide.model.Displayable |
getIcon, getLongLabel, getShortLabel, getToolTipText, toString |
Field Detail |
public static final int NO_OPTIONS
Method Detail |
public java.util.Iterator getChildren()
public TNode childrenAdded(java.util.List children, TNode parent, TreeExplorer tree)
public TNode childrenRemoved(java.util.List children, TNode parent, TreeExplorer tree)
public void setOwner(TNode owner)
public TNode getOwner()
public void setURLFilter(URLFilter filter)
public URLFilter getURLFilter()
public void cache(TNode node)
public void uncache(TNode node)
public void refresh(TNode[] nodes)
public boolean canRefresh(TNode[] nodes)
public TNode update(TNode node, UpdateMessage change)
public int getOptions()
public void setOptions(int options)
public int getType()
FilterTypes.newType()
.public java.util.Comparator getComparator()
Comparator
that is used to sort the children of
the owner TNode
.
|
Extension SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |