Package org.opencms.util
Class A_CmsHtmlConverter
- java.lang.Object
-
- org.opencms.util.A_CmsHtmlConverter
-
- All Implemented Interfaces:
I_CmsHtmlConverter
- Direct Known Subclasses:
CmsHtmlConverterJTidy
public abstract class A_CmsHtmlConverter extends java.lang.Object implements I_CmsHtmlConverter
-
-
Constructor Summary
Constructors Constructor Description A_CmsHtmlConverter()
Empty constructor.A_CmsHtmlConverter(java.lang.String encoding, java.util.List<java.lang.String> modes)
Constructor, with parameters.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract java.lang.String
convertToString(java.lang.String htmlInput)
Converts the given HTML code according to the settings of this converter.java.lang.String
getEncoding()
Returns the encoding used for the HTML code conversion.java.util.List<java.lang.String>
getModes()
Returns the conversion modes to use as List of String parameters.void
init(java.lang.String encoding, java.util.List<java.lang.String> modes)
Initializes the HTML converter instance.
-
-
-
Constructor Detail
-
A_CmsHtmlConverter
public A_CmsHtmlConverter()
Empty constructor.Initializes with encoding
CmsEncoder.ENCODING_UTF_8
and with an empty String as mode.
-
A_CmsHtmlConverter
public A_CmsHtmlConverter(java.lang.String encoding, java.util.List<java.lang.String> modes)
Constructor, with parameters.- Parameters:
encoding
- the encoding used for the HTML code conversionmodes
- the conversion modes to use
-
-
Method Detail
-
convertToString
public abstract java.lang.String convertToString(java.lang.String htmlInput) throws java.io.UnsupportedEncodingException
Description copied from interface:I_CmsHtmlConverter
Converts the given HTML code according to the settings of this converter.- Specified by:
convertToString
in interfaceI_CmsHtmlConverter
- Parameters:
htmlInput
- the HTML input stored in a string- Returns:
- string containing the converted HTML
- Throws:
java.io.UnsupportedEncodingException
- if the encoding set for the conversion is not supported- See Also:
I_CmsHtmlConverter.convertToString(java.lang.String)
-
getEncoding
public java.lang.String getEncoding()
Description copied from interface:I_CmsHtmlConverter
Returns the encoding used for the HTML code conversion.- Specified by:
getEncoding
in interfaceI_CmsHtmlConverter
- Returns:
- the encoding used for the HTML code conversion
- See Also:
I_CmsHtmlConverter.getEncoding()
-
getModes
public java.util.List<java.lang.String> getModes()
Description copied from interface:I_CmsHtmlConverter
Returns the conversion modes to use as List of String parameters.- Specified by:
getModes
in interfaceI_CmsHtmlConverter
- Returns:
- the conversion modes to use as List of String parameters
- See Also:
I_CmsHtmlConverter.getModes()
-
init
public void init(java.lang.String encoding, java.util.List<java.lang.String> modes)
Description copied from interface:I_CmsHtmlConverter
Initializes the HTML converter instance.Possible values for the conversion mode are dependent from the converter implementation.
- Specified by:
init
in interfaceI_CmsHtmlConverter
- Parameters:
encoding
- the encoding used for the HTML code conversionmodes
- the conversion modes to use- See Also:
I_CmsHtmlConverter.init(java.lang.String, java.util.List)
-
-