Package org.opencms.xml.types
Class CmsXmlVfsImageValue
- java.lang.Object
-
- org.opencms.xml.types.A_CmsXmlContentValue
-
- org.opencms.xml.types.CmsXmlVfsFileValue
-
- org.opencms.xml.types.CmsXmlVfsImageValue
-
- All Implemented Interfaces:
java.lang.Comparable<I_CmsXmlSchemaType>
,I_CmsWidgetParameter
,I_CmsXmlContentValue
,I_CmsXmlSchemaType
,I_CmsJsonFormattableValue
public class CmsXmlVfsImageValue extends CmsXmlVfsFileValue
Describes the XML content type "OpenCmsVfsImage".This type allows links to internal VFS images only.
- Since:
- 7.5.0
-
-
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 java.lang.String
NODE_SCALE
Node name for the scale element.static java.lang.String
PARAM_DESCRIPTION
Request parameter name for the description parameter.static java.lang.String
PARAM_FORMAT
Request parameter name for the format parameter.static java.lang.String
TYPE_NAME_IMAGE
The name of this type as used in the XML schema.-
Fields inherited from class org.opencms.xml.types.CmsXmlVfsFileValue
NO_LINK, TYPE_NAME, TYPE_VFS_LINK
-
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 CmsXmlVfsImageValue()
Creates a new, empty schema type descriptor of type "OpenCmsVfsImage".CmsXmlVfsImageValue(java.lang.String name, java.lang.String minOccurs, java.lang.String maxOccurs)
Creates a new schema type descriptor for the type "OpenCmsVfsImage".CmsXmlVfsImageValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsVfsImage".
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description I_CmsXmlContentValue
createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
Creates a XML content value object for this type.java.lang.String
getDescription(CmsObject cms)
Returns the description of the image.java.lang.String
getFormat(CmsObject cms)
Returns the format information of the image.java.lang.String
getRequestLink(CmsObject cms)
Returns the link without parameters from the string value.java.lang.String
getScaleOptions(CmsObject cms)
Returns the scale options of the image.java.lang.String
getSchemaDefinition()
Returns a String representation of the XML definition for this schema type.java.lang.String
getTypeName()
Returns the schema type name.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.void
setDescription(CmsObject cms, java.lang.String description)
Sets the description of the image.void
setFormat(CmsObject cms, java.lang.String format)
Sets the format information of the image.void
setScaleOptions(CmsObject cms, java.lang.String scaleOptions)
Sets the scale options of the image.void
setStringValue(CmsObject cms, java.lang.String value)
Sets the provided String as value of this XML content node.-
Methods inherited from class org.opencms.xml.types.CmsXmlVfsFileValue
fillEntry, generateXml, getLink, getPlainText, getStringValue, getUncheckedLink, isSearchable, setIdValue, toJson
-
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 Detail
-
NODE_SCALE
public static final java.lang.String NODE_SCALE
Node name for the scale element.- See Also:
- Constant Field Values
-
PARAM_DESCRIPTION
public static final java.lang.String PARAM_DESCRIPTION
Request parameter name for the description parameter.- See Also:
- Constant Field Values
-
PARAM_FORMAT
public static final java.lang.String PARAM_FORMAT
Request parameter name for the format parameter.- See Also:
- Constant Field Values
-
TYPE_NAME_IMAGE
public static final java.lang.String TYPE_NAME_IMAGE
The name of this type as used in the XML schema.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsXmlVfsImageValue
public CmsXmlVfsImageValue()
Creates a new, empty schema type descriptor of type "OpenCmsVfsImage".
-
CmsXmlVfsImageValue
public CmsXmlVfsImageValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale, I_CmsXmlSchemaType type)
Creates a new XML content value of type "OpenCmsVfsImage".- 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
-
CmsXmlVfsImageValue
public CmsXmlVfsImageValue(java.lang.String name, java.lang.String minOccurs, java.lang.String maxOccurs)
Creates a new schema type descriptor for the type "OpenCmsVfsImage".- 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 Detail
-
createValue
public I_CmsXmlContentValue createValue(I_CmsXmlDocument document, org.dom4j.Element element, java.util.Locale locale)
Description copied from interface:I_CmsXmlSchemaType
Creates a XML content value object for this type.- Specified by:
createValue
in interfaceI_CmsXmlSchemaType
- Overrides:
createValue
in classCmsXmlVfsFileValue
- 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:
I_CmsXmlSchemaType.createValue(I_CmsXmlDocument, org.dom4j.Element, Locale)
-
getDescription
public java.lang.String getDescription(CmsObject cms)
Returns the description of the image.- Parameters:
cms
- the current users context- Returns:
- the description of the image or an empty String
-
getFormat
public java.lang.String getFormat(CmsObject cms)
Returns the format information of the image.- Parameters:
cms
- the current users context- Returns:
- the format information of the image or an empty String
-
getRequestLink
public java.lang.String getRequestLink(CmsObject cms)
Returns the link without parameters from the string value.- Parameters:
cms
- the current users context- Returns:
- the link without parameters
-
getScaleOptions
public java.lang.String getScaleOptions(CmsObject cms)
Returns the scale options of the image.- Parameters:
cms
- the current users context- Returns:
- the scale options of the image or an empty String
-
getSchemaDefinition
public java.lang.String getSchemaDefinition()
Description copied from interface:I_CmsXmlSchemaType
Returns a String representation of the XML definition for this schema type.- Specified by:
getSchemaDefinition
in interfaceI_CmsXmlSchemaType
- Overrides:
getSchemaDefinition
in classCmsXmlVfsFileValue
- Returns:
- a String representation of the XML definition for this schema type
- See Also:
I_CmsXmlSchemaType.getSchemaDefinition()
-
getTypeName
public java.lang.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.
- Specified by:
getTypeName
in interfaceI_CmsXmlSchemaType
- Overrides:
getTypeName
in classCmsXmlVfsFileValue
- Returns:
- the schema type name
- See Also:
I_CmsXmlSchemaType.getTypeName()
-
newInstance
public I_CmsXmlSchemaType newInstance(java.lang.String name, java.lang.String minOccurs, java.lang.String maxOccurs)
Description copied from interface:I_CmsXmlSchemaType
Creates a new instance of this XML schema type initialized with the given values.- Specified by:
newInstance
in interfaceI_CmsXmlSchemaType
- Overrides:
newInstance
in classCmsXmlVfsFileValue
- 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:
I_CmsXmlSchemaType.newInstance(java.lang.String, java.lang.String, java.lang.String)
-
setDescription
public void setDescription(CmsObject cms, java.lang.String description)
Sets the description of the image.- Parameters:
cms
- the current users contextdescription
- the description of the image
-
setFormat
public void setFormat(CmsObject cms, java.lang.String format)
Sets the format information of the image.- Parameters:
cms
- the current users contextsformat
- the format information of the image
-
setScaleOptions
public void setScaleOptions(CmsObject cms, java.lang.String scaleOptions)
Sets the scale options of the image.- Parameters:
cms
- the current users contextscaleOptions
- the scale options of the image
-
setStringValue
public void setStringValue(CmsObject cms, java.lang.String value) throws CmsIllegalArgumentException
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 interfaceI_CmsWidgetParameter
- Specified by:
setStringValue
in interfaceI_CmsXmlContentValue
- Overrides:
setStringValue
in classCmsXmlVfsFileValue
- Parameters:
cms
- an initialized instance of a CmsObjectvalue
- the value to set- Throws:
CmsIllegalArgumentException
- See Also:
I_CmsXmlContentValue.setStringValue(org.opencms.file.CmsObject, java.lang.String)
-
-