Package com.helger.html.hc.html.root

Class HCHtml

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

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

com.helger.html.hc.html.root.HCHtml

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<HCHtml>, IHCElement<HCHtml>, IHCHasCSSClasses<HCHtml>, IHCHasCSSStyles<HCHtml>, IHCHasID<HCHtml>, IHCNode, Serializable

public class HCHtml
extends AbstractHCElement<HCHtml>

The node that represents a full HTML document.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

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

Constructor	Description
HCHtml()	Create a new HTML object
HCHtml(HCHead aHead, HCBody aBody)

Method Summary

Modifier and Type	Method	Description
void	addAllOutOfBandNodesToHead(List<IHCNode> aAllOOBNodes)	Add the passed OOB nodes to the head.
HCBody	body()
com.helger.commons.collection.impl.ICommonsList<? extends IHCNode>	getAllChildren()
com.helger.commons.collection.impl.ICommonsList<IHCNode>	getAllOutOfBandNodesWithMergedInlineNodes()	Extract all out-of-band (OOB) nodes from head and body.
IHCNode	getChildAtIndex(int nIndex)
int	getChildCount()
com.helger.commons.collection.impl.ICommonsIterable<? extends IHCNode>	getChildren()
IHCNode	getFirstChild()
IHCNode	getLastChild()
String	getPlainText()
boolean	hasChildren()
HCHead	head()
protected com.helger.xml.microdom.IMicroDocument	internalConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)
void	moveScriptElementsToBody()	Move all JS nodes from the head to the body.
String	toString()

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

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, fillMicroElement, 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, 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

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getNodeState, 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, hasNoChildren

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

forAllChildrenRecursive, forAllChildrenRecursive

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

findFirstChild, findFirstChildMapped

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

setTranslate, withCustomAttrs

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

addClasses, addClasses, addClasses

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

addStyle, addStyles, addStyles, addStyles

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

ensureID, hasID, hasNoID, setUniqueID

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

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, registerExternalResources

Constructor Detail

HCHtml

public HCHtml()

Create a new HTML object

HCHtml

public HCHtml(@Nonnull
              HCHead aHead,
              @Nonnull
              HCBody aBody)

Method Detail

head

@Nonnull
public final HCHead head()

body

@Nonnull
public final HCBody body()

getAllChildren

@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<? extends IHCNode> getAllChildren()

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IHCNode>

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>

Overrides:

getAllChildren in class AbstractHCNode

getChildren

@Nonnull
public final com.helger.commons.collection.impl.ICommonsIterable<? extends IHCNode> getChildren()

Specified by:

getChildren in interface com.helger.commons.hierarchy.IHasChildren<IHCNode>

Overrides:

getChildren in class AbstractHCNode

getChildAtIndex

@Nullable
public final IHCNode getChildAtIndex(int nIndex)

Specified by:

getChildAtIndex in interface com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>

Overrides:

getChildAtIndex in class AbstractHCNode

getFirstChild

@Nonnull
public final IHCNode getFirstChild()

Specified by:

getFirstChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>

Overrides:

getFirstChild in class AbstractHCNode

getLastChild

@Nonnull
public final IHCNode getLastChild()

Specified by:

getLastChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>

Overrides:

getLastChild in class AbstractHCNode

hasChildren

public final boolean hasChildren()

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IHasChildren<IHCNode>

Overrides:

hasChildren in class AbstractHCNode

getChildCount

public final int getChildCount()

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IHasChildren<IHCNode>

Overrides:

getChildCount in class AbstractHCNode

internalConvertToMicroNode

@Nonnull
protected final com.helger.xml.microdom.IMicroDocument internalConvertToMicroNode(@Nonnull
                                                                                  IHCConversionSettingsToNode aConversionSettings)

Overrides:

internalConvertToMicroNode in class AbstractHCElement<HCHtml>

getAllOutOfBandNodesWithMergedInlineNodes

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IHCNode> getAllOutOfBandNodesWithMergedInlineNodes()

Extract all out-of-band (OOB) nodes from head and body. Afterwards merge all inline CSS and JS nodes.

Returns:

An ordered list of all OOB nodes in the correct order.

addAllOutOfBandNodesToHead

public void addAllOutOfBandNodesToHead(@Nonnull
                                       List<IHCNode> aAllOOBNodes)

Add the passed OOB nodes to the head.

Parameters:

aAllOOBNodes - The out-of-band node list. Usually retrieved from getAllOutOfBandNodesWithMergedInlineNodes(). May not be null.

moveScriptElementsToBody

public void moveScriptElementsToBody()

Move all JS nodes from the head to the body.

getPlainText

@Nonnull
public String getPlainText()

Specified by:

getPlainText in interface IHCNode

Overrides:

getPlainText in class AbstractHCNode

Returns:

The plain text representation of this text. May not be null.

toString

public String toString()

Overrides:

toString in class AbstractHCElement<HCHtml>