|
||||||||||
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.StructureHandle
public class StructureHandle
Handle to a structure within a list property. List properties contain objects called structures. Structures have members that hold data values.
MemberHandle
Field Summary | |
---|---|
protected org.eclipse.birt.report.model.core.StructureContext |
structContext
Reference to the structure. |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
StructureHandle(DesignElementHandle element,
org.eclipse.birt.report.model.core.MemberRef ref)
Deprecated. |
|
StructureHandle(DesignElementHandle element,
org.eclipse.birt.report.model.core.StructureContext context)
Constructs a handle for a structure within a list property of a given element. |
|
StructureHandle(SimpleValueHandle valueHandle,
int index)
Constructs a handle for a structure within a list property or a structure member. |
Method Summary | |
---|---|
void |
drop()
Removes this structure from a list property or member. |
org.eclipse.birt.report.model.core.StructureContext |
getContext()
Returns the structure context to the value. |
IStructureDefn |
getDefn()
Returns the definition of the structure. |
ExpressionHandle |
getExpressionProperty(java.lang.String memberName)
Gets the value of the member as an expression. |
java.lang.String |
getExternalizedValue(java.lang.String textIDProp,
java.lang.String textProp)
Returns externalized message. |
java.lang.String |
getExternalizedValue(java.lang.String textIDProp,
java.lang.String textProp,
com.ibm.icu.util.ULocale locale)
Returns the externalized message. |
protected int |
getIntProperty(java.lang.String memberName)
Get the integer value of a member. |
MemberHandle |
getMember(java.lang.String memberName)
Returns a handle to a structure member. |
java.lang.Object |
getProperty(java.lang.String memberName)
Gets the value of a member. |
IElementPropertyDefn |
getPropertyDefn()
Gets the property definition. |
protected java.lang.String |
getStringProperty(java.lang.String memberName)
Get the string value of a member. |
IStructure |
getStructure()
Returns the structure. |
boolean |
isDesignTime()
Justifies whether this structure handle is generated in design time. |
java.util.Iterator |
iterator()
Returns an iterator over the members of this structure. |
void |
setDesignTime(boolean isDesignTime)
|
void |
setExpressionProperty(java.lang.String memberName,
Expression value)
Sets the value of the member as an expression. |
void |
setProperty(java.lang.String memberName,
java.lang.Object value)
Sets the value of the member. |
protected void |
setPropertySilently(java.lang.String memberName,
java.lang.Object value)
Set the value of a member without throwing exceptions. |
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 structContext
Constructor Detail |
---|
public StructureHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.StructureContext context)
element
- handle to the report element.context
- context of the structurepublic StructureHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)
element
- handle to the report element.ref
- reference to the structurepublic StructureHandle(SimpleValueHandle valueHandle, int index)
valueHandle
- handle to a list property or memberindex
- index of the structure within the listMethod Detail |
---|
public IElementPropertyDefn getPropertyDefn()
ValueHandle
getPropertyDefn
in class ValueHandle
public IStructure getStructure()
MemberHandle
class for all
modifications.
public java.lang.Object getProperty(java.lang.String memberName)
memberName
- name of the member to get
null
if the member is
not set or is not found.protected java.lang.String getStringProperty(java.lang.String memberName)
memberName
- name of the member to get
null
if the member is
not set or is not found.protected int getIntProperty(java.lang.String memberName)
memberName
- name of the member to get
0
if the member is
not set or is not defined.public void setProperty(java.lang.String memberName, java.lang.Object value) throws SemanticException
memberName
- name of the member to set.value
- the value to set
SemanticException
- if the member name is not defined on the structure or the
value is not valid for the member.protected final void setPropertySilently(java.lang.String memberName, java.lang.Object value)
Note that this method will internal swallow exceptions thrown when performing the set operation. The exception will be deemed as internal error. So calling this method when you are sure that exception is a programming error.
memberName
- name of the member to set.value
- value to set.public IStructureDefn getDefn()
public MemberHandle getMember(java.lang.String memberName)
memberName
- the name of the member
null
if the member is not
defined on the structure.public java.util.Iterator iterator()
MemberIterator
.
MemberIterator
public org.eclipse.birt.report.model.core.StructureContext getContext()
ValueHandle
getContext
in class ValueHandle
public void drop() throws PropertyValueException
PropertyValueException
- if the structure is not contained in the list.public java.lang.String getExternalizedValue(java.lang.String textIDProp, java.lang.String textProp)
textIDProp
- name of the property that defines the message keytextProp
- name of the property that defines the default non-externalized
value if the key is not found in message file
textProp
public java.lang.String getExternalizedValue(java.lang.String textIDProp, java.lang.String textProp, com.ibm.icu.util.ULocale locale)
textIDProp
- name of the property that defines the message keytextProp
- name of the property that defines the default non-externalized
value if the key is not found in message filelocale
- the user-defined locale
textProp
public boolean isDesignTime()
public void setDesignTime(boolean isDesignTime) throws SemanticException
isDesignTime
-
SemanticException
public void setExpressionProperty(java.lang.String memberName, Expression value) throws SemanticException
memberName
- name of the member to set.value
- the expression to set
SemanticException
- if the member name is not defined on the structure or the
value is not valid for the member.public ExpressionHandle getExpressionProperty(java.lang.String memberName)
memberName
- name of the member to set.
SemanticException
- if the member name is not defined on the structure or the
value is not valid for the member.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |