Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> jface >> [ viewers overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.jface.viewers
Class TreeViewer  

java.lang.Object
  org.eclipse.jface.viewers.Viewer
      org.eclipse.jface.viewers.ContentViewer
          org.eclipse.jface.viewers.StructuredViewer
              org.eclipse.jface.viewers.AbstractTreeViewer
                  org.eclipse.jface.viewers.TreeViewer

All Implemented Interfaces:

IInputProvider, IInputSelectionProvider, IPostSelectionProvider, ISelectionProvider

Direct Known Subclasses:

CheckboxTreeViewer

---

public class TreeViewer

extends AbstractTreeViewer

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 the ITreeContentProvider interface.

---

Nested Class Summary

 

Nested classes inherited from class org.eclipse.jface.viewers.AbstractTreeViewer

AbstractTreeViewer.UpdateItemSafeRunnable

 

Field Summary
private  org.eclipse.swt.widgets.Tree	tree           This viewer's control.

 

Fields inherited from class org.eclipse.jface.viewers.AbstractTreeViewer

ALL_LEVELS

 

Fields inherited from class org.eclipse.jface.viewers.StructuredViewer

 

Fields inherited from class org.eclipse.jface.viewers.ContentViewer

 

Fields inherited from class org.eclipse.jface.viewers.Viewer

WIDGET_DATA_KEY

 

Constructor Summary

TreeViewer(org.eclipse.swt.widgets.Composite parent)           Creates a tree viewer on a newly-created tree control under the given parent.

TreeViewer(org.eclipse.swt.widgets.Composite parent, int style)           Creates a tree viewer on a newly-created tree control under the given parent.

TreeViewer(org.eclipse.swt.widgets.Tree tree)           Creates a tree viewer on the given tree control.

 

Method Summary
protected  void	addTreeListener(org.eclipse.swt.widgets.Control c, org.eclipse.swt.events.TreeListener listener)           Adds the given SWT tree listener to the given SWT control.
protected  void	doUpdateItem(org.eclipse.swt.widgets.Item item, java.lang.Object element)           Copies the attributes of the given element into the given SWT item.
protected  org.eclipse.swt.widgets.Item[]	getChildren(org.eclipse.swt.widgets.Widget o)           Returns the SWT child items for the given SWT widget.
org.eclipse.swt.widgets.Control	getControl()           Returns the primary control associated with this viewer.
protected  boolean	getExpanded(org.eclipse.swt.widgets.Item item)           Returns whether the given SWT item is expanded or collapsed.
protected  org.eclipse.swt.widgets.Item	getItem(int x, int y)           Returns the item at the given display-relative coordinates, or null if there is no item at that location.
protected  int	getItemCount(org.eclipse.swt.widgets.Control widget)           Returns the number of child items of the given SWT control.
protected  int	getItemCount(org.eclipse.swt.widgets.Item item)           Returns the number of child items of the given SWT item.
protected  org.eclipse.swt.widgets.Item[]	getItems(org.eclipse.swt.widgets.Item item)           Returns the child items of the given SWT item.
IBaseLabelProvider	getLabelProvider()           The tree viewer implementation of this Viewer framework method returns the label provider, which in the case of tree viewers will be an instance of ILabelProvider.
protected  org.eclipse.swt.widgets.Item	getParentItem(org.eclipse.swt.widgets.Item item)           Returns the parent item of the given item in the tree, or null if there is parent item.
protected  org.eclipse.swt.widgets.Item[]	getSelection(org.eclipse.swt.widgets.Control widget)           Returns all selected items for the given SWT control.
org.eclipse.swt.widgets.Tree	getTree()           Returns this tree viewer's tree control.
private  boolean	haveSameData(java.util.List items, org.eclipse.swt.widgets.Item[] current)           Returns true if the given list and array of items refer to the same model elements.
protected  org.eclipse.swt.widgets.Item	newItem(org.eclipse.swt.widgets.Widget parent, int flags, int ix)           Creates a new item.
protected  void	removeAll(org.eclipse.swt.widgets.Control widget)           Removes all items from the given control.
protected  void	setExpanded(org.eclipse.swt.widgets.Item node, boolean expand)           Sets the expand state of the given item.
void	setLabelProvider(IBaseLabelProvider labelProvider)           The tree viewer implementation of this Viewer framework method ensures that the given label provider is an instance of ILabelProvider.
protected  void	setSelection(java.util.List items)           Sets the selection to the given list of items.
protected  void	showItem(org.eclipse.swt.widgets.Item item)           Shows the given item.

 

Methods inherited from class org.eclipse.jface.viewers.AbstractTreeViewer

add, add, addSelectionListener, addTreeListener, associate, collapseAll, collapseToLevel, createChildren, createTreeItem, disassociate, doFindInputItem, doFindItem, doUpdateItem, expandAll, expandToLevel, expandToLevel, fireTreeCollapsed, fireTreeExpanded, getAutoExpandLevel, getExpandedElements, getExpandedState, getNextItem, getPreviousItem, getRawChildren, getSelectionFromWidget, getVisibleExpandedElements, handleTreeCollapse, handleTreeExpand, hookControl, indexForElement, inputChanged, internalCollapseToLevel, internalExpand, internalExpandToLevel, internalRefresh, internalRefresh, isExpandable, labelProviderChanged, remove, remove, removeTreeListener, reveal, scrollDown, scrollUp, setAutoExpandLevel, setContentProvider, setExpandedElements, setExpandedState, setSelectionToWidget, updateChildren, updatePlus

 

Methods inherited from class org.eclipse.jface.viewers.StructuredViewer

addDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertElementsNotNull, equals, filter, findItem, fireDoubleClick, fireOpen, firePostSelectionChanged, getComparer, getFilteredChildren, getFilters, getRoot, getSelection, getSortedChildren, getSorter, handleDoubleSelect, handleInvalidSelection, handleLabelProviderChanged, handleOpen, handlePostSelect, handleSelect, hasFilters, mapElement, needsRefilter, newHashtable, preservingSelection, refresh, refresh, refresh, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparer, setInput, setSelection, setSelectionToWidget, setSorter, setUseHashlookup, testFindItem, unmapAllElements, unmapElement, unmapElement, update, update, updateItem, updateSelection, usingElementMap

 

Methods inherited from class org.eclipse.jface.viewers.ContentViewer

getContentProvider, getInput, handleDispose

 

Methods inherited from class org.eclipse.jface.viewers.Viewer

addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, setData, setSelection

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider

addSelectionChangedListener, removeSelectionChangedListener, setSelection

 

Field Detail

tree

private org.eclipse.swt.widgets.Tree tree

This viewer's control.

Constructor Detail

TreeViewer

public TreeViewer(org.eclipse.swt.widgets.Composite parent)

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.

---

TreeViewer

public TreeViewer(org.eclipse.swt.widgets.Composite parent,
                  int style)

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.

---

TreeViewer

public TreeViewer(org.eclipse.swt.widgets.Tree tree)

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.

Method Detail

addTreeListener

protected void addTreeListener(org.eclipse.swt.widgets.Control c,
                               org.eclipse.swt.events.TreeListener listener)

Description copied from class: AbstractTreeViewer

Adds the given SWT tree listener to the given SWT control.

Specified by:

addTreeListener in class AbstractTreeViewer

---

doUpdateItem

protected void doUpdateItem(org.eclipse.swt.widgets.Item item,
                            java.lang.Object element)

Description copied from class: AbstractTreeViewer

Copies the attributes of the given element into the given SWT item.

Specified by:

doUpdateItem in class AbstractTreeViewer

---

getChildren

protected org.eclipse.swt.widgets.Item[] getChildren(org.eclipse.swt.widgets.Widget o)

Description copied from class: AbstractTreeViewer

Returns the SWT child items for the given SWT widget.

Specified by:

getChildren in class AbstractTreeViewer

---

getControl

public org.eclipse.swt.widgets.Control getControl()

Description copied from class: Viewer

Returns the primary control associated with this viewer.

Specified by:

getControl in class Viewer

---

getExpanded

protected boolean getExpanded(org.eclipse.swt.widgets.Item item)

Description copied from class: AbstractTreeViewer

Returns whether the given SWT item is expanded or collapsed.

Specified by:

getExpanded in class AbstractTreeViewer

---

getItem

protected org.eclipse.swt.widgets.Item getItem(int x,
                                               int y)

Description copied from class: StructuredViewer

Returns the item at the given display-relative coordinates, or null if there is no item at that location.

The default implementation of this method returns null.

Overrides:

getItem in class StructuredViewer

---

getItemCount

protected int getItemCount(org.eclipse.swt.widgets.Control widget)

Description copied from class: AbstractTreeViewer

Returns the number of child items of the given SWT control.

Specified by:

getItemCount in class AbstractTreeViewer

---

getItemCount

protected int getItemCount(org.eclipse.swt.widgets.Item item)

Description copied from class: AbstractTreeViewer

Returns the number of child items of the given SWT item.

Specified by:

getItemCount in class AbstractTreeViewer

---

getItems

protected org.eclipse.swt.widgets.Item[] getItems(org.eclipse.swt.widgets.Item item)

Description copied from class: AbstractTreeViewer

Returns the child items of the given SWT item.

Specified by:

getItems in class AbstractTreeViewer

---

getLabelProvider

public IBaseLabelProvider getLabelProvider()

The tree viewer implementation of this Viewer framework method returns the label provider, which in the case of tree viewers will be an instance of ILabelProvider.

Overrides:

getLabelProvider in class ContentViewer

---

getParentItem

protected org.eclipse.swt.widgets.Item getParentItem(org.eclipse.swt.widgets.Item item)

Description copied from class: AbstractTreeViewer

Returns the parent item of the given item in the tree, or null if there is parent item.

Specified by:

getParentItem in class AbstractTreeViewer

---

getSelection

protected org.eclipse.swt.widgets.Item[] getSelection(org.eclipse.swt.widgets.Control widget)

Description copied from class: AbstractTreeViewer

Returns all selected items for the given SWT control.

Specified by:

getSelection in class AbstractTreeViewer

---

getTree

public org.eclipse.swt.widgets.Tree getTree()

Returns this tree viewer's tree control.

---

newItem

protected org.eclipse.swt.widgets.Item newItem(org.eclipse.swt.widgets.Widget parent,
                                               int flags,
                                               int ix)

Description copied from class: AbstractTreeViewer

Creates a new item.

Specified by:

newItem in class AbstractTreeViewer

---

removeAll

protected void removeAll(org.eclipse.swt.widgets.Control widget)

Description copied from class: AbstractTreeViewer

Removes all items from the given control.

Specified by:

removeAll in class AbstractTreeViewer

---

setExpanded

protected void setExpanded(org.eclipse.swt.widgets.Item node,
                           boolean expand)

Description copied from class: AbstractTreeViewer

Sets the expand state of the given item.

Specified by:

setExpanded in class AbstractTreeViewer

---

setLabelProvider

public void setLabelProvider(IBaseLabelProvider labelProvider)

The tree viewer implementation of this Viewer framework method ensures that the given label provider is an instance of ILabelProvider.

Overrides:

setLabelProvider in class ContentViewer

---

setSelection

protected void setSelection(java.util.List items)

Description copied from class: AbstractTreeViewer

Sets the selection to the given list of items.

Specified by:

setSelection in class AbstractTreeViewer

---

haveSameData

private boolean haveSameData(java.util.List items,
                             org.eclipse.swt.widgets.Item[] current)

Returns true if the given list and array of items refer to the same model elements. Order is unimportant.

---

showItem

protected void showItem(org.eclipse.swt.widgets.Item item)

Description copied from class: AbstractTreeViewer

Shows the given item.

Specified by:

showItem in class AbstractTreeViewer

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> jface >> [ viewers overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---