Class MemberHandle
- java.lang.Object
-
- org.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 extends SimpleValueHandle
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.- See Also:
StructureHandle
-
-
Field Summary
Fields Modifier and Type Field Description protected org.eclipse.birt.report.model.core.StructureContextmemberContextThe context to the member itself.-
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
-
-
Constructor Summary
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddItem(java.lang.Object item)Adds an item to the end of a list property.org.eclipse.birt.report.model.core.StructureContextgetContext()Returns the structure context to the value.IPropertyDefngetDefn()Gets the generic property definition.IElementPropertyDefngetPropertyDefn()Gets the property definition.protected java.lang.ObjectgetRawValue()Gets the value stored in the memory directly.booleanisReadOnly()Checks whether a value is read-only in the property sheet.booleanisVisible()Checks whether a value is visible in the property sheet.voidremoveItem(int posn)Removes an item from a list property or member.voidsetValue(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
-
-
-
-
Constructor Detail
-
MemberHandle
public 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. This form is used by theStructureIteratorclass.- Parameters:
structHandle- a handle to the structuremember- definition of the member within the structure
-
-
Method Detail
-
getDefn
public IPropertyDefn getDefn()
Description copied from class:SimpleValueHandleGets the generic property definition. Its a property definition for an element or a member definition for a structure.- Specified by:
getDefnin classSimpleValueHandle- Returns:
- the value definition.
-
getRawValue
protected java.lang.Object getRawValue()
Description copied from class:SimpleValueHandleGets the value stored in the memory directly. The returned value won't be done any conversion.- Specified by:
getRawValuein classSimpleValueHandle- Returns:
- the value stored in the memory
-
setValue
public void setValue(java.lang.Object value) throws SemanticExceptionDescription copied from class:SimpleValueHandleSets the value of a property or member to the object given. If the object isnull, then the value is cleared.- Specified by:
setValuein classSimpleValueHandle- Parameters:
value- The new value.- Throws:
SemanticException- If the value is not valid for the property or member.- See Also:
SimpleValueHandle.setIntValue(int),SimpleValueHandle.setStringValue(java.lang.String),SimpleValueHandle.setFloatValue(double),SimpleValueHandle.setNumberValue(java.math.BigDecimal),SimpleValueHandle.clearValue()
-
removeItem
public void removeItem(int posn) throws PropertyValueExceptionDescription copied from class:SimpleValueHandleRemoves an item from a list property or member. The handle must be working on a list property or member.- Specified by:
removeItemin classSimpleValueHandle- Parameters:
posn- The position of the item to remove.- Throws:
PropertyValueException- If the property is not a list property.
-
addItem
public void addItem(java.lang.Object item) throws SemanticExceptionDescription copied from class:SimpleValueHandleAdds an item to the end of a list property. The handle must be working on a list property.- Specified by:
addItemin classSimpleValueHandle- Parameters:
item- The new item to add.- Throws:
SemanticException- If the property is not a list property, or if the the value of the item is incorrect.
-
getPropertyDefn
public IElementPropertyDefn getPropertyDefn()
Description copied from class:ValueHandleGets the property definition. This is the definition of the property that contains the specific value. If the value is a structure or member, then this is the definition of the property that contains the list that contains the structure that contains the member.- Specified by:
getPropertyDefnin classValueHandle- Returns:
- the property definition
-
getContext
public org.eclipse.birt.report.model.core.StructureContext getContext()
Description copied from class:ValueHandleReturns the structure context to the value. The context is used to identify a list entry or member.- Specified by:
getContextin classValueHandle
-
isReadOnly
public boolean isReadOnly()
Description copied from class:SimpleValueHandleChecks whether a value is read-only in the property sheet.- Specified by:
isReadOnlyin classSimpleValueHandle- Returns:
trueif it is read-only. Otherwisefalse.
-
isVisible
public boolean isVisible()
Description copied from class:SimpleValueHandleChecks whether a value is visible in the property sheet.- Specified by:
isVisiblein classSimpleValueHandle- Returns:
trueif it is visible. Otherwisefalse.
-
-