org.eclipse.graphiti.tb

Class BorderDecorator

java.lang.Object

org.eclipse.graphiti.tb.AbstractDecorator

org.eclipse.graphiti.tb.BorderDecorator

All Implemented Interfaces:

IBorderDecorator, IDecorator

public class BorderDecorator
extends AbstractDecorator
implements IBorderDecorator

Border decorators can be used to add a border (a rectangle around the shape) to the visualization of a shape without modifying the dirty state of the displaying editor, see IDecorator.

Since:

0.9

Constructor Summary

Constructors

Constructor and Description
BorderDecorator() Creates a new border decorator that decorates a shape with a border.
BorderDecorator(IColorConstant borderColor, java.lang.Integer lineWidth, java.lang.Integer lineStyle) Creates a new border decorator that decorates a shape with a border with the given settings.

Method Summary

Modifier and Type	Method and Description
IColorConstant	getBorderColor() Returns the color that will be used for the border.
java.lang.Integer	getBorderStyle() Returns the style that will be used for the border line.
java.lang.Integer	getBorderWidth() Returns the width that will be used for the border line.
void	setBorderColor(IColorConstant borderColor) Sets the color to be used for the border line.
void	setBorderStyle(java.lang.Integer lineStyle) Sets the style that will be used for the border line.
void	setBorderWidth(java.lang.Integer lineWidth) Sets the width that will be used for the border line.

Methods inherited from class org.eclipse.graphiti.tb.AbstractDecorator

getMessage, setMessage

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.graphiti.tb.IDecorator

getMessage, setMessage

Constructor Detail

BorderDecorator

public BorderDecorator()

Creates a new border decorator that decorates a shape with a border.

BorderDecorator

public BorderDecorator(IColorConstant borderColor,
                       java.lang.Integer lineWidth,
                       java.lang.Integer lineStyle)

Creates a new border decorator that decorates a shape with a border with the given settings. See the setter methods for details on these values.

Parameters:

borderColor - an IColorConstant defining the color for the border line

lineWidth - an Integer defining the width of the border line

lineStyle - an Integer defining the style of the border line

Method Detail

getBorderColor

public IColorConstant getBorderColor()

Description copied from interface: IBorderDecorator

Returns the color that will be used for the border. By default (when returning null) IColorConstant.BLACK is used.

Specified by:

getBorderColor in interface IBorderDecorator

Returns:

a IColorConstant defining the color

setBorderColor

public void setBorderColor(IColorConstant borderColor)

Sets the color to be used for the border line. By default (when null is set) IColorConstant.BLACK is used.

Parameters:

borderColor -

getBorderWidth

public java.lang.Integer getBorderWidth()

Description copied from interface: IBorderDecorator

Returns the width that will be used for the border line. By default (when returning null or a value smaller than 1) 1 is used.

Specified by:

getBorderWidth in interface IBorderDecorator

Returns:

an Integer defining the width of the border line

setBorderWidth

public void setBorderWidth(java.lang.Integer lineWidth)

Sets the width that will be used for the border line. By default (when null or a value smaller than 1 is set) 1 is used.

Parameters:

lineWidth - an Integer defining the width of the border line

getBorderStyle

public java.lang.Integer getBorderStyle()

Description copied from interface: IBorderDecorator

Returns the style that will be used for the border line. Possible values are:

• Graphics.LINE_SOLID
• Graphics.LINE_DASH
• Graphics.LINE_DASHDOT
• Graphics.LINE_DASHDOTDOT
• Graphics.LINE_DOT

By default (when returning null or an invalid value) Graphics.LINE_SOLID is used.

Specified by:

getBorderStyle in interface IBorderDecorator

Returns:

an Integer defining the width of the border style

setBorderStyle

public void setBorderStyle(java.lang.Integer lineStyle)

Sets the style that will be used for the border line. Possible values are:

• Graphics.LINE_SOLID
• Graphics.LINE_DASH
• Graphics.LINE_DASHDOT
• Graphics.LINE_DASHDOTDOT
• Graphics.LINE_DOT

By default (when null or an invalid value is set) Graphics.LINE_SOLID is used.

Parameters:

lineStyle - an Integer defining the style of the border line