Class CmsXmlAccessRestrictionValue
- All Implemented Interfaces:
Comparable<I_CmsXmlSchemaType>
,I_CmsWidgetParameter
,I_CmsXmlContentValue
,I_CmsXmlSchemaType
This type allows links to internal VFS resources only.
- Since:
- 7.0.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.opencms.xml.types.I_CmsXmlContentValue
I_CmsXmlContentValue.SearchContentType
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
The name of this type as used in the XML schema.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
ConstructorDescriptionCreates a new, empty schema type descriptor of type "OpenCmsCategoryValue".CmsXmlAccessRestrictionValue
(String name, String minOccurs, String maxOccurs) Creates a new schema type descriptor for the type "OpenCmsCategoryValue".CmsXmlAccessRestrictionValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsCategoryValue". -
Method Summary
Modifier and TypeMethodDescriptioncreateValue
(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) Creates a XML content value object for this type.org.dom4j.Element
generateXml
(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale) Appends an XML for a new, empty node of this schema type to the given root element.getPlainText
(CmsObject cms) Returns the value of this XML content node as a plain text String.Returns a String representation of the XML definition for this schema type.getStringValue
(CmsObject cms) Returns the value of this XML content node as a String.Returns the schema type name.boolean
The default implementation always returnstrue
.newInstance
(String name, String minOccurs, String maxOccurs) Creates a new instance of this XML schema type initialized with the given values.void
setStringValue
(CmsObject cms, 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, getChoiceMaxOccurs, getContentDefinition, getDefault, getDefault, getDocument, getElement, getId, getIndex, getKey, getLocale, getMaxIndex, getMaxOccurs, getMinOccurs, getName, getPath, getRelationType, getXmlIndex, hasError, hashCode, isChoiceOption, isChoiceType, 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_CmsXmlContentValue
getSearchContentType
-
Field Details
-
TYPE_NAME
The name of this type as used in the XML schema.- See Also:
-
N_ACCESS_RESTRICTION_VALUE
- See Also:
-
-
Constructor Details
-
CmsXmlAccessRestrictionValue
public CmsXmlAccessRestrictionValue()Creates a new, empty schema type descriptor of type "OpenCmsCategoryValue". -
CmsXmlAccessRestrictionValue
public CmsXmlAccessRestrictionValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type) Creates a new XML content value of type "OpenCmsCategoryValue".- Parameters:
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 for
-
CmsXmlAccessRestrictionValue
Creates a new schema type descriptor for the type "OpenCmsCategoryValue".- Parameters:
name
- the name of the XML node containing the value according to the XML schemaminOccurs
- minimum number of occurrences of this type according to the XML schemamaxOccurs
- maximum number of occurrences of this type according to the XML schema
-
-
Method Details
-
createValue
public I_CmsXmlContentValue createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale) Description copied from interface:I_CmsXmlSchemaType
Creates a XML content value object for this type.- Parameters:
document
- the XML content instance this value belongs toelement
- the XML element to create the value fromlocale
- the locale to create the value for- Returns:
- the created XML content value object
- See Also:
-
generateXml
public org.dom4j.Element generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, Locale locale) Description copied from interface:I_CmsXmlSchemaType
Appends an XML for a new, empty node of this schema type to the given root element.This is used to dynamically build a vaild XML content object from an initialized
CmsXmlContentDefinition
class.Important: This method can only be used during initialization of a XML content object, not to add values to an already initialized XML content. To add values after initialization, use
CmsXmlContent.addValue(CmsObject, String, Locale, int)
.- Specified by:
generateXml
in interfaceI_CmsXmlSchemaType
- Overrides:
generateXml
in classA_CmsXmlContentValue
- Parameters:
cms
- the current users OpenCms contextdocument
- the document the XML is generated forroot
- the element to append the XML tolocale
- the locale to generate the element default content for- Returns:
- the generated XML element
- See Also:
-
getPlainText
Description copied from interface:I_CmsXmlContentValue
Returns the value of this XML content node as a plain text String.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).- Specified by:
getPlainText
in interfaceI_CmsXmlContentValue
- Overrides:
getPlainText
in classA_CmsXmlContentValue
- Parameters:
cms
- an initialized instance of a CmsObject- Returns:
- the value of this XML content node as a plain text String
- See Also:
-
getSchemaDefinition
Description copied from interface:I_CmsXmlSchemaType
Returns a String representation of the XML definition for this schema type.- Returns:
- a String representation of the XML definition for this schema type
- See Also:
-
getStringValue
Description copied from interface:I_CmsXmlContentValue
Returns the value of this XML content node as a String.- Parameters:
cms
- an initialized instance of a CmsObject- Returns:
- the value of this XML content node as a String
- Throws:
CmsRuntimeException
- See Also:
-
getTypeName
Description copied from interface:I_CmsXmlSchemaType
Returns the schema type name.By convention, a XML schema type name has the form
"OpenCms + ${name}"
. Examples are"OpenCmsString"
or"OpenCmsBoolean"
.The schema type name is fixed by the implementation.
- Returns:
- the schema type name
- See Also:
-
isSearchable
Description copied from class:A_CmsXmlContentValue
The default implementation always returnstrue
.- Specified by:
isSearchable
in interfaceI_CmsXmlContentValue
- Overrides:
isSearchable
in classA_CmsXmlContentValue
- Returns:
true
in case this value is searchable by default- See Also:
-
newInstance
Description copied from interface:I_CmsXmlSchemaType
Creates a new instance of this XML schema type initialized with the given values.- Parameters:
name
- the name to use in the xml documentminOccurs
- minimum number of occurrencesmaxOccurs
- maximum number of occurrences- Returns:
- a new instance of this XML content type initialized with the given values
- See Also:
-
setStringValue
Description copied from interface:I_CmsXmlContentValue
Sets the provided String as value of this XML content node.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.
- Parameters:
cms
- an initialized instance of a CmsObjectvalue
- the value to set- Throws:
CmsIllegalArgumentException
- See Also:
-