public abstract class AbstractScalarParameterHandleImpl extends ParameterHandle implements org.eclipse.birt.report.model.elements.interfaces.IAbstractScalarParameterModel
AbstractScalarParameter
element
module
CONTROL_TYPE_PROP, DATA_TYPE_PROP, DATASET_NAME_PROP, DEFAULT_VALUE_PROP, DISTINCT_PROP, IS_REQUIRED_PROP, LABEL_EXPR_PROP, LIST_LIMIT_PROP, SELECTION_LIST_PROP, SORT_BY_COLUMN_PROP, SORT_BY_PROP, SORT_DIRECTION_PROP, VALUE_EXPR_PROP, VALUE_TYPE_PROP
HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, HIDDEN_PROP, PROMPT_TEXT_ID_PROP, PROMPT_TEXT_PROP, VALIDATE_PROP
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 and Description |
---|
AbstractScalarParameterHandleImpl(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator |
choiceIterator()
Returns the iterator for the static selection list defined on this scalar
parameter.
|
boolean |
distinct()
Checks whether duplicate values should be shown when preview.
|
DataSetHandle |
getDataSet()
Returns the handle for the data set defined on the parameter.
|
java.lang.String |
getDataSetName()
Returns the data set name of the dynamic list for this parameter.
|
java.lang.String |
getDataType()
Returns the data type for this parameter.
|
java.util.List |
getDefaultValueList()
Returns the default value list of the parameter.
|
java.lang.String |
getLabelExpr()
Returns an expression on the data row from the dynamic list data set that
returns the prompt for the choice.
|
int |
getListlimit()
get the list limited number.
|
java.lang.String |
getSortBy()
Gets the sort key for parameter values when preview.
|
java.lang.String |
getSortByColumn()
Gets the expression by which the result sorts.
|
java.lang.String |
getSortDirection()
Gets the sort order for parameter values when preview.
|
java.lang.String |
getValueExpr()
Returns an expression on the data row from the dynamic list data set that
returns the value for the choice.
|
java.lang.String |
getValueType()
Returns the parameter type for this scalar parameter.
|
boolean |
isRequired()
Tests whether the string value of the parameter is required.
|
void |
setDataSet(DataSetHandle handle)
Sets the data set of the report item.
|
void |
setDataSetName(java.lang.String dataSetName)
Sets the data set name of the dynamic list for this parameter.
|
void |
setDataType(java.lang.String type)
Sets the data type for this parameter.
|
void |
setDefaultValueList(java.util.List<? extends java.lang.Object> defaultValueList)
Sets the default value list of the parameter.
|
void |
setDistinct(boolean distinct)
Sets the flag that indicates whether duplicate values should be shown
when preview.
|
void |
setIsRequired(boolean isRequired)
Sets the flag that indicates whether the value of the parameter is
required.
|
void |
setLabelExpr(java.lang.String labelExpr)
Sets an expression on the data row from the dynamic list data set that
returns the prompt for the choice.
|
void |
setListlimit(int listLimit)
Set the value for the list limitation number.
|
void |
setSortBy(java.lang.String sortValue)
Sets the sort key for parameter values when preview.
|
void |
setSortByColumn(java.lang.String sortByColumn)
Sets the expression by which the result sorts.
|
void |
setSortDirection(java.lang.String direction)
Sets the sort order for parameter values when preview.
|
void |
setValueExpr(java.lang.String valueExpr)
Sets an expression on the data row from the dynamic list data set that
returns the value for the choice.
|
void |
setValueType(java.lang.String type)
Sets the parameter value type for this scalar parameter.
|
getDisplayPromptText, getHelpText, getHelpTextKey, getPromptText, getPromptTextID, getValidate, isHidden, setHelpText, setHelpTextKey, setHidden, setPromptText, setPromptTextID, setValidate
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask
add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIterator
public AbstractScalarParameterHandleImpl(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementpublic void setIsRequired(boolean isRequired) throws SemanticException
null
or empty. For other type parameters, required value
cannot be null
.isRequired
- true
if the value is required. Otherwise
false
.SemanticException
- if the property is locked.public boolean isRequired()
null
or empty. For other type parameters, required value cannot be
null
.true
if the value is required. Otherwise
false
.public void setSortByColumn(java.lang.String sortByColumn) throws SemanticException
sortByColumn
- expression by which the result sortsSemanticException
public java.lang.String getSortByColumn()
public void setSortDirection(java.lang.String direction) throws SemanticException
null
direction
- SemanticException
- if the property is locked.public java.lang.String getSortDirection()
null
public void setSortBy(java.lang.String sortValue) throws SemanticException
sortValue
- SemanticException
- if the property is locked.public java.lang.String getSortBy()
public java.lang.String getValueType()
DesignChoiceConstants
can be one of the followings:
PARAM_VALUE_TYPE_STATIC
PARAM_VALUE_TYPE_DYNAMIC
setValueType(String)
,
DesignChoiceConstants
public void setValueType(java.lang.String type) throws SemanticException
DesignChoiceConstants
can be one of the
followings:
PARAM_TYPE_STATIC
PARAM_TYPE_DYNAMIC
type
- the type for the scalar parameterSemanticException
- if the input type is not one of above choices.getValueType()
,
DesignChoiceConstants
public void setListlimit(int listLimit) throws SemanticException
listLimit
- The limited number.SemanticException
public int getListlimit()
public java.lang.String getValueExpr()
public void setValueExpr(java.lang.String valueExpr) throws SemanticException
valueExpr
- the expression that returns the parameter value for each row
in the dynamic list.SemanticException
- if the property is locked.public java.lang.String getLabelExpr()
public void setLabelExpr(java.lang.String labelExpr) throws SemanticException
labelExpr
- an expression that returns the display value for each row in
the dynamic list.SemanticException
- if the property is locked.public void setDataSetName(java.lang.String dataSetName) throws SemanticException
dataSetName
- the data set name of the dynamic listSemanticException
- if the property is locked.public void setDataSet(DataSetHandle handle) throws SemanticException
handle
- the handle of the data set, if handle
is null,
data set property will be cleared.SemanticException
- if the property is locked.public java.util.Iterator choiceIterator()
SelectionChoiceHandle
.SelectionChoice
public java.lang.String getDataSetName()
public DataSetHandle getDataSet()
null
.public void setDefaultValueList(java.util.List<? extends java.lang.Object> defaultValueList) throws SemanticException
defaultValueList
- the default value for the parameterSemanticException
- if the property is locked.public java.util.List getDefaultValueList()
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 parameterSemanticException
- if the input type is not one of above choices.getDataType()
,
DesignChoiceConstants
public void setDistinct(boolean distinct) throws SemanticException
distinct
- true
if duplicate values only show once.
Otherwise false
.SemanticException
- if the property is locked.public boolean distinct()
true
if duplicate values only show once. Otherwise
false
.Copyright © 2008 Actuate Corp. All rights reserved.