|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.FactoryPropertyHandle
public class FactoryPropertyHandle
A specialized handle for use when creating the Factory data structures. This handle caches the element definition and property value. It uses specialized property resolution rules:
The various "get" methods also have special meanings: they convert property values to the format needed by the Factory.
Field Summary | |
---|---|
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn |
propDefn
Handle to the design element. |
protected java.lang.Object |
value
The cached property value. |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
FactoryPropertyHandle(DesignElementHandle element,
org.eclipse.birt.report.model.metadata.ElementPropertyDefn prop)
Constructs a factory property handle with the given DesignElementHandle and the definition of the property. |
Method Summary | |
---|---|
boolean |
getBooleanValue()
Returns the value as a Boolean. |
java.lang.String |
getColorValue()
Gets the CSS color value. |
double |
getFloatValue()
Returns the value as a double. |
int |
getIntValue()
Returns the property value as an integer. |
java.math.BigDecimal |
getNumberValue()
Returns the value as a number (BigDecimal). |
java.lang.String |
getStringValue()
Returns the value as a non-localized string. |
java.lang.Object |
getValue()
Returns the cached factory property value. |
boolean |
isSet()
Tests whether this property value is set for this element. |
boolean |
isStyleProperty()
Tests whether this is a style property. |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn propDefn
protected java.lang.Object value
Constructor Detail |
---|
public FactoryPropertyHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn prop)
DesignElementHandle
and the definition of the property.
element
- handle to the design element. It provides the Factory context.prop
- the definition of the propertyMethod Detail |
---|
public java.lang.Object getValue()
DesignElement.getFactoryProperty(Module,
ElementPropertyDefn)
public boolean isStyleProperty()
true
if this is a style property, otherwise
false
.public boolean isSet()
true
if the value is set, false
if
it is not setpublic int getIntValue()
public java.lang.String getStringValue()
public double getFloatValue()
public java.math.BigDecimal getNumberValue()
null
if the value
cannot be converted to a number.public boolean getBooleanValue()
Note: This method returns false if the value is unset. It DOES NOT return
the default value for the property. Call isSet
before
calling this method to determine if the property is set.
false
if the value
cannot be converted to a boolean, or if the value is not set.public java.lang.String getColorValue()
null
if the property is not set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |