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
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.eclipse.birt.report.model.core.StructureContextThe context to the member itself.Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle -
Constructor Summary
ConstructorsConstructorDescriptionMemberHandle(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
Modifier and TypeMethodDescriptionvoidAdds an item to the end of a list property.org.eclipse.birt.report.model.core.StructureContextReturns the structure context to the value.getDefn()Gets the generic property definition.Gets the property definition.protected ObjectGets the value stored in the memory directly.booleanChecks whether a value is read-only in the property sheet.booleanChecks whether a value is visible in the property sheet.voidremoveItem(int posn) Removes an item from a list property or member.voidSets 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, setStringValueMethods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReferenceMethods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
Field Details
-
memberContext
protected org.eclipse.birt.report.model.core.StructureContext memberContextThe context to the member itself.
-
-
Constructor Details
-
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 Details
-
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
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
Description 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:
-
removeItem
Description 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
Description 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
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.
-