|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.xml.types.A_CmsXmlContentValue
org.opencms.xml.types.A_CmsXmlValueCdataBase
Base class for XML content value implementations that require only a simple XML cdata text node.
Field Summary | |
protected java.lang.String |
m_stringValue
The String value of the element node. |
Fields inherited from class org.opencms.xml.types.A_CmsXmlContentValue |
m_defaultValue, m_document, m_element, m_locale, m_maxOccurs, m_minOccurs, m_name |
Fields inherited from interface org.opencms.xml.types.I_CmsXmlSchemaType |
XSI_NAMESPACE, XSI_NAMESPACE_ATTRIBUTE_NO_SCHEMA_LOCATION |
Constructor Summary | |
protected |
A_CmsXmlValueCdataBase()
Default constructor for a xml content type that initializes some internal values. |
protected |
A_CmsXmlValueCdataBase(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Initializes the required members for this XML content value. |
protected |
A_CmsXmlValueCdataBase(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs)
Initializes the schema type descriptor values for this type descriptor. |
Method Summary | |
java.lang.String |
getPlainText(CmsObject cms)
Returns the value of this XML content node as a plain text String. |
java.lang.String |
getStringValue(CmsObject cms)
Returns the value of this XML content node as a String. |
void |
setStringValue(CmsObject cms,
java.lang.String value)
Sets the provided String as value of this XML content node. |
Methods inherited from class org.opencms.xml.types.A_CmsXmlContentValue |
appendXmlSchema, compareTo, equals, generateXml, getContentDefinition, getDefault, getDefault, getDocument, getElement, getId, getIndex, getKey, getLocale, getMaxIndex, getMaxOccurs, getMinOccurs, getName, getPath, hasError, hashCode, isSimpleType, moveDown, moveUp, moveValue, readSchemaDefinition, setContentDefinition, setDefault, setKeyPrefix, toString, validateValue |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.opencms.xml.types.I_CmsXmlSchemaType |
createValue, getSchemaDefinition, getTypeName, newInstance |
Field Detail |
protected java.lang.String m_stringValue
Constructor Detail |
protected A_CmsXmlValueCdataBase()
protected A_CmsXmlValueCdataBase(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type)
document
- the XML content instance this value belongs toelement
- the XML element that contains this valuelocale
- the locale this value is created fortype
- the type instance to create the value forprotected A_CmsXmlValueCdataBase(java.lang.String name, java.lang.String minOccurs, java.lang.String maxOccurs)
name
- the name of the XML node containing the value according to the XML schemaminOccurs
- minimum number of occurences of this type according to the XML schemamaxOccurs
- maximum number of occurences of this type according to the XML schemaMethod Detail |
public java.lang.String getPlainText(CmsObject cms)
I_CmsXmlContentValue
Plain text in this context means a pure textual representation
of the content (i.e. without html tags).
The plain text may be null
, too, if there is no sound or useful
textual representation (i.e. color values).
getPlainText
in interface I_CmsXmlContentValue
getPlainText
in class A_CmsXmlContentValue
I_CmsXmlContentValue.getPlainText(org.opencms.file.CmsObject)
public java.lang.String getStringValue(CmsObject cms) throws CmsRuntimeException
I_CmsXmlContentValue
cms
- an initialized instance of a CmsObject
CmsRuntimeException
I_CmsXmlContentValue.getStringValue(CmsObject)
public void setStringValue(CmsObject cms, java.lang.String value) throws CmsIllegalArgumentException
I_CmsXmlContentValue
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 a CmsObjectvalue
- the value to set
CmsIllegalArgumentException
I_CmsXmlContentValue.setStringValue(org.opencms.file.CmsObject, java.lang.String)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |