com.openhtmltopdf.css.constants

Class ValueConstants

java.lang.Object

com.openhtmltopdf.css.constants.ValueConstants

public final class ValueConstants
extends Object

Utility class for working with CSSValue instances.

Constructor Summary

Constructors

Constructor and Description
ValueConstants()

Method Summary

Modifier and Type	Method and Description
static Float	absoluteLengthToPixels(short type, float value) Converts a length in an absolute unit to CSS pixels.
static boolean	isAbsoluteUnit(short type) Returns true if the specified type absolute (even if we have a computed value for it), meaning that either the value can be used directly (e.g.
static boolean	isNumber(short cssPrimitiveType) Deprecated. Only used by the broken DOMInspector.
static String	stringForSACPrimitiveType(short type) Given a unit constant like CSSPrimitiveValue.CSS_EMS will return the unit suffix like em.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueConstants

public ValueConstants()

Method Detail

stringForSACPrimitiveType

public static String stringForSACPrimitiveType(short type)

Given a unit constant like CSSPrimitiveValue.CSS_EMS will return the unit suffix like em. FIXME: Not exhaustive.

absoluteLengthToPixels

public static Float absoluteLengthToPixels(short type,
                                           float value)

Converts a length in an absolute unit to CSS pixels.

Unlike LengthValue.calcFloatProportionalValue(com.openhtmltopdf.css.style.CalculatedStyle, com.openhtmltopdf.css.constants.CSSName, java.lang.String, float, short, float, com.openhtmltopdf.css.style.CssContext), which converts to dots and therefore needs a style and a context, this only handles the units whose conversion is fixed by CSS, and so needs neither. Useful where a length turns up outside a styled element, such as the width attribute of an SVG that is being used as an image.

A unitless number is treated as pixels, as CSS and SVG both do.

Parameters:

type - the unit, one of the CSSPrimitiveValue constants

value - the length in that unit

Returns:

the length in CSS pixels, or null for a unit that can not be resolved without knowing the surroundings, such as a percentage or a font relative unit.

isAbsoluteUnit

public static boolean isAbsoluteUnit(short type)

Returns true if the specified type absolute (even if we have a computed value for it), meaning that either the value can be used directly (e.g. pixels) or there is a fixed context-independent conversion for it (e.g. inches). Proportional types (e.g. %) return false. FIXME: Font proportional units are returned as absolute. Probably wrong method name rather than wrong behavior.

Parameters:

type - The CSSValue type to check.

Returns:

See desc.

isNumber

@Deprecated
public static boolean isNumber(short cssPrimitiveType)

Deprecated. Only used by the broken DOMInspector.

Returns true if the SAC primitive value type is a number unit--a unit that can only contain a numeric value. This is a shorthand way of saying, did the user declare this as a number unit (like px)?