| org.opencms.widgets.I_CmsWidgetParameter
All known Subclasses: org.opencms.workplace.CmsWidgetDialogParameter, org.opencms.xml.types.A_CmsXmlContentValue,
I_CmsWidgetParameter | public interface I_CmsWidgetParameter (Code) | | Parameter value wrapper used by the OpenCms workplace widgets.
author: Alexander Kandzior version: $Revision: 1.8 $ since: 6.0.0 |
getDefault | String getDefault(CmsObject cms)(Code) | | Returns the default value of this parameter.
If no default value has been provided, null is returned.
Parameters: cms - an initialized instance of an OpenCms user context the default value of this parameter |
getId | String getId()(Code) | | Returns the form id of this parameter.
the form id of this parameter |
getIndex | int getIndex()(Code) | | Returns the index of this widget parameter,
starting with 0.
This is usefull in case there are more then one parameters
with the same name, for example when creating a list of parameters of the same type.
the index of this widget parameter |
getKey | String getKey()(Code) | | Returns the localized key identificator of this parameter.
the localized key identificator of this parameter |
getMaxOccurs | int getMaxOccurs()(Code) | | Returns the maximum occurences of this parameter.
the maximum occurences of this parameter |
getMinOccurs | int getMinOccurs()(Code) | | Returns the minimum occurences of this parameter.
the minimum occurences of this parameter |
getName | String getName()(Code) | | Returns the name of this parameter.
the name of this parameter |
getStringValue | String getStringValue(CmsObject cms)(Code) | | Returns the value of this parameter.
Parameters: cms - an initialized instance of an OpenCms user context the value of this parameter |
hasError | boolean hasError()(Code) | | Returns true if this widgets value contains an error.
true if this widgets value contains an error |
setKeyPrefix | void setKeyPrefix(String prefix)(Code) | | Sets an optional localized key prefix identificator of this parameter.
Parameters: prefix - the optional localized key prefix identificator of this parameter |
setStringValue | void setStringValue(CmsObject cms, String value)(Code) | | Sets the value of this parameter.
This method does provide processing of the content based on the
users current OpenCms context. This can be used e.g. for link
extraction and replacement in the content.
Parameters: cms - an initialized instance of an OpenCms user context Parameters: value - the value to set |
|
|