Package com.helger.pdflayout.spec

Class SizeSpec

java.lang.Object

com.helger.pdflayout.spec.SizeSpec

All Implemented Interfaces:

Serializable

@Immutable
@MustImplementEqualsAndHashcode
public class SizeSpec
extends Object
implements Serializable

This class defines a size.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static float	DEFAULT_FLOAT
static SizeSpec	SIZE_MAX
static SizeSpec	SIZE0

Constructor Summary

Constructors

Constructor	Description
SizeSpec(float fWidth, float fHeight)	Constructor

Method Summary

Modifier and Type	Method	Description
static SizeSpec	create(org.apache.pdfbox.pdmodel.common.PDRectangle aRect)
static SizeSpec	createMM(float fWidth, float fHeight)
boolean	equals(Object o)
org.apache.pdfbox.pdmodel.common.PDRectangle	getAsRectangle()
float	getHeight()
float	getWidth()
int	hashCode()
static SizeSpec	height(float fHeight)
SizeSpec	minus(float fWidth, float fHeight)
SizeSpec	minus(SizeSpec aOther)
SizeSpec	plus(float fWidth, float fHeight)
SizeSpec	plus(SizeSpec aOther)
String	toString()
static SizeSpec	width(float fWidth)
SizeSpec	withHeight(float fHeight)
SizeSpec	withWidth(float fWidth)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FLOAT

public static final float DEFAULT_FLOAT

See Also:

Constant Field Values

SIZE0

public static final SizeSpec SIZE0

SIZE_MAX

public static final SizeSpec SIZE_MAX

Constructor Detail

SizeSpec

public SizeSpec(@Nonnegative
                float fWidth,
                @Nonnegative
                float fHeight)

Constructor

Parameters:

fWidth - Width. Must be ≥ 0.

fHeight - Height. Must be ≥ 0.

Method Detail

getWidth

@Nonnegative
public final float getWidth()

Returns:

Width. Always ≥ 0.

getHeight

@Nonnegative
public final float getHeight()

Returns:

Height. Always ≥ 0.

getAsRectangle

@Nonnull
public org.apache.pdfbox.pdmodel.common.PDRectangle getAsRectangle()

plus

@Nonnull
@CheckReturnValue
public SizeSpec plus(float fWidth,
                     float fHeight)

plus

@Nonnull
@CheckReturnValue
public SizeSpec plus(@Nonnull
                     SizeSpec aOther)

minus

@Nonnull
@CheckReturnValue
public SizeSpec minus(float fWidth,
                      float fHeight)

minus

@Nonnull
@CheckReturnValue
public SizeSpec minus(@Nonnull
                      SizeSpec aOther)

withWidth

@Nonnull
@CheckReturnValue
public SizeSpec withWidth(float fWidth)

withHeight

@Nonnull
@CheckReturnValue
public SizeSpec withHeight(float fHeight)

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

create

@Nonnull
public static SizeSpec create(@Nonnull
                              org.apache.pdfbox.pdmodel.common.PDRectangle aRect)

createMM

@Nonnull
public static SizeSpec createMM(float fWidth,
                                float fHeight)

width

@Nonnull
public static SizeSpec width(float fWidth)

height

@Nonnull
public static SizeSpec height(float fHeight)