| Package | Description |
|---|---|
| org.opencms.xml |
Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
|
| 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 |
|---|---|
I_CmsXmlSchemaType |
CmsXmlContentTypeManager.addContentType(java.lang.Class<?> clazz)
Adds a XML content schema type class to the registered XML content types.
|
I_CmsXmlSchemaType |
CmsXmlContentTypeManager.getContentType(org.dom4j.Element typeElement,
java.util.Set<CmsXmlContentDefinition> nestedDefinitions)
Generates an initialized instance of a XML content type definition
from the given XML schema element.
|
I_CmsXmlSchemaType |
CmsXmlContentTypeManager.getContentType(java.lang.String typeName)
Returns the content type registered with the given name, or
null. |
I_CmsXmlSchemaType |
CmsXmlContentDefinition.getSchemaType(java.lang.String elementPath)
Returns the schema type for the given element name, or
null if no
node is defined with this name. |
| Modifier and Type | Method and Description |
|---|---|
java.util.List<I_CmsXmlSchemaType> |
CmsXmlContentTypeManager.getRegisteredSchemaTypes()
Returns an alphabetically sorted list of all configured XML content schema types.
|
java.util.List<I_CmsXmlSchemaType> |
CmsXmlContentDefinition.getTypeSequence()
Returns the type sequence, contains instances of
I_CmsXmlSchemaType. |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsXmlContentDefinition.addType(I_CmsXmlSchemaType type)
Adds the given content type.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
CmsXmlContentDefinition.findSchemaTypesForPath(java.lang.String path,
java.util.function.BiConsumer<I_CmsXmlSchemaType,java.lang.String> consumer)
Iterates over all schema types along a given xpath, starting from a root content definition.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<I_CmsXmlSchemaType> |
CmsXmlContent.getChoiceOptions(java.lang.String xpath,
java.util.Locale locale)
Returns the list of choice options for the given xpath in the selected locale.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsDefaultXmlContentHandler.addDefaultCheckRules(CmsXmlContentDefinition rootContentDefinition,
I_CmsXmlSchemaType schemaType,
java.lang.String elementPath)
Adds all needed default check rules recursively for the given schema type.
|
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_CmsComplexWidget |
CmsDefaultXmlContentHandler.getComplexWidget(I_CmsXmlSchemaType value) |
I_CmsComplexWidget |
I_CmsXmlContentHandler.getComplexWidget(I_CmsXmlSchemaType value)
Gets the complex widget for the given schema type.
|
java.lang.String |
CmsDefaultXmlContentHandler.getConfiguration(I_CmsXmlSchemaType type) |
java.lang.String |
I_CmsXmlContentHandler.getConfiguration(I_CmsXmlSchemaType type)
Returns the configuration String value for the widget used to edit the given XML content schema type.
|
java.lang.String |
CmsDefaultXmlContentHandler.getDefault(CmsObject cms,
CmsResource resource,
I_CmsXmlSchemaType type,
java.lang.String path,
java.util.Locale locale) |
java.lang.String |
I_CmsXmlContentHandler.getDefault(CmsObject cms,
CmsResource resource,
I_CmsXmlSchemaType type,
java.lang.String path,
java.util.Locale locale)
Returns the default String value for the given XML content schema type object in the given XML content.
|
I_CmsXmlContentHandler.DisplayType |
CmsDefaultXmlContentHandler.getDisplayType(I_CmsXmlSchemaType type) |
I_CmsXmlContentHandler.DisplayType |
I_CmsXmlContentHandler.getDisplayType(I_CmsXmlSchemaType type)
Returns if the widget for this type should be displayed in compact view.
|
I_CmsWidget |
CmsDefaultXmlContentHandler.getWidget(I_CmsXmlSchemaType value)
Deprecated.
|
I_CmsWidget |
I_CmsXmlContentHandler.getWidget(I_CmsXmlSchemaType value)
Deprecated.
|
boolean |
CmsDefaultXmlContentHandler.isValueVisible(CmsObject cms,
I_CmsXmlSchemaType value,
java.lang.String elementName,
java.lang.String params,
CmsResource resource,
java.util.Locale contentLocale)
Returns the content field visibilty.
|
boolean |
I_CmsXmlContentVisibilityHandler.isValueVisible(CmsObject cms,
I_CmsXmlSchemaType value,
java.lang.String elementPath,
java.lang.String params,
CmsResource resource,
java.util.Locale contentLocale)
Returns if the given content value field should be visible to the current user.
|
boolean |
CmsDefaultXmlContentHandler.isVisible(CmsObject cms,
I_CmsXmlSchemaType contentValue,
java.lang.String valuePath,
CmsResource resource,
java.util.Locale contentLocale) |
boolean |
I_CmsXmlContentHandler.isVisible(CmsObject cms,
I_CmsXmlSchemaType schemaType,
java.lang.String valuePath,
CmsResource resource,
java.util.Locale contentLocale)
Returns if the given content field should be visible to the current user.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
I_CmsXmlContentValue
Provides access to the value of a specific XML content node.
|
| 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_CmsXmlSchemaType |
CmsXmlDateTimeValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlPlainTextStringValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlStringValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlNestedContentDefinition.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlVfsFileValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlVarLinkValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlColorValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlHtmlValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlBooleanValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
I_CmsXmlSchemaType.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs)
Creates a new instance of this XML schema type initialized with the given values.
|
I_CmsXmlSchemaType |
CmsXmlCategoryValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlDynamicCategoryValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlSerialDateValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlVfsImageValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlDisplayFormatterValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
I_CmsXmlSchemaType |
CmsXmlLocaleValue.newInstance(java.lang.String name,
java.lang.String minOccurs,
java.lang.String maxOccurs) |
| Modifier and Type | Method and Description |
|---|---|
int |
A_CmsXmlContentValue.compareTo(I_CmsXmlSchemaType obj) |
| Constructor and Description |
|---|
A_CmsXmlContentValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Initializes the required members for this XML content value.
|
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.
|
A_CmsXmlValueTextBase(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Initializes the required members for this XML content value.
|
CmsXmlBooleanValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsBoolean".
|
CmsXmlCategoryValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsCategoryValue".
|
CmsXmlColorValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsColor".
|
CmsXmlDateTimeValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsDateTime".
|
CmsXmlDisplayFormatterValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsDisplayFormatter".
|
CmsXmlDynamicCategoryValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsCategoryValue".
|
CmsXmlHtmlValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsHtml".
|
CmsXmlLocaleValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsLocale".
|
CmsXmlNestedContentDefinition(CmsXmlContentDefinition contentDefinition,
I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value for the nested content definition.
|
CmsXmlPlainTextStringValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsString".
|
CmsXmlSerialDateValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsSerialDate".
|
CmsXmlStringValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsString".
|
CmsXmlVarLinkValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsVfsFile".
|
CmsXmlVfsFileValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsVfsFile".
|
CmsXmlVfsImageValue(I_CmsXmlDocument document,
org.dom4j.Element element,
java.util.Locale locale,
I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsVfsImage".
|