Module org.htmlunit

Package org.htmlunit.html.serializer

Class HtmlSerializerInnerOuterText

java.lang.Object

org.htmlunit.html.serializer.HtmlSerializerInnerOuterText

public class HtmlSerializerInnerOuterText
extends Object

Special serializer to generate the output we need for innerText and outerText.

Author:

Ronald Brill

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder	Helper to compose the text for the serializer based on several modes.

Constructor Summary

Constructors

Constructor	Description
HtmlSerializerInnerOuterText(BrowserVersion browserVersion)	Ctor.

Method Summary

Modifier and Type	Method	Description
protected void	appendBreak(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, HtmlBreak htmlBreak)	Process HtmlBreak.
protected void	appendChildren(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, DomNode node, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	Iterates over all children and calls appendNode() for every child.
protected void	appendDefinitionTerm(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, HtmlDefinitionTerm htmlDefinitionTerm, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	Process HtmlDefinitionTerm.
protected void	appendDescendantOptions(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, DomNode node, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	Iterate over all descendant options.
protected void	appendDetails(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, HtmlDetails htmlDetails, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	Process HtmlDetails.
protected void	appendElement(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, DomNode node, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	Process all other nodes; block level elements are surrounded by a required line break and elements with an own white-space style switch the mode for their children.
protected void	appendListItem(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, HtmlListItem htmlListItem, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	Process HtmlListItem.
protected void	appendNode(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, DomNode node, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	The core distribution method; calls the different appendXXX methods depending on the type of the given node.
protected void	appendParagraph(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, HtmlParagraph htmlParagraph, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	Process HtmlParagraph.
protected void	appendPreformattedText(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, HtmlElement htmlPre, boolean insideHead, boolean insideSelect)	Process HtmlPreformattedText.
protected void	appendSelect(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, HtmlSelect htmlSelect, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode, boolean insideHead, boolean insideSelect)	Process HtmlSelect.
protected void	appendText(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder, DomText domText, HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode)	Process DomText.
String	asText(DomNode node)	Converts an HTML node to text.

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlSerializerInnerOuterText

public HtmlSerializerInnerOuterText(BrowserVersion browserVersion)

Ctor.

Parameters:

browserVersion - the BrowserVersion

Method Details

asText

public String asText(DomNode node)

Converts an HTML node to text.

Parameters:

node - a node

Returns:

the text representation according to the setting of this serializer

appendChildren

protected void appendChildren(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 DomNode node,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

Iterates over all children and calls appendNode() for every child.

Parameters:

builder - the StringBuilder to add to

node - the node to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select

appendNode

protected void appendNode(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 DomNode node,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

The core distribution method; calls the different appendXXX methods depending on the type of the given node.

Parameters:

builder - the StringBuilder to add to

node - the node to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select

appendElement

protected void appendElement(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 DomNode node,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

Process all other nodes; block level elements are surrounded by a required line break and elements with an own white-space style switch the mode for their children.

Parameters:

builder - the StringBuilder to add to

node - the node to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select

appendText

protected void appendText(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 DomText domText,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode)

Process DomText.

Parameters:

builder - the StringBuilder to add to

domText - the target to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

appendBreak

protected void appendBreak(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 HtmlBreak htmlBreak)

Process HtmlBreak.

Parameters:

builder - the StringBuilder to add to

htmlBreak - the target to process

appendParagraph

protected void appendParagraph(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 HtmlParagraph htmlParagraph,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

Process HtmlParagraph.

Parameters:

builder - the StringBuilder to add to

htmlParagraph - the target to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select

appendPreformattedText

protected void appendPreformattedText(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 HtmlElement htmlPre,
 boolean insideHead,
 boolean insideSelect)

Process HtmlPreformattedText. The default white-space handling of a pre element is 'pre', but an explicit white-space style of the element (or one of its ancestors) wins.

Parameters:

builder - the StringBuilder to add to

htmlPre - the target to process

insideHead - true if inside head section

insideSelect - true if inside a select

appendListItem

protected void appendListItem(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 HtmlListItem htmlListItem,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

Process HtmlListItem.

Parameters:

builder - the StringBuilder to add to

htmlListItem - the target to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select

appendDetails

protected void appendDetails(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 HtmlDetails htmlDetails,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

Process HtmlDetails.

Parameters:

builder - the StringBuilder to add to

htmlDetails - the target to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select

appendDefinitionTerm

protected void appendDefinitionTerm(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 HtmlDefinitionTerm htmlDefinitionTerm,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

Process HtmlDefinitionTerm.

Parameters:

builder - the StringBuilder to add to

htmlDefinitionTerm - the target to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select

appendSelect

protected void appendSelect(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 HtmlSelect htmlSelect,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

Process HtmlSelect.

Select and its Option children are rendered as native form-control widgets in real browsers, not as normal inline/block boxes. The widget's internal text drawing doesn't go through the same CSS text-layout pipeline that divs or spans use, so properties like white-space: pre on a <select> or <option> get ignored by Chrome/Firefox/etc.

Parameters:

builder - the StringBuilder to add to

htmlSelect - the target to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select

appendDescendantOptions

protected void appendDescendantOptions(HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder builder,
 DomNode node,
 HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode mode,
 boolean insideHead,
 boolean insideSelect)

Iterate over all descendant options.

Parameters:

builder - the StringBuilder to add to

node - the node to process

mode - the HtmlSerializerInnerOuterText.HtmlSerializerTextBuilder.Mode to use for processing

insideHead - true if inside head section

insideSelect - true if inside a select