|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_CmsXmlContentValue
Provides access to the value of a specific XML content node.
Field Summary |
---|
Fields inherited from interface org.opencms.xml.types.I_CmsXmlSchemaType |
---|
XSI_NAMESPACE, XSI_NAMESPACE_ATTRIBUTE_NO_SCHEMA_LOCATION |
Method Summary | |
---|---|
I_CmsXmlDocument |
getDocument()
Returns the XML content instance this value belongs to. |
org.dom4j.Element |
getElement()
Returns the original XML element of this XML content value. |
int |
getIndex()
Returns the node index of this XML content value in the source XML document, starting with 0. |
java.util.Locale |
getLocale()
Returns the locale of this XML content value was generated for. |
int |
getMaxIndex()
Returns the total number of XML elements of this type that currently exist in the source document. |
java.lang.String |
getPath()
Returns the path of this XML content value in the source document. |
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. |
boolean |
isSearchable()
Returns true in case this value is searchable by default with
the integrated full text search. |
void |
moveDown()
Moves this XML content value one position down in the source document, if possible. |
void |
moveUp()
Moves this XML content value one position up in the source document, if possible. |
void |
setStringValue(CmsObject cms,
java.lang.String value)
Sets the provided String as value of this XML content node. |
Methods inherited from interface org.opencms.xml.types.I_CmsXmlSchemaType |
---|
appendXmlSchema, createValue, generateXml, getContentDefinition, getDefault, getMaxOccurs, getMinOccurs, getName, getSchemaDefinition, getTypeName, isSimpleType, newInstance, setContentDefinition, setDefault, validateValue |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Method Detail |
---|
I_CmsXmlDocument getDocument()
org.dom4j.Element getElement()
int getIndex()
This is useful in case there are more then one elements with the same XML node name in the source XML document.
java.util.Locale getLocale()
int getMaxIndex()
java.lang.String getPath()
java.lang.String getPlainText(CmsObject cms)
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).
cms
- an initialized instance of a CmsObject
java.lang.String getStringValue(CmsObject cms)
cms
- an initialized instance of a CmsObject
boolean isSearchable()
true
in case this value is searchable by default with
the integrated full text search.
true
in case this value is searchable by defaultvoid moveDown()
If the XML content value is already the first in it's sequence, it is not moved.
void moveUp()
If the XML content value is already the last in it's sequence, it is not moved.
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 a CmsObjectvalue
- the value to set
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |