Package com.helger.pdflayout.spec

Class LineDashPatternSpec

java.lang.Object

com.helger.pdflayout.spec.LineDashPatternSpec

All Implemented Interfaces:

Serializable

@MustImplementEqualsAndHashcode
public class LineDashPatternSpec
extends Object
implements Serializable

Different dashed line times

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static LineDashPatternSpec	DASHED_2
static LineDashPatternSpec	DASHED_3
static LineDashPatternSpec	DASHED_4
static LineDashPatternSpec	DASHED_5
static LineDashPatternSpec	SOLID

Constructor Summary

Constructors

Constructor	Description
LineDashPatternSpec()
LineDashPatternSpec(float fPattern)
LineDashPatternSpec(float[] aPattern, float fPhase)
LineDashPatternSpec(float fPatternOn, float fPatternOff)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
float[]	getPattern()
org.apache.pdfbox.cos.COSArray	getPatternCOSArray()
float	getPhase()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SOLID

public static final LineDashPatternSpec SOLID

DASHED_2

public static final LineDashPatternSpec DASHED_2

DASHED_3

public static final LineDashPatternSpec DASHED_3

DASHED_4

public static final LineDashPatternSpec DASHED_4

DASHED_5

public static final LineDashPatternSpec DASHED_5

Constructor Detail

LineDashPatternSpec

public LineDashPatternSpec()

LineDashPatternSpec

public LineDashPatternSpec(@Nonnegative
                           float fPattern)

LineDashPatternSpec

public LineDashPatternSpec(@Nonnegative
                           float fPatternOn,
                           @Nonnegative
                           float fPatternOff)

LineDashPatternSpec

public LineDashPatternSpec(@Nonnull
                           float[] aPattern,
                           float fPhase)

Parameters:

aPattern - The pattern array. May not be null. Must have 0-2 items. 0 items means solid line, 1 item means identical on and off length and 2 items means potentially different on and off length. All contains values must be > 0.

fPhase - The phase of the pattern. Where to start the painting, first counting on than off.

Method Detail

getPattern

@Nonnull
@ReturnsMutableCopy
public final float[] getPattern()

Returns:

A copy with all patterns. 0-2 elements.

getPatternCOSArray

@Nonnull
@ReturnsMutableCopy
public final org.apache.pdfbox.cos.COSArray getPatternCOSArray()

Returns:

A COS array with 0-2 elements. Never null.

getPhase

public final float getPhase()

Returns:

The phase to use.

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