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

An EditPartViewer implementation based on a Tree.


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(Point pt, Collection exclude, EditPartViewer.Conditional condition)
          Returns null or the EditPart at the specified location, using the given exclusion set and conditional.
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)
          Reveals 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. The default styles will show scrollbars as needed, and allows for multiple selection.

Specified by:
createControl in interface EditPartViewer
Specified by:
createControl in class AbstractEditPartViewer
Parameters:
parent - The parent for the Tree
Returns:
the control
See Also:
EditPartViewer.createControl(org.eclipse.swt.widgets.Composite)

findObjectAtExcluding

public EditPart findObjectAtExcluding(Point pt,
                                      Collection exclude,
                                      EditPartViewer.Conditional condition)
Description copied from interface: EditPartViewer
Returns null or the EditPart at the specified location, using the given exclusion set and conditional. This method behaves similarly to EditPartViewer.findObjectAt(Point).

Parameters:
pt - The mouse location
exclude - The set of EditParts to be excluded
condition - the Conditional used to evaluate a potential hit
Returns:
null or an EditPart
See Also:
EditPartViewer.findObjectAtExcluding(Point, Collection, EditPartViewer.Conditional)

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
See Also:
AbstractEditPartViewer.fireSelectionChanged()

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
See Also:
AbstractEditPartViewer.unhookControl()

reveal

public void reveal(EditPart part)
Description copied from interface: EditPartViewer
Reveals 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.