CPDFGeneration.layout

Class CUnitValue

java.lang.Object

CPDFGeneration.layout.CUnitValue

public class CUnitValue
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	PERCENT Percent unit (%).
static int	POINT Point unit (pt).

Constructor Summary

Constructors

Constructor and Description
CUnitValue() Create a UnitValue with default settings.
CUnitValue(int type, float v) Create a UnitValue with specified type and value.

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<CUnitValue>	CreatePercentArray(float[] values) Convert a float array into a percent UnitValue list by normalizing values.
static java.util.ArrayList<CUnitValue>	CreatePercentArray(int size) Create an equal-percent UnitValue list of specified size.
static CUnitValue	CreatePercentValue(float value) Create a PERCENT UnitValue.
static java.util.ArrayList<CUnitValue>	CreatePointArray(float[] values) Convert a float array into a point UnitValue list.
static CUnitValue	CreatePointValue(float value) Create a POINT UnitValue.
int	GetUnitType() Get unit type.
float	GetValue() Get stored value.
boolean	IsPercentValue() Check whether this UnitValue is PERCENT.
boolean	IsPointValue() Check whether this UnitValue is POINT.
void	SetUnitType(int unitType) Set unit type.
void	SetValue(float value) Set stored value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

POINT

public static final int POINT

Point unit (pt).

See Also:

Constant Field Values

PERCENT

public static final int PERCENT

Percent unit (%).

See Also:

Constant Field Values

Constructor Detail

CUnitValue

public CUnitValue()

Create a UnitValue with default settings.

Defaults to POINT with value 0.

CUnitValue

public CUnitValue(int type,
                  float v)

Create a UnitValue with specified type and value.

Parameters:

type - Unit type, POINT or PERCENT.

v - Stored value.

Method Detail

CreatePointValue

public static CUnitValue CreatePointValue(float value)

Create a POINT UnitValue.

Parameters:

value - Stored value.

Returns:

New POINT UnitValue.

CreatePercentValue

public static CUnitValue CreatePercentValue(float value)

Create a PERCENT UnitValue.

Parameters:

value - Stored value.

Returns:

New PERCENT UnitValue.

CreatePercentArray

public static java.util.ArrayList<CUnitValue> CreatePercentArray(float[] values)

Convert a float array into a percent UnitValue list by normalizing values.

Steps:

1. Compute sum of all items
2. Convert each item to (item / sum) * 100

Parameters:

values - Input values.

Returns:

List of percent UnitValues, or null if values is null.

CreatePercentArray

public static java.util.ArrayList<CUnitValue> CreatePercentArray(int size)

Create an equal-percent UnitValue list of specified size. For example, size=4 will produce [25%, 25%, 25%, 25%].

Parameters:

size - List size.

Returns:

Equal-percent UnitValue list.

CreatePointArray

public static java.util.ArrayList<CUnitValue> CreatePointArray(float[] values)

Convert a float array into a point UnitValue list.

Parameters:

values - Input values.

Returns:

List of point UnitValues, or null if values is null.

GetUnitType

public int GetUnitType()

Get unit type.

Returns:

POINT or PERCENT.

SetUnitType

public void SetUnitType(int unitType)

Set unit type.

Parameters:

unitType - POINT or PERCENT.

GetValue

public float GetValue()

Get stored value.

Returns:

Stored value.

SetValue

public void SetValue(float value)

Set stored value.

Parameters:

value - Stored value.

IsPointValue

public boolean IsPointValue()

Check whether this UnitValue is POINT.

Returns:

true if POINT, otherwise false.

IsPercentValue

public boolean IsPercentValue()

Check whether this UnitValue is PERCENT.

Returns:

true if PERCENT, otherwise false.