Eclipse GEF
2.1

org.eclipse.gef.ui.parts
Class TreeViewer

java.lang.Object
  |
  +--org.eclipse.gef.ui.parts.AbstractEditPartViewer
        |
        +--org.eclipse.gef.ui.parts.TreeViewer
All Implemented Interfaces:
EditPartViewer, ISelectionProvider

public class TreeViewer
extends AbstractEditPartViewer


Nested Class Summary
 
Nested classes inherited from class org.eclipse.gef.EditPartViewer
EditPartViewer.Conditional
 
Field Summary
 
Fields inherited from class org.eclipse.gef.ui.parts.AbstractEditPartViewer
constantSelection, selection, selectionListeners
 
Constructor Summary
TreeViewer()
          The constructor.
 
Method Summary
 Control createControl(Composite parent)
          Creates the default tree and sets it as the control.
 EditPart findObjectAtExcluding(org.eclipse.draw2d.geometry.Point pt, Collection exclude, EditPartViewer.Conditional condition)
          Returns the Data of the TreeItem at the given point.
protected  void fireSelectionChanged()
          Fires selection changed to the registered listeners at the time called.
protected  void hookControl()
          "Hooks up" a Control, i.e. sets it as the control for the RootTreeEditPart, adds necessary listener for proper operation, etc.
 void reveal(EditPart part)
          Shows the given EditPart if it is not visible.
protected  void unhookControl()
          Unhooks a control so that it can be reset.
 
Methods inherited from class org.eclipse.gef.ui.parts.AbstractEditPartViewer
addDragSourceListener, addDropTargetListener, addSelectionChangedListener, appendSelection, deselect, deselectAll, findObjectAt, findObjectAtExcluding, flush, getContents, getContextMenu, getControl, getDelegatingDragAdapter, getDelegatingDropAdapter, getDragSource, getDropTarget, getEditDomain, getEditPartFactory, getEditPartRegistry, getFocusEditPart, getKeyHandler, getRootEditPart, getSelectedEditParts, getSelection, getVisualPartMap, handleDispose, hookDragSource, hookDropTarget, init, primGetSelectedEditParts, refreshDragSourceAdapter, refreshDropTargetAdapter, registerAccessibleEditPart, removeDragSourceListener, removeDropTargetListener, removeSelectionChangedListener, select, setContents, setContents, setContextMenu, setControl, setCursor, setDragSource, setDropTarget, setEditDomain, setEditPartFactory, setFocus, setKeyHandler, setRootEditPart, setRouteEventsToEditDomain, setSelection, unregisterAccessibleEditPart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TreeViewer

public TreeViewer()
The constructor. It sets up the default root edit part. The setEditor() and either one of createControl() or setControl() methods should be called to completely set up the GEFTreeViewer.

Method Detail

createControl

public Control createControl(Composite parent)
Creates the default tree and sets it as the control.

Specified by:
createControl in interface EditPartViewer
Specified by:
createControl in class AbstractEditPartViewer
Parameters:
parent - The parent Composite for the Control (tree).
Returns:
the created Control for convenience
See Also:
EditPartViewer.setControl(Control)

findObjectAtExcluding

public EditPart findObjectAtExcluding(org.eclipse.draw2d.geometry.Point pt,
                                      Collection exclude,
                                      EditPartViewer.Conditional condition)
Returns the Data of the TreeItem at the given point. Returns null if the Point is not on the Control (Tree). Returns the data of the Tree if there is no TreeItem at the given point. Sub-classes can override this method to respect the request to exclude the Objects in the given Collection.

Parameters:
pt - The location at which to look for a TreeItem
exclude - The collection of EditParts to be excluded.
condition - the Conditional used to evaluate a potential hit
Returns:
null or an EditPart

fireSelectionChanged

protected void fireSelectionChanged()
Description copied from class: AbstractEditPartViewer
Fires selection changed to the registered listeners at the time called.

Overrides:
fireSelectionChanged in class AbstractEditPartViewer

hookControl

protected void hookControl()
"Hooks up" a Control, i.e. sets it as the control for the RootTreeEditPart, adds necessary listener for proper operation, etc.

Overrides:
hookControl in class AbstractEditPartViewer

reveal

public void reveal(EditPart part)
Description copied from interface: EditPartViewer
Shows the given EditPart if it is not visible.

Specified by:
reveal in interface EditPartViewer
Overrides:
reveal in class AbstractEditPartViewer
See Also:
AbstractEditPartViewer.reveal(org.eclipse.gef.EditPart)

unhookControl

protected void unhookControl()
Unhooks a control so that it can be reset. This method deactivates the contents, removes the Control as being the Control of the RootTreeEditPart, etc. It does not remove the listeners because it is causing errors, although that would be a desirable outcome.

Overrides:
unhookControl in class AbstractEditPartViewer

Eclipse GEF
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.