Package org.ametys.cms.data.type.impl
Class RichTextRepositoryElementType
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.core.model.type.AbstractModelItemType
org.ametys.core.model.type.AbstractElementType<RichText>
org.ametys.cms.data.type.AbstractRichTextElementType
org.ametys.cms.data.type.impl.RichTextRepositoryElementType
- All Implemented Interfaces:
ComplexRepositoryElementType<RichText>
,RepositoryElementType<RichText>
,RepositoryModelItemType
,ElementType<RichText>
,ModelItemType
,LogEnabled
,PluginAware
,Component
,Serviceable
- Direct Known Subclasses:
HTMLRichTextRepositoryElementType
,RichTextContentElementType
public class RichTextRepositoryElementType
extends AbstractRichTextElementType
implements ComplexRepositoryElementType<RichText>
Class for rich text type of elements stored in the repository
-
Field Summary
Fields inherited from class org.ametys.cms.data.type.AbstractRichTextElementType
_manager, _resolver, _richTextHandlerFactory, _richTextTransformer
Fields inherited from class org.ametys.core.model.type.AbstractElementType
_jsonUtils
Fields inherited from interface org.ametys.plugins.repository.data.type.ComplexRepositoryElementType
TYPE_ID_DATA_NAME
Fields inherited from interface org.ametys.plugins.repository.data.type.RepositoryModelItemType
EMPTY_METADATA_SUFFIX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
emptySingleValue
(ModifiableRepositoryData parentData, String name) Empties the single value into the given repositoryData This method is called by theComplexRepositoryElementType.write(ModifiableRepositoryData, String, Object)
method, when the given value isnull
externalizableValueToSAX
(Object value, DataContext context) Retrieve the value to SAX for externalizable dataRetrieves the type of repository data used for this typeboolean
isSingleValueEmpty
(RepositoryData singleValueData) Checks if the single value is emptyreadSingleValue
(RepositoryData singleValueData) Read the single value in the given repository databoolean
Determines if the existing value has to be removed before writing the new onevoid
writeSingleValue
(ModifiableRepositoryData parentData, String name, RichText value) Write the single value into the given repository data This method is called by theComplexRepositoryElementType.write(ModifiableRepositoryData, String, Object)
method, once for each value if the value is an arrayMethods inherited from class org.ametys.cms.data.type.AbstractRichTextElementType
_compareMultipleValues, _compareSingleValues, _getLocalMediaObjectContentHandler, _singleValueFromXML, _singleValueToJSON, _singleValueToJSONForEdition, _singleValueToSAX, _valueToSAXForEdition, convertValue, fromJSONForClient, isSimple, service, toString
Methods inherited from class org.ametys.core.model.type.AbstractElementType
_getValueAttributes, _isMultiple, _isSingle, _isValueFromXMLMultiple, _useJSONForEdition, _valueToJSON, _valueToSAX, _valueToSAX, castValue, compareValues, getManagedClass, getManagedClassArray, isCompatible, parseConfiguration, valueFromXML, valueToJSONForClient, valueToJSONForEdition, valueToSAX, valueToSAXForEdition
Methods inherited from class org.ametys.core.model.type.AbstractModelItemType
_getContextAttributes, getId, setPluginInfo
Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.ametys.plugins.repository.data.type.ComplexRepositoryElementType
hasNonEmptyValue, isCompatible, read, write
Methods inherited from interface org.ametys.runtime.model.type.ElementType
castValue, compareValues, fromJSONForClient, getManagedClass, getManagedClassArray, isCompatible, isSimple, parseConfiguration, toString, valueFromXML, valueToJSONForClient, valueToJSONForEdition
Methods inherited from interface org.ametys.runtime.model.type.ModelItemType
getId, valueToSAX, valueToSAX, valueToSAXForEdition
Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware
setPluginInfo
Methods inherited from interface org.ametys.plugins.repository.data.type.RepositoryModelItemType
hasValue, isMultiple, remove
-
Constructor Details
-
RichTextRepositoryElementType
public RichTextRepositoryElementType()
-
-
Method Details
-
isSingleValueEmpty
Description copied from interface:ComplexRepositoryElementType
Checks if the single value is empty- Specified by:
isSingleValueEmpty
in interfaceComplexRepositoryElementType<RichText>
- Parameters:
singleValueData
- repository data containing the value to check- Returns:
true
if the value is empty,false
otherwise
-
readSingleValue
Description copied from interface:ComplexRepositoryElementType
Read the single value in the given repository data- Specified by:
readSingleValue
in interfaceComplexRepositoryElementType<RichText>
- Parameters:
singleValueData
- repository data containing the value- Returns:
- the value. Can return null if the given data does not contain the necessary elements
-
emptySingleValue
Description copied from interface:ComplexRepositoryElementType
Empties the single value into the given repositoryData This method is called by theComplexRepositoryElementType.write(ModifiableRepositoryData, String, Object)
method, when the given value isnull
- Specified by:
emptySingleValue
in interfaceComplexRepositoryElementType<RichText>
- Parameters:
parentData
- repository where to empty the single value.name
- the name of the element to empty
-
writeSingleValue
Description copied from interface:ComplexRepositoryElementType
Write the single value into the given repository data This method is called by theComplexRepositoryElementType.write(ModifiableRepositoryData, String, Object)
method, once for each value if the value is an array- Specified by:
writeSingleValue
in interfaceComplexRepositoryElementType<RichText>
- Parameters:
parentData
- repository where to store the single value.name
- the name of the element to writevalue
- the single value to write. Can be null. In this case, an empty data must be created
-
externalizableValueToSAX
Description copied from interface:RepositoryElementType
Retrieve the value to SAX for externalizable data- Specified by:
externalizableValueToSAX
in interfaceRepositoryElementType<RichText>
- Parameters:
value
- the value to SAX This view item gives context for the SAX event that will be generated here.context
- The context of the data to SAX- Returns:
- the value to SAX for externalizable data
-
removeValueBeforeWritingIt
Description copied from interface:ComplexRepositoryElementType
Determines if the existing value has to be removed before writing the new one- Specified by:
removeValueBeforeWritingIt
in interfaceComplexRepositoryElementType<RichText>
- Returns:
true
if the previous value has to be removed,false
otherwise
-
getRepositoryDataType
Description copied from interface:RepositoryModelItemType
Retrieves the type of repository data used for this type- Specified by:
getRepositoryDataType
in interfaceRepositoryModelItemType
- Returns:
- the type of repository data used for this type
-