Module io.sf.carte.css4j

Package io.sf.carte.doc.style.css.property

Class NumberValue

java.lang.Object

io.sf.carte.doc.style.css.property.StyleValue

io.sf.carte.doc.style.css.property.PrimitiveValue

io.sf.carte.doc.style.css.property.NumberValue

All Implemented Interfaces:

CSSPrimitiveValue2, ExtendedCSSPrimitiveValue, ExtendedCSSValue, Cloneable, CSSPrimitiveValue, CSSValue

Direct Known Subclasses:

PercentageValue

public class NumberValue
extends PrimitiveValue

Number-specific CSSPrimitiveValue.

Field Summary

Fields

Modifier and Type	Field	Description
protected float	realvalue

Fields inherited from interface org.w3c.dom.css.CSSPrimitiveValue

CSS_ATTR, CSS_CM, CSS_COUNTER, CSS_DEG, CSS_DIMENSION, CSS_EMS, CSS_EXS, CSS_GRAD, CSS_HZ, CSS_IDENT, CSS_IN, CSS_KHZ, CSS_MM, CSS_MS, CSS_NUMBER, CSS_PC, CSS_PERCENTAGE, CSS_PT, CSS_PX, CSS_RAD, CSS_RECT, CSS_RGBCOLOR, CSS_S, CSS_STRING, CSS_UNKNOWN, CSS_URI

Fields inherited from interface io.sf.carte.doc.style.css.CSSPrimitiveValue2

CSS_CAP, CSS_CH, CSS_COUNTERS, CSS_CUSTOM_PROPERTY, CSS_DPCM, CSS_DPI, CSS_DPPX, CSS_ELEMENT_REFERENCE, CSS_ENV_VAR, CSS_EXPRESSION, CSS_FR, CSS_FUNCTION, CSS_GRADIENT, CSS_IC, CSS_LH, CSS_QUARTER_MM, CSS_RATIO, CSS_REM, CSS_RLH, CSS_TURN, CSS_UNICODE_CHARACTER, CSS_UNICODE_RANGE, CSS_UNICODE_WILDCARD, CSS_VB, CSS_VH, CSS_VI, CSS_VMAX, CSS_VMIN, CSS_VW

Fields inherited from interface org.w3c.dom.css.CSSValue

CSS_CUSTOM, CSS_INHERIT, CSS_PRIMITIVE_VALUE, CSS_VALUE_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
	NumberValue()
protected	NumberValue(NumberValue copied)

Method Summary

Modifier and Type	Method	Description
NumberValue	clone()	Creates and returns a copy of this object.
static NumberValue	createCSSNumberValue(short unit, float floatValue)
boolean	equals(Object obj)
static float	floatValueConversion(float fvalue, short declType, short unitType)	Converts a float value, expressed in declType units, to unitType units.
String	getCssText()	Get a string representation of the current value.
String	getDimensionUnitText()	Gives the text representation of the dimension unit, if this value represents a dimension.
float	getFloatValue(short unitType)	Gets a float value in a specified unit.
String	getMinifiedCssText(String propertyName)	Gives a minified version of the css text of the property, for the given property name.
int	hashCode()
static boolean	isAngleUnitType(short primitiveType)
boolean	isCalculatedNumber()	Test whether this is a numeric value that was the result of a calc() expression.
static boolean	isLengthUnitType(short primitiveType)
boolean	isNegativeNumber()	Test whether this is a numeric value that is less than zero.
boolean	isNumberZero()	Is this value a number set to a value of zero, or an absolute value less than 1e-5 ?
String	minifyAbsolute(String propertyName)
void	serializeAbsolute(SimpleWriter wri)
void	setAbsolutizedUnit()	Set that the value that this number represents was originally specified as a calculation or as a relative unit, but comes from being either calculated or absolutized.
void	setCssText(String cssText)	Attempts to change this value to match the supplied css text.
void	setExpectInteger()
void	setFloatValue(short unitType, float floatValue)
void	setFloatValuePt(float floatValue)
void	setIntegerValue(int intValue)
void	writeCssText(SimpleWriter wri)	Serialize this value to a SimpleWriter.

Methods inherited from class io.sf.carte.doc.style.css.property.PrimitiveValue

getCounterValue, getPrimitiveType, getRectValue, getRGBColorValue, getStringValue, isSubproperty, setStringValue, setSubproperty

Methods inherited from class io.sf.carte.doc.style.css.property.StyleValue

getCssValueType, isSystemDefault, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.css.CSSValue

getCssValueType

Field Details

realvalue

protected float realvalue

Constructor Details

NumberValue

public NumberValue()

NumberValue

protected NumberValue(NumberValue copied)

Method Details

getCssText

public String getCssText()

Description copied from class: StyleValue

Get a string representation of the current value.

Specified by:

getCssText in interface CSSValue

Specified by:

getCssText in class StyleValue

Returns:

the css text representing the value of this property.

writeCssText

public void writeCssText(SimpleWriter wri)
                  throws IOException

Description copied from interface: ExtendedCSSValue

Serialize this value to a SimpleWriter.

Parameters:

wri - the SimpleWriter.

Throws:

IOException - if an error happened while writing.

serializeAbsolute

public void serializeAbsolute(SimpleWriter wri)
                       throws IOException

Throws:

IOException

getMinifiedCssText

public String getMinifiedCssText(String propertyName)

Description copied from interface: ExtendedCSSValue

Gives a minified version of the css text of the property, for the given property name.

Specified by:

getMinifiedCssText in interface ExtendedCSSValue

Overrides:

getMinifiedCssText in class StyleValue

Parameters:

propertyName - the property name.

Returns:

the minified css text.

minifyAbsolute

public String minifyAbsolute(String propertyName)

setFloatValue

public void setFloatValue(short unitType,
 float floatValue)
                   throws DOMException

Specified by:

setFloatValue in interface CSSPrimitiveValue

Overrides:

setFloatValue in class PrimitiveValue

Throws:

DOMException

setFloatValuePt

public void setFloatValuePt(float floatValue)

setIntegerValue

public void setIntegerValue(int intValue)

setExpectInteger

public void setExpectInteger()

Overrides:

setExpectInteger in class PrimitiveValue

setCssText

public void setCssText(String cssText)
                throws DOMException

Description copied from class: StyleValue

Attempts to change this value to match the supplied css text.

In css4j, it is not recommended to set property values using this method.

Specified by:

setCssText in interface CSSValue

Overrides:

setCssText in class StyleValue

Throws:

DOMException - SYNTAX_ERR: Raised if the specified CSS string value has a syntax error (according to the attached property) or is unparsable.
INVALID_MODIFICATION_ERR: Raised if the specified CSS string value represents a different type of values than the values allowed by the CSS property.
NO_MODIFICATION_ALLOWED_ERR: Raised if this value is read-only.

isCalculatedNumber

public boolean isCalculatedNumber()

Description copied from interface: CSSPrimitiveValue2

Test whether this is a numeric value that was the result of a calc() expression.

Specified by:

isCalculatedNumber in interface CSSPrimitiveValue2

Overrides:

isCalculatedNumber in class PrimitiveValue

Returns:

true if this is a numeric value, and it was produced as the output of a calculation (instead of declared as a plain, constant numeric value).

setAbsolutizedUnit

public void setAbsolutizedUnit()

Set that the value that this number represents was originally specified as a calculation or as a relative unit, but comes from being either calculated or absolutized.

This has consequences as to how the number is serialized.

isNegativeNumber

public boolean isNegativeNumber()

Description copied from interface: CSSPrimitiveValue2

Test whether this is a numeric value that is less than zero.

Specified by:

isNegativeNumber in interface CSSPrimitiveValue2

Overrides:

isNegativeNumber in class PrimitiveValue

Returns:

true if this is a numeric value and its value is negative.

isNumberZero

public boolean isNumberZero()

Description copied from class: PrimitiveValue

Is this value a number set to a value of zero, or an absolute value less than 1e-5 ?

Specified by:

isNumberZero in interface ExtendedCSSPrimitiveValue

Overrides:

isNumberZero in class PrimitiveValue

Returns:

true if this is a number and is set to zero (or equivalently small value).

getFloatValue

public float getFloatValue(short unitType)
                    throws DOMException

Gets a float value in a specified unit. If this CSS value doesn't contain a float value or can't be converted into the specified unit, a DOMException is raised.

Specified by:

getFloatValue in interface CSSPrimitiveValue

Overrides:

getFloatValue in class PrimitiveValue

Parameters:

unitType - A unit code to get the float value. The unit code can only be a float unit type (i.e. CSS_NUMBER, CSS_PERCENTAGE, CSS_EMS, CSS_EXS, CSS_PX, CSS_CM, CSS_MM, CSS_IN, CSS_PT, CSS_PC, CSS_DEG, CSS_RAD, CSS_GRAD, CSS_MS, CSS_S, CSS_HZ, CSS_KHZ, CSS_DIMENSION).

Returns:

The float value in the specified unit.

Throws:

DOMException - INVALID_ACCESS_ERR if the CSS value can't be converted into the specified unit.

floatValueConversion

public static float floatValueConversion(float fvalue,
 short declType,
 short unitType)
                                  throws DOMException

Converts a float value, expressed in declType units, to unitType units.

Parameters:

fvalue - the float value to convert.

declType - the declared type of the value.

unitType - the desired unit type.

Returns:

the value converted to the unitType unit.

Throws:

DOMException - if the unit conversion could not be done.

getDimensionUnitText

public String getDimensionUnitText()

Gives the text representation of the dimension unit, if this value represents a dimension.

Returns:

the text representation of the dimension unit, or the empty string if this value does not represent a dimension.

hashCode

public int hashCode()

Overrides:

hashCode in class PrimitiveValue

equals

public boolean equals(Object obj)

Overrides:

equals in class PrimitiveValue

clone

public NumberValue clone()

Description copied from class: PrimitiveValue

Creates and returns a copy of this object.

The object will be the same except for the subproperty flag, that will be disabled in the clone object.

Specified by:

clone in interface ExtendedCSSValue

Specified by:

clone in class PrimitiveValue

Returns:

a copy of this object.

isLengthUnitType

public static boolean isLengthUnitType(short primitiveType)

isAngleUnitType

public static boolean isAngleUnitType(short primitiveType)

createCSSNumberValue

public static NumberValue createCSSNumberValue(short unit,
 float floatValue)