|
||||||||||
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.ValueHandle
org.eclipse.birt.report.model.api.ComplexValueHandle
public abstract class ComplexValueHandle
Abstract class for working with properties that have internal structure, such as a color, a dimension or a font.
Field Summary | |
---|---|
protected org.eclipse.birt.report.model.core.MemberRef |
memberRef
Path to the property within an element, a list or a structure. |
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn |
propDefn
Property definition. |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
ComplexValueHandle(DesignElementHandle element,
org.eclipse.birt.report.model.metadata.ElementPropertyDefn thePropDefn)
Constructs a handle given an element handle and definition of a property. |
|
ComplexValueHandle(DesignElementHandle element,
org.eclipse.birt.report.model.core.MemberRef theMemberRef)
Constructs a handle given an element handle and member reference. |
Method Summary | |
---|---|
protected IPropertyDefn |
getDefn()
Returns a definition for the handle. |
java.lang.String |
getDisplayValue()
Returns the value of the property or member in a localized format. |
IElementPropertyDefn |
getPropertyDefn()
Gets the property definition. |
org.eclipse.birt.report.model.core.MemberRef |
getReference()
Returns a reference to the value. |
java.lang.String |
getStringValue()
Gets the property value converted to a string value. |
java.lang.Object |
getValue()
Gets the value of the property as a generic object. |
boolean |
isSet()
Tests whether this property value is set for this element or the structure. |
void |
setStringValue(java.lang.String value)
Sets the value of a property or member to a string. |
void |
setValue(java.lang.Object value)
Sets the value of a property to the given value. |
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 org.eclipse.birt.report.model.core.MemberRef memberRef
Constructor Detail |
---|
public ComplexValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn thePropDefn)
element
- handle to the report element that contains the element
property.thePropDefn
- element property definition.public ComplexValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef theMemberRef)
element
- handle to the report element that has the property that
contains the structure that contains the member.theMemberRef
- The reference to the member.Method Detail |
---|
public void setValue(java.lang.Object value) throws SemanticException
value
- The new value.
SemanticException
- If the value is not valid for the property or member.public java.lang.Object getValue()
public void setStringValue(java.lang.String value) throws SemanticException
value
- the value to set
SemanticException
- if the string value is not valid for the property or member.public java.lang.String getStringValue()
public java.lang.String getDisplayValue()
public IElementPropertyDefn getPropertyDefn()
ValueHandle
getPropertyDefn
in class ValueHandle
public org.eclipse.birt.report.model.core.MemberRef getReference()
ValueHandle
getReference
in class ValueHandle
protected IPropertyDefn getDefn()
public boolean isSet()
null
,
otherwise it is considered unset.
true
if the value is set, false
if
it is not set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |