Eclipse Draw2d
2.1

org.eclipse.draw2d
Interface Border

All Known Subinterfaces:
LabeledBorder
All Known Implementing Classes:
AbstractBorder, AbstractLabeledBorder, FrameBorder

public interface Border

A Border is a graphical decoration that is painted just inside the outer edge of a Figure.


Method Summary
 Insets getInsets(IFigure figure)
          Returns the Insets for this Border for the given Figure.
 Dimension getPreferredSize(IFigure figure)
          Returns the preferred width and height that this border would like to display itself properly.
 boolean isOpaque()
          Returns true if the Border completely fills the region defined in paint(IFigure, Graphics, Insets).
 void paint(IFigure figure, Graphics graphics, Insets insets)
          Paints the border.
 

Method Detail

getInsets

public Insets getInsets(IFigure figure)
Returns the Insets for this Border for the given Figure.

Parameters:
figure - The figure this border belongs to
Returns:
The insets

getPreferredSize

public Dimension getPreferredSize(IFigure figure)
Returns the preferred width and height that this border would like to display itself properly.

Parameters:
figure - The figure
Returns:
The preferred size

isOpaque

public boolean isOpaque()
Returns true if the Border completely fills the region defined in paint(IFigure, Graphics, Insets).

Returns:
true if this border is opaque

paint

public void paint(IFigure figure,
                  Graphics graphics,
                  Insets insets)
Paints the border. The border should paint inside figure's IFigure.getBounds(), inset by the parameter insets. The border generally should not paint inside its own insets. More specifically, Border b should paint inside the rectangle: figure.getBounds().getCropped(insets) and outside of the rectangle: figure.getBounds().getCropped(insets).getCropped(getInsets()) where inside is defined as Rectangle.contains(int, int).

Parameters:
figure - The figure this border belongs to
graphics - The graphics object used for painting
insets - The insets

Eclipse Draw2d
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.