|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Parameter value wrapper used by the OpenCms workplace widgets.
Method Summary | |
java.lang.String |
getDefault(CmsObject cms)
Returns the default value of this parameter. |
java.lang.String |
getId()
Returns the form id of this parameter. |
int |
getIndex()
Returns the index of this widget parameter, starting with 0. |
java.lang.String |
getKey()
Returns the localized key identificator of this parameter. |
int |
getMaxOccurs()
Returns the maximum occurences of this parameter. |
int |
getMinOccurs()
Returns the minimum occurences of this parameter. |
java.lang.String |
getName()
Returns the name of this parameter. |
java.lang.String |
getStringValue(CmsObject cms)
Returns the value of this parameter. |
boolean |
hasError()
Returns true if this widgets value contains an error. |
void |
setKeyPrefix(java.lang.String prefix)
Sets an optional localized key prefix identificator of this parameter. |
void |
setStringValue(CmsObject cms,
java.lang.String value)
Sets the value of this parameter. |
Method Detail |
public java.lang.String getDefault(CmsObject cms)
If no default value has been provided, null
is returned.
cms
- an initialized instance of an OpenCms user context
public java.lang.String getId()
public int getIndex()
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.
public java.lang.String getKey()
public int getMaxOccurs()
public int getMinOccurs()
public java.lang.String getName()
public java.lang.String getStringValue(CmsObject cms)
cms
- an initialized instance of an OpenCms user context
public boolean hasError()
true
if this widgets value contains an error.
true
if this widgets value contains an errorpublic void setKeyPrefix(java.lang.String prefix)
prefix
- the optional localized key prefix identificator of this parameterpublic void setStringValue(CmsObject cms, java.lang.String value)
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.
cms
- an initialized instance of an OpenCms user contextvalue
- the value to set
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |