Interface IScalarParameterDefn
- All Superinterfaces:
IParameterDefn
,IParameterDefnBase
Defines a scalar parameter
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from interface org.eclipse.birt.report.engine.api.IParameterDefn
SELECTION_LIST_DYNAMIC, SELECTION_LIST_NONE, SELECTION_LIST_STATIC, TYPE_ANY, TYPE_BOOLEAN, TYPE_DATE, TYPE_DATE_TIME, TYPE_DECIMAL, TYPE_FLOAT, TYPE_INTEGER, TYPE_STRING, TYPE_TIME
Fields inherited from interface org.eclipse.birt.report.engine.api.IParameterDefnBase
CASCADING_PARAMETER_GROUP, FILTER_PARAMETER, LIST_PARAMETER, PARAMETER_GROUP, SCALAR_PARAMETER, TABLE_PARAMETER
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.boolean
returns whether the user can enter a value different from values in a selection list Applies only to parameters with a selection list.boolean
Deprecated.boolean
returns whether the UI should display the seleciton list in a fixed order.int
int
int
boolean
void
setScalarParameterType
(String type) Set parameter type.Methods inherited from interface org.eclipse.birt.report.engine.api.IParameterDefn
getDataType, getSelectionList, getSelectionListType, isHidden, isRequired
Methods inherited from interface org.eclipse.birt.report.engine.api.IParameterDefnBase
getDisplayName, getHandle, getHelpText, getName, getParameterType, getPromptText, getTypeName, getUserPropertyValue, getUserPropertyValues
-
Field Details
-
TEXT_BOX
static final int TEXT_BOX- See Also:
-
LIST_BOX
static final int LIST_BOX- See Also:
-
RADIO_BUTTON
static final int RADIO_BUTTON- See Also:
-
CHECK_BOX
static final int CHECK_BOX- See Also:
-
AUTO_SUGGEST
static final int AUTO_SUGGEST- See Also:
-
AUTO
static final int AUTO- See Also:
-
LEFT
static final int LEFT- See Also:
-
CENTER
static final int CENTER- See Also:
-
RIGHT
static final int RIGHT- See Also:
-
-
Method Details
-
allowNewValues
boolean allowNewValues()returns whether the user can enter a value different from values in a selection list Applies only to parameters with a selection list. Usually, a parameter with allowNewValue=true is displayed as a combo-box, while a parameter with allowNewValue=false is displayed as a list. This is only a UI gesture. Engine does not validate whether the value passed in is in the list.- Returns:
- whether the user can enter a value different from all values in the list. Applies only when the parameter has a selection list. Default is true.
-
displayInFixedOrder
boolean displayInFixedOrder()returns whether the UI should display the seleciton list in a fixed order. Only applies to parameters with a selection list.- Returns:
- whether the UI should display the selection list in fixed order as the values appear in the list. Default is true.
-
isValueConcealed
boolean isValueConcealed()- Returns:
- whether the input value needs to be concealed (i.e., password, bank account number, etc.)
-
allowNull
Deprecated.- Returns:
- whether the parameter allow null value. If it does not, the end user has to supply a value for the parameter before the report can be run
-
allowBlank
Deprecated.- Returns:
- whether the parameter allow empty string as input. If not, the end user has to supply a string value that is non-empty
-
getDisplayFormat
String getDisplayFormat()- Returns:
- the formatting instructions for the parameter value within the parameter UI
-
getControlType
int getControlType()- Returns:
- the control type used in the parameter UI. Supports TEXT_BOX (default), LIST_BOX, RADIO_BUTTON and CHECK_BOX.
-
getAlignment
int getAlignment()- Returns:
- how the items should appear in the UI. Choices are AUTO (default), LEFT, CENTER and RIGHT
-
getDefaultValue
String getDefaultValue()- Returns:
- the default value
-
getScalarParameterType
String getScalarParameterType()- Returns:
- the scalar parameter type, like "simple", "multi-value" or "ad-hoc"
-
setScalarParameterType
Set parameter type.- Parameters:
type
- scalar parameter type
-
getAutoSuggestThreshold
int getAutoSuggestThreshold()- Returns:
- the number of values that a picklist could have
-