Package org.eclipse.draw2d
Class SchemeBorder
java.lang.Object
org.eclipse.draw2d.AbstractBorder
org.eclipse.draw2d.SchemeBorder
- All Implemented Interfaces:
Border
,ColorConstants
- Direct Known Subclasses:
ButtonBorder
,SimpleEtchedBorder
,SimpleLoweredBorder
,SimpleRaisedBorder
SchemeBorder allows the creation of borders based on
Schemes
. A Scheme is a class whose only
purpose is to carry border specific information. SchemeBorder renders the
border based on the information given by the Scheme set to it.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Holds a set of information about a border, which can be changed to create a wide range of schemes.static interface
Interface which defines some commonly used schemes for the border.Nested classes/interfaces inherited from interface org.eclipse.draw2d.ColorConstants
ColorConstants.SystemColorFactory
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Color[]
protected static final Color[]
Arrays of Colors, used for shadow or highlight effectsprotected static final Color[]
protected SchemeBorder.Scheme
TheSchemeBorder.Scheme
associated with this SchemeBorderFields inherited from class org.eclipse.draw2d.AbstractBorder
tempRect
Fields inherited from interface org.eclipse.draw2d.ColorConstants
black, blue, button, buttonDarker, buttonDarkest, buttonLightest, cyan, darkBlue, darkGray, darkGreen, gray, green, lightBlue, lightGray, lightGreen, lineForeground, listBackground, listForeground, listHoverBackgroundColor, listSelectedBackgroundColor, menuBackground, menuBackgroundSelected, menuForeground, menuForegroundSelected, orange, red, titleBackground, titleForeground, titleGradient, titleInactiveBackground, titleInactiveForeground, titleInactiveGradient, tooltipBackground, tooltipForeground, white, yellow
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructs a default SchemeBorder with no scheme defined.SchemeBorder
(SchemeBorder.Scheme scheme) Constructs a SchemeBorder with the Scheme given as input. -
Method Summary
Modifier and TypeMethodDescriptionReturns the Insets for this Border for the given Figure.protected SchemeBorder.Scheme
Returns the scheme used by this border.boolean
isOpaque()
Returns the opaque state of this border.protected void
Paints the border using the information in the set Scheme and the inputs given.void
Paints the border.protected void
setScheme
(SchemeBorder.Scheme scheme) Sets the Scheme for this border to the Scheme given as input.Methods inherited from class org.eclipse.draw2d.AbstractBorder
getPaintRectangle, getPreferredSize
-
Field Details
-
scheme
TheSchemeBorder.Scheme
associated with this SchemeBorder -
DARKEST_DARKER
Arrays of Colors, used for shadow or highlight effects -
LIGHTER_DARKER
-
DARKER_LIGHTER
-
-
Constructor Details
-
SchemeBorder
protected SchemeBorder()Constructs a default SchemeBorder with no scheme defined.- Since:
- 2.0
-
SchemeBorder
Constructs a SchemeBorder with the Scheme given as input.- Parameters:
scheme
- the Scheme to be used by this border- Since:
- 2.0
-
-
Method Details
-
getInsets
Description copied from interface:Border
Returns the Insets for this Border for the given Figure. -
getScheme
Returns the scheme used by this border.- Returns:
- the Scheme used by this border
- Since:
- 2.0
-
isOpaque
public boolean isOpaque()Returns the opaque state of this border. Returnstrue
indicating that this will fill in the area enclosed by the border.- Specified by:
isOpaque
in interfaceBorder
- Overrides:
isOpaque
in classAbstractBorder
- Returns:
true
if this border is opaque- See Also:
-
setScheme
Sets the Scheme for this border to the Scheme given as input.- Parameters:
scheme
- the Scheme for this border- Since:
- 2.0
-
paint
Description copied from interface:Border
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)
. -
paint
Paints the border using the information in the set Scheme and the inputs given. Side widths are determined by the number of colors in the Scheme for each side.- Parameters:
graphics
- the graphics objectfig
- the figure this border belongs toinsets
- the insetstl
- the highlight (top/left) colorsbr
- the shadow (bottom/right) colors
-