Uses of Interface
org.opencms.xml.types.I_CmsXmlContentValue
Packages that use I_CmsXmlContentValue
Package
Description
Contains server side classes for the XML content editor.
Utility classes to be used for JSP pages.
Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
Contains the basic XML content type definitions, used for XML content and XML pages.
-
Uses of I_CmsXmlContentValue in org.opencms.ade.contenteditor
Methods in org.opencms.ade.contenteditor with parameters of type I_CmsXmlContentValueModifier and TypeMethodDescriptionstatic CmsWidgetUtil.WidgetInfo
CmsWidgetUtil.collectWidgetInfo
(CmsObject cms, I_CmsXmlContentValue value) Collects widget information for a given content value.static String
CmsContentService.getAttributeName
(I_CmsXmlContentValue contentValue) Returns the entity attribute name representing the given content value.static String
CmsContentService.getEntityId
(I_CmsXmlContentValue contentValue) Returns the entity id to the given content value.static String
CmsContentService.getRdfaAttributes
(I_CmsXmlContentValue value) Returns the RDF annotations required for in line editing.static String
CmsContentService.getRdfaAttributes
(I_CmsXmlContentValue parentValue, String childNames) Returns the RDF annotations required for in line editing. -
Uses of I_CmsXmlContentValue in org.opencms.jsp.util
Methods in org.opencms.jsp.util that return I_CmsXmlContentValueModifier and TypeMethodDescriptionCmsJspContentAccessValueWrapper.getContentValue()
Returns the wrapped content value.CmsJspContentAccessValueWrapper.NullValueInfo.getParentValue()
Returns the parent value.CmsJspContentAccessValueWrapper.obtainContentValue()
Deprecated.Methods in org.opencms.jsp.util with parameters of type I_CmsXmlContentValueModifier and TypeMethodDescriptionCmsJspContentAccessValueWrapper.createWrapper
(CmsObject cms, I_CmsXmlContentValue value, I_CmsXmlDocument content, String valueName, Locale locale) Factory method to create a new XML content value wrapper.CmsJspContentAccessValueWrapper.createWrapper
(CmsObject cms, I_CmsXmlContentValue value, I_CmsXmlContentValue parentValue, String valueName) Factory method to create a new XML content value wrapper.Constructors in org.opencms.jsp.util with parameters of type I_CmsXmlContentValueModifierConstructorDescriptionprotected
NullValueInfo
(I_CmsXmlContentValue parentValue, String valueName) Constructor. -
Uses of I_CmsXmlContentValue in org.opencms.workplace.editors
Methods in org.opencms.workplace.editors that return types with arguments of type I_CmsXmlContentValueModifier and TypeMethodDescriptionCmsXmlContentWidgetVisitor.getValues()
Returns all simple values that were found in the content.Methods in org.opencms.workplace.editors with parameters of type I_CmsXmlContentValueModifier and TypeMethodDescriptionvoid
CmsXmlContentWidgetVisitor.visit
(I_CmsXmlContentValue value) -
Uses of I_CmsXmlContentValue in org.opencms.xml
Methods in org.opencms.xml that return I_CmsXmlContentValueModifier and TypeMethodDescriptionprotected I_CmsXmlContentValue
A_CmsXmlDocument.getBookmark
(String bookmark) Returns the bookmarked value for the given bookmark, which must be a valid bookmark name.protected I_CmsXmlContentValue
A_CmsXmlDocument.getBookmark
(String path, Locale locale) Returns the bookmarked value for the given name.Returns the content value Object for the given path, ornull
if no such value exists.Returns the content value Object for the given path and the selected index, ornull
if no such value exists.protected I_CmsXmlContentValue
A_CmsXmlDocument.getValueInternal
(String path, 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
(String path, Locale locale) Removes the bookmark for an element with the given name and locale.Methods in org.opencms.xml that return types with arguments of type I_CmsXmlContentValueModifier and TypeMethodDescriptionA_CmsXmlDocument.getSubValues
(String path, Locale locale) I_CmsXmlDocument.getSubValues
(String path, Locale locale) Returns all content values (of typeI_CmsXmlContentValue
) directly below the given path available in this document for the given locale.Returns all content values (of typeI_CmsXmlContentValue
) with the given path available in this document for the given locale.Returns all available content values (of typeI_CmsXmlContentValue
) in this document for the given locale.Methods in org.opencms.xml with parameters of type I_CmsXmlContentValueModifier and TypeMethodDescriptionprotected void
A_CmsXmlDocument.addBookmark
(String path, Locale locale, boolean enabled, I_CmsXmlContentValue value) Adds a bookmark for the given value. -
Uses of I_CmsXmlContentValue in org.opencms.xml.containerpage
Methods in org.opencms.xml.containerpage with parameters of type I_CmsXmlContentValueModifier and TypeMethodDescriptionCmsXmlContainerPageHandler.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. -
Uses of I_CmsXmlContentValue in org.opencms.xml.content
Methods in org.opencms.xml.content that return I_CmsXmlContentValueModifier and TypeMethodDescriptionAdds 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.addValue
(CmsObject cms, org.dom4j.Element parent, I_CmsXmlSchemaType type, Locale locale, int insertIndex) Adds a new XML schema type with the default value to the given parent node.Adds a value element of the type the original xpath indicates at the selected index to the XML content document.Adds a value element of the type indicated by the given xpath at the selected index to the XML content document.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.protected I_CmsXmlContentValue
CmsXmlContent.getBookmark
(String bookmark) CmsXmlContentValueLocation.getValue()
Returns the content value at the given location.CmsXmlContentValueSequence.getValue
(int index) Returns the XML content values from the index position of this sequence.I_CmsXmlContentValueLocation.getValue()
Returns the content value at the given location.Methods in org.opencms.xml.content that return types with arguments of type I_CmsXmlContentValueModifier and TypeMethodDescriptionCmsXmlContent.getAllSimpleSubValues
(I_CmsXmlContentValue value) Returns all simple type sub values.CmsXmlContent.getSimpleValuesBelowPath
(String elementPath, Locale locale) Returns all simple type values below a given path.CmsXmlContent.getSubValues
(String path, Locale locale) Returns the list of sub-value for the given xpath in the selected locale.CmsXmlContentValueSequence.getValues()
Returns the list of XML content values for the selected schema type and locale in the XML content.CmsXmlContent.getValuesByPath
(String elementPath, Locale locale) Returns all values of the given element path.Methods in org.opencms.xml.content with parameters of type I_CmsXmlContentValueModifier and TypeMethodDescriptionprotected void
CmsXmlContent.addBookmarkForValue
(I_CmsXmlContentValue value, String path, Locale locale, boolean enabled) Adds a bookmark for the given value.void
CmsXmlContentErrorHandler.addError
(I_CmsXmlContentValue value, String message) Adds an error message to the internal list of errors, also raised the "has errors" flag.void
CmsXmlContentErrorHandler.addWarning
(I_CmsXmlContentValue value, String message) Adds an warning message to the internal list of errors, also raised the "has warning" flag.CmsXmlContent.getAllSimpleSubValues
(I_CmsXmlContentValue value) Returns all simple type sub values.CmsDefaultXmlContentHandler.getDefault
(CmsObject cms, I_CmsXmlContentValue value, Locale locale) I_CmsXmlContentHandler.getDefault
(CmsObject cms, I_CmsXmlContentValue value, Locale locale) Returns the default String value for the given XML content schema type object in the given XML content.protected String
CmsDefaultXmlContentHandler.getReferencePath
(CmsObject cms, I_CmsXmlContentValue value) Returns the category reference path for the given value.CmsDefaultXmlContentHandler.getRelationType
(I_CmsXmlContentValue value) Deprecated.I_CmsXmlContentHandler.getRelationType
(I_CmsXmlContentValue value) Deprecated.useI_CmsXmlContentHandler.getRelationType(String)
withgetPath()
insteadCmsDefaultXmlContentHandler.getSearchContentConfig
(I_CmsXmlContentValue value) I_CmsXmlContentHandler.getSearchContentConfig
(I_CmsXmlContentValue value) Returns the search content configuration, ie., the way how to integrate the value into full text search.protected String
CmsDefaultXmlContentHandler.getValidationMessage
(CmsObject cms, I_CmsXmlContentValue value, String regex, String valueStr, boolean matchResult, boolean isWarning) Returns the validation message to be displayed if a certain rule was violated.default boolean
I_CmsXmlContentHandler.isSearchable
(I_CmsXmlContentValue value) Deprecated.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.CmsDefaultXmlContentHandler.resolveValidation
(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler) 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, ifnull
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, String valueStr, CmsXmlContentErrorHandler errorHandler, boolean isWarning) Checks the default XML schema validation rules.protected CmsXmlContentErrorHandler
CmsDefaultXmlContentHandler.validateValue
(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler, Map<String, String> rules, boolean isWarning) Validates the given rules against the given value.void
CmsXmlContentMacroVisitor.visit
(I_CmsXmlContentValue value) void
I_CmsXmlContentValueVisitor.visit
(I_CmsXmlContentValue value) Visits the given value.Constructors in org.opencms.xml.content with parameters of type I_CmsXmlContentValueModifierConstructorDescriptionConstructs a new XML content value location. -
Uses of I_CmsXmlContentValue in org.opencms.xml.types
Classes in org.opencms.xml.types that implement I_CmsXmlContentValueModifier and TypeClassDescriptionclass
Base class for XML content value implementations.class
Base class for XML content value implementations that require only a simple XML cdata text node.class
Base class for XML content value implementations that require only a simple XML plain text node.class
Describes the XML content type "OpenCmsVfsFile".class
Describes the XML content type "OpenCmsBoolean".class
Describes the XML content type "OpenCmsVfsFile".class
Describes the XML content type "OpenCmsColor".class
Describes the XML content type "OpenCmsDateTime".class
XML value type for display formatters.class
Describes the XML content type "OpenCmsVfsFile".class
Describes the XML content type "OpenCmsHtml".class
Describes the XML content type "OpenCmsLocale".class
A nested content XML definition that is included by another XML content definition.class
Describes the XML content type "OpenCmsPlainTextString".class
Describes the XML content type "OpenCmsSerialDate".class
Describes the XML content type "OpenCmsString".class
Describes the XML content type "OpenCmsVarLink".class
Describes the XML content type "OpenCmsVfsFile".class
Describes the XML content type "OpenCmsVfsImage".Methods in org.opencms.xml.types that return I_CmsXmlContentValueModifier and TypeMethodDescriptionCmsXmlAccessRestrictionValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlBooleanValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlCategoryValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlColorValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlDateTimeValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlDisplayFormatterValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlDynamicCategoryValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlHtmlValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlLocaleValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlNestedContentDefinition.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlPlainTextStringValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlSerialDateValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlStringValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlVarLinkValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlVfsFileValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) CmsXmlVfsImageValue.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) I_CmsXmlSchemaType.createValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) Creates a XML content value object for this type. -
Uses of I_CmsXmlContentValue in org.opencms.xml.xml2json
Methods in org.opencms.xml.xml2json that return I_CmsXmlContentValueModifier and TypeMethodDescriptionCmsXmlContentTree.Node.getValue()
Gets the content value (null for root node).Methods in org.opencms.xml.xml2json with parameters of type I_CmsXmlContentValueModifier and TypeMethodDescriptionCmsXmlContentTree.getNodeForValue
(I_CmsXmlContentValue value) Gets the node corresponding to the given value.Constructors in org.opencms.xml.xml2json with parameters of type I_CmsXmlContentValueModifierConstructorDescriptionNode
(CmsXmlContentTree.NodeType type, I_CmsXmlContentValue value, CmsXmlContentDefinition contentDef, org.dom4j.Element elem, List<CmsXmlContentTree.Field> fields) Creates a new instance.
CmsJspContentAccessValueWrapper.getContentValue()
instead