|
||||||||||
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.ReportElementHandle
org.eclipse.birt.report.model.api.ParameterHandle
public abstract class ParameterHandle
Represents the various parameter types. This abstract base parameter element defines properties common to all types of parameters.
Parameter
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IParameterModel |
---|
HELP_TEXT_KEY_PROP, HELP_TEXT_PROP, HIDDEN_PROP, VALIDATE_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, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
ParameterHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs the handle for a parameter with the given design and element. |
Method Summary | |
---|---|
java.lang.String |
getHelpText()
Returns the additional text to display for the parameter to explain how to use the parameter. |
java.lang.String |
getHelpTextKey()
Returns the resource key of the additional text to display for the parameter to explain how to use the parameter. |
java.lang.String |
getValidate()
Gets the custom validation code for the parameter. |
boolean |
isHidden()
Tests whether the parameter will appear in the Requester page. |
void |
setHelpText(java.lang.String helpText)
Returns the additional text to display for the parameter to explain how to use the parameter. |
void |
setHelpTextKey(java.lang.String resourceKey)
Sets the resource key of the additional text to display for the parameter to explain how to use the parameter. |
void |
setHidden(boolean hidden)
Sets the hidden property of this parameter. |
void |
setValidate(java.lang.String validation)
Sets the custom validation code for the parameter. |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ParameterHandle(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 getHelpText()
public void setHelpText(java.lang.String helpText) throws SemanticException
helpText
- the help text
SemanticException
- if the property is locked.public java.lang.String getHelpTextKey()
public void setHelpTextKey(java.lang.String resourceKey) throws SemanticException
resourceKey
- the resource key of the help text
SemanticException
- if the property is locked.public boolean isHidden()
true
means the parameter will not be visible.
false
means the invisibility of the parameter.public void setHidden(boolean hidden) throws SemanticException
true
, the
parameter will not appear in the Requester page. Parameter is visible by
default.
hidden
- true
if the parameter is visible. Otherwise
false
.
SemanticException
- if the property is locked.public java.lang.String getValidate()
public void setValidate(java.lang.String validation) throws SemanticException
validation
- the custom validation code to set
SemanticException
- if the property is locked
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |