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 of EditPart for use with GraphicalViewers. The visual part of a GraphicalEditPart is a Figure.

IMPORTANT: This interface is not intended to be implemented by clients. Clients should inherit from AbstractGraphicalEditPart. New methods may be added in the future.

  • Method Details

    • 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

      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

      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
    • getChildren

      List<? extends GraphicalEditPart> getChildren()
      The children of GraphicalEditparts have to be GraphicalEditParts. Therefore the GraphicalEditPart refines this method from its parent interface.
      Specified by:
      getChildren in interface EditPart
      Returns:
      a List of children
      See Also:
    • getContentPane

      org.eclipse.draw2d.IFigure getContentPane()
      The Figure into which childrens' Figures will be added. May return the same Figure as getFigure(). The GraphicalEditPart's primary Figure may 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, Object constraint)
      Sets the specified constraint for a child's Figure on the content pane figure for this GraphicalEditPart. The constraint will be applied to the content pane's LayoutManager. 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 set
      figure - the Figure whose constraint is being set
      constraint - the constraint for the draw2d LayoutManager