Package com.helger.html.hc.impl

Class AbstractHCTextNode<IMPLTYPE extends AbstractHCTextNode<IMPLTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.impl.AbstractHCTextNode<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>, IHCNode, IHCTextNode<IMPLTYPE>, Serializable

Direct Known Subclasses:

HCTextNode

public abstract class AbstractHCTextNode<IMPLTYPE extends AbstractHCTextNode<IMPLTYPE>>
extends AbstractHCNode
implements IHCTextNode<IMPLTYPE>

Represents a single text node as HC node.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractHCTextNode()

Method Summary

Modifier and Type	Method	Description
IMPLTYPE	appendText(String sText)
String	getPlainText()
String	getText()
protected com.helger.xml.microdom.IMicroText	internalConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)
boolean	isEscape()
IMPLTYPE	prependText(String sText)
IMPLTYPE	setEscape(boolean bEscape)	Enable or disable XML escaping in the final document.
IMPLTYPE	setText(String sText)
String	toString()

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

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getNodeState, hasChildren, internalSetNodeState, onConsistencyCheck, onCustomizeNode, onFinalizeNodeState, 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.IHCNode

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

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

appendText, appendText, prependText, prependText, setText, setText

Constructor Detail

AbstractHCTextNode

public AbstractHCTextNode()

Method Detail

getText

@Nonnull
public final String getText()

Specified by:

getText in interface IHCTextNode<IMPLTYPE extends AbstractHCTextNode<IMPLTYPE>>

Returns:

The unescaped text. Never null.

setText

@Nonnull
public final IMPLTYPE setText(@Nullable
                              String sText)

Specified by:

setText in interface IHCTextNode<IMPLTYPE extends AbstractHCTextNode<IMPLTYPE>>

prependText

@Nonnull
public final IMPLTYPE prependText(@Nullable
                                  String sText)

Specified by:

prependText in interface IHCTextNode<IMPLTYPE extends AbstractHCTextNode<IMPLTYPE>>

appendText

@Nonnull
public final IMPLTYPE appendText(@Nullable
                                 String sText)

Specified by:

appendText in interface IHCTextNode<IMPLTYPE extends AbstractHCTextNode<IMPLTYPE>>

setEscape

@Nonnull
public final IMPLTYPE setEscape(boolean bEscape)

Description copied from interface: IHCTextNode

Enable or disable XML escaping in the final document. By default all text is escaped (MicroText.DEFAULT_ESCAPE), but for certain special cases (like script elements in HTML), XML escaping must be disabled.

Specified by:

setEscape in interface IHCTextNode<IMPLTYPE extends AbstractHCTextNode<IMPLTYPE>>

Parameters:

bEscape - true to enable escaping (default), false to disable it

Returns:

this

isEscape

public final boolean isEscape()

Specified by:

isEscape in interface IHCTextNode<IMPLTYPE extends AbstractHCTextNode<IMPLTYPE>>

Returns:

true if XML escaping is enabled, false if it is disabled

internalConvertToMicroNode

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

Specified by:

internalConvertToMicroNode in class AbstractHCNode

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 AbstractHCNode