Package com.helger.html.hc.config

Class HCConversionSettings

java.lang.Object

com.helger.html.hc.config.HCConversionSettings

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<IHCConversionSettings>, IHCConversionSettings, IHCConversionSettingsToNode

@NotThreadSafe
public class HCConversionSettings
extends Object
implements IHCConversionSettings

The default implementation of IHCConversionSettings containing the real settings for HTML output.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_CONSISTENCY_CHECKS	Default consistency checks: true
static com.helger.css.ECSSVersion	DEFAULT_CSS_VERSION	Default CSS version 3.0
static boolean	DEFAULT_EXTRACT_OUT_OF_BAND_NODES	Default extract out-of-band nodes: true
static boolean	DEFAULT_INDENT_AND_ALIGN_CSS	Default indent and align CSS: true
static boolean	DEFAULT_INDENT_AND_ALIGN_HTML	Default indent and align HTML: true
static boolean	DEFAULT_INDENT_AND_ALIGN_JS	Default indent and align JS: true

Constructor Summary

Constructors

Constructor	Description
HCConversionSettings(EHTMLVersion eHTMLVersion)	Constructor
HCConversionSettings(IHCConversionSettings aBase)	Copy constructor.
HCConversionSettings(IHCConversionSettings aBase, EHTMLVersion eHTMLVersion)	Kind of copy constructor.

Method Summary

Modifier and Type	Method	Description
boolean	areConsistencyChecksEnabled()
static com.helger.css.writer.CSSWriterSettings	createDefaultCSSWriterSettings()
static IHCCustomizer	createDefaultCustomizer()
static JSWriterSettings	createDefaultJSWriterSettings()
static com.helger.xml.serialize.write.XMLWriterSettings	createDefaultXMLWriterSettings(EHTMLVersion eHTMLVersion)
HCConversionSettings	getClone()
HCConversionSettings	getClone(EHTMLVersion eHTMLVersion)	Get a clone of this settings, but with a different HTML version.
HCConversionSettings	getCloneIfNecessary(EHTMLVersion eHTMLVersion)	Get a clone of this settings, but with a different HTML version.
com.helger.css.writer.CSSWriterSettings	getCSSWriterSettings()
IHCCustomizer	getCustomizer()
String	getHTMLNamespaceURI()
EHTMLVersion	getHTMLVersion()
JSWriterSettings	getJSWriterSettings()
com.helger.css.writer.CSSWriterSettings	getMutableCSSWriterSettings()
JSWriterSettings	getMutableJSWriterSettings()
com.helger.xml.serialize.write.XMLWriterSettings	getMutableXMLWriterSettings()
com.helger.xml.serialize.write.XMLWriterSettings	getXMLWriterSettings()
static boolean	isDefaultCustomizer(IHCCustomizer aCustomizer)	Check if the passed customizer is a default customizer.
boolean	isExtractOutOfBandNodes()
HCConversionSettings	setConsistencyChecksEnabled(boolean bConsistencyChecksEnabled)	Enable or disable the consistency checks.
HCConversionSettings	setCSSWriterSettings(com.helger.css.ICSSWriterSettings aCSSWriterSettings)	Set the CSS writer settings to be used.
HCConversionSettings	setCSSWriterSettingsOptimized(boolean bOptimized)
HCConversionSettings	setCustomizer(IHCCustomizer aCustomizer)	Set the global customizer to be used to globally customize created elements.
HCConversionSettings	setExtractOutOfBandNodes(boolean bExtractOutOfBandNodes)	Enable or disable the extraction of out-of-band nodes.
HCConversionSettings	setHTMLVersion(EHTMLVersion eHTMLVersion)	Change the HTML version.
HCConversionSettings	setJSWriterSettings(IJSWriterSettings aJSWriterSettings)	Set the JS formatter settings to be used.
HCConversionSettings	setJSWriterSettingsOptimized(boolean bOptimized)
HCConversionSettings	setToDefault()
HCConversionSettings	setToOptimized()
HCConversionSettings	setXMLWriterSettings(com.helger.xml.serialize.write.IXMLWriterSettings aXMLWriterSettings)	Set the XML writer settings to be used.
HCConversionSettings	setXMLWriterSettingsOptimized(boolean bOptimized)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.html.hc.IHCConversionSettingsToNode

getCharset

Field Detail

DEFAULT_INDENT_AND_ALIGN_HTML

public static final boolean DEFAULT_INDENT_AND_ALIGN_HTML

Default indent and align HTML: true

See Also:

Constant Field Values

DEFAULT_CSS_VERSION

public static final com.helger.css.ECSSVersion DEFAULT_CSS_VERSION

Default CSS version 3.0

DEFAULT_INDENT_AND_ALIGN_CSS

public static final boolean DEFAULT_INDENT_AND_ALIGN_CSS

Default indent and align CSS: true

See Also:

Constant Field Values

DEFAULT_INDENT_AND_ALIGN_JS

public static final boolean DEFAULT_INDENT_AND_ALIGN_JS

Default indent and align JS: true

See Also:

Constant Field Values

DEFAULT_CONSISTENCY_CHECKS

public static final boolean DEFAULT_CONSISTENCY_CHECKS

Default consistency checks: true

See Also:

Constant Field Values

DEFAULT_EXTRACT_OUT_OF_BAND_NODES

public static final boolean DEFAULT_EXTRACT_OUT_OF_BAND_NODES

Default extract out-of-band nodes: true

See Also:

Constant Field Values

Constructor Detail

HCConversionSettings

public HCConversionSettings(@Nonnull
                            EHTMLVersion eHTMLVersion)

Constructor

Parameters:

eHTMLVersion - The HTML version to use. May not be null.

HCConversionSettings

public HCConversionSettings(@Nonnull
                            IHCConversionSettings aBase)

Copy constructor. Also creates a copy of the XMLWriterSettings and the CSSWriterSettings.

Parameters:

aBase - Object to copy the settings from. May not be null.

HCConversionSettings

public HCConversionSettings(@Nonnull
                            IHCConversionSettings aBase,
                            @Nonnull
                            EHTMLVersion eHTMLVersion)

Kind of copy constructor. Also creates a copy of the XMLWriterSettings and the CSSWriterSettings.

Parameters:

aBase - Object to copy the settings from. May not be null.

eHTMLVersion - A different HTML version to use than the one from the base settings

Method Detail

createDefaultXMLWriterSettings

@Nonnull
public static com.helger.xml.serialize.write.XMLWriterSettings createDefaultXMLWriterSettings(@Nonnull
                                                                                              EHTMLVersion eHTMLVersion)

createDefaultCSSWriterSettings

@Nonnull
public static com.helger.css.writer.CSSWriterSettings createDefaultCSSWriterSettings()

createDefaultJSWriterSettings

@Nonnull
public static JSWriterSettings createDefaultJSWriterSettings()

createDefaultCustomizer

@Nullable
public static IHCCustomizer createDefaultCustomizer()

Returns:

The default customizer. Currently null.

See Also:

isDefaultCustomizer(IHCCustomizer)

isDefaultCustomizer

public static boolean isDefaultCustomizer(@Nullable
                                          IHCCustomizer aCustomizer)

Check if the passed customizer is a default customizer.

Parameters:

aCustomizer - Customizer to check.

Returns:

true if the passed customizer is the default customizer, false otherwise.

See Also:

createDefaultCustomizer()

setHTMLVersion

@Nonnull
public HCConversionSettings setHTMLVersion(@Nonnull
                                           EHTMLVersion eHTMLVersion)

Change the HTML version. Note: this does NOT change the XMLWriterSettings!

Parameters:

eHTMLVersion - The HTML version to use.

Returns:

this

getHTMLVersion

@Nonnull
public EHTMLVersion getHTMLVersion()

Specified by:

getHTMLVersion in interface IHCConversionSettingsToNode

Returns:

The HTML version to be used to transform HC nodes into micro nodes. Never null.

getHTMLNamespaceURI

@Nullable
public String getHTMLNamespaceURI()

Specified by:

getHTMLNamespaceURI in interface IHCConversionSettingsToNode

Returns:

The namespace URI of the HTML version. This should result in the same as calling getHTMLVersion().getNamespaceURI()

setXMLWriterSettingsOptimized

@Nonnull
public HCConversionSettings setXMLWriterSettingsOptimized(boolean bOptimized)

setXMLWriterSettings

@Nonnull
public HCConversionSettings setXMLWriterSettings(@Nonnull
                                                 com.helger.xml.serialize.write.IXMLWriterSettings aXMLWriterSettings)

Set the XML writer settings to be used. By default values equivalent to XMLWriterSettings.DEFAULT_XML_SETTINGS are used.

Parameters:

aXMLWriterSettings - The XML writer settings to be used. May not be null.

Returns:

this

getXMLWriterSettings

@Nonnull
@ReturnsMutableObject("Design")
public com.helger.xml.serialize.write.XMLWriterSettings getXMLWriterSettings()

Specified by:

getXMLWriterSettings in interface IHCConversionSettingsToNode

Returns:

The XML writer settings to be used. Never null.

getMutableXMLWriterSettings

@Nonnull
@ReturnsMutableCopy
public com.helger.xml.serialize.write.XMLWriterSettings getMutableXMLWriterSettings()

Specified by:

getMutableXMLWriterSettings in interface IHCConversionSettingsToNode

Returns:

A mutable copy of the XML writer settings to be used. Never null.

setCSSWriterSettingsOptimized

@Nonnull
public HCConversionSettings setCSSWriterSettingsOptimized(boolean bOptimized)

setCSSWriterSettings

@Nonnull
public HCConversionSettings setCSSWriterSettings(@Nonnull
                                                 com.helger.css.ICSSWriterSettings aCSSWriterSettings)

Set the CSS writer settings to be used.

Parameters:

aCSSWriterSettings - The settings. May not be null.

Returns:

this

getCSSWriterSettings

@Nonnull
@ReturnsMutableObject("Design")
public com.helger.css.writer.CSSWriterSettings getCSSWriterSettings()

Specified by:

getCSSWriterSettings in interface IHCConversionSettingsToNode

Returns:

The CSS writer settings to be used. Never null.

getMutableCSSWriterSettings

@Nonnull
@ReturnsMutableCopy
public com.helger.css.writer.CSSWriterSettings getMutableCSSWriterSettings()

Specified by:

getMutableCSSWriterSettings in interface IHCConversionSettingsToNode

Returns:

A mutable copy of the CSS writer settings to be used. Never null.

setJSWriterSettingsOptimized

@Nonnull
public HCConversionSettings setJSWriterSettingsOptimized(boolean bOptimized)

setJSWriterSettings

@Nonnull
public HCConversionSettings setJSWriterSettings(@Nonnull
                                                IJSWriterSettings aJSWriterSettings)

Set the JS formatter settings to be used.

Parameters:

aJSWriterSettings - The settings. May not be null.

Returns:

this

getJSWriterSettings

@Nonnull
@ReturnsMutableObject("Design")
public JSWriterSettings getJSWriterSettings()

Specified by:

getJSWriterSettings in interface IHCConversionSettingsToNode

Returns:

The JS formatter settings to be used. Never null.

getMutableJSWriterSettings

@Nonnull
@ReturnsMutableCopy
public JSWriterSettings getMutableJSWriterSettings()

Specified by:

getMutableJSWriterSettings in interface IHCConversionSettingsToNode

Returns:

A mutable copy of the JS formatter settings to be used. Never null.

setConsistencyChecksEnabled

@Nonnull
public HCConversionSettings setConsistencyChecksEnabled(boolean bConsistencyChecksEnabled)

Enable or disable the consistency checks. It is recommended that the consistency checks are only run in debug mode!

Parameters:

bConsistencyChecksEnabled - The new value.

Returns:

this

areConsistencyChecksEnabled

public boolean areConsistencyChecksEnabled()

Specified by:

areConsistencyChecksEnabled in interface IHCConversionSettingsToNode

Returns:

true if the consistency checks are enabled, false otherwise.

setExtractOutOfBandNodes

@Nonnull
public HCConversionSettings setExtractOutOfBandNodes(boolean bExtractOutOfBandNodes)

Enable or disable the extraction of out-of-band nodes.

Parameters:

bExtractOutOfBandNodes - The new value.

Returns:

this

isExtractOutOfBandNodes

public boolean isExtractOutOfBandNodes()

Specified by:

isExtractOutOfBandNodes in interface IHCConversionSettingsToNode

Returns:

true if out-of-band nodes should be extracted, false if not. By default true is returned.

setCustomizer

@Nonnull
public HCConversionSettings setCustomizer(@Nullable
                                          IHCCustomizer aCustomizer)

Set the global customizer to be used to globally customize created elements.

Parameters:

aCustomizer - The customizer to be used. May not be null.

Returns:

this

getCustomizer

@Nullable
public IHCCustomizer getCustomizer()

Specified by:

getCustomizer in interface IHCConversionSettingsToNode

Returns:

The current customizer to be used. May be null. The default is null.

setToDefault

@OverridingMethodsMustInvokeSuper
@Nonnull
public HCConversionSettings setToDefault()

setToOptimized

@OverridingMethodsMustInvokeSuper
public HCConversionSettings setToOptimized()

getClone

@Nonnull
public HCConversionSettings getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<IHCConversionSettings>

getClone

@Nonnull
public HCConversionSettings getClone(@Nonnull
                                     EHTMLVersion eHTMLVersion)

Description copied from interface: IHCConversionSettings

Get a clone of this settings, but with a different HTML version.

Specified by:

getClone in interface IHCConversionSettings

Parameters:

eHTMLVersion - The new HTML version to use. May not be null.

Returns:

Never null.

getCloneIfNecessary

@Nonnull
public HCConversionSettings getCloneIfNecessary(@Nonnull
                                                EHTMLVersion eHTMLVersion)

Description copied from interface: IHCConversionSettings

Get a clone of this settings, but with a different HTML version. If the passed HTML version equals this HTML version than this is returned unchanged.

Specified by:

getCloneIfNecessary in interface IHCConversionSettings

Parameters:

eHTMLVersion - The new HTML version to use. May not be null.

Returns:

this or a clone of this.

toString

public String toString()

Overrides:

toString in class Object