Package org.opencms.xml.types

Class CmsXmlDisplayFormatterValue

java.lang.Object

org.opencms.xml.types.A_CmsXmlContentValue

org.opencms.xml.types.A_CmsXmlValueTextBase

org.opencms.xml.types.CmsXmlDisplayFormatterValue

All Implemented Interfaces:

Comparable<I_CmsXmlSchemaType>, I_CmsWidgetParameter, I_CmsXmlContentValue, I_CmsXmlSchemaType

public class CmsXmlDisplayFormatterValue
extends A_CmsXmlValueTextBase

XML value type for display formatters.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.xml.types.I_CmsXmlContentValue

I_CmsXmlContentValue.SearchContentType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEPARATOR	The value separator string.

Fields inherited from class org.opencms.xml.types.A_CmsXmlValueTextBase

m_stringValue

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

Constructors

Constructor	Description
CmsXmlDisplayFormatterValue()	Creates a new, empty schema type descriptor of type "OpenCmsDisplayFormatter".
CmsXmlDisplayFormatterValue(String name, String minOccurs, String maxOccurs)	Creates a new schema type descriptor for the type "OpenCmsDisplayFormatter".
CmsXmlDisplayFormatterValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale, I_CmsXmlSchemaType type)	Creates a new XML content value of type "OpenCmsDisplayFormatter".

Method Summary

Modifier and Type	Method	Description
I_CmsXmlContentValue	createValue(I_CmsXmlDocument document, org.dom4j.Element element, Locale locale)	Creates a XML content value object for this type.
String	getDisplayType()	Returns the display resource type name.
String	getFormatterId()	Returns the formatter config id.
String	getSchemaDefinition()	Returns a String representation of the XML definition for this schema type.
String	getStringValue(CmsObject cms)	Returns the value of this XML content node as a String.
String	getTypeName()	Returns the schema type name.
I_CmsXmlSchemaType	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_CmsXmlValueTextBase

getPlainText

Methods inherited from class org.opencms.xml.types.A_CmsXmlContentValue

appendXmlSchema, compareTo, equals, generateXml, getChoiceMaxOccurs, getContentDefinition, getDefault, getDefault, getDocument, getElement, getId, getIndex, getKey, getLocale, getMaxIndex, getMaxOccurs, getMinOccurs, getName, getPath, getRelationType, getXmlIndex, hasError, hashCode, isChoiceOption, isChoiceType, isSearchable, 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

SEPARATOR

public static final String SEPARATOR

The value separator string.

See Also:

• Constant Field Values

Constructor Details

CmsXmlDisplayFormatterValue

public CmsXmlDisplayFormatterValue()

Creates a new, empty schema type descriptor of type "OpenCmsDisplayFormatter".

CmsXmlDisplayFormatterValue

public CmsXmlDisplayFormatterValue(I_CmsXmlDocument document,
 org.dom4j.Element element,
 Locale locale,
 I_CmsXmlSchemaType type)

Creates a new XML content value of type "OpenCmsDisplayFormatter".

Parameters:

document - the XML content instance this value belongs to

element - the XML element that contains this value

locale - the locale this value is created for

type - the type instance to create the value for

CmsXmlDisplayFormatterValue

public CmsXmlDisplayFormatterValue(String name,
 String minOccurs,
 String maxOccurs)

Creates a new schema type descriptor for the type "OpenCmsDisplayFormatter".

Parameters:

name - the name of the XML node containing the value according to the XML schema

minOccurs - minimum number of occurrences of this type according to the XML schema

maxOccurs - 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 to

element - the XML element to create the value from

locale - the locale to create the value for

Returns:

the created XML content value object

See Also:

• I_CmsXmlSchemaType.createValue(org.opencms.xml.I_CmsXmlDocument, org.dom4j.Element, java.util.Locale)

getDisplayType

public String getDisplayType()

Returns the display resource type name.

Returns:

the display resource type

getFormatterId

public String getFormatterId()

Returns the formatter config id.

Returns:

the formatter config id

getSchemaDefinition

public String 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:

• I_CmsXmlSchemaType.getSchemaDefinition()

getStringValue

public String getStringValue(CmsObject cms)
                      throws CmsRuntimeException

Description copied from interface: I_CmsXmlContentValue

Returns the value of this XML content node as a String.

Specified by:

getStringValue in interface I_CmsWidgetParameter

Specified by:

getStringValue in interface I_CmsXmlContentValue

Overrides:

getStringValue in class A_CmsXmlValueTextBase

Parameters:

cms - an initialized instance of a CmsObject

Returns:

the value of this XML content node as a String

Throws:

CmsRuntimeException

See Also:

• A_CmsXmlValueTextBase.getStringValue(org.opencms.file.CmsObject)

getTypeName

public String 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:

• I_CmsXmlSchemaType.getTypeName()

newInstance

public I_CmsXmlSchemaType newInstance(String name,
 String minOccurs,
 String maxOccurs)

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 document

minOccurs - minimum number of occurrences

maxOccurs - maximum number of occurrences

Returns:

a new instance of this XML content type initialized with the given values

See Also:

• I_CmsXmlSchemaType.newInstance(java.lang.String, java.lang.String, java.lang.String)

setStringValue

public void setStringValue(CmsObject cms,
 String value)

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.

Specified by:

setStringValue in interface I_CmsWidgetParameter

Specified by:

setStringValue in interface I_CmsXmlContentValue

Overrides:

setStringValue in class A_CmsXmlValueTextBase

Parameters:

cms - an initialized instance of a CmsObject

value - the value to set

See Also:

• A_CmsXmlValueTextBase.setStringValue(org.opencms.file.CmsObject, java.lang.String)