com.frameworkset.platform.cms.driver.htmlconverter

Interface I_CmsHtmlConverterInterface

All Superinterfaces:

java.io.Serializable

Deprecated.

Will not be supported past the OpenCms 6 release.

public interface I_CmsHtmlConverterInterface
extends java.io.Serializable

Interface definition of CmsHtmlConverter with declaration of necessary methods.

Method Summary

Modifier and Type	Method and Description
boolean	converterConfigured() Deprecated. Checks whether CmsHtmlConverter is already configured or not.
void	convertHTML(java.io.Reader in, java.io.Writer out) Deprecated. Transforms HTML code into user defined output.
java.lang.String	convertHTML(java.lang.String inString) Deprecated. Transforms HTML code into user defined output.
java.lang.String	getConverterConfFile() Deprecated. If defined, returns filename of CmsHtmlConverter configuration file.
int	getNumberErrors() Deprecated. Returns the number of found errors in last parsed html code.
java.lang.String	getTidyConfFile() Deprecated. If defined, returns JTidy configuration filename.
boolean	hasErrors(java.io.InputStream input) Deprecated. Checks if HTML code has errors.
boolean	hasErrors(java.lang.String inString) Deprecated. Checks if HTML code has errors.
void	setConverterConfFile(java.lang.String confFile) Deprecated. Configures CmsHtmlConverter from file.
void	setConverterConfString(java.lang.String configuration) Deprecated. Configures CmsHtmlConverter from string.
void	setTidyConfFile(java.lang.String fileName) Deprecated. Configures JTidy from file.
void	showErrors(java.io.InputStream input, java.io.OutputStream output) Deprecated. Checks if HTML code has errors and lists errors.
java.lang.String	showErrors(java.lang.String inString) Deprecated. Checks if HTML code has errors and lists errors.
boolean	tidyConfigured() Deprecated. Checks whether JTidy is already configured or not.

Method Detail

setTidyConfFile

void setTidyConfFile(java.lang.String fileName)

Deprecated.

Configures JTidy from file.

Parameters:

fileName - filename of JTidy configuration file

getTidyConfFile

java.lang.String getTidyConfFile()

Deprecated.

If defined, returns JTidy configuration filename.

Returns:

filename of JTidy configuration file

tidyConfigured

boolean tidyConfigured()

Deprecated.

Checks whether JTidy is already configured or not.

Returns:

true if JTidy configuration file is set, otherwise false

setConverterConfFile

void setConverterConfFile(java.lang.String confFile)

Deprecated.

Configures CmsHtmlConverter from file.

Parameters:

confFile - filename of configuration file

setConverterConfString

void setConverterConfString(java.lang.String configuration)

Deprecated.

Configures CmsHtmlConverter from string.

Parameters:

configuration - string with CmsHtmlConverter configuration

getConverterConfFile

java.lang.String getConverterConfFile()

Deprecated.

If defined, returns filename of CmsHtmlConverter configuration file.

Returns:

filename of configuration file

converterConfigured

boolean converterConfigured()

Deprecated.

Checks whether CmsHtmlConverter is already configured or not.

Returns:

true if CmsHtmlConverter configuration is set, otherwise false

hasErrors

boolean hasErrors(java.lang.String inString)

Deprecated.

Checks if HTML code has errors.

Parameters:

inString - String with HTML code

Returns:

true if errors were detected, otherwise false

hasErrors

boolean hasErrors(java.io.InputStream input)

Deprecated.

Checks if HTML code has errors.

Parameters:

input - InputStream with HTML code

Returns:

true if errors were detected, otherwise false

getNumberErrors

int getNumberErrors()

Deprecated.

Returns the number of found errors in last parsed html code.

Returns:

int with number of errors

showErrors

java.lang.String showErrors(java.lang.String inString)

Deprecated.

Checks if HTML code has errors and lists errors.

Parameters:

inString - String with HTML code

Returns:

String with detected errors

showErrors

void showErrors(java.io.InputStream input,
                java.io.OutputStream output)

Deprecated.

Checks if HTML code has errors and lists errors.

Parameters:

input - InputStream with HTML code

output - OutputStream with detected errors

convertHTML

java.lang.String convertHTML(java.lang.String inString)

Deprecated.

Transforms HTML code into user defined output.

Parameters:

inString - String with HTML code

Returns:

String with transformed code

convertHTML

void convertHTML(java.io.Reader in,
                 java.io.Writer out)

Deprecated.

Transforms HTML code into user defined output.

Parameters:

in - InputStream with HTML code

out - OutputStream with transformed code