com.helger.pdflayout.spec

Class WidthSpec

java.lang.Object

com.helger.pdflayout.spec.WidthSpec

@Immutable
 @MustImplementEqualsAndHashcode
public class WidthSpec
extends Object

This class defines a dependent width of an elements:

• absolute - element has a fixed width
• percentage - element width is a certain percentage of the surrounding element
• star - element width is a relative part of the unused width of the surrounding element

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WidthSpec.EWidthType Defines the type of width unit of measure used.

Constructor Summary

Constructors

Constructor and Description
WidthSpec(WidthSpec.EWidthType eType, float fValue)

Method Summary

Modifier and Type	Method and Description
static WidthSpec	abs(float fValue) Create a width element with an absolute value.
boolean	equals(Object o)
float	getEffectiveValue(float fAvailableWidth) Get the effective width based on the passed available width.
WidthSpec.EWidthType	getType()
String	getTypeID()
float	getValue()
int	hashCode()
boolean	isStar()
static WidthSpec	perc(float fPerc) Create a width element with an percentage value.
static WidthSpec	star() Create a new star width element.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WidthSpec

public WidthSpec(@Nonnull
                 WidthSpec.EWidthType eType,
                 float fValue)

Method Detail

getType

@Nonnull
public WidthSpec.EWidthType getType()

Returns:

The width type. Never null.

getTypeID

@Nonnull
 @Nonempty
public String getTypeID()

Returns:

The ID of the width type. Never null.

isStar

public boolean isStar()

Returns:

true if type is 'star'.

getValue

@Nonnegative
public float getValue()

Returns:

The width value - is either an absolute value or a percentage value - depending on getType(). For star width elements this is 0.

getEffectiveValue

@Nonnegative
public float getEffectiveValue(float fAvailableWidth)

Get the effective width based on the passed available width. This may not be called for star width elements.

Parameters:

fAvailableWidth - The available width.

Returns:

The effective width 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

abs

@Nonnull
public static WidthSpec abs(@Nonnegative
                                      float fValue)

Create a width element with an absolute value.

Parameters:

fValue - The width to use. Must be > 0.

Returns:

Never null.

perc

@Nonnull
public static WidthSpec perc(@Nonnegative
                                       float fPerc)

Create a width element with an percentage value.

Parameters:

fPerc - The width percentage to use. Must be > 0.

Returns:

Never null.

star

@Nonnull
public static WidthSpec star()

Create a new star width element.

Returns:

Never null.