|
|||||||||||
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.SimpleValueHandle
org.eclipse.birt.report.model.api.PropertyHandle
A handle for working with a top-level property of an element.
PropertyDefn
,
PropertyType
Field Summary | |
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn |
propDefn
Definition of the property. |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
elementHandle |
Constructor Summary | |
PropertyHandle(DesignElementHandle element,
org.eclipse.birt.report.model.metadata.ElementPropertyDefn prop)
Constructs the handle for a top-level property with the given element handle and the definition of the property. |
|
PropertyHandle(DesignElementHandle element,
java.lang.String propName)
Constructs the handle for a top-level property with the given element handle and property name. |
Method Summary | |
boolean |
equals(java.lang.Object propertyHandle)
Returns true if the two property handle has the same element and the same property. |
IPropertyDefn |
getDefn()
Gets the generic property definition. |
IElementPropertyDefn |
getPropertyDefn()
Gets the property definition. |
org.eclipse.birt.report.model.core.MemberRef |
getReference()
Returns a reference to the value. |
java.util.List |
getReferenceableElementList()
returns the element reference value list if the property is element referenceable type. |
java.lang.Object |
getValue()
Gets the value of the property as a generic object. |
boolean |
isLocal()
Determines whether this property value is set locally for this element. |
boolean |
isReadOnly()
Checks whether a value is read-only in the property sheet. |
boolean |
isSet()
Determines whether this property value is set for this element. |
boolean |
isVisible()
Checks whether a value is visible in the property sheet. |
void |
setValue(java.lang.Object value)
Sets the value of a property or member to the object given. |
Methods inherited from class org.eclipse.birt.report.model.api.SimpleValueHandle |
addItem, clearValue, getAt, getChoices, getDefaultUnit, getDisplayValue, getFloatValue, getIntValue, getListValue, getNumberValue, getStringValue, getTypeCode, insertItem, isList, iterator, moveItem, removeItem, removeItem, removeItems, replaceItem, setFloatValue, setIntValue, setNumberValue, setStringValue |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn propDefn
Constructor Detail |
public PropertyHandle(DesignElementHandle element, java.lang.String propName)
element
- a handle to a report elementpropName
- the name of the propertypublic PropertyHandle(DesignElementHandle element, org.eclipse.birt.report.model.metadata.ElementPropertyDefn prop)
element
- a handle to a report elementprop
- the definition of the property.Method Detail |
public IElementPropertyDefn getPropertyDefn()
ValueHandle
getPropertyDefn
in class ValueHandle
public IPropertyDefn getDefn()
SimpleValueHandle
getDefn
in class SimpleValueHandle
public java.lang.Object getValue()
SimpleValueHandle
getValue
in class SimpleValueHandle
SimpleValueHandle.getStringValue( )
,
SimpleValueHandle.getIntValue( )
,
SimpleValueHandle.getFloatValue( )
,
SimpleValueHandle.getNumberValue( )
public void setValue(java.lang.Object value) throws SemanticException
SimpleValueHandle
null
, then the value is cleared.
setValue
in class SimpleValueHandle
value
- The new value.
SemanticException
- If the value is not valid for the property or member.SimpleValueHandle.setIntValue(int)
,
SimpleValueHandle.setStringValue(java.lang.String)
,
SimpleValueHandle.setFloatValue(double)
,
SimpleValueHandle.setNumberValue(java.math.BigDecimal)
,
SimpleValueHandle.clearValue()
public org.eclipse.birt.report.model.core.MemberRef getReference()
ValueHandle
getReference
in class ValueHandle
public boolean isSet()
true
if the value is set, false
if
it is not setpublic boolean isLocal()
true
if the local value is set, otherwise
false
.public boolean equals(java.lang.Object propertyHandle)
propertyHandle
- the property handle
public java.util.List getReferenceableElementList()
public boolean isReadOnly()
SimpleValueHandle
isReadOnly
in class SimpleValueHandle
true
if it is read-only. Otherwise
false
.public boolean isVisible()
SimpleValueHandle
isVisible
in class SimpleValueHandle
true
if it is visible. Otherwise
false
.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |