com.hfg.graphics.units

Interface GfxSize

All Known Implementing Classes:

EMUs, GfxSizeImpl, Inches, Millimeters, Pixels, Points, Twips

public interface GfxSize

Interface for a unit-independent graphic length measurement.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	DOUBLE_WITH_UNITS_PATTERN
static Pattern	INT_WITH_UNITS_PATTERN
static Pattern	MEASUREMENT_PATTERN
static Pattern	SCIENTIFIC_NOTATION_WITH_UNITS_PATTERN

Method Summary

Modifier and Type	Method and Description
GfxSize	add(GfxSize inValue)
static GfxSize	allocate(float inValue, GfxUnits inUnits) Function for constructing a GfxSize object.
static GfxSize	allocate(int inValue, GfxUnits inUnits) Function for constructing a GfxSize object.
static GfxSize	allocate(String inStringValue) Convenience allocator that accepts a string with a value followed by units.
static GfxSize	allocate(String inStringValue, GfxUnits inDefaultUnits) Function for converting a string representation of a graphics measurement into its appropriate object.
GfxUnits	getUnits()
default boolean	greaterThan(GfxSize inValue)
default boolean	lessThan(GfxSize inValue)
void	scale(float inScalingFactor)
GfxSize	subtract(GfxSize inValue)
float	to(GfxUnits inUnits)
int	toInt(GfxUnits inUnits)
float	value()

Field Detail

MEASUREMENT_PATTERN

static final Pattern MEASUREMENT_PATTERN

INT_WITH_UNITS_PATTERN

static final Pattern INT_WITH_UNITS_PATTERN

DOUBLE_WITH_UNITS_PATTERN

static final Pattern DOUBLE_WITH_UNITS_PATTERN

SCIENTIFIC_NOTATION_WITH_UNITS_PATTERN

static final Pattern SCIENTIFIC_NOTATION_WITH_UNITS_PATTERN

Method Detail

to

float to(GfxUnits inUnits)

toInt

int toInt(GfxUnits inUnits)

value

float value()

getUnits

GfxUnits getUnits()

add

GfxSize add(GfxSize inValue)

subtract

GfxSize subtract(GfxSize inValue)

scale

void scale(float inScalingFactor)

allocate

static GfxSize allocate(String inStringValue)

Convenience allocator that accepts a string with a value followed by units.

Parameters:

inStringValue - the string value

allocate

static GfxSize allocate(String inStringValue,
                        GfxUnits inDefaultUnits)

Function for converting a string representation of a graphics measurement into its appropriate object.

Parameters:

inStringValue - the string representation (ex: "10px", "12pt", or "17.5")

inDefaultUnits - the units to use if the string representation is unit-less.

Returns:

a GfxSize-extending object

allocate

static GfxSize allocate(int inValue,
                        GfxUnits inUnits)

Function for constructing a GfxSize object.

Parameters:

inValue - the integer value

inUnits - the units to use

Returns:

a GfxSize-extending object

allocate

static GfxSize allocate(float inValue,
                        GfxUnits inUnits)

Function for constructing a GfxSize object.

Parameters:

inValue - the float value

inUnits - the units to use

Returns:

a GfxSize-extending object

greaterThan

default boolean greaterThan(GfxSize inValue)

lessThan

default boolean lessThan(GfxSize inValue)