Package com.helger.html.hc.html.script

Class AbstractHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.html.AbstractHCElement<IMPLTYPE>

com.helger.html.hc.html.script.AbstractHCScript<IMPLTYPE>

com.helger.html.hc.html.script.AbstractHCScriptInline<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IHCElement<IMPLTYPE>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCScript<IMPLTYPE>, IHCScriptInline<IMPLTYPE>, IHCHasID<IMPLTYPE>, IHCNode, Serializable

Direct Known Subclasses:

HCScriptInline, HCScriptInlineOnDocumentReady

public abstract class AbstractHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>
extends AbstractHCScript<IMPLTYPE>
implements IHCScriptInline<IMPLTYPE>

This class represents an HTML <script> element with inline JS content.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_EMIT_AFTER_FILES	By default place inline JS after script files

Fields inherited from class com.helger.html.hc.html.script.AbstractHCScript

DEFAULT_TYPE

Fields inherited from class com.helger.html.hc.html.AbstractHCElement

DEFAULT_HIDDEN, DEFAULT_SPELLCHECK, DEFAULT_TRANSLATE, DEFAULT_UNFOCUSABLE

Fields inherited from interface com.helger.html.hc.html.IHCElement

DEFAULT_TABINDEX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHCScriptInline()
protected	AbstractHCScriptInline(IHasJSCode aProvider)

Method Summary

Modifier and Type	Method	Description
boolean	canConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)	This method checks whether the node is suitable for conversion to an IMicroNode.
protected void	fillMicroElement(com.helger.xml.microdom.IMicroElement aElement, IHCConversionSettingsToNode aConversionSettings)	Set all attributes and child elements of this object
String	getJSCode(IJSWriterSettings aSettings)
IHasJSCode	getJSCodeProvider()
EHCScriptInlineMode	getMode()
boolean	isEmitAfterFiles()
IMPLTYPE	setEmitAfterFiles(boolean bEmitAfterFiles)
static void	setInlineScript(com.helger.xml.microdom.IMicroNodeWithChildren aElement, String sContent, EHCScriptInlineMode eMode, String sLineSeparator)
IMPLTYPE	setJSCodeProvider(IHasJSCode aProvider)
IMPLTYPE	setMode(EHCScriptInlineMode eMode)	Set the masking mode.
String	toString()

Methods inherited from class com.helger.html.hc.html.script.AbstractHCScript

getCharset, getCrossOrigin, getIntegrity, getType, setCharset, setCrossOrigin, setIntegrity, setType

Methods inherited from class com.helger.html.hc.html.AbstractHCElement

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, finishMicroElement, getAccessKey, getAllClasses, getAllClassesAsString, getAllClassNames, getAllStyles, getAllStylesAsString, getAllStyleValues, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getID, getLanguage, getRole, getStyleValue, getTabIndex, getTagName, getTitle, getTranslate, hasAnyClass, hasAnyStyle, hasStyle, internalConvertToMicroNode, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, isValidID, onConsistencyCheck, onFinalizeNodeState, prependEventHandler, removeAllClasses, removeAllEventHandler, removeAllStyles, removeClass, removeStyle, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setID, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setUnfocusable

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getNodeState, getPlainText, hasChildren, internalSetNodeState, onCustomizeNode, onRegisterExternalResources, registerExternalResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

findFirstChild, findFirstChildMapped, getAllChildren, getChildAtIndex, getFirstChild, getLastChild

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

addEventHandler, containsEventHandler, customAttrs, getAccessKey, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getLanguage, getRole, getTabIndex, getTagName, getTitle, getTranslate, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable, withCustomAttrs

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

addClass, addClasses, addClasses, addClasses, containsClass, getAllClasses, getAllClassesAsString, getAllClassNames, hasAnyClass, removeAllClasses, removeClass

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

addStyle, addStyle, addStyles, addStyles, addStyles, containsStyle, getAllStyles, getAllStylesAsString, getAllStyleValues, getStyleValue, hasAnyStyle, hasStyle, removeAllStyles, removeStyle

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

ensureID, getID, hasID, hasNoID, setID, setUniqueID

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

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

Methods inherited from interface com.helger.html.hc.html.script.IHCScript

getCharset, getCrossOrigin, getIntegrity, getType, setCharset, setCharset, setCrossOrigin, setIntegrity, setType

Field Detail

DEFAULT_EMIT_AFTER_FILES

public static final boolean DEFAULT_EMIT_AFTER_FILES

By default place inline JS after script files

See Also:

Constant Field Values

Constructor Detail

AbstractHCScriptInline

protected AbstractHCScriptInline()

AbstractHCScriptInline

protected AbstractHCScriptInline(@Nonnull
                                 IHasJSCode aProvider)

Method Detail

getJSCodeProvider

@Nonnull
public final IHasJSCode getJSCodeProvider()

Specified by:

getJSCodeProvider in interface IHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

Returns:

The JS code passed in the constructor. Never null.

setJSCodeProvider

@Nonnull
public final IMPLTYPE setJSCodeProvider(@Nonnull
                                        IHasJSCode aProvider)

Specified by:

setJSCodeProvider in interface IHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

getJSCode

@Nullable
public final String getJSCode(@Nonnull
                              IJSWriterSettings aSettings)

Specified by:

getJSCode in interface IHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

Parameters:

aSettings - The settings to be used. May be null to use the default.

Returns:

The text representation of the JS code passed in the constructor. May be null.

getMode

@Nonnull
public final EHCScriptInlineMode getMode()

Specified by:

getMode in interface IHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

Returns:

The masking mode. Never null.

setMode

@Nonnull
public final IMPLTYPE setMode(@Nonnull
                              EHCScriptInlineMode eMode)

Set the masking mode.

Specified by:

setMode in interface IHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

Parameters:

eMode - The mode to use. MAy not be null.

Returns:

this

isEmitAfterFiles

public final boolean isEmitAfterFiles()

Specified by:

isEmitAfterFiles in interface IHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

setEmitAfterFiles

@Nonnull
public final IMPLTYPE setEmitAfterFiles(boolean bEmitAfterFiles)

Specified by:

setEmitAfterFiles in interface IHCScriptInline<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

setInlineScript

public static void setInlineScript(@Nonnull
                                   com.helger.xml.microdom.IMicroNodeWithChildren aElement,
                                   @Nullable
                                   String sContent,
                                   @Nonnull
                                   EHCScriptInlineMode eMode,
                                   @Nonnull
                                   String sLineSeparator)

canConvertToMicroNode

public boolean canConvertToMicroNode(@Nonnull
                                     IHCConversionSettingsToNode aConversionSettings)

Description copied from interface: IHCNode

This method checks whether the node is suitable for conversion to an IMicroNode. If this node cannot be converted, no child node will be converted as well!

Specified by:

canConvertToMicroNode in interface IHCNode

Overrides:

canConvertToMicroNode in class AbstractHCNode

Parameters:

aConversionSettings - The conversion settings to be used

Returns:

true if the node can be converted to a node, false otherwise.

fillMicroElement

protected void fillMicroElement(com.helger.xml.microdom.IMicroElement aElement,
                                IHCConversionSettingsToNode aConversionSettings)

Description copied from class: AbstractHCElement

Set all attributes and child elements of this object

Overrides:

fillMicroElement in class AbstractHCScript<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>

Parameters:

aElement - The current micro element to be filled. Never null.

aConversionSettings - The conversion settings to be used. Never null.

toString

public String toString()

Overrides:

toString in class AbstractHCScript<IMPLTYPE extends AbstractHCScriptInline<IMPLTYPE>>