com.helger.pdflayout.spec

Class SizeSpec

java.lang.Object

com.helger.pdflayout.spec.SizeSpec

@Immutable
 @MustImplementEqualsAndHashcode
public class SizeSpec
extends Object

This class defines a size.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static SizeSpec	SIZE0

Constructor Summary

Constructors

Constructor and Description
SizeSpec(float fWidth, float fHeight) Constructor

Method Summary

Modifier and Type	Method and 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()
SizeSpec	minus(float fWidth, float fHeight)
SizeSpec	minus(SizeSpec aOther)
SizeSpec	plus(float fWidth, float fHeight)
SizeSpec	plus(SizeSpec aOther)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SIZE0

public static final SizeSpec SIZE0

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 float getWidth()

Returns:

Width. Always ≥ 0.

getHeight

@Nonnegative
public 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)

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)