org.ametys.cms.data

Class RichText

java.lang.Object

org.ametys.cms.data.Resource

org.ametys.cms.data.RichText

public class RichText
extends Resource

CLass representing a rich text

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__ATTACHMENT_CONTENT_IDENTIFIER
private static String	__RICH_TEXT_ENCODING
private static String	__RICH_TEXT_MIME_TYPE
protected Map<String,NamedResource>	_addedAttachments the files contained in the rich text
protected Map<String,List<String>>	_annotations the rich text's annotations
protected Map<String,NamedResource>	_attachments the files contained in the rich text
protected RepositoryData	_folderData The resource's repository data
protected Collection<String>	_removedAttachments the files contained in the rich text

Fields inherited from class org.ametys.cms.data.Resource

_buffer, _encoding, _lastModificationDate, _mimeType, _repositoryData, _tmpFile

Constructor Summary

Constructors

Constructor and Description
RichText() Default constructor
RichText(RepositoryData richTextData, RepositoryData folderData) Constructor to use when reading the rich text from the repository

Method Summary

Modifier and Type	Method and Description
private NamedResource	_getAttachmentFromFolderData(String filename)
private List<NamedResource>	_getAttachmentsFromFolderData()
void	addAnnotations(String name, String... values) Add annotations to the rich text
void	addAttachment(NamedResource attachment) Adds an attachment to the rich text
Collection<NamedResource>	getAddedAttachments() Retrieves the attachments that have been added to the rich text
Map<String,List<String>>	getAllAnnotations() Retrieves the rich text's annotations
List<String>	getAnnotations(String name) Retrieves the rich text's annotations of the given name
NamedResource	getAttachment(String filename) Retrieves the rich text's attachment with the given name, or null if there is no such attachment
Collection<String>	getAttachmentNames() Retrieves the names of the rich text's attachments
Collection<NamedResource>	getAttachments() Retrieves the rich text's attachments
String	getEncoding() Retrieves the encoding of the resource's data
String	getMimeType() Retrieves the mime type of the resource's data
Collection<String>	getRemovedAttachments() Retrieves the names of the removed attachments of the rich text
boolean	hasAttachment(String filename) Checks if the rich text has an attachment with the given name
void	removeAllAnnotations() Removes all rich text's annotations
void	removeAnnotations(String name) Removes the rich text's annotations of the given name
void	removeAttachment(String filename) Remove an attachment from the rich text
void	removeAttachments() Remove all the attachments from the rich text
void	setEncoding(String encoding) Sets the encoding of the resource's data
void	setMimeType(String mimeType) Sets the mime type of the resource's data

Methods inherited from class org.ametys.cms.data.Resource

closeOutputStream, getInputStream, getLastModificationDate, getLength, getOutputStream, setInputStream, setLastModificationDate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

__ATTACHMENT_CONTENT_IDENTIFIER

private static final String __ATTACHMENT_CONTENT_IDENTIFIER

See Also:

Constant Field Values

__RICH_TEXT_MIME_TYPE

private static final String __RICH_TEXT_MIME_TYPE

See Also:

Constant Field Values

__RICH_TEXT_ENCODING

private static final String __RICH_TEXT_ENCODING

See Also:

Constant Field Values

_annotations

protected Map<String,List<String>> _annotations

the rich text's annotations

_folderData

protected RepositoryData _folderData

The resource's repository data

_attachments

protected Map<String,NamedResource> _attachments

the files contained in the rich text

_addedAttachments

protected Map<String,NamedResource> _addedAttachments

the files contained in the rich text

_removedAttachments

protected Collection<String> _removedAttachments

the files contained in the rich text

Constructor Detail

RichText

public RichText()

Default constructor

RichText

public RichText(RepositoryData richTextData,
                RepositoryData folderData)

Constructor to use when reading the rich text from the repository

Parameters:

richTextData - the repository data containing the rich text's data

folderData - the repository data containing the folder's data

Method Detail

getMimeType

public String getMimeType()

Description copied from class: Resource

Retrieves the mime type of the resource's data

Overrides:

getMimeType in class Resource

Returns:

the mime type of the resource's data

setMimeType

public void setMimeType(String mimeType)

Description copied from class: Resource

Sets the mime type of the resource's data

Overrides:

setMimeType in class Resource

Parameters:

mimeType - the mime type to set

getEncoding

public String getEncoding()

Description copied from class: Resource

Retrieves the encoding of the resource's data

Overrides:

getEncoding in class Resource

Returns:

the encoding of the resource's data

setEncoding

public void setEncoding(String encoding)

Description copied from class: Resource

Sets the encoding of the resource's data

Overrides:

setEncoding in class Resource

Parameters:

encoding - the encoding to set

getAllAnnotations

public Map<String,List<String>> getAllAnnotations()

Retrieves the rich text's annotations

Returns:

the rich text's annotations

getAnnotations

public List<String> getAnnotations(String name)

Retrieves the rich text's annotations of the given name

Parameters:

name - the name of the annotations to retrieve

Returns:

the rich text's annotations of the given name

addAnnotations

public void addAnnotations(String name,
                           String... values)

Add annotations to the rich text

Parameters:

name - the name of the annotations to add

values - annotations to add

removeAllAnnotations

public void removeAllAnnotations()

Removes all rich text's annotations

removeAnnotations

public void removeAnnotations(String name)

Removes the rich text's annotations of the given name

Parameters:

name - the name of the annotations to remove

getAttachmentNames

public Collection<String> getAttachmentNames()

Retrieves the names of the rich text's attachments

Returns:

the names of the rich text's attachments

getAttachments

public Collection<NamedResource> getAttachments()

Retrieves the rich text's attachments

Returns:

the rich text's attachments

_getAttachmentsFromFolderData

private List<NamedResource> _getAttachmentsFromFolderData()

getAddedAttachments

public Collection<NamedResource> getAddedAttachments()

Retrieves the attachments that have been added to the rich text

Returns:

the added attachments

getRemovedAttachments

public Collection<String> getRemovedAttachments()

Retrieves the names of the removed attachments of the rich text

Returns:

the names of the removed attachments

hasAttachment

public boolean hasAttachment(String filename)

Checks if the rich text has an attachment with the given name

Parameters:

filename - the name of the attachment

Returns:

true if the rich text has an attachment with the given name, false otherwise

getAttachment

public NamedResource getAttachment(String filename)

Retrieves the rich text's attachment with the given name, or null if there is no such attachment

Parameters:

filename - the name of the attachment to retrieve

Returns:

the rich text's attachment with the given name

_getAttachmentFromFolderData

private NamedResource _getAttachmentFromFolderData(String filename)

addAttachment

public void addAttachment(NamedResource attachment)

Adds an attachment to the rich text

Parameters:

attachment - the attachment to add

removeAttachment

public void removeAttachment(String filename)

Remove an attachment from the rich text

Parameters:

filename - the name of the attachment to remove

removeAttachments

public void removeAttachments()

Remove all the attachments from the rich text