org.eclipse.gef
Interface GraphicalEditPart

All Superinterfaces:

EditPart, IAdaptable

All Known Subinterfaces:

ConnectionEditPart, NodeEditPart

All Known Implementing Classes:

AbstractGraphicalEditPart

public interface GraphicalEditPart

extends EditPart

Specialized EditPart for use with Graphical draw2d Figures.

Fields inherited from interface org.eclipse.gef.EditPart

SELECTED, SELECTED_NONE, SELECTED_PRIMARY

Method Summary

IFigure	getContentPane() The figure into which children will be placed.
IFigure	getFigure() Returns the outer-most figure representing this EditPart.
List	getSourceConnections() Returns the connections for which this EditPart is the source.
List	getTargetConnections() Returns the connections for which this EditPart is the target.
void	setLayoutConstraint(EditPart child, IFigure figure, Object constraint) A child can call this method to set the layout constraint for its figure.

Methods inherited from interface org.eclipse.gef.EditPart

activate, addEditPartListener, deactivate, dispose, eraseSourceFeedback, eraseTargetFeedback, getChildren, getCommand, getDragTracker, getEditPolicy, getKeyHandler, getModel, getParent, getRoot, getSelected, getTargetEditPart, hasFocus, installEditPolicy, performRequest, refresh, removeEditPartListener, removeEditPolicy, setFocus, setModel, setParent, setSelected, showSourceFeedback, showTargetFeedback, understandsRequest

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getFigure

public IFigure getFigure()

Returns the outer-most figure representing this EditPart. This is the figure that will be added into the parent's content pane.

getSourceConnections

public List getSourceConnections()

Returns the connections for which this EditPart is the source. This method should only be called internally or by helpers such as edit policies.

getTargetConnections

public List getTargetConnections()

Returns the connections for which this EditPart is the target. This method should only be called internally or by helpers such as edit policies.

getContentPane

public IFigure getContentPane()

The figure into which children will be placed. Should not return null, but may return the same figure as getFigure(). An example would be a GraphicalEditPart that uses a ScrollPane, which looks like this:

┬	ScrollPane - returned by getFigure()
└	┬	Viewport - (internal, does the scrolling)
	└	─	View - returned by getContentPane()

A ScrollPane already has a special child, so the GraphicalEditPart's children will get added to the View

setLayoutConstraint

public void setLayoutConstraint(EditPart child,
                                IFigure figure,
                                Object constraint)

A child can call this method to set the layout constraint for its figure.