|
Eclipse GEF 2.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.gef.editparts.AbstractEditPart | +--org.eclipse.gef.editparts.AbstractTreeEditPart
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 inherited from class org.eclipse.gef.editparts.AbstractEditPart |
AbstractEditPart.EditPolicyIterator |
Field Summary | |
protected Widget |
widget
Either a Tree or TreeItem |
Fields 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_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 | |
AbstractTreeEditPart()
Default constructor |
|
AbstractTreeEditPart(Object model)
Constructs a new EditPart with the specified model. |
Method Summary | |
protected void |
addChildVisual(EditPart childEditPart,
int index)
Implemented to assign the child its widget .
|
protected boolean |
checkTreeItem()
Convenience method that returns true if the widget is a TreeItem and is
safe to use. |
protected void |
createEditPolicies()
Override this method to install the EditPolicies for your EditPart. |
DragTracker |
getDragTracker(Request req)
Returns a DragTracker for dragging this EditPart. |
protected Image |
getImage()
Override this method to return the Image for this EditPart's widget . |
protected String |
getText()
Override this method to return the String to be used in this EditPart's widget . |
Widget |
getWidget()
Returns either a Tree or
TreeItem . |
protected void |
refreshVisuals()
By default, this method will apply an Image and String to the widget if it is a
TreeItem . |
protected void |
removeChildVisual(EditPart childEditPart)
Disposes the child's widget and sets it to null . |
protected void |
reorderChild(EditPart editpart,
int index)
Moves a child EditPart into a lower index than it currently occupies. |
void |
setWidget(Widget widget)
Sets the widget . |
protected void |
setWidgetImage(Image image)
Sets a specified Image into the widget iff it is a TreeItem . |
protected void |
setWidgetText(String text)
Sets a specified String into the widget iff it is a TreeItem . |
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, getChildren, 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 Detail |
protected Widget widget
Constructor Detail |
public AbstractTreeEditPart(Object model)
model
- the modelpublic AbstractTreeEditPart()
Method Detail |
protected void addChildVisual(EditPart childEditPart, int index)
widget
.
Subclasses should not call or override this method.
addChildVisual
in class AbstractEditPart
childEditPart
- The EditPart being added.index
- The child's position.AbstractEditPart.addChildVisual(EditPart, int)
protected final boolean checkTreeItem()
true
if the widget is a TreeItem and is
safe to use.
true
if the widget is a TreeItem
and is not disposedprotected void createEditPolicies()
createEditPolicies
in class AbstractEditPart
AbstractEditPart.createEditPolicies()
public DragTracker getDragTracker(Request req)
EditPart
DragTracker
for dragging this EditPart. The SelectionTool
is the only Tool by default that
calls this method. The SelectionTool will use a SelectionRequest
to provide information such as which mouse
button is down, and what modifier keys are pressed.
getDragTracker
in interface EditPart
req
- a Request
indicating the context of the drag
null
or a DragTrackerEditPart.getDragTracker(Request)
protected Image getImage()
Image
for this EditPart's widget
. This method is called from
refreshVisuals()
.
protected String getText()
widget
. This method is called from refreshVisuals()
.
public Widget getWidget()
TreeEditPart
Tree
or
TreeItem
.
getWidget
in interface TreeEditPart
TreeEditPart.getWidget()
protected void refreshVisuals()
Image
and String
to the widget if it is a
TreeItem
. Subclasses should override getImage()
and getText()
to provide the Image
and String
used.
Subclasses might extend this method if they also want to change the TreeItem's foreground or background color.
refreshVisuals
in class AbstractEditPart
AbstractEditPart.refreshVisuals()
protected void removeChildVisual(EditPart childEditPart)
widget
and sets it to null
.
removeChildVisual
in class AbstractEditPart
childEditPart
- the child EditPartAbstractEditPart.removeChildVisual(EditPart)
protected void reorderChild(EditPart editpart, int index)
AbstractEditPart
EditPart
into a lower index than it currently occupies. This
method is called from AbstractEditPart.refreshChildren()
.
reorderChild
in class AbstractEditPart
editpart
- the child being reorderedindex
- new index for the childAbstractEditPart.reorderChild(EditPart, int)
public void setWidget(Widget widget)
widget
.
setWidget
in interface TreeEditPart
widget
- the WidgetTreeEditPart.setWidget(Widget)
protected final void setWidgetImage(Image image)
Image
into the widget iff it is a TreeItem
.
image
- the Imageprotected final void setWidgetText(String text)
String
into the widget iff it is a TreeItem
.
text
- the String
|
Eclipse GEF 2.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |