Package org.eclipse.gef
Interface GraphicalEditPart
-
- All Superinterfaces:
EditPart,IAdaptable
- All Known Subinterfaces:
ConnectionEditPart,IScrollableEditPart,NodeEditPart
- All Known Implementing Classes:
AbstractConnectionEditPart,AbstractGraphicalEditPart,FreeformGraphicalRootEditPart,GraphicalRootEditPart,ScalableFreeformRootEditPart,ScalableRootEditPart,SimpleRootEditPart
public interface GraphicalEditPart extends EditPart
A Specialization ofEditPartfor use withGraphicalViewers. The visual part of a GraphicalEditPart is aFigure.IMPORTANT: This interface is not intended to be implemented by clients. Clients should inherit from
AbstractGraphicalEditPart. New methods may be added in the future.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.gef.EditPart
SELECTED, SELECTED_NONE, SELECTED_PRIMARY
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddNodeListener(NodeListener listener)Adds a NodeListener to the EditPart.org.eclipse.draw2d.IFiguregetContentPane()The Figure into which childrens' Figures will be added.org.eclipse.draw2d.IFiguregetFigure()Returns the primary Figure representing this GraphicalEditPart.java.util.ListgetSourceConnections()Returns the source connections for this GraphicalEditPart.java.util.ListgetTargetConnections()Returns the target connections for this GraphicalEditPart.voidremoveNodeListener(NodeListener listener)Removes the first occurance of the specified listener from the list of listeners.voidsetLayoutConstraint(EditPart child, org.eclipse.draw2d.IFigure figure, java.lang.Object constraint)Sets the specified constraint for a child's Figure on thecontent panefigure for this GraphicalEditPart.-
Methods inherited from interface org.eclipse.gef.EditPart
activate, addEditPartListener, addNotify, deactivate, eraseSourceFeedback, eraseTargetFeedback, getChildren, getCommand, getDragTracker, 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
-
-
-
-
Method Detail
-
addNodeListener
void addNodeListener(NodeListener listener)
Adds a NodeListener to the EditPart. Duplicate calls result in duplicate notification.- Parameters:
listener- the Listener
-
getFigure
org.eclipse.draw2d.IFigure getFigure()
Returns the primary Figure representing this GraphicalEditPart. The parent will add this Figure to its content pane. The Figure may be a composition of several Figures.- Returns:
- this EditPart's Figure
-
getSourceConnections
java.util.List getSourceConnections()
Returns the source connections for this GraphicalEditPart. This method should only be called by the EditPart itself, and its helpers such as EditPolicies.- Returns:
- the source connections
-
getTargetConnections
java.util.List getTargetConnections()
Returns the target connections for this GraphicalEditPart. This method should only be called by the EditPart itself, and its helpers such as EditPolicies.- Returns:
- the target connections
-
getContentPane
org.eclipse.draw2d.IFigure getContentPane()
The Figure into which childrens' Figures will be added. May return the same Figure asgetFigure(). The GraphicalEditPart'sprimary Figuremay be composed of multiple figures. This is the figure in that composition that will contain children's figures.- Returns:
- the content pane Figure
-
removeNodeListener
void removeNodeListener(NodeListener listener)
Removes the first occurance of the specified listener from the list of listeners. Does nothing if the listener was not present.- Parameters:
listener- the listener being removed
-
setLayoutConstraint
void setLayoutConstraint(EditPart child, org.eclipse.draw2d.IFigure figure, java.lang.Object constraint)
Sets the specified constraint for a child's Figure on thecontent panefigure for this GraphicalEditPart. The constraint will be applied to the content pane'sLayoutManager.revalidate()is called on the content pane, which will cause it to layout during the next update.- Parameters:
child- the child GraphicalEditPart whose constraint is being setfigure- the Figure whose constraint is being setconstraint- the constraint for the draw2dLayoutManager
-
-