|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ContentElementHandle
org.eclipse.birt.report.model.api.VariableElementHandle
public class VariableElementHandle
Represents a variable.
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ContentElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IVariableElementModel |
---|
DATA_TYPE_PROP, TYPE_PROP, VALUE_PROP, VARIABLE_NAME_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
---|
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
VariableElementHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a variable handle with the given design and the element. |
Method Summary | |
---|---|
java.lang.String |
getDataType()
Returns the data type for this variable element. |
java.lang.String |
getName()
Returns the name of this element. |
java.lang.String |
getType()
Gets the value of work mode property.The return value is defined in DesignChoiceConstants and can be one of:
VARIABLE_TYPE_REPORT
VARIABLE_TYPE_PAGE
|
java.lang.String |
getValue()
Returns the value of the variable. |
java.lang.String |
getVariableName()
Returns the name of the variable. |
void |
setDataType(java.lang.String type)
Sets the data type for this variable element. |
void |
setName(java.lang.String name)
Sets the name of this element. |
void |
setType(java.lang.String workMode)
Sets the value of work mode property. |
void |
setValue(java.lang.String value)
Sets the value of the variable. |
void |
setVariableName(java.lang.String name)
Sets the name of the variable. |
Methods inherited from class org.eclipse.birt.report.model.api.ContentElementHandle |
---|
addListener, addUserPropertyDefn, canTransformToTemplate, clientsIterator, createTemplateElement, derivedIterator, getElement, getEventHandlerClass, getExtends, getPrivateStyle, getQualifiedName, getUserProperties, getUserPropertyDefnHandle, isTemplateParameterValue, localize, removeListener, revertToReportItem, revertToTemplate, setEventHandlerClass, setExtends, setExtendsName, setStyle, setStyleName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VariableElementHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public java.lang.String getVariableName()
public void setVariableName(java.lang.String name) throws SemanticException
name
- the name to set
SemanticException
getVariableName()
public java.lang.String getValue()
public void setValue(java.lang.String value) throws SemanticException
value
- the value to set
SemanticException
public java.lang.String getType()
DesignChoiceConstants
and can be one of:
VARIABLE_TYPE_REPORT
VARIABLE_TYPE_PAGE
public void setType(java.lang.String workMode) throws SemanticException
DesignChoiceConstants
and can be one of:
VARIABLE_TYPE_REPORT
VARIABLE_TYPE_PAGE
workMode
- the work mode property value.
SemanticException
public java.lang.String getName()
DesignElementHandle
null
if the
element does not have a name. Many elements do not require a name. The
name does not inherit. If this element does not have a name, it will not
inherit the name of its parent element.
getName
in class ContentElementHandle
public void setName(java.lang.String name) throws NameException
DesignElementHandle
null
, then the
name is cleared if this element does not require a name.
setName
in class ContentElementHandle
name
- the new name
NameException
- if the name is duplicate, or if the name is null
and this element requires a name.public java.lang.String getDataType()
DesignChoiceConstants
can be one of the followings:
PARAM_TYPE_STRING
PARAM_TYPE_FLOAT
PARAM_TYPE_DECIMAL
PARAM_TYPE_INTEGER
PARAM_TYPE_DATETIME
PARAM_TYPE_DATE
PARAM_TYPE_TIME
PARAM_TYPE_BOOLEAN
setDataType(String)
,
DesignChoiceConstants
public void setDataType(java.lang.String type) throws SemanticException
DesignChoiceConstants
can be one of the followings:
PARAM_TYPE_STRING
PARAM_TYPE_FLOAT
PARAM_TYPE_DECIMAL
PARAM_TYPE_INTEGER
PARAM_TYPE_DATETIME
PARAM_TYPE_DATE
PARAM_TYPE_TIME
PARAM_TYPE_BOOLEAN
type
- the type for the variable element
SemanticException
- if the input type is not one of above choices.getDataType()
,
DesignChoiceConstants
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |