Package org.ametys.cms.transformation

Interface RichTextTransformer

All Known Implementing Classes:

AbstractRichTextTransformer, DocbookTransformer, HTMLTransformer, HTMLTransformer

public interface RichTextTransformer

Transform back and forth between a String and a RichText.

Method Summary

Modifier and Type	Method	Description
void	transform(String source, RichText dest)	Transform a String into a RichText.
void	transform(String source, ModifiableRichText dest)	Deprecated. use transform(String, RichText) instead
void	transformForEditing(RichText source, DataContext dataContext, StringBuilder dest)	Transform a RichText into a StringBuilder.
void	transformForEditing(ModifiableRichText source, StringBuilder dest)	Deprecated. use transformForEditing(RichText, DataContext, StringBuilder) instead
void	transformForRendering(RichText source, ContentHandler handler)	SAXes a RichText into a ContentHandler for rendering purposes.
void	transformForRendering(RichText source, ContentHandler handler)	Deprecated. use transformForRendering(RichText, ContentHandler) instead

Method Detail

transform

@Deprecated
void transform(String source,
               ModifiableRichText dest)
        throws AmetysRepositoryException,
               IOException

Deprecated.

use transform(String, RichText) instead

Transform a String into a ModifiableRichText.

Parameters:

source - the source.

dest - the ModifiableRichText to populate.

Throws:

AmetysRepositoryException - if an error occurs.

IOException - if an error occurs.

transform

void transform(String source,
               RichText dest)
        throws AmetysRepositoryException,
               IOException

Transform a String into a RichText.

Parameters:

source - the source.

dest - the RichText to populate.

Throws:

AmetysRepositoryException - if an error occurs.

IOException - if an error occurs.

transformForEditing

@Deprecated
void transformForEditing(ModifiableRichText source,
                         StringBuilder dest)
                  throws AmetysRepositoryException,
                         IOException

Deprecated.

use transformForEditing(RichText, DataContext, StringBuilder) instead

Transform a ModifiableRichText into a StringBuilder.

Parameters:

source - the source.

dest - the StringBuilder to populate.

Throws:

AmetysRepositoryException - if an error occurs.

IOException - if an error occurs.

transformForEditing

void transformForEditing(RichText source,
                         DataContext dataContext,
                         StringBuilder dest)
                  throws AmetysRepositoryException,
                         IOException

Transform a RichText into a StringBuilder.

Parameters:

source - the source.

dataContext - the context of the rich text

dest - the StringBuilder to populate.

Throws:

AmetysRepositoryException - if an error occurs.

IOException - if an error occurs.

transformForRendering

@Deprecated
void transformForRendering(RichText source,
                           ContentHandler handler)
                    throws AmetysRepositoryException,
                           SAXException,
                           IOException

Deprecated.

use transformForRendering(RichText, ContentHandler) instead

SAXes a RichText into a ContentHandler for rendering purposes.

Parameters:

source - the source.

handler - the StringBuilder to populate.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

transformForRendering

void transformForRendering(RichText source,
                           ContentHandler handler)
                    throws AmetysRepositoryException,
                           SAXException,
                           IOException

SAXes a RichText into a ContentHandler for rendering purposes.

Parameters:

source - the source.

handler - the StringBuilder to populate.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.