Package org.eclipse.draw2d
Interface Border
- All Known Subinterfaces:
FlowBorder
,LabeledBorder
- All Known Implementing Classes:
AbstractBackground
,AbstractBorder
,AbstractFlowBorder
,AbstractLabeledBorder
,ButtonBorder
,CompoundBorder
,FocusBorder
,FrameBorder
,GroupBoxBorder
,LineBorder
,MarginBorder
,SchemeBorder
,SimpleEtchedBorder
,SimpleLoweredBorder
,SimpleRaisedBorder
,TitleBarBorder
public interface Border
A decoration on a Figure. A border may paint itself within the bounds of a
figure, and it may provide Insets which can affect how the figures children
are posiiton and painted.
A border instance may be used with multiple figure instances.
-
Method Summary
Modifier and TypeMethodDescriptionReturns the Insets for this Border for the given Figure.getPreferredSize
(IFigure figure) Returns the preferred width and height that this border would like to display itself properly.boolean
isOpaque()
Returnstrue
if the Border completely fills the region defined inpaint(IFigure, Graphics, Insets)
.void
Paints the border.
-
Method Details
-
getInsets
Returns the Insets for this Border for the given Figure.- Parameters:
figure
- The figure this border belongs to- Returns:
- The insets
-
getPreferredSize
Returns the preferred width and height that this border would like to display itself properly.- Parameters:
figure
- The figure- Returns:
- The preferred size
-
isOpaque
boolean isOpaque()Returnstrue
if the Border completely fills the region defined inpaint(IFigure, Graphics, Insets)
.- Returns:
true
if this border is opaque
-
paint
Paints the border. The border should paint inside figure'sIFigure.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 asRectangle.contains(int, int)
.- Parameters:
figure
- The figure this border belongs tographics
- The graphics object used for paintinginsets
- The insets
-