# Uses of Interface
org.eclipse.draw2d.IFigure

Packages that use IFigure
Package
Description
org.eclipse.draw2d
Primary package containing general interfaces and implementation classes.
org.eclipse.draw2d.parts
This package contains some complex parts used with Draw2d.
org.eclipse.draw2d.text
Figures and support classes related to the layout and rendering of rich text.

## Uses of IFigure in org.eclipse.draw2d

Subinterfaces of IFigure in org.eclipse.draw2d
Modifier and Type
Interface
Description
`interface`
`Connection`
A Connection is a figure that connects two objects.
`interface`
`FreeformFigure`
A figure that allows its children to extend into negative coordinates.
`interface`
`IImageFigure`
Interface for image figures
`interface`
`IScalablePane`
Interface for scaleable panes which provides the default functionality for deciding if a scaled graphics or the given graphics should be used for drawing.
`interface`
`IScrollableFigure`
Interface to stereotype those figures that contain a ScrollPane with a nested Viewport.
`interface`
`Orientable`
An interface for objects that can be either horizontally or vertically oriented.
`interface`
`RotatableDecoration`
An IFigure that can be rotated.
`interface`
`ScalableFigure`
A figure that can be scaled.
Classes in org.eclipse.draw2d that implement IFigure
Modifier and Type
Class
Description
`class`
`AbstractImageFigure`
Abstract implementation of the image figure.
`class`
`AbstractPointListShape`
Base superclass for all polylines/polygons
`class`
`ArrowButton`
A Button which displays a triangle pointing in a specified direction.
`class`
`AutoscaleFreeformViewport`
IMPORTANT: This class is not part of the GEF public API.
`class`
`Button`
A Button usually has a border and appears to move up and down in response to being pressed.
`final class`
`CheckBox`
A Checkbox is a toggle figure which toggles between the checked and unchecked figures to simulate a check box.
`class`
`Clickable`
A Clickable responds to mouse clicks in some way (determined by a ClickBehavior) and fires action events.
`class`
`ConnectionLayer`
Layer designed specifically to handle the presence of connections.
`class`
`Container`
Lightweight Container which just draws the children according to the given layout.
`class`
`Ellipse`
An figure that draws an ellipse filling its bounds.
`class`
`Figure`
The base implementation for graphical figures.
`class`
`FreeformLayer`
A Layer that can extend in all 4 directions.
`class`
`FreeformLayeredPane`
A LayeredPane that contains `FreeformLayers`.
`class`
`FreeformViewport`
A viewport for `FreeformFigures`.
`class`
`GhostImageFigure`
A figure used to render a partly transparent copy of an original source figure.
`class`
`ImageFigure`
A Figure that simply contains an Image.
`class`
`Label`
A figure that can display text and/or an image.
`class`
`LabeledContainer`
A Container with a title bar describing the contents of the container.
`class`
`Layer`
A transparent figure intended to be added exclusively to a `LayeredPane`, who has the responsibilty of managing its layers.
`class`
`LayeredPane`
A figure capable of holding any number of layers.
`protected class`
`LightweightSystem.RootFigure`
The figure at the root of the LightweightSystem.
`class`
`Panel`
A General purpose Container.
`class`
`Polygon`
Renders a `PointList` as a polygonal shape.
`class`
`PolygonDecoration`
A rotatable, polygon shaped decoration most commonly used for decorating the ends of `polylines`.
`class`
`PolygonShape`
Renders a `PointList` as a polygonal shape.
`class`
`Polyline`
Renders a `PointList` as a series of line segments.
`class`
`PolylineConnection`
An implementation of `Connection` based on Polyline.
`class`
`PolylineDecoration`
A decorative Figure intended to be placed on a `Polyline`.
`class`
`PolylineShape`
Renders a `PointList` as a series of line segments.
`class`
`PuristicScrollPane`
A `ScrollPane` with transparent `ScrollBar`s.
`class`
`PuristicScrollPane.PuristicScrollBar`
A `ScrollBar` with no thumb and non-opaque buttons.
`class`
`RectangleFigure`
Draws a rectangle whose size is determined by the bounds set to it.
`class`
`RoundedRectangle`
Draws a Rectangle whose corners are rounded in appearance.
`class`
`ScalableFreeformLayeredPane`
`class`
`ScalableLayeredPane`
A non-freeform, scalable layered pane.
`class`
`ScalablePolygonShape`
Renders a `PointList` as a polygonal shape scaled in accordance with bounds to fill whole figure.
`class`
`ScrollBar`
Provides for the scrollbars used by the `ScrollPane`.
`class`
`ScrollPane`
A class which implements automatic horizontal and/or vertical scrolling for a single IFigure child.
`class`
`Shape`
Provides abstract support for a variety of shapes.
`class`
`Toggle`
Basic Rule for Toggle: Whoever creates the toggle is reponsible for response changes for it (selection, rollover, etc).
`class`
`ToggleButton`
A Toggle that appears like a 3-dimensional button.
`final class`
`Triangle`
A triangular graphical figure.
`class`
`Viewport`
A Viewport is a flexible window onto a `ScrollPane` and represents the visible portion of the ScrollPane.
Fields in org.eclipse.draw2d declared as IFigure
Modifier and Type
Field
Description
`IFigure`
FocusEvent.`gainer`
The figure gaining focus
`IFigure`
FocusEvent.`loser`
The figure losing focus
`protected IFigure`
SubordinateUpdateManager.`root`
Deprecated.
A root figure.
`IFigure[]`
FlowLayout.WorkingData.`row`
`protected IFigure`
Figure.`toolTip`
Deprecated, for removal: This API element is subject to removal in a future version.
access using `Figure.getToolTip()` This field will be made private after the 2027-09 release.
Fields in org.eclipse.draw2d with type parameters of type IFigure
Modifier and Type
Field
Description
`protected Map<IFigure,Object>`
AbstractConstraintLayout.`constraints`
The layout constraints
`protected Map<IFigure,Object>`
GridLayout.`constraints`
The layout contraints
Methods in org.eclipse.draw2d that return IFigure
Modifier and Type
Method
Description
`protected IFigure`
PuristicScrollPane.PuristicScrollBar.`createDefaultThumb()`
`protected IFigure`
ScrollBar.`createDefaultThumb()`
Creates the Scrollbar's "thumb", the draggable Figure that indicates the Scrollbar's position.
`static IFigure`
FigureUtilities.`findCommonAncestor(IFigure l, IFigure r)`
Returns the figure which is the nearest common ancestor of both figures, or `null` if there is no common ancestor.
`protected IFigure`
Figure.`findDescendantAtExcluding(int x, int y, TreeSearch search)`
Returns a descendant of this Figure such that the Figure returned contains the point (x, y), and is accepted by the given TreeSearch.
`final IFigure`
Figure.`findFigureAt(int x, int y)`
`IFigure`
Figure.`findFigureAt(int x, int y, TreeSearch search)`
`final IFigure`
Figure.`findFigureAt(Point pt)`
`IFigure`
IFigure.`findFigureAt(int x, int y)`
Returns the IFigure at the specified location.
`IFigure`
IFigure.`findFigureAt(int x, int y, TreeSearch search)`
Returns the IFigure at the specified location based on the conditional TreeSearch.
`IFigure`
IFigure.`findFigureAt(Point p)`
Returns the IFigure at the specified location.
`IFigure`
Layer.`findFigureAt(int x, int y, TreeSearch search)`
Overridden to implement transparency.
`final IFigure`
Figure.`findFigureAtExcluding(int x, int y, Collection<IFigure> c)`
`IFigure`
IFigure.`findFigureAtExcluding(int x, int y, Collection<IFigure> collection)`
Returns the IFigure at the specified location, excluding any IFigures in `collection`.
`IFigure`
Figure.`findMouseEventTargetAt(int x, int y)`
Returns the deepest descendant for which `Figure.isMouseEventTarget()` returns `true` or `null` if none found.
`IFigure`
IFigure.`findMouseEventTargetAt(int x, int y)`
Returns the IFigure located at the given location which will accept mouse events.
`protected IFigure`
Figure.`findMouseEventTargetInDescendantsAt(int x, int y)`
Searches this Figure's children for the deepest descendant for which `Figure.isMouseEventTarget()` returns `true` and returns that descendant or `null` if none found.
`protected IFigure`
ScrollBar.`getButtonDown()`
Returns the figure used as the down button.
`protected IFigure`
ScrollBar.`getButtonUp()`
Returns the figure used as the up button.
`IFigure`
ShortestPathConnectionRouter.`getContainer()`
`IFigure`
AutoscaleFreeformViewport.`getContents()`
`IFigure`
FigureCanvas.`getContents()`
`IFigure`
ScrollPane.`getContents()`
Returns the contents of the viewport.
`IFigure`
Viewport.`getContents()`
Returns the view, which is the contents of the `ScrollPane` associated with this Viewport.
`IFigure`
FocusTraverseManager.`getCurrentFocusOwner()`
`protected IFigure`
SWTEventDispatcher.`getCursorTarget()`
Returns the figure that the cursor is over.
`abstract IFigure`
EventDispatcher.`getFocusOwner()`
Returns the IFigure that currently has focus.
`IFigure`
SWTEventDispatcher.`getFocusOwner()`
`protected abstract IFigure`
SubordinateUpdateManager.`getHost()`
Deprecated.
Returns the host figure.
`protected IFigure`
SWTEventDispatcher.`getMouseTarget()`
Returns the figure that is the target of mouse events.
`IFigure`
FocusTraverseManager.`getNextFocusableFigure(IFigure root, IFigure prevFocus)`
Returns the IFigure that will receive focus upon a 'tab' traverse event.
`IFigure`
AbstractConnectionAnchor.`getOwner()`
Returns the owner Figure on which this anchor's location is dependent.
`IFigure`
ConnectionAnchor.`getOwner()`
Returns the IFigure that contains this ConnectionAnchor.
`IFigure`
XYAnchor.`getOwner()`
Returns `null` as these anchors inherently do not depend on other figures for their location.
`protected IFigure`
ScrollBar.`getPageDown()`
Returns the figure used for page down.
`protected IFigure`
ScrollBar.`getPageUp()`
Returns the figure used for page up.
`IFigure`
Figure.`getParent()`
`IFigure`
IFigure.`getParent()`
Returns the IFigure that is the current parent of this IFigure or `null` if there is no parent.
`IFigure`
FocusTraverseManager.`getPreviousFocusableFigure(IFigure root, IFigure prevFocus)`
Returns the IFigure that will receive focus upon a 'shift-tab' traverse event.
`protected IFigure`
PrintFigureOperation.`getPrintSource()`
Returns the printSource.
`protected IFigure`
RelativeLocator.`getReferenceFigure()`
Returns the Figure this locator is relative to.
`static IFigure`
FigureUtilities.`getRoot(IFigure figure)`
Returns the highest ancestor for the given figure
`protected IFigure`
SWTEventDispatcher.`getRoot()`
Returns the root figure for this dispatcher.
`IFigure`
LightweightSystem.`getRootFigure()`
Returns this LightweightSystem's root figure.
`protected IFigure`
ScrollBar.`getThumb()`
Returns the figure used as the scrollbar's thumb.
`IFigure`
Figure.`getToolTip()`
`IFigure`
IFigure.`getToolTip()`
Returns a IFigure that is the tooltip for this IFigure.
`IFigure`
ScrollPane.`getView()`
Deprecated.
use getContents()
`IFigure`
Figure.ReverseFigureChildrenIterator.`next()`
`IFigure`
Figure.FigureIterator.`nextFigure()`
Deprecated, for removal: This API element is subject to removal in a future version.
Returns the next Figure.
Methods in org.eclipse.draw2d that return types with arguments of type IFigure
Modifier and Type
Method
Description
`List<? extends IFigure>`
Figure.`getChildren()`
`List<? extends IFigure>`
IFigure.`getChildren()`
Returns an unmodifiable list of children by reference.
`Iterable<IFigure>`
Figure.`getChildrenRevIterable()`
Provide an iterable that will iterate in reverse over all children of this figure.
Methods in org.eclipse.draw2d with parameters of type IFigure
Modifier and Type
Method
Description
`boolean`
ExclusionSearch.`accept(IFigure figure)`
`boolean`
Figure.IdentitySearch.`accept(IFigure f)`
Always returns `true`.
`boolean`
TreeSearch.`accept(IFigure figure)`
Returns `true` if the given figure is accepted by the search.
`void`
ConnectionLayer.`add(IFigure figure, Object constraint, int index)`
Adds the given figure with the given contraint at the given index.
`final void`
Figure.`add(IFigure figure)`
Calls `Figure.add(IFigure, Object, int)` with `null` as the constraint and -1 as the index.
`final void`
Figure.`add(IFigure figure, int index)`
Calls `Figure.add(IFigure, Object, int)` with `null` as the constraint.
`final void`
Figure.`add(IFigure figure, Object constraint)`
Calls `Figure.add(IFigure, Object, int)` with -1 as the index.
`void`
Figure.`add(IFigure figure, Object constraint, int index)`
`void`
FreeformLayer.`add(IFigure child, Object constraint, int index)`
`void`
FreeformLayeredPane.`add(IFigure child, Object constraint, int index)`
`void`
IFigure.`add(IFigure figure)`
Adds the given IFigure as a child of this IFigure.
`void`
IFigure.`add(IFigure figure, int index)`
Adds the given IFigure as a child of this IFigure at the given index.
`void`
IFigure.`add(IFigure figure, Object constraint)`
Adds the given IFigure as a child of this IFigure with the given constraint.
`void`
IFigure.`add(IFigure figure, Object constraint, int index)`
Adds the child with the specified index and constraint.
`void`
LayeredPane.`add(IFigure figure, Object layerKey, int index)`
Adds the given layer figure, identifiable with the given key, at the specified index.
`void`
DeferredUpdateManager.`addDirtyRegion(IFigure figure, int x, int y, int w, int h)`
Adds a dirty region (defined by the rectangle x, y, w, h) to the update queue.
`void`
SubordinateUpdateManager.`addDirtyRegion(IFigure f, int x, int y, int w, int h)`
Deprecated.
`abstract void`
UpdateManager.`addDirtyRegion(IFigure figure, int x, int y, int w, int h)`
Adds the dirty region defined by the coordinates on the IFigure figure.
`void`
UpdateManager.`addDirtyRegion(IFigure figure, Rectangle rect)`
`void`
DeferredUpdateManager.`addInvalidFigure(IFigure f)`
Adds the given figure to the update queue.
`void`
SubordinateUpdateManager.`addInvalidFigure(IFigure f)`
Deprecated.
`abstract void`
UpdateManager.`addInvalidFigure(IFigure figure)`
The receiver should call validate() on the IFigure figure in a timely fashion.
`void`
AbstractConnectionAnchor.`ancestorAdded(IFigure ancestor)`
`void`
AncestorListener.`ancestorAdded(IFigure ancestor)`
Called when an ancestor has been added into the listening figure's hierarchy.
`void`
AncestorListener.Stub.`ancestorAdded(IFigure ancestor)`
`void`
AbstractConnectionAnchor.`ancestorMoved(IFigure figure)`
Notifies all the listeners of this anchor's location change.
`void`
AncestorListener.`ancestorMoved(IFigure ancestor)`
Called when an ancestor has moved to a new location.
`void`
AncestorListener.Stub.`ancestorMoved(IFigure ancestor)`
`void`
AbstractConnectionAnchor.`ancestorRemoved(IFigure ancestor)`
`void`
AncestorListener.`ancestorRemoved(IFigure ancestor)`
Called when an ancestor has been removed from the listening figure's hierarchy.
`void`
AncestorListener.Stub.`ancestorRemoved(IFigure ancestor)`
`protected abstract Insets`
AbstractLabeledBorder.`calculateInsets(IFigure figure)`
Calculates insets based on the current font and other attributes.
`protected Insets`
GroupBoxBorder.`calculateInsets(IFigure figure)`
Calculates and returns the Insets for this GroupBoxBorder.
`protected Insets`
TitleBarBorder.`calculateInsets(IFigure figure)`
Calculates and returns the Insets for this border.
`protected Dimension`
AbstractHintLayout.`calculateMinimumSize(IFigure container, int wHint, int hHint)`
Calculates the minimum size using the given width and height hints.
`protected Dimension`
BorderLayout.`calculateMinimumSize(IFigure container, int wHint, int hHint)`
`Dimension`
ScrollPaneLayout.`calculateMinimumSize(IFigure figure, int w, int h)`
`protected Dimension`
StackLayout.`calculateMinimumSize(IFigure figure, int wHint, int hHint)`
Returns the minimum size required by the input container.
`protected Dimension`
ToolbarLayout.`calculateMinimumSize(IFigure container, int wHint, int hHint)`
Calculates the minimum size of the container based on the given hints.
`protected Dimension`
ViewportLayout.`calculateMinimumSize(IFigure figure, int wHint, int hHint)`
Returns the minimum size required by the input viewport figure.
`protected final void`
AbstractLayout.`calculatePreferredSize(IFigure container)`
This method is now `AbstractLayout.calculatePreferredSize(IFigure, int, int)`.
`protected abstract Dimension`
AbstractLayout.`calculatePreferredSize(IFigure container, int wHint, int hHint)`
Calculates the preferred size of the given figure, using width and height hints.
`protected Dimension`
BorderLayout.`calculatePreferredSize(IFigure figure, int wHint, int hHint)`
`protected Dimension`
DelegatingLayout.`calculatePreferredSize(IFigure parent, int wHint, int hHint)`
Calculates the preferred size of the given Figure.
`protected Dimension`
FlowLayout.`calculatePreferredSize(IFigure container, int wHint, int hHint)`
`protected Dimension`
GridLayout.`calculatePreferredSize(IFigure container, int wHint, int hHint)`
`protected Dimension`
ScrollBarLayout.`calculatePreferredSize(IFigure parent, int w, int h)`
`protected Dimension`
ScrollPaneLayout.`calculatePreferredSize(IFigure container, int wHint, int hHint)`
Calculates and returns the preferred size of the container based on the given hints.
`protected Dimension`
StackLayout.`calculatePreferredSize(IFigure figure, int wHint, int hHint)`
Calculates and returns the preferred size of the given figure.
`protected Dimension`
ToolbarLayout.`calculatePreferredSize(IFigure container, int wHint, int hHint)`
Calculates the preferred size of the container based on the given hints.
`protected Dimension`
ViewportLayout.`calculatePreferredSize(IFigure parent, int wHint, int hHint)`
Calculates and returns the preferred size of the figure based on the given hints.
`protected Dimension`
XYLayout.`calculatePreferredSize(IFigure f, int wHint, int hHint)`
Calculates and returns the preferred size of the input figure.
`void`
Animator.`capture(IFigure figure)`
Captures the final state of the given figure.
`void`
CoordinateListener.`coordinateSystemChanged(IFigure source)`
Indicates that the coordinate system has changed in a way that affects the absolute locations of contained figures.
`void`
ToolTipHelper.`displayToolTipNear(IFigure hoverSource, IFigure tip, int eventX, int eventY)`
Sets the LightWeightSystem's contents to the passed tooltip, and displays the tip.
`void`
FigureListener.`figureMoved(IFigure source)`
Called when the given IFigure has moved.
`static IFigure`
FigureUtilities.`findCommonAncestor(IFigure l, IFigure r)`
Returns the figure which is the nearest common ancestor of both figures, or `null` if there is no common ancestor.
`protected Rectangle`
ViewportAwareConnectionLayerClippingStrategy.`getAbsoluteBoundsAsCopy(IFigure figure)`
Returns the figure's bounds in absolute coordinates.
`protected Rectangle`
ViewportAwareConnectionLayerClippingStrategy.`getAbsoluteClientAreaAsCopy(IFigure figure)`
Returns the viewport's client area in absolute coordinates.
`protected Dimension`
AbstractLayout.`getBorderPreferredSize(IFigure container)`
Returns the preferred size of the figure's border.
`protected Dimension`
ToolbarLayout.`getChildMinimumSize(IFigure child, int wHint, int hHint)`
`protected Dimension`
ToolbarLayout.`getChildPreferredSize(IFigure child, int wHint, int hHint)`
`protected Dimension`
FlowLayout.`getChildSize(IFigure child, int wHint, int hHint)`
Provides the given child's preferred size.
`protected Dimension`
GridLayout.`getChildSize(IFigure child, int wHint, int hHint)`
`Rectangle[]`
IClippingStrategy.`getClip(IFigure childFigure)`
Specifies the clipping region for the given child figure.
`Rectangle[]`
ViewportAwareConnectionLayerClippingStrategy.`getClip(IFigure figure)`
`Object`
AbstractConstraintLayout.`getConstraint(IFigure figure)`
`Object`
AbstractLayout.`getConstraint(IFigure child)`
Returns the constraint for the given figure.
`Object`
GridLayout.`getConstraint(IFigure child)`
`Object`
LayoutManager.`getConstraint(IFigure child)`
Returns the constraint for the given figure.
`protected abstract Object`
Animator.`getCurrentState(IFigure figure)`
Returns an object encapsulating the current state of the figure.
`protected Object`
LayoutAnimator.`getCurrentState(IFigure container)`
Returns an object encapsulating the placement of children in a container.
`protected Object`
RoutingAnimator.`getCurrentState(IFigure connection)`
Returns the current state of the connection.
`static List<Viewport>`
ViewportUtilities.`getEnclosingViewportsPath(IFigure figure)`
Returns all enclosing `Viewport`s for a given `IFigure`, beginning with its direct enclosing `Viewport` up the root `Viewport` in the figure's parent hierarchy.
`static Object`
Animation.`getFinalState(Animator animator, IFigure figure)`
Returns the final animation state for the given figure.
`protected Font`
AbstractLabeledBorder.`getFont(IFigure f)`
Returns the font that this border will use.
`static Object`
Animation.`getInitialState(Animator animator, IFigure figure)`
Returns the initial animation state for the given animator and figure.
`Insets`
AbstractBackground.`getInsets(IFigure figure)`
Returns the Insets for this Border for the given Figure.
`Insets`
AbstractLabeledBorder.`getInsets(IFigure fig)`
Returns the insets, or space associated for this border.
`Insets`
Border.`getInsets(IFigure figure)`
Returns the Insets for this Border for the given Figure.
`Insets`
CompoundBorder.`getInsets(IFigure figure)`
Returns the total insets required to hold both the inner and outer borders of this CompoundBorder.
`Insets`
FocusBorder.`getInsets(IFigure figure)`
`Insets`
LineBorder.`getInsets(IFigure figure)`
Returns the space used by the border for the figure provided as input.
`Insets`
MarginBorder.`getInsets(IFigure figure)`
`Insets`
SchemeBorder.`getInsets(IFigure figure)`
`Insets`
SimpleEtchedBorder.`getInsets(IFigure figure)`
Returns the Insets used by this border.
`Dimension`
AbstractHintLayout.`getMinimumSize(IFigure container, int w, int h)`
`final void`
AbstractLayout.`getMinimumSize(IFigure container)`
This method is now `AbstractLayout.getMinimumSize(IFigure, int, int)`.
`Dimension`
AbstractLayout.`getMinimumSize(IFigure container, int wHint, int hHint)`
`Dimension`
LayoutManager.`getMinimumSize(IFigure container, int wHint, int hHint)`
Returns the minimum size of the given figure.
`static Viewport`
ViewportUtilities.`getNearestCommonViewport(IFigure firstFigure, IFigure secondFigure)`
Returns the nearest common enclosing `Viewport` for two given `Figure`s.
`static Viewport`
ViewportUtilities.`getNearestEnclosingViewport(IFigure figure)`
Returns the nearest enclosing `Viewport` of a given `IFigure` by walking up the figure's hierarchy.
`static Viewport`
ViewportUtilities.`getNearestViewport(IFigure figure)`
Returns the given figure in case it is a `Viewport` itself, otherwise its nearest enclosing `Viewport`.
`IFigure`
FocusTraverseManager.`getNextFocusableFigure(IFigure root, IFigure prevFocus)`
Returns the IFigure that will receive focus upon a 'tab' traverse event.
`protected Rectangle`
ViewportAwareConnectionLayerClippingStrategy.`getNodeClippingRectangle(IFigure figure)`
Computes clipping rectangle for a given (node) figure.
`Point`
FreeformLayout.`getOrigin(IFigure figure)`
Returns the point (0,0) as the origin.
`Point`
XYLayout.`getOrigin(IFigure parent)`
Returns the origin for the given figure.
`protected static final Rectangle`
AbstractBorder.`getPaintRectangle(IFigure figure, Insets insets)`
Returns a temporary rectangle representing the figure's bounds cropped by the specified insets.
`Dimension`
AbstractBorder.`getPreferredSize(IFigure f)`
`final Dimension`
AbstractHintLayout.`getPreferredSize(IFigure container, int w, int h)`
`Dimension`
AbstractLabeledBorder.`getPreferredSize(IFigure fig)`
`final void`
AbstractLayout.`getPreferredSize(IFigure container)`
This method is now `AbstractLayout.getPreferredSize(IFigure, int, int)`.
`Dimension`
AbstractLayout.`getPreferredSize(IFigure container, int wHint, int hHint)`
Returns the preferred size of the given figure, using width and height hints.
`Dimension`
Border.`getPreferredSize(IFigure figure)`
Returns the preferred width and height that this border would like to display itself properly.
`Dimension`
CompoundBorder.`getPreferredSize(IFigure fig)`
`Dimension`
GroupBoxBorder.`getPreferredSize(IFigure fig)`
`Dimension`
LayoutManager.`getPreferredSize(IFigure container, int wHint, int hHint)`
Returns the preferred size of the given figure, using width and height hints.
`Dimension`
TitleBarBorder.`getPreferredSize(IFigure fig)`
Overwritten to handle padding appropriately.
`IFigure`
FocusTraverseManager.`getPreviousFocusableFigure(IFigure root, IFigure prevFocus)`
Returns the IFigure that will receive focus upon a 'shift-tab' traverse event.
`static IFigure`
FigureUtilities.`getRoot(IFigure figure)`
Returns the highest ancestor for the given figure
`static Viewport`
ViewportUtilities.`getRootViewport(IFigure figure)`
Returns the upper most enclosing `Viewport` for the given `IFigure`.
`protected Dimension`
AbstractLabeledBorder.`getTextExtents(IFigure f)`
Calculates and returns the size required by this border's label.
`void`
Animator.`init(IFigure figure)`
Sets up the animator for the given figure to be animated.
`protected void`
FlowLayout.`initVariables(IFigure parent)`
Initializes state data for laying out children, based on the Figure given as input.
`protected void`
AbstractLayout.`invalidate(IFigure child)`
Removes any cached information about the given figure.
`final void`
LayoutAnimator.`invalidate(IFigure container)`
Hooks invalidation in case animation is in progress.
`void`
LayoutListener.`invalidate(IFigure container)`
Called when a container has been invalidated.
`void`
LayoutListener.Stub.`invalidate(IFigure container)`
Stub which does nothing.
`static boolean`
FigureUtilities.`isAncestor(IFigure ancestor, IFigure descendant)`
Returns `true` if the ancestor contains the descendant, or is the ancestor of the descendant's parent.
`static boolean`
FigureUtilities.`isNotFullyClipped(IFigure figure)`
Determines whether the given figure is showing and not (completely) clipped.
`protected boolean`
AbstractHintLayout.`isSensitiveHorizontally(IFigure container)`
Returns whether this layout manager is sensitive to changes in the horizontal hint.
`protected boolean`
FlowLayout.`isSensitiveHorizontally(IFigure parent)`
`protected boolean`
ToolbarLayout.`isSensitiveHorizontally(IFigure parent)`
`protected boolean`
ViewportLayout.`isSensitiveHorizontally(IFigure parent)`
`protected boolean`
AbstractHintLayout.`isSensitiveVertically(IFigure container)`
Returns whether this layout manager is sensitive to changes in the vertical hint.
`protected boolean`
FlowLayout.`isSensitiveVertically(IFigure parent)`
`protected boolean`
ToolbarLayout.`isSensitiveVertically(IFigure parent)`
`protected boolean`
ViewportLayout.`isSensitiveVertically(IFigure parent)`
`void`
BorderLayout.`layout(IFigure container)`
`void`
DelegatingLayout.`layout(IFigure parent)`
Lays out the given figure's children based on their `Locator` constraint.
`void`
FlowLayout.`layout(IFigure parent)`
`void`
GridLayout.`layout(IFigure container)`
`final boolean`
LayoutAnimator.`layout(IFigure container)`
Hooks layout in case animation is in progress.
`boolean`
LayoutListener.`layout(IFigure container)`
Called prior to layout occurring.
`boolean`
LayoutListener.Stub.`layout(IFigure container)`
Stub which does nothing.
`void`
LayoutManager.`layout(IFigure container)`
Lays out the given figure.
`void`
ScrollBarLayout.`layout(IFigure parent)`
`void`
ScrollPaneLayout.`layout(IFigure parent)`
`void`
StackLayout.`layout(IFigure figure)`
`void`
ToolbarLayout.`layout(IFigure parent)`
`void`
ViewportLayout.`layout(IFigure figure)`
`void`
XYLayout.`layout(IFigure parent)`
Implements the algorithm to layout the components of the given container figure.
`protected void`
FlowLayout.`layoutRow(IFigure parent)`
Layouts one row of components.
`void`
AbstractBackground.`paint(IFigure figure, Graphics graphics, Insets insets)`
Paints the border.
`void`
Border.`paint(IFigure figure, Graphics graphics, Insets insets)`
Paints the border.
`void`
ButtonBorder.`paint(IFigure figure, Graphics graphics, Insets insets)`
Paints this border with the help of the set scheme, the model of the clickable figure, and other inputs.
`void`
CompoundBorder.`paint(IFigure figure, Graphics g, Insets insets)`
`void`
FocusBorder.`paint(IFigure figure, Graphics graphics, Insets insets)`
Paints a focus rectangle.
`void`
GroupBoxBorder.`paint(IFigure figure, Graphics g, Insets insets)`
`void`
LineBorder.`paint(IFigure figure, Graphics graphics, Insets insets)`
`void`
MarginBorder.`paint(IFigure figure, Graphics graphics, Insets insets)`
This method does nothing, since this border is just for spacing.
`protected void`
SchemeBorder.`paint(Graphics graphics, IFigure fig, Insets insets, Color[] tl, Color[] br)`
Paints the border using the information in the set Scheme and the inputs given.
`void`
SchemeBorder.`paint(IFigure figure, Graphics g, Insets insets)`
`void`
SeparatorBorder.`paint(IFigure f, Graphics g, Insets i)`
`void`
SimpleEtchedBorder.`paint(IFigure figure, Graphics g, Insets insets)`
`void`
TitleBarBorder.`paint(IFigure figure, Graphics g, Insets insets)`
`void`
AbstractBackground.`paintBackground(IFigure figure, Graphics graphics, Insets insets)`
Called when this Background should paint.
`static void`
FigureUtilities.`paintGrid(Graphics g, IFigure f, Point origin, int distanceX, int distanceY)`
Helper method to paint a grid.
`protected boolean`
Animator.`playback(IFigure figure)`
Plays back the animation for the given figure and returns `true` if successful.
`protected boolean`
LayoutAnimator.`playback(IFigure container)`
Plays back the animated layout.
`protected boolean`
RoutingAnimator.`playback(IFigure figure)`
Plays back the interpolated state.
`void`
Animator.`playbackStarting(IFigure figure)`
Sent as playback is starting for a given figure.
`void`
RoutingAnimator.`playbackStarting(IFigure connection)`
Overridden to sync initial and final states.
`final void`
LayoutAnimator.`postLayout(IFigure container)`
Hooks post layout in case animation is in progress.
`void`
LayoutListener.`postLayout(IFigure container)`
Called after layout has occurred.
`void`
LayoutListener.Stub.`postLayout(IFigure container)`
Stub which does nothing.
`boolean`
ExclusionSearch.`prune(IFigure f)`
Returns `true` if the figure is a member of the Collection.
`boolean`
Figure.IdentitySearch.`prune(IFigure f)`
Always returns `false`.
`boolean`
TreeSearch.`prune(IFigure figure)`
Returns `true` if the figure and all of its contained figures should be pruned from the search.
`protected void`
Animator.`recordFinalState(IFigure figure)`
Records the final state information for a figure.
`protected void`
Animator.`recordInitialState(IFigure figure)`
Records initial state information for the given figure.
`void`
AbstractLocator.`relocate(IFigure target)`
Recalculates the position of the figure and returns the updated bounds.
`void`
ArrowLocator.`relocate(IFigure target)`
Relocates the passed in figure (which must be a `RotatableDecoration`) at either the start or end of the connection.
`void`
ConnectionEndpointLocator.`relocate(IFigure figure)`
Relocates the given IFigure at either the source or target end of the Connection, based on the `boolean` given in the constructor `ConnectionEndpointLocator(Connection, boolean)`.
`void`
Locator.`relocate(IFigure target)`
Relocates the given IFigure.
`void`
RelativeLocator.`relocate(IFigure target)`
Relocates the target using the relative offset locations.
`void`
AbstractConstraintLayout.`remove(IFigure figure)`
`void`
AbstractLayout.`remove(IFigure child)`
Removes the given figure from this LayoutManager's list of figures.
`void`
BorderLayout.`remove(IFigure child)`
`void`
ConnectionLayer.`remove(IFigure figure)`
Removes the figure from this Layer.
`void`
DelegatingLayout.`remove(IFigure child)`
Removes the locator for the given figure.
`void`
Figure.`remove(IFigure figure)`
Removes the given child Figure from this Figure's hierarchy and revalidates this Figure.
`void`
FreeformLayer.`remove(IFigure child)`
`void`
FreeformLayeredPane.`remove(IFigure child)`
`void`
IFigure.`remove(IFigure figure)`
Removes the given child from this figure's children.
`void`
LayeredPane.`remove(IFigure figure)`
`final void`
LayoutAnimator.`remove(IFigure child)`
This callback is unused.
`void`
LayoutListener.`remove(IFigure child)`
Called when a child is about to be removed from its parent.
`void`
LayoutListener.Stub.`remove(IFigure child)`
Stub which does nothing.
`void`
LayoutManager.`remove(IFigure child)`
Removes the given child from this layout.
`void`
ScrollBarLayout.`remove(IFigure child)`
`void`
LayeredPane.`removeLayer(IFigure layer)`
Deprecated, for removal: This API element is subject to removal in a future version.
call `remove(IFigure)` instead.
`abstract void`
EventDispatcher.`requestFocus(IFigure fig)`
Requests focus for the given figure.
`void`
SWTEventDispatcher.`requestFocus(IFigure fig)`
`abstract void`
EventDispatcher.`requestRemoveFocus(IFigure fig)`
Requests focus to be removed from the given figure.
`void`
SWTEventDispatcher.`requestRemoveFocus(IFigure fig)`
`protected void`
FlowLayout.`setBoundsOfChild(IFigure parent, IFigure child, Rectangle bounds)`
Sets the given bounds for the child figure input.
`protected abstract void`
EventDispatcher.`setCapture(IFigure figure)`
Sets capture to the given figure.
`protected void`
SWTEventDispatcher.`setCapture(IFigure figure)`
`void`
AbstractConstraintLayout.`setConstraint(IFigure figure, Object newConstraint)`
Sets the layout constraint of the given figure.
`void`
AbstractLayout.`setConstraint(IFigure child, Object constraint)`
Sets the constraint for the given figure.
`void`
BorderLayout.`setConstraint(IFigure child, Object constraint)`
Sets the location of hte given child in this layout.
`void`
Figure.`setConstraint(IFigure child, Object constraint)`
`void`
GridLayout.`setConstraint(IFigure figure, Object newConstraint)`
Sets the layout constraint of the given figure.
`void`
IFigure.`setConstraint(IFigure child, Object constraint)`
Convenience method to set the constraint of the specified child in the current LayoutManager.
`final void`
LayoutAnimator.`setConstraint(IFigure child, Object constraint)`
This callback is unused.
`void`
LayoutListener.`setConstraint(IFigure child, Object constraint)`
Called when a child's constraint is initialized or updated.
`void`
LayoutListener.Stub.`setConstraint(IFigure child, Object constraint)`
Stub which does nothing.
`void`
LayoutManager.`setConstraint(IFigure child, Object constraint)`
Sets the constraint for the given child.
`void`
ScrollBarLayout.`setConstraint(IFigure figure, Object constraint)`
`void`
XYLayout.`setConstraint(IFigure figure, Object newConstraint)`
Sets the layout constraint of the given figure.
`void`
AutoscaleFreeformViewport.`setContents(IFigure figure)`
`protected void`
Clickable.`setContents(IFigure contents)`
Sets the Figure which is the contents of this Clickable.
`void`
FigureCanvas.`setContents(IFigure figure)`
Sets the contents of the `Viewport`.
`void`
LightweightSystem.`setContents(IFigure figure)`
Sets the contents of the LightweightSystem to the passed figure.
`void`
ScrollPane.`setContents(IFigure figure)`
Sets the contents of the current viewport.
`void`
Viewport.`setContents(IFigure figure)`
Sets this Viewport to be associated with the passed Figure.
`void`
FocusTraverseManager.`setCurrentFocusOwner(IFigure fig)`
Sets the currently focused figure.
`protected void`
SWTEventDispatcher.`setFigureUnderCursor(IFigure f)`
Sets the figure under the mouse cursor.
`protected void`
SWTEventDispatcher.`setFocus(IFigure fig)`
Sets the focus figure.
`protected void`
SWTEventDispatcher.`setMouseTarget(IFigure figure)`
Sets the given figure to be the target of future mouse events.
`void`
AbstractConnectionAnchor.`setOwner(IFigure owner)`
Sets the owner of this anchor, on whom this anchors location is dependent.
`void`
Figure.`setParent(IFigure p)`
`void`
IFigure.`setParent(IFigure parent)`
Sets this IFigure's parent.
`protected void`
PrintFigureOperation.`setPrintSource(IFigure printSource)`
Sets the printSource.
`void`
RelativeLocator.`setReferenceFigure(IFigure reference)`
Sets the reference figure this locator uses to place the target figure.
`void`
DeferredUpdateManager.`setRoot(IFigure figure)`
Sets the root figure.
`abstract void`
EventDispatcher.`setRoot(IFigure figure)`
Sets the root figure for this dispatcher.
`void`
SubordinateUpdateManager.`setRoot(IFigure f)`
Deprecated.
`void`
SWTEventDispatcher.`setRoot(IFigure figure)`
`abstract void`
UpdateManager.`setRoot(IFigure figure)`
Sets the root figure.
`void`
ScrollBar.`setThumb(IFigure figure)`
Sets the ScrollBar's thumb to the passed Figure.
`void`
Figure.`setToolTip(IFigure f)`
`void`
IFigure.`setToolTip(IFigure figure)`
Sets a tooltip that is displayed when the mouse hovers over this IFigure.
`protected void`
PrintFigureOperation.`setupPrinterGraphicsFor(Graphics graphics, IFigure figure)`
Sets up Graphics object for the given IFigure.
`void`
ScrollPane.`setView(IFigure figure)`
Deprecated.
call setContents(IFigure) instead
`void`
Animator.`tearDown(IFigure figure)`
Reverts any temporary changes made to the figure during animation.
`void`
ToolTipHelper.`updateToolTip(IFigure figureUnderMouse, IFigure tip, int eventX, int eventY)`
Displays the hover source's tooltip if a tooltip of another source is currently being displayed.
Method parameters in org.eclipse.draw2d with type arguments of type IFigure
Modifier and Type
Method
Description
`final IFigure`
Figure.`findFigureAtExcluding(int x, int y, Collection<IFigure> c)`
`IFigure`
IFigure.`findFigureAtExcluding(int x, int y, Collection<IFigure> collection)`
Returns the IFigure at the specified location, excluding any IFigures in `collection`.
`protected void`
UpdateManager.`firePainting(Rectangle damage, Map<IFigure,Rectangle> dirtyRegions)`
Notifies listeners that painting is about to occur, passing them the damaged rectangle and the map of dirty regions.
`void`
UpdateListener.`notifyPainting(Rectangle damage, Map<IFigure,Rectangle> dirtyRegions)`
Notifies the listener that the listened to object is painting.
`void`
UpdateListener.Stub.`notifyPainting(Rectangle damage, Map<IFigure,Rectangle> dirtyRegions)`
Constructors in org.eclipse.draw2d with parameters of type IFigure
Modifier
Constructor
Description
``
`AbstractConnectionAnchor(IFigure owner)`
Constructs an AbstractConnectionAnchor with the owner supplied as input.
``
`ChopboxAnchor(IFigure owner)`
Constructs a ChopboxAnchor with the given owner figure.
``
`Clickable(IFigure contents)`
Constructs a Clickable whose contents are provided as input.
``
`Clickable(IFigure contents, int style)`
Constructs a Clickable whose contents are provided as input.
``
`EllipseAnchor(IFigure owner)`
``
`FigureIterator(IFigure figure)`
Deprecated, for removal: This API element is subject to removal in a future version.
Constructs a new FigureIterator for the given Figure.
``
`FocusEvent(IFigure loser, IFigure gainer)`
Constructs a new FocusEvent.
``
`GhostImageFigure(IFigure source, int alpha, RGB transparency)`
The single constructor.
``
`InputEvent(EventDispatcher dispatcher, IFigure source, int state)`
Constructs a new InputEvent.
``
`KeyEvent(EventDispatcher dispatcher, IFigure source, KeyEvent ke)`
Constructs a new KeyEvent.
``
`MouseEvent(int x, int y, EventDispatcher dispatcher, IFigure f, int button, int stateMask)`
Deprecated.
Use `MouseEvent(EventDispatcher, IFigure, org.eclipse.swt.events.MouseEvent)` instead.
``
`MouseEvent(EventDispatcher dispatcher, IFigure source, MouseEvent me)`
Constructs a new MouseEvent.
``
`PrintFigureOperation(Printer p, IFigure srcFigure)`
Constructor for PrintFigureOperation.
``
`RelativeLocator(IFigure reference, double relativeX, double relativeY)`
Constructs a RelativeLocator with the given reference Figure and offset ratios.
``
`RelativeLocator(IFigure reference, int location)`
Constructs a RelativeLocator with the given reference figure and relative location.
``
`ReverseFigureChildrenIterator(IFigure figure)`
``
`ShortestPathConnectionRouter(IFigure container)`
Creates a new shortest path router with the given container.
``
`Toggle(IFigure contents)`
Constructs a Toggle with passed IFigure as its contents.
``
`Toggle(IFigure contents, int style)`
Constructs a Toggle with the passed figure as its contents and the given style.
``
`ToggleButton(IFigure contents)`
Constructs a ToggleButton with the passed IFigure as its contents.
Constructor parameters in org.eclipse.draw2d with type arguments of type IFigure
Modifier
Constructor
Description
``
`ExclusionSearch(Collection<IFigure> collection)`
Constructs an Exclusion search using the given collection.

## Uses of IFigure in org.eclipse.draw2d.parts

Classes in org.eclipse.draw2d.parts that implement IFigure
Modifier and Type
Class
Description
`class`
`ScrollableThumbnail`
A scaled image representation of a Figure.
`class`
`Thumbnail`
A Thumbnail is a Figure that displays an image of its source Figure at a smaller size.
Methods in org.eclipse.draw2d.parts that return IFigure
Modifier and Type
Method
Description
`protected IFigure`
Thumbnail.`getSource()`
Returns the source figure being used to generate a thumbnail.
Methods in org.eclipse.draw2d.parts with parameters of type IFigure
Modifier and Type
Method
Description
`void`
Thumbnail.`setSource(IFigure fig)`
Sets the source Figure.
Method parameters in org.eclipse.draw2d.parts with type arguments of type IFigure
Modifier and Type
Method
Description
`void`
Thumbnail.`notifyPainting(Rectangle damage, Map<IFigure,Rectangle> dirtyRegions)`
Constructors in org.eclipse.draw2d.parts with parameters of type IFigure
Modifier
Constructor
Description
``
`Thumbnail(IFigure fig)`
Creates a new Thumbnail with the given IFigure as its source figure.

## Uses of IFigure in org.eclipse.draw2d.text

Classes in org.eclipse.draw2d.text that implement IFigure
Modifier and Type
Class
Description
`class`
`BlockFlow`
A `FlowFigure` represented by a single `BlockBox` containing one or more lines.
`class`
`FlowAdapter`
Adapts non-flow figures for use within a parent hierarchy requiring flow figures.
`class`
`FlowFigure`
The base implementation for text flow figures.
`class`
`FlowPage`
The root of a Flow hierarchy.
`class`
`InlineFlow`
A `FlowFigure` represented by multiple `LineBox` fragments.
`class`
`TextFlow`
An inline flow figure that renders a string of text across one or more lines.
Methods in org.eclipse.draw2d.text with parameters of type IFigure
Modifier and Type
Method
Description
`void`
FlowFigure.`add(IFigure child, Object constraint, int index)`
If the child is a `FlowFigure`, its FlowContext is passed to it.
`Object`
FlowFigureLayout.`getConstraint(IFigure child)`
Not applicable.
`Insets`
AbstractFlowBorder.`getInsets(IFigure figure)`
`Dimension`
FlowFigureLayout.`getMinimumSize(IFigure container, int wHint, int hHint)`
Not applicable.
`Dimension`
FlowFigureLayout.`getPreferredSize(IFigure container, int wHint, int hHint)`
Not applicable.
`final void`
FlowFigureLayout.`layout(IFigure figure)`
`final void`
AbstractFlowBorder.`paint(IFigure figure, Graphics graphics, Insets insets)`
This method is not called on FlowBorders.
`void`
FlowFigure.`remove(IFigure figure)`
Overridden to revalidateBidi when fragments are removed.
`void`
FlowFigureLayout.`remove(IFigure child)`
Not applicable.
`protected void`
BlockFlow.`revalidateBidi(IFigure origin)`
A Block will invalidate the Bidi state of all its children, so that it is re-evaluated when this block is next validated.
`protected void`
FlowFigure.`revalidateBidi(IFigure origin)`
This method should be invoked whenever a change that can potentially affect the Bidi evaluation is made (eg., adding or removing children, changing text, etc.).
`void`
FlowFigureLayout.`setConstraint(IFigure child, Object constraint)`
Not applicable.