|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IParameterDefnBase
Captures properties shared by all types of parameters and parameter group, i.e., name, display name, help text and custom-defined properties. Note that even though display name and help text are locale-sensitive, the API does not take a locale. The parameter returned to the user was obtained from a report runnable, which has already had a locale.
Field Summary | |
---|---|
static int |
CASCADING_PARAMETER_GROUP
|
static int |
FILTER_PARAMETER
|
static int |
LIST_PARAMETER
|
static int |
PARAMETER_GROUP
|
static int |
SCALAR_PARAMETER
|
static int |
TABLE_PARAMETER
|
Method Summary | |
---|---|
java.lang.String |
getDisplayName()
returns the locale-specific display name for the parameter. |
org.eclipse.birt.report.model.api.ReportElementHandle |
getHandle()
returns the report element handle which is wrapped by this object. |
java.lang.String |
getHelpText()
returns the locale-specific help text. |
java.lang.String |
getName()
returns the name of the parameter |
int |
getParameterType()
|
java.lang.String |
getPromptText()
|
java.lang.String |
getTypeName()
|
java.lang.String |
getUserPropertyValue(java.lang.String name)
returns the value of a user-defined property |
java.util.Map |
getUserPropertyValues()
returns a collection of user-defined property name and value pairs |
Field Detail |
---|
static final int SCALAR_PARAMETER
static final int FILTER_PARAMETER
static final int LIST_PARAMETER
static final int TABLE_PARAMETER
static final int PARAMETER_GROUP
static final int CASCADING_PARAMETER_GROUP
Method Detail |
---|
int getParameterType()
java.lang.String getTypeName()
java.lang.String getName()
java.lang.String getDisplayName()
java.lang.String getHelpText()
java.util.Map getUserPropertyValues()
java.lang.String getUserPropertyValue(java.lang.String name)
org.eclipse.birt.report.model.api.ReportElementHandle getHandle()
java.lang.String getPromptText()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |