Module io.sf.carte.echosvg.css

Package io.sf.carte.echosvg.css.engine.value

Class FloatValue

java.lang.Object

io.sf.carte.echosvg.css.engine.value.AbstractValue

io.sf.carte.echosvg.css.engine.value.NumericValue

io.sf.carte.echosvg.css.engine.value.FloatValue

All Implemented Interfaces:

CSSNumberValue, CSSPrimitiveValue, CSSTypedValue, CSSValue, CSSVal, TypedValue, Value, Serializable, Cloneable, CSSNumericValue, CSSStyleValue, CSSUnitValue

public class FloatValue
extends NumericValue
implements CSSNumberValue, CSSUnitValue

This class represents float values.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.w3c.css.om.typed.CSSNumericValue

CSSNumericValue.CSSNumericBaseType, CSSNumericValue.CSSNumericType

Nested classes/interfaces inherited from interface io.sf.carte.doc.style.css.CSSValue

CSSValue.CssType, CSSValue.Type

Constructor Summary

Constructors

Constructor	Description
FloatValue(short unitType, float floatValue)	Creates a new value.

Method Summary

Modifier and Type	Method	Description
FloatValue	clone()	Create and return a copy of this object.
static FloatValue	createConstant(short unit, float value)	Create a constant with the given unit and value.
boolean	equals(Object obj)
String	getCssText()	A string representation of the current value.
static String	getCssText(short unit, float value)	Returns the CSS text associated with the given type/value pair.
float	getFloatValue()	Returns the float value.
CSSValue.Type	getPrimitiveType()	The type of the value.
String	getUnit()	Gets the unit string.
short	getUnitType()	Gets the css unit as in CSS4J's CSSUnit.
double	getValue()	Gets the numeric value in the units represented by this object.
int	hashCode()
boolean	isCalculatedNumber()
boolean	isNegativeNumber()
boolean	isNumberZero()
void	roundToInteger()
void	setCalculatedNumber(boolean calculated)	Sets whether this number is the result of a calculation.
void	setCssText(String cssText)
void	setExpectInteger()
void	setValue(double value)	Set the numeric value in the units represented by this object.
void	setValue(String cssText)
CSSUnitValue	to(String unit)	Converts this value into one in the given unit.

Methods inherited from class io.sf.carte.echosvg.css.engine.value.NumericValue

type

Methods inherited from class io.sf.carte.echosvg.css.engine.value.AbstractValue

createDOMException, getColorValue, getCounterValue, getCssValueType, getIdentifierValue, getLength, getModificationHandler, getRectValue, getStringValue, getURIValue, setFloatValue, setModificationHandler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.css.om.typed.CSSNumericValue

type

Methods inherited from interface io.sf.carte.doc.style.css.CSSPrimitiveValue

isPrimitiveValue

Methods inherited from interface org.w3c.css.om.typed.CSSStyleValue

toString

Methods inherited from interface io.sf.carte.doc.style.css.CSSTypedValue

getStringValue, toRGBColorValue

Methods inherited from interface io.sf.carte.echosvg.css.engine.value.CSSVal

getIdentifierValue, getLength, getStringValue, getURIValue, matches, writeCssText

Methods inherited from interface io.sf.carte.doc.style.css.CSSValue

getCssValueType, getMinifiedCssText, getMinifiedCssText, getPrecedingComments, getTrailingComments

Methods inherited from interface io.sf.carte.echosvg.css.engine.value.TypedValue

getFloatValue, setFloatValue, setStringValue, toRGBColor

Methods inherited from interface io.sf.carte.echosvg.css.engine.value.Value

getColorValue, getCounterValue, getIdentifier, getModificationHandler, getRectValue, isComponent, isIdentifier, item, iterator, setFloatValue, setModificationHandler

Constructor Details

FloatValue

public FloatValue(short unitType,
 float floatValue)

Creates a new value.

Parameters:

unitType - the unit.

floatValue - the value expressed in that unit.

Method Details

getCssText

public static String getCssText(short unit,
 float value)

Returns the CSS text associated with the given type/value pair.

createConstant

public static FloatValue createConstant(short unit,
 float value)

Create a constant with the given unit and value.

If you want to have a modifiable copy of the returned value, clone it.

Parameters:

unit - the unit.

value - the value expressed in that unit.

Returns:

the immutable value.

getPrimitiveType

public CSSValue.Type getPrimitiveType()

The type of the value.

Specified by:

getPrimitiveType in interface CSSValue

getUnitType

public short getUnitType()

Description copied from interface: Value

Gets the css unit as in CSS4J's CSSUnit.

If the value has no valid CSS unit, returns CSSUnit.CSS_INVALID.

Specified by:

getUnitType in interface CSSPrimitiveValue

Specified by:

getUnitType in interface TypedValue

Specified by:

getUnitType in interface Value

Returns:

the css unit as in CSS4J's CSSUnit.

getFloatValue

public float getFloatValue()

Returns the float value.

Specified by:

getFloatValue in interface CSSTypedValue

Specified by:

getFloatValue in interface CSSVal

Specified by:

getFloatValue in interface TypedValue

Overrides:

getFloatValue in class AbstractValue

Returns:

the float value.

getValue

public double getValue()

Description copied from interface: CSSUnitValue

Gets the numeric value in the units represented by this object.

Specified by:

getValue in interface CSSUnitValue

Returns:

the numeric value.

setValue

public void setValue(double value)

Description copied from interface: CSSUnitValue

Set the numeric value in the units represented by this object.

Specified by:

setValue in interface CSSUnitValue

Parameters:

value - the numeric value.

setValue

public void setValue(String cssText)
              throws DOMException

Throws:

DOMException

getUnit

public String getUnit()

Description copied from interface: CSSUnitValue

Gets the unit string.

Specified by:

getUnit in interface CSSUnitValue

Returns:

the unit string.

getCssText

public String getCssText()

A string representation of the current value.

Specified by:

getCssText in interface CSSValue

setCssText

public void setCssText(String cssText)
                throws DOMException

Specified by:

setCssText in interface CSSValue

Overrides:

setCssText in class AbstractValue

Throws:

DOMException

isCalculatedNumber

public boolean isCalculatedNumber()

Specified by:

isCalculatedNumber in interface CSSTypedValue

Specified by:

isCalculatedNumber in interface TypedValue

setCalculatedNumber

public void setCalculatedNumber(boolean calculated)

Sets whether this number is the result of a calculation.

Specified by:

setCalculatedNumber in interface CSSNumberValue

Parameters:

calculated - true if this number was calculated.

setExpectInteger

public void setExpectInteger()
                      throws DOMException

Specified by:

setExpectInteger in interface CSSPrimitiveValue

Specified by:

setExpectInteger in interface TypedValue

Throws:

DOMException

roundToInteger

public void roundToInteger()
                    throws DOMException

Specified by:

roundToInteger in interface CSSNumberValue

Throws:

DOMException

isNegativeNumber

public boolean isNegativeNumber()

Specified by:

isNegativeNumber in interface CSSPrimitiveValue

isNumberZero

public boolean isNumberZero()

Specified by:

isNumberZero in interface CSSTypedValue

Specified by:

isNumberZero in interface TypedValue

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractValue

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractValue

to

public CSSUnitValue to(String unit)

Description copied from interface: CSSNumericValue

Converts this value into one in the given unit.

Specified by:

to in interface CSSNumericValue

Parameters:

unit - the unit.

Returns:

the new converted value,

clone

public FloatValue clone()

Description copied from interface: Value

Create and return a copy of this object.

If this object is unmodifiable, the clone will be modifiable.

Specified by:

clone in interface CSSTypedValue

Specified by:

clone in interface CSSVal

Specified by:

clone in interface CSSValue

Specified by:

clone in interface TypedValue

Specified by:

clone in interface Value

Overrides:

clone in class NumericValue

Returns:

a modifiable copy of this object.