|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Handles special XML content livetime events, and also provides XML content editor rendering hints.
Field Summary | |
static java.lang.String[] |
ATTRIBUTE_ARRAY
Array of all allowed attribute mapping names. |
static java.util.List |
ATTRIBUTES
List of all allowed attribute mapping names, for fast lookup. |
static java.lang.String |
MAPTO_ATTRIBUTE
Prefix for attribute mappings. |
static java.lang.String |
MAPTO_PROPERTY
Prefix for property mappings. |
static java.lang.String |
MAPTO_PROPERTY_INDIVIDUAL
Prefix for property mappings. |
static java.lang.String |
MAPTO_PROPERTY_LIST
Prefix for property list mappings. |
static java.lang.String |
MAPTO_PROPERTY_LIST_INDIVIDUAL
Prefix for property list mappings. |
static java.lang.String |
MAPTO_PROPERTY_LIST_SHARED
Prefix for property list mappings. |
static java.lang.String |
MAPTO_PROPERTY_SHARED
Prefix for property mappings. |
Method Summary | |
java.lang.String |
getConfiguration(I_CmsXmlSchemaType type)
Returns the configuration String value for the widget used to edit the given XML content schema type. |
java.lang.String |
getDefault(CmsObject cms,
I_CmsXmlContentValue value,
java.util.Locale locale)
Returns the default String value for the given XML content schema type object in the given XML content. |
CmsMessages |
getMessages(java.util.Locale locale)
Returns the CmsMessages that are used to resolve localized keys
for the given locale in this content handler. |
java.lang.String |
getPreview(CmsObject cms,
CmsXmlContent content,
java.lang.String resourcename)
Returns the preview URI for the given XML content value object to be displayed in the editor. |
I_CmsWidget |
getWidget(I_CmsXmlContentValue value)
Returns the editor widget that should be used for the given XML content value. |
void |
initialize(org.dom4j.Element appInfoElement,
CmsXmlContentDefinition contentDefinition)
Initializes this content handler for the given XML content definition by analyzing the "appinfo" node. |
CmsFile |
prepareForWrite(CmsObject cms,
CmsXmlContent content,
CmsFile file)
Prepares the given XML content to be written to the OpenCms VFS. |
void |
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. |
CmsXmlContentErrorHandler |
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. |
Field Detail |
public static final java.lang.String[] ATTRIBUTE_ARRAY
public static final java.util.List ATTRIBUTES
public static final java.lang.String MAPTO_ATTRIBUTE
public static final java.lang.String MAPTO_PROPERTY
public static final java.lang.String MAPTO_PROPERTY_INDIVIDUAL
public static final java.lang.String MAPTO_PROPERTY_LIST
public static final java.lang.String MAPTO_PROPERTY_LIST_INDIVIDUAL
public static final java.lang.String MAPTO_PROPERTY_LIST_SHARED
public static final java.lang.String MAPTO_PROPERTY_SHARED
Method Detail |
public java.lang.String getConfiguration(I_CmsXmlSchemaType type)
If no configuration value is available, this method must return null
.
type
- the value to get the widget configuration for
public java.lang.String getDefault(CmsObject cms, I_CmsXmlContentValue value, java.util.Locale locale)
If a schema type does not have a default value, this method must return null
.
cms
- the current users OpenCms contextvalue
- the value to get the default forlocale
- the currently selected locale for the value
I_CmsXmlSchemaType.getDefault(Locale)
public CmsMessages getMessages(java.util.Locale locale)
CmsMessages
that are used to resolve localized keys
for the given locale in this content handler.
If no localized messages are configured for this content handler,
this method returns null
.
locale
- the locale to get the messages for
CmsMessages
that are used to resolve localized keys
for the given locale in this content handlerpublic java.lang.String getPreview(CmsObject cms, CmsXmlContent content, java.lang.String resourcename)
If null
is returned, no preview is possible for contents using this handler.
cms
- the current OpenCms user contextcontent
- the XML content to display the preview URI forresourcename
- the name in the VFS of the resource that is currently edited
public I_CmsWidget getWidget(I_CmsXmlContentValue value) throws CmsXmlException
The handler implementations should use the "appinfo" node of the XML content definition schema to define the mappings of elements to widgets.
value
- the XML content value to get the widget for
CmsXmlException
- if something goes wrongpublic void initialize(org.dom4j.Element appInfoElement, CmsXmlContentDefinition contentDefinition) throws CmsXmlException
appInfoElement
- the "appinfo" element root node to analyzecontentDefinition
- the XML content definition that XML content handler belongs to
CmsXmlException
- if something goes wrongpublic CmsFile prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file) throws CmsException
This method is alway called before any content gets written. It can be used to perform XML validation, pretty - printing or customized actions on the given XML content.
cms
- the current OpenCms user contextcontent
- the XML content to be writtenfile
- the resource the XML content in it's current state was unmarshalled from
CmsException
- in case something goes wrongpublic void resolveMapping(CmsObject cms, CmsXmlContent content, I_CmsXmlContentValue value) throws CmsException
cms
- the current OpenCms user contextcontent
- the XML content to resolve the mappings forvalue
- the value to resolve the mappings for
CmsException
- if something goes wrongpublic CmsXmlContentErrorHandler resolveValidation(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler)
The errorHandler parameter is optional, if null
is given a new error handler
instance must be created.
cms
- the current OpenCms user contextvalue
- the value to resolve the validation rules forerrorHandler
- (optional) an error handler instance that contains previous error or warnings
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |