Package com.helger.html.hc

Interface IHCTextNode<IMPLTYPE extends IHCTextNode<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, com.helger.commons.hierarchy.IHasChildren<IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>, IHCNode, Serializable

All Known Implementing Classes:

AbstractHCTextNode, HCTextNode

public interface IHCTextNode<IMPLTYPE extends IHCTextNode<IMPLTYPE>>
extends IHCNode, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

This class represents a text node.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
default IMPLTYPE	appendText(char[] aChars)
default IMPLTYPE	appendText(char[] aChars, int nOfs, int nLen)
IMPLTYPE	appendText(String sText)
String	getText()
boolean	isEscape()
default IMPLTYPE	prependText(char[] aChars)
default IMPLTYPE	prependText(char[] aChars, int nOfs, int nLen)
IMPLTYPE	prependText(String sText)
IMPLTYPE	setEscape(boolean bEscape)	Enable or disable XML escaping in the final document.
default IMPLTYPE	setText(char[] aChars)
default IMPLTYPE	setText(char[] aChars, int nOfs, int nLen)
IMPLTYPE	setText(String sText)

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, getPlainText, registerExternalResources

Method Detail

getText

@Nonnull
String getText()

Returns:

The unescaped text. Never null.

setText

@Nonnull
IMPLTYPE setText(@Nullable
                 String sText)

setText

@Nonnull
default IMPLTYPE setText(@Nonnull
                         char[] aChars)

setText

@Nonnull
default IMPLTYPE setText(@Nonnull
                         char[] aChars,
                         @Nonnegative
                         int nOfs,
                         @Nonnegative
                         int nLen)

prependText

@Nonnull
IMPLTYPE prependText(@Nullable
                     String sText)

prependText

@Nonnull
default IMPLTYPE prependText(@Nonnull
                             char[] aChars)

prependText

@Nonnull
default IMPLTYPE prependText(@Nonnull
                             char[] aChars,
                             @Nonnegative
                             int nOfs,
                             @Nonnegative
                             int nLen)

appendText

@Nonnull
IMPLTYPE appendText(@Nullable
                    String sText)

appendText

@Nonnull
default IMPLTYPE appendText(@Nonnull
                            char[] aChars)

appendText

@Nonnull
default IMPLTYPE appendText(@Nonnull
                            char[] aChars,
                            @Nonnegative
                            int nOfs,
                            @Nonnegative
                            int nLen)

setEscape

@Nonnull
IMPLTYPE setEscape(boolean bEscape)

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.

Parameters:

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

Returns:

this

isEscape

boolean isEscape()

Returns:

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