|
||||||||||
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.MemberHandle
public class MemberHandle
A handle to a member of a property structure. A structure list occurs in an element property that contains a list of structures. The class handles a member of one structure in the list.
StructureHandle
Field Summary | |
---|---|
protected org.eclipse.birt.report.model.core.StructureContext |
memberContext
The context to the member itself. |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
MemberHandle(StructureHandle structHandle,
org.eclipse.birt.report.model.metadata.StructPropertyDefn member)
Constructs a member handle with the given structure handle and the member property definition. |
Method Summary | |
---|---|
void |
addItem(java.lang.Object item)
Adds an item to the end of a list property. |
org.eclipse.birt.report.model.core.StructureContext |
getContext()
Returns the structure context to the value. |
IPropertyDefn |
getDefn()
Gets the generic property definition. |
IElementPropertyDefn |
getPropertyDefn()
Gets the property definition. |
protected java.lang.Object |
getRawValue()
Gets the value stored in the memory directly. |
boolean |
isReadOnly()
Checks whether a value is read-only in the property sheet. |
boolean |
isVisible()
Checks whether a value is visible in the property sheet. |
void |
removeItem(int posn)
Removes an item from a list property or member. |
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, get, getAt, getChoices, getDefaultUnit, getDisplayValue, getFloatValue, getIntValue, getItems, getListValue, getNumberValue, getStringValue, getTypeCode, getValue, indexOf, insertItem, isList, iterator, moveItem, removeItem, removeItems, replaceItem, setFloatValue, setIntValue, setNumberValue, setStringValue |
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle |
---|
getReference |
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.core.StructureContext memberContext
Constructor Detail |
---|
public MemberHandle(StructureHandle structHandle, org.eclipse.birt.report.model.metadata.StructPropertyDefn member)
StructureIterator
class.
structHandle
- a handle to the structuremember
- definition of the member within the structureMethod Detail |
---|
public IPropertyDefn getDefn()
SimpleValueHandle
getDefn
in class SimpleValueHandle
protected java.lang.Object getRawValue()
SimpleValueHandle
getRawValue
in class SimpleValueHandle
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 void removeItem(int posn) throws PropertyValueException
SimpleValueHandle
removeItem
in class SimpleValueHandle
posn
- The position of the item to remove.
PropertyValueException
- If the property is not a list property.public void addItem(java.lang.Object item) throws SemanticException
SimpleValueHandle
addItem
in class SimpleValueHandle
item
- The new item to add.
SemanticException
- If the property is not a list property, or if the the value
of the item is incorrect.public IElementPropertyDefn getPropertyDefn()
ValueHandle
getPropertyDefn
in class ValueHandle
public org.eclipse.birt.report.model.core.StructureContext getContext()
ValueHandle
getContext
in class ValueHandle
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 |