| Package | Description |
|---|---|
| org.opencms.ade.contenteditor |
Contains server side classes for the XML content editor.
|
| org.opencms.jsp.util |
Utility classes to be used for JSP pages.
|
| org.opencms.workplace.editors |
Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
|
| org.opencms.xml |
Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
|
| org.opencms.xml.containerpage |
Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
|
| org.opencms.xml.content |
Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
|
| org.opencms.xml.types |
Contains the basic XML content type definitions, used for XML content and XML pages.
|
| Modifier and Type | Method and Description |
|---|---|
static CmsWidgetUtil.WidgetInfo |
CmsWidgetUtil.collectWidgetInfo(I_CmsXmlContentValue value)
Collects widget information for a given content value.
|
static java.lang.String |
CmsContentService.getAttributeName(I_CmsXmlContentValue contentValue)
Returns the entity attribute name representing the given content value.
|
static java.lang.String |
CmsContentService.getEntityId(I_CmsXmlContentValue contentValue)
Returns the entity id to the given content value.
|
static java.lang.String |
CmsContentService.getRdfaAttributes(I_CmsXmlContentValue value)
Returns the RDF annotations required for in line editing.
|
static java.lang.String |
CmsContentService.getRdfaAttributes(I_CmsXmlContentValue parentValue,
java.lang.String childNames)
Returns the RDF annotations required for in line editing.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsXmlContentValue |
CmsJspContentAccessValueWrapper.getContentValue()
Returns the wrapped content value.
|
I_CmsXmlContentValue |
CmsJspContentAccessValueWrapper.NullValueInfo.getParentValue()
Returns the parent value.
|
I_CmsXmlContentValue |
CmsJspContentAccessValueWrapper.obtainContentValue()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CmsJspContentAccessValueWrapper |
CmsJspContentAccessValueWrapper.createWrapper(CmsObject cms,
I_CmsXmlContentValue value,
I_CmsXmlContentValue parentValue,
java.lang.String valueName)
Factory method to create a new XML content value wrapper.
|
static CmsJspContentAccessValueWrapper |
CmsJspContentAccessValueWrapper.createWrapper(CmsObject cms,
I_CmsXmlContentValue value,
I_CmsXmlDocument content,
java.lang.String valueName,
java.util.Locale locale)
Factory method to create a new XML content value wrapper.
|
| Constructor and Description |
|---|
NullValueInfo(I_CmsXmlContentValue parentValue,
java.lang.String valueName)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.Map<java.lang.String,I_CmsXmlContentValue> |
CmsXmlContentWidgetVisitor.getValues()
Returns all simple values that were found in the content.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsXmlContentWidgetVisitor.visit(I_CmsXmlContentValue value) |
| Modifier and Type | Method and Description |
|---|---|
protected I_CmsXmlContentValue |
A_CmsXmlDocument.getBookmark(java.lang.String bookmark)
Returns the bookmarked value for the given bookmark,
which must be a valid bookmark name.
|
protected I_CmsXmlContentValue |
A_CmsXmlDocument.getBookmark(java.lang.String path,
java.util.Locale locale)
Returns the bookmarked value for the given name.
|
I_CmsXmlContentValue |
I_CmsXmlDocument.getValue(java.lang.String path,
java.util.Locale locale)
Returns the content value Object for the given path,
or
null if no such value exists. |
I_CmsXmlContentValue |
A_CmsXmlDocument.getValue(java.lang.String path,
java.util.Locale locale) |
I_CmsXmlContentValue |
I_CmsXmlDocument.getValue(java.lang.String path,
java.util.Locale locale,
int index)
Returns the content value Object for the given path and the selected index,
or
null if no such value exists. |
I_CmsXmlContentValue |
A_CmsXmlDocument.getValue(java.lang.String path,
java.util.Locale locale,
int index) |
protected I_CmsXmlContentValue |
A_CmsXmlDocument.getValueInternal(java.lang.String path,
java.util.Locale locale)
Internal method to look up a value, requires that the name already has been
"normalized" for the bookmark lookup.
|
protected I_CmsXmlContentValue |
A_CmsXmlDocument.removeBookmark(java.lang.String path,
java.util.Locale locale)
Removes the bookmark for an element with the given name and locale.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<I_CmsXmlContentValue> |
I_CmsXmlDocument.getSubValues(java.lang.String path,
java.util.Locale locale)
Returns all content values (of type
I_CmsXmlContentValue) directly below the given path
available in this document for the given locale. |
java.util.List<I_CmsXmlContentValue> |
A_CmsXmlDocument.getSubValues(java.lang.String path,
java.util.Locale locale) |
java.util.List<I_CmsXmlContentValue> |
I_CmsXmlDocument.getValues(java.util.Locale locale)
Returns all available content values (of type
I_CmsXmlContentValue)
in this document for the given locale. |
java.util.List<I_CmsXmlContentValue> |
A_CmsXmlDocument.getValues(java.util.Locale locale) |
java.util.List<I_CmsXmlContentValue> |
I_CmsXmlDocument.getValues(java.lang.String path,
java.util.Locale locale)
Returns all content values (of type
I_CmsXmlContentValue) with the given path
available in this document for the given locale. |
java.util.List<I_CmsXmlContentValue> |
A_CmsXmlDocument.getValues(java.lang.String path,
java.util.Locale locale) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
A_CmsXmlDocument.addBookmark(java.lang.String path,
java.util.Locale locale,
boolean enabled,
I_CmsXmlContentValue value)
Adds a bookmark for the given value.
|
| Modifier and Type | Method and Description |
|---|---|
CmsXmlContentErrorHandler |
CmsXmlContainerPageHandler.resolveValidation(CmsObject cms,
I_CmsXmlContentValue value,
CmsXmlContentErrorHandler errorHandler) |
protected boolean |
CmsXmlContainerPageHandler.validateLink(CmsObject cms,
I_CmsXmlContentValue value,
CmsXmlContentErrorHandler errorHandler) |
protected void |
CmsXmlContainerPageHandler.validateNames(CmsObject cms,
I_CmsXmlContentValue value,
CmsXmlContent content)
Validates container names, so that they are unique in the page.
|
| Modifier and Type | Method and Description |
|---|---|
protected I_CmsXmlContentValue |
CmsXmlContent.addValue(CmsObject cms,
org.dom4j.Element parent,
I_CmsXmlSchemaType type,
java.util.Locale locale,
int insertIndex)
Adds a new XML schema type with the default value to the given parent node.
|
I_CmsXmlContentValue |
CmsXmlContentValueSequence.addValue(CmsObject cms,
I_CmsXmlSchemaType type,
int index)
Adds a value element of the given type
at the selected index to the XML content document.
|
I_CmsXmlContentValue |
CmsXmlContentValueSequence.addValue(CmsObject cms,
int index)
Adds a value element of the type the original xpath indicates
at the selected index to the XML content document.
|
I_CmsXmlContentValue |
CmsXmlContentValueSequence.addValue(CmsObject cms,
java.lang.String xpath,
int index)
Adds a value element of the type indicated by the given xpath
at the selected index to the XML content document.
|
I_CmsXmlContentValue |
CmsXmlContent.addValue(CmsObject cms,
java.lang.String path,
java.util.Locale locale,
int index)
Adds a new XML content value for the given element name and locale at the given index position
to this XML content document.
|
protected I_CmsXmlContentValue |
CmsXmlContent.getBookmark(java.lang.String bookmark) |
I_CmsXmlContentValue |
I_CmsXmlContentValueLocation.getValue()
Returns the content value at the given location.
|
I_CmsXmlContentValue |
CmsXmlContentValueLocation.getValue()
Returns the content value at the given location.
|
I_CmsXmlContentValue |
CmsXmlContentValueSequence.getValue(int index)
Returns the XML content values from the index position of this sequence.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<I_CmsXmlContentValue> |
CmsXmlContent.getAllSimpleSubValues(I_CmsXmlContentValue value)
Returns all simple type sub values.
|
java.util.List<I_CmsXmlContentValue> |
CmsXmlContent.getSimpleValuesBelowPath(java.lang.String elementPath,
java.util.Locale locale)
Returns all simple type values below a given path.
|
java.util.List<I_CmsXmlContentValue> |
CmsXmlContent.getSubValues(java.lang.String path,
java.util.Locale locale)
Returns the list of sub-value for the given xpath in the selected locale.
|
java.util.List<I_CmsXmlContentValue> |
CmsXmlContentValueSequence.getValues()
Returns the list of XML content values for the selected schema type and locale in the XML content.
|
java.util.List<I_CmsXmlContentValue> |
CmsXmlContent.getValuesByPath(java.lang.String elementPath,
java.util.Locale locale)
Returns all values of the given element path.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsXmlContent.addBookmarkForValue(I_CmsXmlContentValue value,
java.lang.String path,
java.util.Locale locale,
boolean enabled)
Adds a bookmark for the given value.
|
void |
CmsXmlContentErrorHandler.addError(I_CmsXmlContentValue value,
java.lang.String message)
Adds an error message to the internal list of errors,
also raised the "has errors" flag.
|
void |
CmsXmlContentErrorHandler.addWarning(I_CmsXmlContentValue value,
java.lang.String message)
Adds an warning message to the internal list of errors,
also raised the "has warning" flag.
|
java.util.List<I_CmsXmlContentValue> |
CmsXmlContent.getAllSimpleSubValues(I_CmsXmlContentValue value)
Returns all simple type sub values.
|
java.lang.String |
CmsDefaultXmlContentHandler.getDefault(CmsObject cms,
I_CmsXmlContentValue value,
java.util.Locale locale) |
java.lang.String |
I_CmsXmlContentHandler.getDefault(CmsObject cms,
I_CmsXmlContentValue value,
java.util.Locale locale)
Returns the default String value for the given XML content schema type object in the given XML content.
|
protected java.lang.String |
CmsDefaultXmlContentHandler.getReferencePath(CmsObject cms,
I_CmsXmlContentValue value)
Returns the category reference path for the given value.
|
CmsRelationType |
CmsDefaultXmlContentHandler.getRelationType(I_CmsXmlContentValue value)
Deprecated.
|
CmsRelationType |
I_CmsXmlContentHandler.getRelationType(I_CmsXmlContentValue value)
Deprecated.
use
I_CmsXmlContentHandler.getRelationType(String) with getPath() instead |
protected java.lang.String |
CmsDefaultXmlContentHandler.getValidationMessage(CmsObject cms,
I_CmsXmlContentValue value,
java.lang.String regex,
java.lang.String valueStr,
boolean matchResult,
boolean isWarning)
Returns the validation message to be displayed if a certain rule was violated.
|
boolean |
CmsDefaultXmlContentHandler.isSearchable(I_CmsXmlContentValue value) |
boolean |
I_CmsXmlContentHandler.isSearchable(I_CmsXmlContentValue value)
Returns
true in case the given value should be searchable with
the integrated full text search. |
void |
CmsDefaultXmlContentHandler.resolveMapping(CmsObject cms,
CmsXmlContent content,
I_CmsXmlContentValue value) |
void |
I_CmsXmlContentHandler.resolveMapping(CmsObject cms,
CmsXmlContent content,
I_CmsXmlContentValue value)
Resolves the value mappings of the given XML content value, according
to the rules of this XML content handler.
|
CmsXmlContentErrorHandler |
CmsDefaultXmlContentHandler.resolveValidation(CmsObject cms,
I_CmsXmlContentValue value,
CmsXmlContentErrorHandler errorHandler) |
CmsXmlContentErrorHandler |
I_CmsXmlContentHandler.resolveValidation(CmsObject cms,
I_CmsXmlContentValue value,
CmsXmlContentErrorHandler errorHandler)
Performs a validation of the given XML content value, and saves all errors or warnings found in
the provided XML content error handler.
|
protected CmsXmlContentErrorHandler |
CmsDefaultXmlContentHandler.validateCategories(CmsObject cms,
I_CmsXmlContentValue value,
CmsXmlContentErrorHandler errorHandler)
The errorHandler parameter is optional, if
null is given a new error handler
instance must be created. |
protected boolean |
CmsDefaultXmlContentHandler.validateLink(CmsObject cms,
I_CmsXmlContentValue value,
CmsXmlContentErrorHandler errorHandler)
Validates the given rules against the given value.
|
protected CmsXmlContentErrorHandler |
CmsDefaultXmlContentHandler.validateValue(CmsObject cms,
I_CmsXmlContentValue value,
CmsXmlContentErrorHandler errorHandler,
java.util.Map<java.lang.String,java.lang.String> rules,
boolean isWarning)
Validates the given rules against the given value.
|
protected CmsXmlContentErrorHandler |
CmsDefaultXmlContentHandler.validateValue(CmsObject cms,
I_CmsXmlContentValue value,
java.lang.String valueStr,
CmsXmlContentErrorHandler errorHandler,
boolean isWarning)
Checks the default XML schema validation rules.
|
void |
CmsXmlContentMacroVisitor.visit(I_CmsXmlContentValue value) |
void |
I_CmsXmlContentValueVisitor.visit(I_CmsXmlContentValue value)
Visits the given value.
|
| Constructor and Description |
|---|
CmsXmlContentValueLocation(I_CmsXmlContentValue value)
Constructs a new XML content value location.
|
| Modifier and Type | Class and Description |
|---|---|
class |
A_CmsXmlContentValue
Base class for XML content value implementations.
|
class |
A_CmsXmlValueCdataBase
Base class for XML content value implementations that require only a simple XML cdata text node.
|
class |
A_CmsXmlValueTextBase
Base class for XML content value implementations that require only a simple XML plain text node.
|
class |
CmsXmlBooleanValue
Describes the XML content type "OpenCmsBoolean".
|
class |
CmsXmlCategoryValue
Describes the XML content type "OpenCmsVfsFile".
|
class |
CmsXmlColorValue
Describes the XML content type "OpenCmsColor".
|
class |
CmsXmlDateTimeValue
Describes the XML content type "OpenCmsDateTime".
|
class |
CmsXmlDisplayFormatterValue
XML value type for display formatters.
|
class |
CmsXmlDynamicCategoryValue
Describes the XML content type "OpenCmsVfsFile".
|
class |
CmsXmlHtmlValue
Describes the XML content type "OpenCmsHtml".
|
class |
CmsXmlLocaleValue
Describes the XML content type "OpenCmsLocale".
|
class |
CmsXmlNestedContentDefinition
A nested content XML definition that is included by another XML content definition.
|
class |
CmsXmlPlainTextStringValue
Describes the XML content type "OpenCmsPlainTextString".
|
class |
CmsXmlSerialDateValue
Describes the XML content type "OpenCmsSerialDate".
|
class |
CmsXmlStringValue
Describes the XML content type "OpenCmsString".
|
class |
CmsXmlVarLinkValue
Describes the XML content type "OpenCmsVarLink".
|
class |
CmsXmlVfsFileValue
Describes the XML content type "OpenCmsVfsFile".
|
class |
CmsXmlVfsImageValue
Describes the XML content type "OpenCmsVfsImage".
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsXmlContentValue |
CmsXmlDateTimeValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlPlainTextStringValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlStringValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlNestedContentDefinition.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlVfsFileValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlVarLinkValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlColorValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlHtmlValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlBooleanValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
I_CmsXmlSchemaType.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale)
Creates a XML content value object for this type.
|
I_CmsXmlContentValue |
CmsXmlCategoryValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlDynamicCategoryValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlSerialDateValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlVfsImageValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlDisplayFormatterValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |
I_CmsXmlContentValue |
CmsXmlLocaleValue.createValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale) |