|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.viewers.ViewerFilter
public abstract class ViewerFilter
A viewer filter is used by a structured viewer to extract a subset of elements provided by its content provider.
Subclasses must implement the select method
and may implement the isFilterProperty method.
IStructuredContentProvider,
StructuredViewer| Constructor Summary | |
|---|---|
protected |
ViewerFilter()
Creates a new viewer filter. |
| Method Summary | |
|---|---|
Object[] |
filter(Viewer viewer,
Object parent,
Object[] elements)
Filters the given elements for the given viewer. |
Object[] |
filter(Viewer viewer,
TreePath parentPath,
Object[] elements)
Filters the given elements for the given viewer. |
boolean |
isFilterProperty(Object element,
String property)
Returns whether this viewer filter would be affected by a change to the given property of the given element. |
abstract boolean |
select(Viewer viewer,
Object parentElement,
Object element)
Returns whether the given element makes it through this filter. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected ViewerFilter()
| Method Detail |
|---|
public Object[] filter(Viewer viewer,
Object parent,
Object[] elements)
The default implementation of this method calls
select on each element in the array,
and returns only those elements for which select
returns true.
viewer - the viewerparent - the parent elementelements - the elements to filter
public Object[] filter(Viewer viewer,
TreePath parentPath,
Object[] elements)
The default implementation of this method calls
filter(Viewer, Object, Object[]) with the
parent from the path. Subclasses may override
viewer - the viewerparentPath - the path of the parent elementelements - the elements to filter
public boolean isFilterProperty(Object element,
String property)
The default implementation of this method returns false.
Subclasses should reimplement.
element - the elementproperty - the property
true if the filtering would be affected,
and false if it would be unaffected
public abstract boolean select(Viewer viewer,
Object parentElement,
Object element)
viewer - the viewerparentElement - the parent elementelement - the element
true if element is included in the
filtered set, and false if excluded
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.