com.sas.table
Class BorderStyle

com.sas.table.BorderStyle

All Implemented Interfaces:

com.sas.collection.PropertyBagChangedListener, com.sas.collection.PropertyBagChangedSource, com.sas.collection.PropertyBagInterface, com.sas.collection.StaticPropertyBagInterface, com.sas.DeepClonable, com.sas.PublicClonable, com.sas.util.Countable, java.beans.PropertyChangeListener, java.io.ObjectInputValidation, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

public class BorderStyle

A customizable set of border properties.

See CellStyle for more details.

See Also:

Serialized Form

Field Summary

static java.lang.String	HIGHLIGHT_COLOR String used to identify the highlightColor property in the bag.
static java.lang.String	LIGHT_SOURCE String used to identify the lightSource property in the bag.
static java.lang.String	SHADOW_COLOR String used to identify the shadowColor property in the bag.
static java.lang.String	SIDES String used to identify the sides property in the bag.
static java.lang.String	TYPE String used to identify the type property in the bag.
static java.lang.String	WIDTH String used to identify the width property in the bag.

Constructor Summary

BorderStyle()

Method Summary

java.awt.Color	getHighlightColor() Returns the color used for sides of the border that are closest to the light source.
int	getLightSource() Returns the light source -- one of CornerOrientation.
java.awt.Color	getShadowColor() Returns the color used for sides of the border that are furthest from the light source.
int	getSides() Returns which sides of the border to draw.
int	getType() Returns the type -- one of BorderTypes.
com.sas.measures.Length	getWidth() Returns the width (thickness).
boolean	isHighlightColorSet() Determines if the highlightColor property is in the bag.
boolean	isLightSourceSet() Determines if the lightSource property is in the bag.
boolean	isShadowColorSet() Determines if the shadowColor property is in the bag.
boolean	isSidesSet() Determines if the sides property is in the bag.
boolean	isTypeSet() Determines if the type property is in the bag.
boolean	isWidthSet() Determines if the width property is in the bag.
void	setHighlightColor(java.awt.Color newValue) Specifies the color used for sides of the border that are closest to the light source.
void	setLightSource(int newValue) Specifies the light source -- one of CornerOrientation.
void	setShadowColor(java.awt.Color newValue) Specifies the color used for sides of the border that are furthest from the light source.
void	setSides(int newValue) Specifies which sides of the border to draw.
void	setType(int newValue) Specifies the type -- one of BorderTypes.
void	setWidth(com.sas.measures.Length newValue) Specifies the width (thickness).
void	unsetHighlightColor() Removes the highlightColor property from the bag.
void	unsetLightSource() Removes the lightSource property from the bag.
void	unsetShadowColor() Removes the shadowColor property from the bag.
void	unsetSides() Removes the sides property from the bag.
void	unsetType() Removes the type property from the bag.
void	unsetWidth() Removes the width property from the bag.

Field Detail

HIGHLIGHT_COLOR

public static final java.lang.String HIGHLIGHT_COLOR

String used to identify the highlightColor property in the bag.

See Also:

Constant Field Values

LIGHT_SOURCE

public static final java.lang.String LIGHT_SOURCE

String used to identify the lightSource property in the bag.

See Also:

Constant Field Values

SHADOW_COLOR

public static final java.lang.String SHADOW_COLOR

String used to identify the shadowColor property in the bag.

See Also:

Constant Field Values

SIDES

public static final java.lang.String SIDES

String used to identify the sides property in the bag.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

String used to identify the type property in the bag.

See Also:

Constant Field Values

WIDTH

public static final java.lang.String WIDTH

String used to identify the width property in the bag.

See Also:

Constant Field Values

Constructor Detail

BorderStyle

public BorderStyle()

Method Detail

getHighlightColor

public java.awt.Color getHighlightColor()

Returns the color used for sides of the border that are closest to the light source. Also, for those border types that aren't affected by the light source, like SIMPLE, highlightColor serves as the color for the entire border.

Returns:

The value of the highlightColor property.

See Also:

isHighlightColorSet(), setHighlightColor(java.awt.Color), unsetHighlightColor()

setHighlightColor

public void setHighlightColor(java.awt.Color newValue)

Specifies the color used for sides of the border that are closest to the light source. Also, for those border types that aren't affected by the light source, like SIMPLE, highlightColor serves as the color for the entire border.

Parameters:

newValue - The new value to assign the highlightColor property.

See Also:

getHighlightColor(), isHighlightColorSet(), unsetHighlightColor()

isHighlightColorSet

public boolean isHighlightColorSet()

Determines if the highlightColor property is in the bag.

Returns:

true if highlightColor has been set, and false otherwise.

See Also:

getHighlightColor(), setHighlightColor(java.awt.Color), unsetHighlightColor()

unsetHighlightColor

public void unsetHighlightColor()

Removes the highlightColor property from the bag.

See Also:

getHighlightColor(), isHighlightColorSet(), setHighlightColor(java.awt.Color)

getLightSource

public int getLightSource()

Returns the light source -- one of CornerOrientation. lightSource controls the direction from which light appears to shine on the border. Note that some border types like SIMPLE ignore lightSource.

Returns:

The value of the lightSource property.

See Also:

isLightSourceSet(), setLightSource(int), unsetLightSource()

setLightSource

public void setLightSource(int newValue)

Specifies the light source -- one of CornerOrientation. lightSource controls the direction from which light appears to shine on the border. Note that some border types like SIMPLE ignore lightSource.

Parameters:

newValue - The new value to assign the lightSource property.

See Also:

getLightSource(), isLightSourceSet(), unsetLightSource()

isLightSourceSet

public boolean isLightSourceSet()

Determines if the lightSource property is in the bag.

Returns:

true if lightSource has been set, and false otherwise.

See Also:

getLightSource(), setLightSource(int), unsetLightSource()

unsetLightSource

public void unsetLightSource()

Removes the lightSource property from the bag.

See Also:

getLightSource(), isLightSourceSet(), setLightSource(int)

getShadowColor

public java.awt.Color getShadowColor()

Returns the color used for sides of the border that are furthest from the light source. Also, for those border types that aren't affected by the light source, like SIMPLE, shadowColor is ignored.

Returns:

The value of the shadowColor property.

See Also:

isShadowColorSet(), setShadowColor(java.awt.Color), unsetShadowColor()

setShadowColor

public void setShadowColor(java.awt.Color newValue)

Specifies the color used for sides of the border that are furthest from the light source. Also, for those border types that aren't affected by the light source, like SIMPLE, shadowColor is ignored.

Parameters:

newValue - The new value to assign the shadowColor property.

See Also:

getShadowColor(), isShadowColorSet(), unsetShadowColor()

isShadowColorSet

public boolean isShadowColorSet()

Determines if the shadowColor property is in the bag.

Returns:

true if shadowColor has been set, and false otherwise.

See Also:

getShadowColor(), setShadowColor(java.awt.Color), unsetShadowColor()

unsetShadowColor

public void unsetShadowColor()

Removes the shadowColor property from the bag.

See Also:

getShadowColor(), isShadowColorSet(), setShadowColor(java.awt.Color)

getSides

public int getSides()

Returns which sides of the border to draw. Valid values for sides are any combination of the flags defined in SideOrientation.

Returns:

The value of the sides property.

See Also:

isSidesSet(), setSides(int), unsetSides()

setSides

public void setSides(int newValue)

Specifies which sides of the border to draw. Valid values for sides are any combination of the flags defined in SideOrientation.

Parameters:

newValue - The new value to assign the sides property.

See Also:

getSides(), isSidesSet(), unsetSides()

isSidesSet

public boolean isSidesSet()

Determines if the sides property is in the bag.

Returns:

true if sides has been set, and false otherwise.

See Also:

getSides(), setSides(int), unsetSides()

unsetSides

public void unsetSides()

Removes the sides property from the bag.

See Also:

getSides(), isSidesSet(), setSides(int)

getType

public int getType()

Returns the type -- one of BorderTypes.

Returns:

The value of the type property.

See Also:

isTypeSet(), setType(int), unsetType()

setType

public void setType(int newValue)

Specifies the type -- one of BorderTypes.

Parameters:

newValue - The new value to assign the type property.

See Also:

getType(), isTypeSet(), unsetType()

isTypeSet

public boolean isTypeSet()

Determines if the type property is in the bag.

Returns:

true if type has been set, and false otherwise.

See Also:

getType(), setType(int), unsetType()

unsetType

public void unsetType()

Removes the type property from the bag.

See Also:

getType(), isTypeSet(), setType(int)

getWidth

public com.sas.measures.Length getWidth()

Returns the width (thickness).

Returns:

The value of the width property.

See Also:

isWidthSet(), setWidth(com.sas.measures.Length), unsetWidth()

setWidth

public void setWidth(com.sas.measures.Length newValue)

Specifies the width (thickness).

Parameters:

newValue - The new value to assign the width property.

See Also:

getWidth(), isWidthSet(), unsetWidth()

isWidthSet

public boolean isWidthSet()

Determines if the width property is in the bag.

Returns:

true if width has been set, and false otherwise.

See Also:

getWidth(), setWidth(com.sas.measures.Length), unsetWidth()

unsetWidth

public void unsetWidth()

Removes the width property from the bag.

See Also:

getWidth(), isWidthSet(), setWidth(com.sas.measures.Length)