@DOMObjectAttribute @DOMNameAttribute(name="SVGLength") public class SVGLength extends SVGValueType
The SVGLength interface corresponds to the length basic data type. An SVGLength object can be designated as read only, which means that attempts to modify the object will result in an exception being thrown, as described below.
Modifier and Type | Field and Description |
---|---|
static int |
SVG_LENGTHTYPE_CM
A value was specified using the cm units defined in CSS2.
|
static int |
SVG_LENGTHTYPE_EMS
A value was specified using the em units defined in CSS2.
|
static int |
SVG_LENGTHTYPE_EXS
A value was specified using the ex units defined in CSS2.
|
static int |
SVG_LENGTHTYPE_IN
A value was specified using the in units defined in CSS2.
|
static int |
SVG_LENGTHTYPE_MM
A value was specified using the mm units defined in CSS2.
|
static int |
SVG_LENGTHTYPE_NUMBER
No unit type was provided (i.e., a unitless value was specified), which indicates a value in user units.
|
static int |
SVG_LENGTHTYPE_PC
A value was specified using the pc units defined in CSS2.
|
static int |
SVG_LENGTHTYPE_PERCENTAGE
A percentage value was specified.
|
static int |
SVG_LENGTHTYPE_PT
A value was specified using the pt units defined in CSS2.
|
static int |
SVG_LENGTHTYPE_PX
A value was specified using the px units defined in CSS2.
|
static int |
SVG_LENGTHTYPE_UNKNOWN
The unit type is not one of predefined unit types.
|
flags
PropertyChanged, PropertyChangedDelegate
Constructor and Description |
---|
SVGLength(IBrowsingContext context)
Initializes a new instance of the
SVGLength class. |
SVGLength(IBrowsingContext context,
float value,
int unitType)
Initializes a new instance of the
SVGLength class. |
Modifier and Type | Method and Description |
---|---|
void |
convertToSpecifiedUnits(int unitType)
Preserve the same underlying stored value, but reset the stored unit identifier to the given unitType.
|
java.lang.Object |
deepClone()
Creates a new object that is a copy of the current instance.
|
int |
getUnitType()
The type of the value as specified by one of the SVG_LENGTHTYPE_* constants defined on this interface.
|
float |
getValue()
The value as a floating point value, in user units.
|
java.lang.String |
getValueAsString()
The value as a string value, in the units expressed by unitType.
|
float |
getValueInSpecifiedUnits()
The value as a floating point value, in the units expressed by unitType.
|
void |
newValueSpecifiedUnits(int unitType,
float valueInSpecifiedUnits)
Reset the value as a number with an associated unitType, thereby replacing the values for all of the attributes on the object.
|
void |
setValue(float value)
The value as a floating point value, in user units.
|
void |
setValueAsString(java.lang.String value)
The value as a string value, in the units expressed by unitType.
|
void |
setValueInSpecifiedUnits(float value)
The value as a floating point value, in the units expressed by unitType.
|
asReadOnly, dispose, dispose, getKey, isDetached, isObserverSuppressed, isReadOnly, notifyPropertyChanged, setDetached, setObserverSuppressed, toString
fireNotifyPropertyChanged, getCurrentValues, getRuntimesBinding, setCurrentValues, setField, setRuntimesBinding
@DOMNameAttribute(name="SVG_LENGTHTYPE_UNKNOWN") public static final int SVG_LENGTHTYPE_UNKNOWN
The unit type is not one of predefined unit types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.
@DOMNameAttribute(name="SVG_LENGTHTYPE_NUMBER") public static final int SVG_LENGTHTYPE_NUMBER
No unit type was provided (i.e., a unitless value was specified), which indicates a value in user units.
@DOMNameAttribute(name="SVG_LENGTHTYPE_PERCENTAGE") public static final int SVG_LENGTHTYPE_PERCENTAGE
A percentage value was specified.
@DOMNameAttribute(name="SVG_LENGTHTYPE_EMS") public static final int SVG_LENGTHTYPE_EMS
A value was specified using the em units defined in CSS2.
@DOMNameAttribute(name="SVG_LENGTHTYPE_EXS") public static final int SVG_LENGTHTYPE_EXS
A value was specified using the ex units defined in CSS2.
@DOMNameAttribute(name="SVG_LENGTHTYPE_PX") public static final int SVG_LENGTHTYPE_PX
A value was specified using the px units defined in CSS2.
@DOMNameAttribute(name="SVG_LENGTHTYPE_CM") public static final int SVG_LENGTHTYPE_CM
A value was specified using the cm units defined in CSS2.
@DOMNameAttribute(name="SVG_LENGTHTYPE_MM") public static final int SVG_LENGTHTYPE_MM
A value was specified using the mm units defined in CSS2.
@DOMNameAttribute(name="SVG_LENGTHTYPE_IN") public static final int SVG_LENGTHTYPE_IN
A value was specified using the in units defined in CSS2.
@DOMNameAttribute(name="SVG_LENGTHTYPE_PT") public static final int SVG_LENGTHTYPE_PT
A value was specified using the pt units defined in CSS2.
@DOMNameAttribute(name="SVG_LENGTHTYPE_PC") public static final int SVG_LENGTHTYPE_PC
A value was specified using the pc units defined in CSS2.
public SVGLength(IBrowsingContext context)
Initializes a new instance of the SVGLength
class.
context
- The context.public SVGLength(IBrowsingContext context, float value, int unitType)
Initializes a new instance of the SVGLength
class.
context
- The context.value
- The value.unitType
- Type of the unit.@DOMNameAttribute(name="unitType") public int getUnitType()
The type of the value as specified by one of the SVG_LENGTHTYPE_* constants defined on this interface.
Value: The type of the unit.@DOMNameAttribute(name="value") public float getValue()
The value as a floating point value, in user units. Setting this attribute will cause valueInSpecifiedUnits and valueAsString to be updated automatically to reflect this setting.
DOMException
- Code DOMException.NO_MODIFICATION_ALLOWED_ERR
Raised when the length corresponds to a read only attribute or when the object itself is read only.
Value:
The value.@DOMNameAttribute(name="value") public void setValue(float value)
The value as a floating point value, in user units. Setting this attribute will cause valueInSpecifiedUnits and valueAsString to be updated automatically to reflect this setting.
DOMException
- Code DOMException.NO_MODIFICATION_ALLOWED_ERR
Raised when the length corresponds to a read only attribute or when the object itself is read only.
Value:
The value.@DOMNameAttribute(name="valueInSpecifiedUnits") public float getValueInSpecifiedUnits()
The value as a floating point value, in the units expressed by unitType. Setting this attribute will cause value and valueAsString to be updated automatically to reflect this setting.
DOMException
- Code DOMException.NO_MODIFICATION_ALLOWED_ERR
Raised when the length corresponds to a read only attribute or when the object itself is read only.
Value:
The value in specified units.@DOMNameAttribute(name="valueInSpecifiedUnits") public void setValueInSpecifiedUnits(float value)
The value as a floating point value, in the units expressed by unitType. Setting this attribute will cause value and valueAsString to be updated automatically to reflect this setting.
DOMException
- Code DOMException.NO_MODIFICATION_ALLOWED_ERR
Raised when the length corresponds to a read only attribute or when the object itself is read only.
Value:
The value in specified units.@DOMNameAttribute(name="valueAsString") public java.lang.String getValueAsString()
The value as a string value, in the units expressed by unitType. Setting this attribute will cause value, valueInSpecifiedUnits and unitType to be updated automatically to reflect this setting.
DOMException
- Code DOMException.SYNTAX_ERR
Raised if the assigned string cannot be parsed as a valid length.DOMException
- Code DOMException.NO_MODIFICATION_ALLOWED_ERR
Raised when the length corresponds to a read only attribute or when the object itself is read only.
Value:
The value as string.@DOMNameAttribute(name="valueAsString") public void setValueAsString(java.lang.String value)
The value as a string value, in the units expressed by unitType. Setting this attribute will cause value, valueInSpecifiedUnits and unitType to be updated automatically to reflect this setting.
DOMException
- Code DOMException.SYNTAX_ERR
Raised if the assigned string cannot be parsed as a valid length.DOMException
- Code DOMException.NO_MODIFICATION_ALLOWED_ERR
Raised when the length corresponds to a read only attribute or when the object itself is read only.
Value:
The value as string.@DOMNameAttribute(name="newValueSpecifiedUnits") public void newValueSpecifiedUnits(int unitType, float valueInSpecifiedUnits)
Reset the value as a number with an associated unitType, thereby replacing the values for all of the attributes on the object.
unitType
- The unit type for the value.valueInSpecifiedUnits
- The new value..DOMException
- Code DOMException.NOT_SUPPORTED_ERR
Raised if unitType is SVG_LENGTHTYPE_UNKNOWN or not a valid unit type constant (one of the other SVG_LENGTHTYPE_* constants defined on this interface).DOMException
- Code DOMException.NO_MODIFICATION_ALLOWED_ERR
Raised when the length corresponds to a read only attribute or when the object itself is read only.@DOMNameAttribute(name="convertToSpecifiedUnits") public void convertToSpecifiedUnits(int unitType)
Preserve the same underlying stored value, but reset the stored unit identifier to the given unitType. Object attributes unitType, valueInSpecifiedUnits and valueAsString might be modified as a result of this method. For example, if the original value were "0.5cm" and the method was invoked to convert to millimeters, then the unitType would be changed to SVG_LENGTHTYPE_MM, valueInSpecifiedUnits would be changed to the numeric value 5 and valueAsString would be changed to "5mm".
unitType
- The unit type to switch to (e.g., SVG_LENGTHTYPE_MM).DOMException
- Code DOMException.NOT_SUPPORTED_ERR
Raised if unitType is SVG_LENGTHTYPE_UNKNOWN or not a valid unit type constant (one of the other SVG_LENGTHTYPE_* constants defined on this interface).DOMException
- Code DOMException.NO_MODIFICATION_ALLOWED_ERR
Raised when the length corresponds to a read only attribute or when the object itself is read only.public java.lang.Object deepClone()
Creates a new object that is a copy of the current instance.
deepClone
in class SVGValueType