com.gargoylesoftware.htmlunit.html

Class HtmlSerializer

java.lang.Object

com.gargoylesoftware.htmlunit.html.HtmlSerializer

public class HtmlSerializer
extends Object

Utility to handle conversion from HTML code to string.

Author:

Marc Guillemot, Ahmed Ashour, Ronald Brill, Rob Kodey

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AS_TEXT_BLANK Indicates a non blank that can't be trimmed or reduced.
protected static String	AS_TEXT_BLOCK_SEPARATOR Indicates a block.
protected static String	AS_TEXT_NEW_LINE Indicates a new line.
protected static String	AS_TEXT_TAB Indicates a tab.

Constructor Summary

Constructors

Constructor and Description
HtmlSerializer()

Method Summary

Modifier and Type	Method and Description
protected void	appendApplet(StringBuilder builder, HtmlApplet htmlApplet) Process HtmlApplet.
protected void	appendBreak(StringBuilder builder, HtmlBreak htmlBreak) Process HtmlBreak.
protected void	appendChildren(StringBuilder builder, DomNode node) Iterate over all Children and call appendNode() for every.
protected void	appendComment(StringBuilder builder, DomComment domComment) Process DomComment.
protected void	appendDomNode(StringBuilder builder, DomNode domNode) Process HtmlHiddenInput.
protected void	appendHiddenInput(StringBuilder builder, HtmlHiddenInput htmlHiddenInput) Process HtmlHiddenInput.
protected void	appendInlineFrame(StringBuilder builder, HtmlInlineFrame htmlInlineFrame) Process HtmlInlineFrame.
protected void	appendInput(StringBuilder builder, HtmlInput htmlInput) Process HtmlInput.
protected void	appendNode(StringBuilder builder, DomNode node) The core distribution method call the different appendXXX methods depending on the type of the given node.
protected void	appendNoFrames(StringBuilder builder, HtmlNoFrames htmlNoFrames) Process HtmlNoFrames.
protected void	appendNoScript(StringBuilder builder, HtmlNoScript htmlNoScript) Process HtmlNoScript.
protected void	appendOrderedList(StringBuilder builder, HtmlOrderedList htmlOrderedList) Process HtmlOrderedList taking care to numerate it.
protected void	appendPreformattedText(StringBuilder builder, HtmlPreformattedText htmlPreformattedText) Process HtmlPreformattedText.
protected void	appendResetInput(StringBuilder builder, HtmlResetInput htmlResetInput) Process HtmlResetInput.
protected void	appendScript(StringBuilder builder, HtmlScript htmlScript) Process HtmlScript.
protected void	appendSelect(StringBuilder builder, HtmlSelect htmlSelect) Process HtmlSelect.
protected void	appendStyle(StringBuilder builder, HtmlStyle htmlStyle) Process HtmlStyle.
protected void	appendSubmitInput(StringBuilder builder, HtmlSubmitInput htmlSubmitInput) Process HtmlSubmitInput.
protected void	appendTable(StringBuilder builder, HtmlTable htmlTable) Process HtmlTable.
protected void	appendTableRow(StringBuilder builder, HtmlTableRow htmlTableRow) Process HtmlTableRow.
protected boolean	appendTableRows(StringBuilder builder, List<HtmlTableRow> rows, boolean first, TableRowGroup skipParent1, TableRowGroup skipParent2) Process HtmlTableRow.
protected void	appendText(StringBuilder builder, DomText domText) Process DomText.
protected void	appendTextArea(StringBuilder builder, HtmlTextArea htmlTextArea) Process HtmlTextArea.
protected void	appendTitle(StringBuilder builder, HtmlTitle htmlTitle) Process HtmlTitle.
protected void	appendUnorderedList(StringBuilder builder, HtmlUnorderedList htmlUnorderedList) Process HtmlUnorderedList.
String	asText(DomNode node) Converts an HTML node to text.
protected String	cleanUp(String text) Reduce the whitespace and do some more cleanup.
protected void	doAppendCheckBoxInput(StringBuilder builder, HtmlCheckBoxInput htmlCheckBoxInput) Process HtmlCheckBoxInput.
protected void	doAppendRadioButtonInput(StringBuilder builder, HtmlRadioButtonInput htmlRadioButtonInput) Process HtmlRadioButtonInput.
void	setIgnoreMaskedElements(boolean ignore) Indicates if element that are not displayed due to style settings (visibility or display) should be visible in generated text.

Methods inherited from class java.lang.Object

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

Field Detail

AS_TEXT_BLOCK_SEPARATOR

protected static final String AS_TEXT_BLOCK_SEPARATOR

Indicates a block. Will be rendered as line separator (multiple block marks are ignored)

See Also:

Constant Field Values

AS_TEXT_NEW_LINE

protected static final String AS_TEXT_NEW_LINE

Indicates a new line. Will be rendered as line separator.

See Also:

Constant Field Values

AS_TEXT_BLANK

protected static final String AS_TEXT_BLANK

Indicates a non blank that can't be trimmed or reduced.

See Also:

Constant Field Values

AS_TEXT_TAB

protected static final String AS_TEXT_TAB

Indicates a tab.

See Also:

Constant Field Values

Constructor Detail

HtmlSerializer

public HtmlSerializer()

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

cleanUp

protected String cleanUp(String text)

Reduce the whitespace and do some more cleanup.

Parameters:

text - the text to clean up

Returns:

the new text

appendChildren

protected void appendChildren(StringBuilder builder,
                              DomNode node)

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

Parameters:

builder - the StringBuilder to add to

node - the node to process

appendNode

protected void appendNode(StringBuilder builder,
                          DomNode node)

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

appendDomNode

protected void appendDomNode(StringBuilder builder,
                             DomNode domNode)

Process HtmlHiddenInput.

Parameters:

builder - the StringBuilder to add to

domNode - the target to process

appendHiddenInput

protected void appendHiddenInput(StringBuilder builder,
                                 HtmlHiddenInput htmlHiddenInput)

Process HtmlHiddenInput.

Parameters:

builder - the StringBuilder to add to

htmlHiddenInput - the target to process

appendScript

protected void appendScript(StringBuilder builder,
                            HtmlScript htmlScript)

Process HtmlScript.

Parameters:

builder - the StringBuilder to add to

htmlScript - the target to process

appendStyle

protected void appendStyle(StringBuilder builder,
                           HtmlStyle htmlStyle)

Process HtmlStyle.

Parameters:

builder - the StringBuilder to add to

htmlStyle - the target to process

appendNoScript

protected void appendNoScript(StringBuilder builder,
                              HtmlNoScript htmlNoScript)

Process HtmlNoScript.

Parameters:

builder - the StringBuilder to add to

htmlNoScript - the target to process

appendNoFrames

protected void appendNoFrames(StringBuilder builder,
                              HtmlNoFrames htmlNoFrames)

Process HtmlNoFrames.

Parameters:

builder - the StringBuilder to add to

htmlNoFrames - the target to process

appendSubmitInput

protected void appendSubmitInput(StringBuilder builder,
                                 HtmlSubmitInput htmlSubmitInput)

Process HtmlSubmitInput.

Parameters:

builder - the StringBuilder to add to

htmlSubmitInput - the target to process

appendInput

protected void appendInput(StringBuilder builder,
                           HtmlInput htmlInput)

Process HtmlInput.

Parameters:

builder - the StringBuilder to add to

htmlInput - the target to process

appendResetInput

protected void appendResetInput(StringBuilder builder,
                                HtmlResetInput htmlResetInput)

Process HtmlResetInput.

Parameters:

builder - the StringBuilder to add to

htmlResetInput - the target to process

appendUnorderedList

protected void appendUnorderedList(StringBuilder builder,
                                   HtmlUnorderedList htmlUnorderedList)

Process HtmlUnorderedList.

Parameters:

builder - the StringBuilder to add to

htmlUnorderedList - the target to process

appendTitle

protected void appendTitle(StringBuilder builder,
                           HtmlTitle htmlTitle)

Process HtmlTitle.

Parameters:

builder - the StringBuilder to add to

htmlTitle - the target to process

appendTableRow

protected void appendTableRow(StringBuilder builder,
                              HtmlTableRow htmlTableRow)

Process HtmlTableRow.

Parameters:

builder - the StringBuilder to add to

htmlTableRow - the target to process

appendTextArea

protected void appendTextArea(StringBuilder builder,
                              HtmlTextArea htmlTextArea)

Process HtmlTextArea.

Parameters:

builder - the StringBuilder to add to

htmlTextArea - the target to process

appendTable

protected void appendTable(StringBuilder builder,
                           HtmlTable htmlTable)

Process HtmlTable.

Parameters:

builder - the StringBuilder to add to

htmlTable - the target to process

appendTableRows

protected boolean appendTableRows(StringBuilder builder,
                                  List<HtmlTableRow> rows,
                                  boolean first,
                                  TableRowGroup skipParent1,
                                  TableRowGroup skipParent2)

Process HtmlTableRow.

Parameters:

builder - the StringBuilder to add to

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(StringBuilder builder,
                            HtmlSelect htmlSelect)

Process HtmlSelect.

Parameters:

builder - the StringBuilder to add to

htmlSelect - the target to process

appendOrderedList

protected void appendOrderedList(StringBuilder builder,
                                 HtmlOrderedList htmlOrderedList)

Process HtmlOrderedList taking care to numerate it.

Parameters:

builder - the StringBuilder to add to

htmlOrderedList - the OL element

appendPreformattedText

protected void appendPreformattedText(StringBuilder builder,
                                      HtmlPreformattedText htmlPreformattedText)

Process HtmlPreformattedText.

Parameters:

builder - the StringBuilder to add to

htmlPreformattedText - the target to process

appendInlineFrame

protected void appendInlineFrame(StringBuilder builder,
                                 HtmlInlineFrame htmlInlineFrame)

Process HtmlInlineFrame.

Parameters:

builder - the StringBuilder to add to

htmlInlineFrame - the target to process

appendText

protected void appendText(StringBuilder builder,
                          DomText domText)

Process DomText.

Parameters:

builder - the StringBuilder to add to

domText - the target to process

appendComment

protected void appendComment(StringBuilder builder,
                             DomComment domComment)

Process DomComment.

Parameters:

builder - the StringBuilder to add to

domComment - the target to process

appendApplet

protected void appendApplet(StringBuilder builder,
                            HtmlApplet htmlApplet)

Process HtmlApplet.

Parameters:

builder - the StringBuilder to add to

htmlApplet - the target to process

appendBreak

protected void appendBreak(StringBuilder builder,
                           HtmlBreak htmlBreak)

Process HtmlBreak.

Parameters:

builder - the StringBuilder to add to

htmlBreak - the target to process

doAppendCheckBoxInput

protected void doAppendCheckBoxInput(StringBuilder builder,
                                     HtmlCheckBoxInput htmlCheckBoxInput)

Process HtmlCheckBoxInput.

Parameters:

builder - the StringBuilder to add to

htmlCheckBoxInput - the target to process

doAppendRadioButtonInput

protected void doAppendRadioButtonInput(StringBuilder builder,
                                        HtmlRadioButtonInput htmlRadioButtonInput)

Process HtmlRadioButtonInput.

Parameters:

builder - the StringBuilder to add to

htmlRadioButtonInput - the target to process

setIgnoreMaskedElements

public void setIgnoreMaskedElements(boolean ignore)

Indicates if element that are not displayed due to style settings (visibility or display) should be visible in generated text.

Parameters:

ignore - indicates if masked elements should be ignored or not