| java.lang.Object
 org.eclipse.jface.viewers.Viewer
org.eclipse.jface.viewers.ContentViewer
org.eclipse.jface.viewers.StructuredViewer
org.eclipse.jface.viewers.ColumnViewer
org.eclipse.jface.viewers.AbstractTreeViewer
org.eclipse.jface.viewers.TreeViewer
All known Subclasses: org.eclipse.jface.viewers.CheckboxTreeViewer,
| TreeViewer | | public class TreeViewer extends AbstractTreeViewer (Code) | | A concrete viewer based on an SWT Tree control.
This class is not intended to be subclassed outside the viewer framework. It
is designed to be instantiated with a pre-existing SWT tree control and
configured with a domain-specific content provider, label provider, element
filter (optional), and element sorter (optional).
Content providers for tree viewers must implement either the
ITreeContentProvider interface, (as of 3.2) the
ILazyTreeContentProvider interface, or (as of 3.3) the
ILazyTreePathContentProvider . If the content provider is an
ILazyTreeContentProvider or an
ILazyTreePathContentProvider, the underlying Tree must be
created using the
SWT.VIRTUAL style bit, and the tree viewer will not
support sorting or filtering.
|
| Constructor Summary | |
| public | TreeViewer(Composite parent)
Creates a tree viewer on a newly-created tree control under the given
parent. | | public | TreeViewer(Composite parent, int style)
Creates a tree viewer on a newly-created tree control under the given
parent. | | public | TreeViewer(Tree tree)
Creates a tree viewer on the given tree control. |
| Method Summary | |
| protected void | addTreeListener(Control c, TreeListener listener)
| | protected void | assertContentProviderType(IContentProvider provider)
| | protected void | createChildren(Widget widget)
| | protected ColumnViewerEditor | createViewerEditor()
| | protected void | disassociate(Item item)
| | protected int | doGetColumnCount()
| | public void | editElement(Object element, int column)
| | protected Item | getChild(Widget widget, int index)
| | protected Item[] | getChildren(Widget o)
| | protected Widget | getColumnViewerOwner(int columnIndex)
| | public Control | getControl()
| | protected boolean | getExpanded(Item item)
| | protected Item | getItemAt(Point p)
| | protected int | getItemCount(Control widget)
| | protected int | getItemCount(Item item)
| | protected Item[] | getItems(Item item)
| | public IBaseLabelProvider | getLabelProvider()
The tree viewer implementation of this Viewer framework
method ensures that the given label provider is an instance of either
ITableLabelProvider or ILabelProvider. | | protected Object | getParentElement(Object element)
| | protected Item | getParentItem(Item item)
| | protected Object[] | getRawChildren(Object parent)
| | protected Item[] | getSelection(Control widget)
| | public Tree | getTree()
Returns this tree viewer's tree control. | | protected ViewerRow | getViewerRowFromItem(Widget item)
| | protected void | handleTreeExpand(TreeEvent event)
| | protected void | hookControl(Control control)
| | protected void | internalAdd(Widget widget, Object parentElement, Object[] childElements)
| | protected void | internalInitializeTree(Control widget)
| | protected void | internalRefreshStruct(Widget widget, Object element, boolean updateLabels)
| | public boolean | isExpandable(Object element)
| | protected void | mapElement(Object element, Widget item)
| | protected Item | newItem(Widget parent, int flags, int ix)
| | void | preservingSelection(Runnable updateCode, boolean reveal)
| | public void | remove(Object parentOrTreePath, int index)
Removes the element at the specified index of the parent. | | protected void | removeAll(Control widget)
| | public void | replace(Object parentElementOrTreePath, int index, Object element)
For a TreeViewer with a tree with the VIRTUAL style bit set, replace the
given parent's child at index with the given element. | | public void | setChildCount(Object elementOrTreePath, int count)
For a TreeViewer with a tree with the VIRTUAL style bit set, set the
number of children of the given element or tree path. | | public void | setContentProvider(IContentProvider provider)
| | protected void | setExpanded(Item node, boolean expand)
| | public void | setHasChildren(Object elementOrTreePath, boolean hasChildren)
For a TreeViewer with a tree with the VIRTUAL style bit set, inform the
viewer about whether the given element or tree path has children. | | protected void | setSelection(List items)
| | public void | setSelection(ISelection selection, boolean reveal)
Sets a new selection for this viewer and optionally makes it visible. | | protected void | showItem(Item item)
| | protected void | updatePlus(Item item, Object element)
|
| TreeViewer | | public TreeViewer(Composite parent)(Code) | | Creates a tree viewer on a newly-created tree control under the given
parent. The tree control is created using the SWT style bits
MULTI, H_SCROLL, V_SCROLL, and BORDER. The
viewer has no input, no content provider, a default label provider, no
sorter, and no filters.
Parameters:
parent - the parent control |
| TreeViewer | | public TreeViewer(Composite parent, int style)(Code) | | Creates a tree viewer on a newly-created tree control under the given
parent. The tree control is created using the given SWT style bits. The
viewer has no input, no content provider, a default label provider, no
sorter, and no filters.
Parameters:
parent - the parent control
Parameters:
style - the SWT style bits used to create the tree. |
| TreeViewer | | public TreeViewer(Tree tree)(Code) | | Creates a tree viewer on the given tree control. The viewer has no input,
no content provider, a default label provider, no sorter, and no filters.
Parameters:
tree - the tree control |
| addTreeListener | | protected void addTreeListener(Control c, TreeListener listener)(Code) | | |
| createChildren | | protected void createChildren(Widget widget)(Code) | | |
| disassociate | | protected void disassociate(Item item)(Code) | | |
| doGetColumnCount | | protected int doGetColumnCount()(Code) | | |
| editElement | | public void editElement(Object element, int column)(Code) | | |
| getChild | | protected Item getChild(Widget widget, int index)(Code) | | |
| getChildren | | protected Item[] getChildren(Widget o)(Code) | | |
| getColumnViewerOwner | | protected Widget getColumnViewerOwner(int columnIndex)(Code) | | |
| getControl | | public Control getControl()(Code) | | |
| getExpanded | | protected boolean getExpanded(Item item)(Code) | | |
| getItemAt | | protected Item getItemAt(Point p)(Code) | | |
| getItemCount | | protected int getItemCount(Control widget)(Code) | | |
| getItemCount | | protected int getItemCount(Item item)(Code) | | |
| getItems | | protected Item[] getItems(Item item)(Code) | | |
| getLabelProvider | | public IBaseLabelProvider getLabelProvider()(Code) | | The tree viewer implementation of this Viewer framework
method ensures that the given label provider is an instance of either
ITableLabelProvider or ILabelProvider. If
it is an ITableLabelProvider, then it provides a separate
label text and image for each column. If it is an
ILabelProvider, then it provides only the label text and
image for the first column, and any remaining columns are blank.
|
| getParentItem | | protected Item getParentItem(Item item)(Code) | | |
| getSelection | | protected Item[] getSelection(Control widget)(Code) | | |
| getTree | | public Tree getTree()(Code) | | Returns this tree viewer's tree control.
the tree control |
| getViewerRowFromItem | | protected ViewerRow getViewerRowFromItem(Widget item)(Code) | | |
| handleTreeExpand | | protected void handleTreeExpand(TreeEvent event)(Code) | | |
| hookControl | | protected void hookControl(Control control)(Code) | | |
| internalAdd | | protected void internalAdd(Widget widget, Object parentElement, Object[] childElements)(Code) | | |
| internalInitializeTree | | protected void internalInitializeTree(Control widget)(Code) | | |
| internalRefreshStruct | | protected void internalRefreshStruct(Widget widget, Object element, boolean updateLabels)(Code) | | |
| isExpandable | | public boolean isExpandable(Object element)(Code) | | |
| mapElement | | protected void mapElement(Object element, Widget item)(Code) | | |
| newItem | | protected Item newItem(Widget parent, int flags, int ix)(Code) | | |
| preservingSelection | | void preservingSelection(Runnable updateCode, boolean reveal)(Code) | | |
| remove | | public void remove(Object parentOrTreePath, int index)(Code) | | Removes the element at the specified index of the parent. The selection is updated if required.
Parameters:
parentOrTreePath - the parent element, the input element, or a tree path to the parent element
Parameters:
index - child index
since:
3.3 |
| removeAll | | protected void removeAll(Control widget)(Code) | | |
| replace | | public void replace(Object parentElementOrTreePath, int index, Object element)(Code) | | For a TreeViewer with a tree with the VIRTUAL style bit set, replace the
given parent's child at index with the given element. If the given parent
is this viewer's input or an empty tree path, this will replace the root
element at the given index.
This method should be called by implementers of ILazyTreeContentProvider
to populate this viewer.
Parameters:
parentElementOrTreePath - the parent of the element that should be updated, or the treepath to that parent
Parameters:
index - the index in the parent's children
Parameters:
element - the new element
See Also: TreeViewer.setChildCount(Object,int)
See Also: ILazyTreeContentProvider
See Also: ILazyTreePathContentProvider
since:
3.2 |
| setChildCount | | public void setChildCount(Object elementOrTreePath, int count)(Code) | | For a TreeViewer with a tree with the VIRTUAL style bit set, set the
number of children of the given element or tree path. To set the number
of children of the invisible root of the tree, you can pass the input
object or an empty tree path.
Parameters:
elementOrTreePath - the element, or tree path
Parameters:
count -
since:
3.2 |
| setExpanded | | protected void setExpanded(Item node, boolean expand)(Code) | | |
| setHasChildren | | public void setHasChildren(Object elementOrTreePath, boolean hasChildren)(Code) | | For a TreeViewer with a tree with the VIRTUAL style bit set, inform the
viewer about whether the given element or tree path has children. Avoid
calling this method if the number of children has already been set.
Parameters:
elementOrTreePath - the element, or tree path
Parameters:
hasChildren -
since:
3.3 |
| setSelection | | protected void setSelection(List items)(Code) | | |
| setSelection | | public void setSelection(ISelection selection, boolean reveal)(Code) | | Sets a new selection for this viewer and optionally makes it visible.
Currently the reveal parameter is not honored because
Tree does not provide an API to only select an item without
scrolling it into view
Parameters:
selection - the new selection
Parameters:
reveal - true if the selection is to be made visible,and false otherwise |
| showItem | | protected void showItem(Item item)(Code) | | |
| updatePlus | | protected void updatePlus(Item item, Object element)(Code) | | |
| Fields inherited from org.eclipse.jface.viewers.AbstractTreeViewer | final public static int ALL_LEVELS(Code)(Java Doc)
|
| Methods inherited from org.eclipse.jface.viewers.AbstractTreeViewer | public void add(Object parentElementOrTreePath, Object[] childElements)(Code)(Java Doc)
public void add(Object parentElementOrTreePath, Object childElement)(Code)(Java Doc)
protected void addSelectionListener(Control control, SelectionListener listener)(Code)(Java Doc)
public void addTreeListener(ITreeViewerListener listener)(Code)(Java Doc)
abstract protected void addTreeListener(Control control, TreeListener listener)(Code)(Java Doc)
protected void assertContentProviderType(IContentProvider provider)(Code)(Java Doc)
protected void associate(Object element, Item item)(Code)(Java Doc)
protected void buildLabel(ViewerLabel updateLabel, Object elementOrPath)(Code)(Java Doc)
public void collapseAll()(Code)(Java Doc)
public void collapseToLevel(Object elementOrTreePath, int level)(Code)(Java Doc)
protected void createChildren(Widget widget)(Code)(Java Doc)
protected void createTreeItem(Widget parent, Object element, int index)(Code)(Java Doc)
protected ColumnViewerEditor createViewerEditor()(Code)(Java Doc)
protected void disassociate(Item item)(Code)(Java Doc)
protected Widget doFindInputItem(Object element)(Code)(Java Doc)
protected Widget doFindItem(Object element)(Code)(Java Doc)
protected int doGetColumnCount()(Code)(Java Doc)
protected void doUpdateItem(Item item, Object element)(Code)(Java Doc)
protected void doUpdateItem(Widget widget, Object element, boolean fullMap)(Code)(Java Doc)
public void expandAll()(Code)(Java Doc)
public void expandToLevel(int level)(Code)(Java Doc)
public void expandToLevel(Object elementOrTreePath, int level)(Code)(Java Doc)
protected void fireTreeCollapsed(TreeExpansionEvent event)(Code)(Java Doc)
protected void fireTreeExpanded(TreeExpansionEvent event)(Code)(Java Doc)
public int getAutoExpandLevel()(Code)(Java Doc)
protected Item getChild(Widget widget, int index)(Code)(Java Doc)
abstract protected Item[] getChildren(Widget widget)(Code)(Java Doc)
protected Widget getColumnViewerOwner(int columnIndex)(Code)(Java Doc)
abstract protected boolean getExpanded(Item item)(Code)(Java Doc)
public Object[] getExpandedElements()(Code)(Java Doc)
public boolean getExpandedState(Object elementOrTreePath)(Code)(Java Doc)
public TreePath[] getExpandedTreePaths()(Code)(Java Doc)
protected Object[] getFilteredChildren(Object parentElementOrTreePath)(Code)(Java Doc)
protected Item getItemAt(Point point)(Code)(Java Doc)
abstract protected int getItemCount(Control control)(Code)(Java Doc)
abstract protected int getItemCount(Item item)(Code)(Java Doc)
abstract protected Item[] getItems(Item item)(Code)(Java Doc)
protected Item getNextItem(Item item, boolean includeChildren)(Code)(Java Doc)
protected Object getParentElement(Object elementOrTreePath)(Code)(Java Doc)
abstract protected Item getParentItem(Item item)(Code)(Java Doc)
protected Item getPreviousItem(Item item)(Code)(Java Doc)
protected Object[] getRawChildren(Object parentElementOrTreePath)(Code)(Java Doc)
abstract protected Item[] getSelection(Control control)(Code)(Java Doc)
public ISelection getSelection()(Code)(Java Doc)
protected List getSelectionFromWidget()(Code)(Java Doc)
protected Object[] getSortedChildren(Object parentElementOrTreePath)(Code)(Java Doc)
protected TreePath getTreePathFromItem(Item item)(Code)(Java Doc)
protected ViewerRow getViewerRowFromItem(Widget item)(Code)(Java Doc)
public Object[] getVisibleExpandedElements()(Code)(Java Doc)
protected void handleDoubleSelect(SelectionEvent event)(Code)(Java Doc)
protected void handleTreeCollapse(TreeEvent event)(Code)(Java Doc)
protected void handleTreeExpand(TreeEvent event)(Code)(Java Doc)
protected void hookControl(Control control)(Code)(Java Doc)
protected int indexForElement(Widget parent, Object element)(Code)(Java Doc)
protected void inputChanged(Object input, Object oldInput)(Code)(Java Doc)
public void insert(Object parentElementOrTreePath, Object element, int position)(Code)(Java Doc)
protected void internalAdd(Widget widget, Object parentElementOrTreePath, Object[] childElements)(Code)(Java Doc)
protected void internalCollapseToLevel(Widget widget, int level)(Code)(Java Doc)
protected Widget internalExpand(Object elementOrPath, boolean expand)(Code)(Java Doc)
protected void internalExpandToLevel(Widget widget, int level)(Code)(Java Doc)
final protected Widget[] internalFindItems(Object parentElementOrTreePath)(Code)(Java Doc)
protected Widget internalGetWidgetToSelect(Object elementOrTreePath)(Code)(Java Doc)
protected void internalInitializeTree(Control tree)(Code)(Java Doc)
final protected boolean internalIsInputOrEmptyPath(Object elementOrTreePath)(Code)(Java Doc)
protected void internalRefresh(Object element)(Code)(Java Doc)
protected void internalRefresh(Object element, boolean updateLabels)(Code)(Java Doc)
protected void internalRefresh(Widget widget, Object element, boolean doStruct, boolean updateLabels)(Code)(Java Doc)
void internalRefreshStruct(Widget widget, Object element, boolean updateLabels)(Code)(Java Doc)
protected void internalRemove(Object[] elementsOrPaths)(Code)(Java Doc)
protected void internalRemove(Object parent, Object[] elements)(Code)(Java Doc)
public boolean isExpandable(Object elementOrTreePath)(Code)(Java Doc)
protected boolean isSameSelection(List items, Item[] current)(Code)(Java Doc)
protected void labelProviderChanged()(Code)(Java Doc)
abstract protected Item newItem(Widget parent, int style, int index)(Code)(Java Doc)
public void remove(Object[] elementsOrTreePaths)(Code)(Java Doc)
public void remove(Object parent, Object[] elements)(Code)(Java Doc)
public void remove(Object elementsOrTreePaths)(Code)(Java Doc)
abstract protected void removeAll(Control control)(Code)(Java Doc)
public void removeTreeListener(ITreeViewerListener listener)(Code)(Java Doc)
public void reveal(Object elementOrTreePath)(Code)(Java Doc)
public Item scrollDown(int x, int y)(Code)(Java Doc)
public Item scrollUp(int x, int y)(Code)(Java Doc)
public void setAutoExpandLevel(int level)(Code)(Java Doc)
public void setContentProvider(IContentProvider provider)(Code)(Java Doc)
abstract protected void setExpanded(Item item, boolean expand)(Code)(Java Doc)
public void setExpandedElements(Object[] elements)(Code)(Java Doc)
public void setExpandedState(Object elementOrTreePath, boolean expanded)(Code)(Java Doc)
public void setExpandedTreePaths(TreePath[] treePaths)(Code)(Java Doc)
abstract protected void setSelection(List items)(Code)(Java Doc)
protected void setSelectionToWidget(List v, boolean reveal)(Code)(Java Doc)
protected void setSelectionToWidget(ISelection selection, boolean reveal)(Code)(Java Doc)
abstract protected void showItem(Item item)(Code)(Java Doc)
protected void updateChildren(Widget widget, Object parent, Object[] elementChildren)(Code)(Java Doc)
protected void updatePlus(Item item, Object element)(Code)(Java Doc)
|
| Methods inherited from org.eclipse.jface.viewers.StructuredViewer | public void addDoubleClickListener(IDoubleClickListener listener)(Code)(Java Doc)
public void addDragSupport(int operations, Transfer[] transferTypes, DragSourceListener listener)(Code)(Java Doc)
public void addDropSupport(int operations, Transfer[] transferTypes, DropTargetListener listener)(Code)(Java Doc)
public void addFilter(ViewerFilter filter)(Code)(Java Doc)
public void addOpenListener(IOpenListener listener)(Code)(Java Doc)
public void addPostSelectionChangedListener(ISelectionChangedListener listener)(Code)(Java Doc)
protected void assertContentProviderType(IContentProvider provider)(Code)(Java Doc)
protected void assertElementsNotNull(Object[] elements)(Code)(Java Doc)
protected void associate(Object element, Item item)(Code)(Java Doc)
protected void buildLabel(ViewerLabel updateLabel, Object element)(Code)(Java Doc)
void buildLabel(ViewerLabel updateLabel, Object element, IViewerLabelProvider labelProvider)(Code)(Java Doc)
void buildLabel(ViewerLabel updateLabel, TreePath elementPath, ITreePathLabelProvider labelProvider)(Code)(Java Doc)
void buildLabel(ViewerLabel updateLabel, Object element, ILabelProvider labelProvider)(Code)(Java Doc)
protected void disassociate(Item item)(Code)(Java Doc)
abstract protected Widget doFindInputItem(Object element)(Code)(Java Doc)
abstract protected Widget doFindItem(Object element)(Code)(Java Doc)
abstract protected void doUpdateItem(Widget item, Object element, boolean fullMap)(Code)(Java Doc)
protected boolean equals(Object elementA, Object elementB)(Code)(Java Doc)
protected Object[] filter(Object[] elements)(Code)(Java Doc)
final protected Widget findItem(Object element)(Code)(Java Doc)
final protected Widget[] findItems(Object element)(Code)(Java Doc)
protected void fireDoubleClick(DoubleClickEvent event)(Code)(Java Doc)
protected void fireOpen(OpenEvent event)(Code)(Java Doc)
protected void firePostSelectionChanged(SelectionChangedEvent event)(Code)(Java Doc)
protected ColorAndFontCollector getColorAndFontCollector()(Code)(Java Doc)
public ViewerComparator getComparator()(Code)(Java Doc)
public IElementComparer getComparer()(Code)(Java Doc)
protected Object[] getFilteredChildren(Object parent)(Code)(Java Doc)
public ViewerFilter[] getFilters()(Code)(Java Doc)
protected Item getItem(int x, int y)(Code)(Java Doc)
protected Object[] getRawChildren(Object parent)(Code)(Java Doc)
protected Object getRoot()(Code)(Java Doc)
public ISelection getSelection()(Code)(Java Doc)
abstract protected List getSelectionFromWidget()(Code)(Java Doc)
protected Object[] getSortedChildren(Object parent)(Code)(Java Doc)
public ViewerSorter getSorter()(Code)(Java Doc)
protected void handleDispose(DisposeEvent event)(Code)(Java Doc)
protected void handleDoubleSelect(SelectionEvent event)(Code)(Java Doc)
protected void handleInvalidSelection(ISelection invalidSelection, ISelection newSelection)(Code)(Java Doc)
protected void handleLabelProviderChanged(LabelProviderChangedEvent event)(Code)(Java Doc)
protected void handleOpen(SelectionEvent event)(Code)(Java Doc)
protected void handlePostSelect(SelectionEvent e)(Code)(Java Doc)
protected void handleSelect(SelectionEvent event)(Code)(Java Doc)
protected boolean hasFilters()(Code)(Java Doc)
protected void hookControl(Control control)(Code)(Java Doc)
abstract protected void internalRefresh(Object element)(Code)(Java Doc)
protected void internalRefresh(Object element, boolean updateLabels)(Code)(Java Doc)
protected void internalUpdate(Widget widget, Object element, String[] properties)(Code)(Java Doc)
protected void mapElement(Object element, Widget item)(Code)(Java Doc)
protected boolean needsRefilter(Object element, String property)(Code)(Java Doc)
CustomHashtable newHashtable(int capacity)(Code)(Java Doc)
protected void preservingSelection(Runnable updateCode)(Code)(Java Doc)
void preservingSelection(Runnable updateCode, boolean reveal)(Code)(Java Doc)
public void refresh()(Code)(Java Doc)
public void refresh(boolean updateLabels)(Code)(Java Doc)
public void refresh(Object element)(Code)(Java Doc)
public void refresh(Object element, boolean updateLabels)(Code)(Java Doc)
final protected void refreshItem(Widget widget, Object element)(Code)(Java Doc)
public void removeDoubleClickListener(IDoubleClickListener listener)(Code)(Java Doc)
public void removeFilter(ViewerFilter filter)(Code)(Java Doc)
public void removeOpenListener(IOpenListener listener)(Code)(Java Doc)
public void removePostSelectionChangedListener(ISelectionChangedListener listener)(Code)(Java Doc)
public void resetFilters()(Code)(Java Doc)
abstract public void reveal(Object element)(Code)(Java Doc)
public void setComparator(ViewerComparator comparator)(Code)(Java Doc)
public void setComparer(IElementComparer comparer)(Code)(Java Doc)
public void setContentProvider(IContentProvider provider)(Code)(Java Doc)
public void setFilters(ViewerFilter[] filters)(Code)(Java Doc)
final public void setInput(Object input)(Code)(Java Doc)
public void setLabelProvider(IBaseLabelProvider labelProvider)(Code)(Java Doc)
public void setSelection(ISelection selection, boolean reveal)(Code)(Java Doc)
abstract protected void setSelectionToWidget(List l, boolean reveal)(Code)(Java Doc)
protected void setSelectionToWidget(ISelection selection, boolean reveal)(Code)(Java Doc)
public void setSorter(ViewerSorter sorter)(Code)(Java Doc)
public void setUseHashlookup(boolean enable)(Code)(Java Doc)
public Widget testFindItem(Object element)(Code)(Java Doc)
public Widget[] testFindItems(Object element)(Code)(Java Doc)
protected void unmapAllElements()(Code)(Java Doc)
protected void unmapElement(Object element)(Code)(Java Doc)
protected void unmapElement(Object element, Widget item)(Code)(Java Doc)
public void update(Object[] elements, String[] properties)(Code)(Java Doc)
public void update(Object element, String[] properties)(Code)(Java Doc)
final protected void updateItem(Widget widget, Object element)(Code)(Java Doc)
protected void updateSelection(ISelection selection)(Code)(Java Doc)
protected boolean usingElementMap()(Code)(Java Doc)
|
| Fields inherited from org.eclipse.jface.viewers.Viewer | final protected static String WIDGET_DATA_KEY(Code)(Java Doc)
|
|
|