Module org.jhotdraw8.css

Package org.jhotdraw8.css.value

Interface UnitConverter

All Known Implementing Classes:

DefaultUnitConverter

public interface UnitConverter

UnitConverter.

References:

CSS Values and Units Module Level 3. § 5.1.1 Font-relative lengths: the em, ex, ch, rem units

w3.org

CSS Values and Units Module Level 3. § 5.1.2 Viewport-percentage lengths: the vw, vh, vmin, vmax units

w3.org

CSS Values and Units Module Level 3. § 5.2 Absolute lengths: the cm, mm, Q, in, pt, pc, px units

w3.org

Author:

Werner Randelshofer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CENTIMETERS
static final String	DEFAULT	Default unit.
static final String	DEGREES
static final String	EM
static final String	EX
static final String	INCH
static final String	MILLIMETERS
static final String	PERCENTAGE
static final String	PICAS
static final String	PIXELS
static final String	POINTS
static final String	QUARTER_MILLIMETERS
static final String	VIEWPORT_HEIGHT_PERCENTAGE
static final String	VIEWPORT_MAX_PERCENTAGE
static final String	VIEWPORT_MIN_PERCENTAGE
static final String	VIEWPORT_WIDTH_PERCENTAGE

Method Summary

Modifier and Type	Method	Description
default double	convert(double value, @NonNull String inputUnit, @NonNull String outputUnit)	Converts the specified value from input unit to output unit.
default double	convert(@NonNull CssSize value, @NonNull String outputUnit)	Converts the specified value from input unit to output unit.
default @NonNull CssSize	convertSize(double value, @NonNull String inputUnit, @NonNull String outputUnit)
default @NonNull CssSize	convertSize(@NonNull CssSize value, @NonNull String outputUnit)
default double	getDpi()	Gets the resolution in dots per inch.
default double	getFactor(@NonNull String unit)
default double	getFontSize()	Gets the font size;
default double	getFontXHeight()	Gets the x-height of the font size.
default double	getPercentageFactor()	Gets the factor for percentage values.
default double	getViewportHeight()	Gets the viewport height.
default double	getViewportWidth()	Gets the viewport width.

Field Details

DEFAULT

static final String DEFAULT

Default unit.

See Also:

• Constant Field Values

CENTIMETERS

static final String CENTIMETERS

See Also:

• Constant Field Values

DEGREES

static final String DEGREES

See Also:

• Constant Field Values

EM

static final String EM

See Also:

• Constant Field Values

EX

static final String EX

See Also:

• Constant Field Values

INCH

static final String INCH

See Also:

• Constant Field Values

MILLIMETERS

static final String MILLIMETERS

See Also:

• Constant Field Values

QUARTER_MILLIMETERS

static final String QUARTER_MILLIMETERS

See Also:

• Constant Field Values

PERCENTAGE

static final String PERCENTAGE

See Also:

• Constant Field Values

PICAS

static final String PICAS

See Also:

• Constant Field Values

PIXELS

static final String PIXELS

See Also:

• Constant Field Values

POINTS

static final String POINTS

See Also:

• Constant Field Values

VIEWPORT_WIDTH_PERCENTAGE

static final String VIEWPORT_WIDTH_PERCENTAGE

See Also:

• Constant Field Values

VIEWPORT_HEIGHT_PERCENTAGE

static final String VIEWPORT_HEIGHT_PERCENTAGE

See Also:

• Constant Field Values

VIEWPORT_MIN_PERCENTAGE

static final String VIEWPORT_MIN_PERCENTAGE

See Also:

• Constant Field Values

VIEWPORT_MAX_PERCENTAGE

static final String VIEWPORT_MAX_PERCENTAGE

See Also:

• Constant Field Values

Method Details

getDpi

default double getDpi()

Gets the resolution in dots per inch.

Returns:

dpi, default value: 96.0.

getViewportWidth

default double getViewportWidth()

Gets the viewport width.

Returns:

viewport width, default value: 1024.0.

getViewportHeight

default double getViewportHeight()

Gets the viewport height.

Returns:

viewport height, default value: 768.0.

getPercentageFactor

default double getPercentageFactor()

Gets the factor for percentage values.

Returns:

percentageFactor, for example 100.

getFactor

default double getFactor(@NonNull String unit)

getFontSize

default double getFontSize()

Gets the font size;

Returns:

em

getFontXHeight

default double getFontXHeight()

Gets the x-height of the font size.

Returns:

ex

convert

default double convert(double value,
 @NonNull String inputUnit,
 @NonNull String outputUnit)

Converts the specified value from input unit to output unit.

Parameters:

value - a value

inputUnit - the units of the value

outputUnit - the desired output unit

Returns:

converted value

convertSize

default @NonNull CssSize convertSize(double value,
 @NonNull String inputUnit,
 @NonNull String outputUnit)

convert

default double convert(@NonNull CssSize value,
 @NonNull String outputUnit)

Converts the specified value from input unit to output unit.

Parameters:

value - a value

outputUnit - the desired output unit

Returns:

converted value

convertSize

default @NonNull CssSize convertSize(@NonNull CssSize value,
 @NonNull String outputUnit)