org.opencms.util

Class CmsHtmlConverterOption

java.lang.Object

org.opencms.util.CmsHtmlConverterOption

public class CmsHtmlConverterOption
extends java.lang.Object

Represents a single HTML converter configuration as defined in the OpenCms configuration file opencms-vfs.xml.

This is only used to write back the definitions to the configuration file.

Constructor Summary

Constructors

Constructor and Description
CmsHtmlConverterOption(java.lang.String name, java.lang.String className) Constructor, with parameters.
CmsHtmlConverterOption(java.lang.String name, java.lang.String className, boolean isDefault) Constructor, with parameters.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClassName() Returns the class used for HTML conversion of the configured option.
java.lang.String	getName() Returns the name of the configured option.
boolean	isDefault() Returns if the option is an automatically generated default option.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsHtmlConverterOption

public CmsHtmlConverterOption(java.lang.String name,
                      java.lang.String className)

Constructor, with parameters.

Parameters:

name - the name of the configured option

className - the class used for HTML conversion of the configured option

CmsHtmlConverterOption

public CmsHtmlConverterOption(java.lang.String name,
                      java.lang.String className,
                      boolean isDefault)

Constructor, with parameters.

Parameters:

name - the name of the configured option

className - the class used for HTML conversion of the configured option

isDefault - the flag indicating if this is an automatically generated default option

Method Detail

getClassName

public java.lang.String getClassName()

Returns the class used for HTML conversion of the configured option.

Returns:

the class used for HTML conversion of the configured option

getName

public java.lang.String getName()

Returns the name of the configured option.

Returns:

the name of the configured option

isDefault

public boolean isDefault()

Returns if the option is an automatically generated default option.

Returns:

true if the option is an automatically generated default option, otherwise false