org.htmlunit.html.serializer

Class HtmlSerializerVisibleText

java.lang.Object

org.htmlunit.html.serializer.HtmlSerializerVisibleText

public class HtmlSerializerVisibleText
extends Object

Special serializer to generate the output we need at least for selenium WebElement#getText().

This is also used from estimations by ComputedCSSStyleDeclaration.

Author:

Ronald Brill, cd alexndr

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
HtmlSerializerVisibleText()

Method Summary

Modifier and Type	Method and Description
protected void	appendBreak(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlBreak htmlBreak, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlBreak.
protected void	appendCheckBoxInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlCheckBoxInput htmlCheckBoxInput, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlCheckBoxInput.
protected void	appendChildren(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, DomNode node, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Iterate over all Children and call appendNode() for every.
protected void	appendComment(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, DomComment domComment, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process DomComment.
protected void	appendDetails(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlDetails htmlDetails, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlDetails.
protected void	appendDomNode(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, DomNode domNode, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process DomNode.
protected void	appendHiddenInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlHiddenInput htmlHiddenInput, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlHiddenInput.
protected void	appendInlineFrame(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlInlineFrame htmlInlineFrame, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlInlineFrame.
protected void	appendInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlInput htmlInput, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlInput.
protected void	appendMenu(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlMenu htmlMenu, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlMenu.
protected void	appendNode(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, DomNode node, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) The core distribution method call the different appendXXX methods depending on the type of the given node.
protected void	appendNoFrames(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlNoFrames htmlNoFrames, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlNoFrames.
protected void	appendNoScript(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlNoScript htmlNoScript, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlNoScript.
protected void	appendOption(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlOption htmlOption, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlSelect.
protected void	appendOrderedList(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlOrderedList htmlOrderedList, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlOrderedList.
protected void	appendPreformattedText(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlPreformattedText htmlPreformattedText, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlPreformattedText.
protected void	appendRadioButtonInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlRadioButtonInput htmlRadioButtonInput, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlRadioButtonInput.
protected void	appendResetInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlResetInput htmlResetInput, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlResetInput.
protected void	appendScript(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlScript htmlScript, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlScript.
protected void	appendSelect(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlSelect htmlSelect, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlSelect.
protected void	appendStyle(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlStyle htmlStyle, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlStyle.
protected void	appendSubmitInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlSubmitInput htmlSubmitInput, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlSubmitInput.
protected void	appendTable(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlTable htmlTable, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlTable.
protected void	appendTableRow(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlTableRow htmlTableRow, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlTableRow.
protected boolean	appendTableRows(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode, List<HtmlTableRow> rows, boolean first, TableRowGroup skipParent1, TableRowGroup skipParent2) Process HtmlTableRow.
protected void	appendText(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, DomText domText, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process DomText.
protected void	appendTextArea(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlTextArea htmlTextArea, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlTextArea.
protected void	appendTitle(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlTitle htmlTitle, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlTitle.
protected void	appendUnorderedList(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder, HtmlUnorderedList htmlUnorderedList, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode) Process HtmlUnorderedList.
String	asText(DomNode node) Converts an HTML node to text.
protected boolean	isDisplayed(DomNode domNode) Check domNode visibility.
protected HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode	updateWhiteSpaceStyle(DomNode domNode, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode defaultMode)
protected HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode	whiteSpaceStyle(DomNode domNode, HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode defaultMode)

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlSerializerVisibleText

public HtmlSerializerVisibleText()

Method Detail

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(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                              DomNode node,
                              HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Iterate over all Children and call appendNode() for every.

Parameters:

builder - the StringBuilder to add to

node - the node to process

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

appendNode

protected void appendNode(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                          DomNode node,
                          HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

The core distribution method call 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 HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode to use for processing

appendDomNode

protected void appendDomNode(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                             DomNode domNode,
                             HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process DomNode.

Parameters:

builder - the StringBuilder to add to

domNode - the target to process

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

appendHiddenInput

protected void appendHiddenInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                 HtmlHiddenInput htmlHiddenInput,
                                 HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlHiddenInput.

Parameters:

builder - the StringBuilder to add to

htmlHiddenInput - the target to process

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

appendScript

protected void appendScript(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                            HtmlScript htmlScript,
                            HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlScript.

Parameters:

builder - the StringBuilder to add to

htmlScript - the target to process

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

appendStyle

protected void appendStyle(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                           HtmlStyle htmlStyle,
                           HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlStyle.

Parameters:

builder - the StringBuilder to add to

htmlStyle - the target to process

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

appendNoScript

protected void appendNoScript(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                              HtmlNoScript htmlNoScript,
                              HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlNoScript.

Parameters:

builder - the StringBuilder to add to

htmlNoScript - the target to process

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

appendNoFrames

protected void appendNoFrames(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                              HtmlNoFrames htmlNoFrames,
                              HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlNoFrames.

Parameters:

builder - the StringBuilder to add to

htmlNoFrames - the target to process

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

appendSubmitInput

protected void appendSubmitInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                 HtmlSubmitInput htmlSubmitInput,
                                 HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlSubmitInput.

Parameters:

builder - the StringBuilder to add to

htmlSubmitInput - the target to process

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

appendInput

protected void appendInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                           HtmlInput htmlInput,
                           HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlInput.

Parameters:

builder - the StringBuilder to add to

htmlInput - the target to process

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

appendResetInput

protected void appendResetInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                HtmlResetInput htmlResetInput,
                                HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlResetInput.

Parameters:

builder - the StringBuilder to add to

htmlResetInput - the target to process

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

appendMenu

protected void appendMenu(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                          HtmlMenu htmlMenu,
                          HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlMenu.

Parameters:

builder - the StringBuilder to add to

htmlMenu - the target to process

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

appendDetails

protected void appendDetails(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                             HtmlDetails htmlDetails,
                             HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlDetails.

Parameters:

builder - the StringBuilder to add to

htmlDetails - the target to process

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

appendTitle

protected void appendTitle(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                           HtmlTitle htmlTitle,
                           HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlTitle.

Parameters:

builder - the StringBuilder to add to

htmlTitle - the target to process

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

appendTableRow

protected void appendTableRow(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                              HtmlTableRow htmlTableRow,
                              HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlTableRow.

Parameters:

builder - the StringBuilder to add to

htmlTableRow - the target to process

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

isDisplayed

protected boolean isDisplayed(DomNode domNode)

Check domNode visibility.

Parameters:

domNode - the node to check

Returns:

true or false

appendTextArea

protected void appendTextArea(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                              HtmlTextArea htmlTextArea,
                              HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlTextArea.

Parameters:

builder - the StringBuilder to add to

htmlTextArea - the target to process

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

appendTable

protected void appendTable(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                           HtmlTable htmlTable,
                           HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlTable.

Parameters:

builder - the StringBuilder to add to

htmlTable - the target to process

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

appendTableRows

protected boolean appendTableRows(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                  HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode,
                                  List<HtmlTableRow> rows,
                                  boolean first,
                                  TableRowGroup skipParent1,
                                  TableRowGroup skipParent2)

Process HtmlTableRow.

Parameters:

builder - the StringBuilder to add to

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

rows - the rows

first - if true this is the first one

skipParent1 - skip row if the parent is this

skipParent2 - skip row if the parent is this

Returns:

true if this was the first one

appendSelect

protected void appendSelect(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                            HtmlSelect htmlSelect,
                            HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlSelect.

Parameters:

builder - the StringBuilder to add to

htmlSelect - the target to process

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

appendOption

protected void appendOption(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                            HtmlOption htmlOption,
                            HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlSelect.

Parameters:

builder - the StringBuilder to add to

htmlOption - the target to process

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

appendOrderedList

protected void appendOrderedList(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                 HtmlOrderedList htmlOrderedList,
                                 HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlOrderedList.

Parameters:

builder - the StringBuilder to add to

htmlOrderedList - the OL element

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

appendUnorderedList

protected void appendUnorderedList(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                   HtmlUnorderedList htmlUnorderedList,
                                   HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlUnorderedList.

Parameters:

builder - the StringBuilder to add to

htmlUnorderedList - the target to process

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

appendPreformattedText

protected void appendPreformattedText(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                      HtmlPreformattedText htmlPreformattedText,
                                      HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlPreformattedText.

Parameters:

builder - the StringBuilder to add to

htmlPreformattedText - the target to process

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

appendInlineFrame

protected void appendInlineFrame(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                 HtmlInlineFrame htmlInlineFrame,
                                 HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlInlineFrame.

Parameters:

builder - the StringBuilder to add to

htmlInlineFrame - the target to process

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

appendText

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

Process DomText.

Parameters:

builder - the StringBuilder to add to

domText - the target to process

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

appendComment

protected void appendComment(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                             DomComment domComment,
                             HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process DomComment.

Parameters:

builder - the StringBuilder to add to

domComment - the target to process

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

appendBreak

protected void appendBreak(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                           HtmlBreak htmlBreak,
                           HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlBreak.

Parameters:

builder - the StringBuilder to add to

htmlBreak - the target to process

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

appendCheckBoxInput

protected void appendCheckBoxInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                   HtmlCheckBoxInput htmlCheckBoxInput,
                                   HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlCheckBoxInput.

Parameters:

builder - the StringBuilder to add to

htmlCheckBoxInput - the target to process

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

appendRadioButtonInput

protected void appendRadioButtonInput(HtmlSerializerVisibleText.HtmlSerializerTextBuilder builder,
                                      HtmlRadioButtonInput htmlRadioButtonInput,
                                      HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode mode)

Process HtmlRadioButtonInput.

Parameters:

builder - the StringBuilder to add to

htmlRadioButtonInput - the target to process

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

whiteSpaceStyle

protected HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode whiteSpaceStyle(DomNode domNode,
                                                                                   HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode defaultMode)

updateWhiteSpaceStyle

protected HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode updateWhiteSpaceStyle(DomNode domNode,
                                                                                         HtmlSerializerVisibleText.HtmlSerializerTextBuilder.Mode defaultMode)