Package org.eclipse.gef.editparts
Class AbstractTreeEditPart
java.lang.Object
org.eclipse.gef.editparts.AbstractEditPart
org.eclipse.gef.editparts.AbstractTreeEditPart
- All Implemented Interfaces:
IAdaptable
,EditPart
,RequestConstants
,TreeEditPart
Default implementation for
TreeEditPart
s used in GEF
TreeViewer
s.
This is an implementation class, and the documentation here is targeted at subclassing this class. Callers of public API should refer to the interface's documentation.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.gef.editparts.AbstractEditPart
AbstractEditPart.EditPolicyIterator
-
Field Summary
FieldsFields inherited from class org.eclipse.gef.editparts.AbstractEditPart
children, FLAG_ACTIVE, FLAG_FOCUS, MAX_FLAG
Fields inherited from interface org.eclipse.gef.EditPart
SELECTED, SELECTED_NONE, SELECTED_PRIMARY
Fields inherited from interface org.eclipse.gef.RequestConstants
REQ_ADD, REQ_ALIGN, REQ_ALIGN_CHILDREN, REQ_CLONE, REQ_CONNECTION_END, REQ_CONNECTION_START, REQ_CREATE, REQ_CREATE_BENDPOINT, REQ_DELETE, REQ_DELETE_DEPENDANT, REQ_DIRECT_EDIT, REQ_MOVE, REQ_MOVE_BENDPOINT, REQ_MOVE_CHILDREN, REQ_OPEN, REQ_ORPHAN, REQ_ORPHAN_CHILDREN, REQ_RECONNECT_SOURCE, REQ_RECONNECT_TARGET, REQ_RESIZE, REQ_RESIZE_CHILDREN, REQ_SELECTION, REQ_SELECTION_HOVER
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorAbstractTreeEditPart
(Object model) Constructs a new EditPart with the specified model. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addChildVisual
(EditPart childEditPart, int index) Implemented to assign the child itswidget
.protected final boolean
Convenience method that returnstrue
if the widget is a TreeItem and is safe to use.protected void
Override this method to install the EditPolicies for your EditPart.List<? extends TreeEditPart>
Returns the List of childrenEditParts
.getDragTracker
(Request req) Returns aDragTracker
for dragging this EditPart.protected Image
getImage()
Override this method to return theImage
for this EditPart'swidget
.protected String
getText()
Override this method to return the String to be used in this EditPart'swidget
.protected void
By default, this method will apply anImage
andString
to the widget if it is aTreeItem
.protected void
removeChildVisual
(EditPart childEditPart) Disposes the child'swidget
and sets it tonull
.protected void
reorderChild
(EditPart editpart, int index) Moves a childEditPart
into a lower index than it currently occupies.void
Sets thewidget
.protected final void
setWidgetImage
(Image image) Sets a specifiedImage
into the widget iff it is aTreeItem
.protected final void
setWidgetText
(String text) Sets a specifiedString
into the widget iff it is aTreeItem
.Methods inherited from class org.eclipse.gef.editparts.AbstractEditPart
activate, activateEditPolicies, addChild, addEditPartListener, addNotify, createChild, deactivate, deactivateEditPolicies, debug, debugFeedback, eraseSourceFeedback, eraseTargetFeedback, fireActivated, fireChildAdded, fireDeactivated, fireRemovingChild, fireSelectionChanged, getAccessibleEditPart, getAdapter, getCommand, getEditPolicy, getEditPolicyIterable, getEditPolicyIterator, getEventListeners, getEventListenersIterable, getFlag, getModel, getModelChildren, getParent, getRoot, getSelected, getTargetEditPart, getViewer, hasFocus, installEditPolicy, isActive, isSelectable, performRequest, refresh, refreshChildren, register, registerAccessibility, registerModel, registerVisuals, removeChild, removeEditPartListener, removeEditPolicy, removeNotify, setFlag, setFocus, setModel, setParent, setSelected, showSourceFeedback, showTargetFeedback, toString, understandsRequest, unregister, unregisterAccessibility, unregisterModel, unregisterVisuals
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.gef.EditPart
activate, addEditPartListener, addNotify, deactivate, eraseSourceFeedback, eraseTargetFeedback, getCommand, getEditPolicy, getModel, getParent, getRoot, getSelected, getTargetEditPart, getViewer, hasFocus, installEditPolicy, isActive, isSelectable, performRequest, refresh, removeEditPartListener, removeEditPolicy, removeNotify, setFocus, setModel, setParent, setSelected, showSourceFeedback, showTargetFeedback, understandsRequest
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
-
Field Details
-
widget
Either a Tree or TreeItem
-
-
Constructor Details
-
AbstractTreeEditPart
Constructs a new EditPart with the specified model.- Parameters:
model
- the model
-
AbstractTreeEditPart
public AbstractTreeEditPart()Default constructor
-
-
Method Details
-
addChildVisual
Implemented to assign the child itswidget
. Subclasses should not call or override this method.- Specified by:
addChildVisual
in classAbstractEditPart
- Parameters:
childEditPart
- The EditPart being addedindex
- The child's position- See Also:
-
checkTreeItem
protected final boolean checkTreeItem()Convenience method that returnstrue
if the widget is a TreeItem and is safe to use.- Returns:
true
if the widget is aTreeItem
and is not disposed
-
createEditPolicies
protected void createEditPolicies()Override this method to install the EditPolicies for your EditPart.- Specified by:
createEditPolicies
in classAbstractEditPart
- See Also:
-
getChildren
Description copied from interface:EditPart
Returns the List of childrenEditParts
. This method should rarely be called, and is only made public so that helper objects of this EditPart, such as EditPolicies, can obtain the children. The returned List may be by reference, and should never be modified.- Specified by:
getChildren
in interfaceEditPart
- Overrides:
getChildren
in classAbstractEditPart
- Returns:
- a
List
of children - See Also:
-
getDragTracker
Description copied from interface:EditPart
Returns aDragTracker
for dragging this EditPart. TheSelectionTool
is the only Tool by default that calls this method. The SelectionTool will use aSelectionRequest
to provide information such as which mouse button is down, and what modifier keys are pressed.- Specified by:
getDragTracker
in interfaceEditPart
- Parameters:
req
- aRequest
indicating the context of the drag- Returns:
null
or a DragTracker- See Also:
-
getImage
Override this method to return theImage
for this EditPart'swidget
. This method is called fromrefreshVisuals()
.- Returns:
- the Image to be displayed in the TreeItem
-
getText
Override this method to return the String to be used in this EditPart'swidget
. This method is called fromrefreshVisuals()
.- Returns:
- the String to be displayed by the TreeItem
-
getWidget
Description copied from interface:TreeEditPart
- Specified by:
getWidget
in interfaceTreeEditPart
- Returns:
- the Widget
- See Also:
-
refreshVisuals
protected void refreshVisuals()By default, this method will apply anImage
andString
to the widget if it is aTreeItem
. Subclasses should overridegetImage()
andgetText()
to provide theImage
andString
used.Subclasses might extend this method if they also want to change the TreeItem's foreground or background color.
- Overrides:
refreshVisuals
in classAbstractEditPart
- See Also:
-
removeChildVisual
Disposes the child'swidget
and sets it tonull
.- Specified by:
removeChildVisual
in classAbstractEditPart
- Parameters:
childEditPart
- the child EditPart- See Also:
-
reorderChild
Description copied from class:AbstractEditPart
Moves a childEditPart
into a lower index than it currently occupies. This method is called fromAbstractEditPart.refreshChildren()
.- Overrides:
reorderChild
in classAbstractEditPart
- Parameters:
editpart
- the child being reorderedindex
- new index for the child- See Also:
-
setWidget
Sets thewidget
.- Specified by:
setWidget
in interfaceTreeEditPart
- Parameters:
widget
- the Widget- See Also:
-
setWidgetImage
Sets a specifiedImage
into the widget iff it is aTreeItem
.- Parameters:
image
- the Image
-
setWidgetText
Sets a specifiedString
into the widget iff it is aTreeItem
.- Parameters:
text
- the String
-