@ConsumerType
public interface ContentTypeAdapter
Provides a format adapter.
Implementations of this interface are used to convert a certain text format from and to HTML.
By contract, the conversion to HTML must be as precise as possible, as it is used
for render the fragment. I.e., the HTML created by toHTML(String)
is
eventually displayed to the end user.
While it is recommended to provide an "as precise as possible" conversion from HTML
to the target format as well, it is not absolutely required: fromHTML(String)
is only used for manual format changes where it is assumed that the author has to tweak
the results manually anyway.
Modifier and Type | Method and Description |
---|---|
String |
fromHTML(String html)
Converts the given HTML text into the represented text format.
|
String |
getContentType()
Returns the MIME type the adapter is responsible for.
|
String |
toHTML(String formattedText)
Converts the given text that is assumed to be in the adapter's format into a
valid HTML fragment.
|
String getContentType()
String fromHTML(String html) throws ContentFragmentException
html
- The HTML text to convertContentFragmentException
- if the conversion failsString toHTML(String formattedText) throws ContentFragmentException
Converts the given text that is assumed to be in the adapter's format into a valid HTML fragment.
The returned HTML fragment must not have a root tag (like <html>, <body> or <div>).
Note that "is assumed to be in the transformer's format" means that you can't rely on the input being syntactically correct (unless the editor implementation ensures it in the UI). Hence the implementation should handle syntactical errors gracefully. In a worst case scenario, the original text should be treated as plain text.
formattedText
- The text to be converted to HTML; supposed to be in the
adapter's formatContentFragmentException
- if the conversion failsCopyright © 2010 - 2020 Adobe. All Rights Reserved