Package com.helger.pdflayout.spec

Class BorderStyleSpec

java.lang.Object

com.helger.pdflayout.spec.BorderStyleSpec

All Implemented Interfaces:

Serializable

@Immutable
@MustImplementEqualsAndHashcode
public class BorderStyleSpec
extends Object
implements Serializable

This class contains the styling of a single border part. Currently only the color, the dash pattern and the line width can be set.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Color	DEFAULT_COLOR	The default border color: black
static LineDashPatternSpec	DEFAULT_LINE_DASH_PATTERN	The default border style: solid
static float	DEFAULT_LINE_WIDTH	Use the default line width if unspecified.
static BorderStyleSpec	EMPTY

Constructor Summary

Constructors

Constructor	Description
BorderStyleSpec()
BorderStyleSpec(float fLineWidth)
BorderStyleSpec(LineDashPatternSpec aLineDashPattern)
BorderStyleSpec(Color aColor)
BorderStyleSpec(Color aColor, float fLineWidth)
BorderStyleSpec(Color aColor, LineDashPatternSpec aLineDashPattern)
BorderStyleSpec(Color aColor, LineDashPatternSpec aLineDashPattern, float fLineWidth)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BorderStyleSpec	getCloneWithColor(Color aNewColor)
BorderStyleSpec	getCloneWithLineDashPattern(LineDashPatternSpec aNewLineDashPattern)
BorderStyleSpec	getCloneWithLineWidth(float fNewLineWidth)
Color	getColor()
LineDashPatternSpec	getLineDashPattern()
float	getLineWidth()
int	hashCode()
boolean	isDefault()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_COLOR

public static final Color DEFAULT_COLOR

The default border color: black

DEFAULT_LINE_DASH_PATTERN

public static final LineDashPatternSpec DEFAULT_LINE_DASH_PATTERN

The default border style: solid

DEFAULT_LINE_WIDTH

public static final float DEFAULT_LINE_WIDTH

Use the default line width if unspecified. A width of 0 is also valid and would create a hair line

See Also:

Constant Field Values

EMPTY

public static final BorderStyleSpec EMPTY

Constructor Detail

BorderStyleSpec

public BorderStyleSpec()

BorderStyleSpec

public BorderStyleSpec(@Nonnull
                       Color aColor)

BorderStyleSpec

public BorderStyleSpec(@Nonnull
                       LineDashPatternSpec aLineDashPattern)

BorderStyleSpec

public BorderStyleSpec(float fLineWidth)

BorderStyleSpec

public BorderStyleSpec(@Nonnull
                       Color aColor,
                       float fLineWidth)

BorderStyleSpec

public BorderStyleSpec(@Nonnull
                       Color aColor,
                       @Nonnull
                       LineDashPatternSpec aLineDashPattern)

BorderStyleSpec

public BorderStyleSpec(@Nonnull
                       Color aColor,
                       @Nonnull
                       LineDashPatternSpec aLineDashPattern,
                       @Nonnegative
                       float fLineWidth)

Method Detail

getColor

@Nonnull
public final Color getColor()

Returns:

The border color to use. Never null.

getLineDashPattern

@Nonnull
public final LineDashPatternSpec getLineDashPattern()

Returns:

The border line style to use. Never null.

getLineWidth

@Nonnegative
public final float getLineWidth()

isDefault

public final boolean isDefault()

Returns:

true if all values are set to default, false otherwise.

getCloneWithColor

@Nonnull
public BorderStyleSpec getCloneWithColor(@Nonnull
                                         Color aNewColor)

getCloneWithLineDashPattern

@Nonnull
public BorderStyleSpec getCloneWithLineDashPattern(@Nonnull
                                                   LineDashPatternSpec aNewLineDashPattern)

getCloneWithLineWidth

@Nonnull
public BorderStyleSpec getCloneWithLineWidth(float fNewLineWidth)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object