com.meterware.httpunit
Class WebTable

java.lang.Object
  extended bycom.meterware.httpunit.HTMLElementBase
      extended bycom.meterware.httpunit.WebTable
All Implemented Interfaces:
HTMLElement

public class WebTable
extends com.meterware.httpunit.HTMLElementBase

This class represents a table in an HTML page.

Author:
Russell Gold, Benoit Xhenseval

Field Summary
static HTMLElementPredicate MATCH_FIRST_NONBLANK_CELL
          Predicate to match the complete text of a table's first non-blank cell.
static HTMLElementPredicate MATCH_FIRST_NONBLANK_CELL_PREFIX
          Predicate to match a prefix of a table's first non-blank cell.
static HTMLElementPredicate MATCH_ID
          Predicate to match a table's ID.
static HTMLElementPredicate MATCH_SUMMARY
          Predicate to match a table's summary attribute.
 
Method Summary
 java.lang.String[][] asText()
          Returns a rendering of this table with all cells converted to text.
 java.lang.String getAttribute(java.lang.String name)
          Returns the value of the attribute of this element with the specified name.
protected  java.lang.String getAttribute(java.lang.String name, java.lang.String defaultValue)
           
 java.lang.String getCellAsText(int row, int column)
          Returns the contents of the specified table cell as text.
 java.lang.String getClassName()
          Returns the class associated with this element.
 int getColumnCount()
          Returns the number of columns in the table.
 java.lang.String getID()
          Returns the ID associated with this element.
 java.lang.String getName()
          Returns the name associated with this element.
protected  org.w3c.dom.Node getNode()
           
protected  ScriptableDelegate getParentDelegate()
          Returns the scriptable delegate which can provide the scriptable delegate for this element.
 int getRowCount()
          Returns the number of rows in the table.
 TableRow[] getRows()
          Returns an array of rows for this table.
 ScriptableDelegate getScriptableDelegate()
          Returns a scriptable object which can act as a proxy for this control.
 java.lang.String getSummary()
          Returns the summary attribute associated with this table.
 TableCell getTableCell(int row, int column)
          Returns the contents of the specified table cell as text.
 TableCell getTableCellWithID(java.lang.String id)
          Returns the contents of the specified table cell with a given ID
 java.lang.String getTagName()
          Returns the tag name of this node.
 java.lang.String getText()
          Returns the text value of this block.
 java.lang.String getTitle()
          Returns the title associated with this element.
 boolean isSupportedAttribute(java.lang.String name)
          Returns true if this element may have an attribute with the specified name.
protected  ScriptableDelegate newScriptable()
          Creates and returns a scriptable object for this control.
 void purgeEmptyCells()
          Removes all rows and all columns from this table which have no visible text in them.
protected  void supportAttribute(java.lang.String name)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MATCH_FIRST_NONBLANK_CELL

public static final HTMLElementPredicate MATCH_FIRST_NONBLANK_CELL
Predicate to match the complete text of a table's first non-blank cell.


MATCH_FIRST_NONBLANK_CELL_PREFIX

public static final HTMLElementPredicate MATCH_FIRST_NONBLANK_CELL_PREFIX
Predicate to match a prefix of a table's first non-blank cell.


MATCH_SUMMARY

public static final HTMLElementPredicate MATCH_SUMMARY
Predicate to match a table's summary attribute.


MATCH_ID

public static final HTMLElementPredicate MATCH_ID
Predicate to match a table's ID.

Method Detail

getRowCount

public int getRowCount()
Returns the number of rows in the table.


getColumnCount

public int getColumnCount()
Returns the number of columns in the table.


getCellAsText

public java.lang.String getCellAsText(int row,
                                      int column)
Returns the contents of the specified table cell as text. The row and column numbers are zero-based.

Throws:
java.lang.IndexOutOfBoundsException - if the specified cell numbers are not valid

getTableCell

public TableCell getTableCell(int row,
                              int column)
Returns the contents of the specified table cell as text. The row and column numbers are zero-based.

Throws:
java.lang.IndexOutOfBoundsException - if the specified cell numbers are not valid

getTableCellWithID

public TableCell getTableCellWithID(java.lang.String id)
Returns the contents of the specified table cell with a given ID

Returns:
TableCell with given ID or null if ID is not found.

purgeEmptyCells

public void purgeEmptyCells()
Removes all rows and all columns from this table which have no visible text in them.


asText

public java.lang.String[][] asText()
Returns a rendering of this table with all cells converted to text.


getSummary

public java.lang.String getSummary()
Returns the summary attribute associated with this table.


toString

public java.lang.String toString()

newScriptable

protected ScriptableDelegate newScriptable()
Description copied from class: com.meterware.httpunit.HTMLElementBase
Creates and returns a scriptable object for this control. Subclasses should override this if they use a different implementation of Scriptable.


getParentDelegate

protected ScriptableDelegate getParentDelegate()
Description copied from class: com.meterware.httpunit.HTMLElementBase
Returns the scriptable delegate which can provide the scriptable delegate for this element.


getRows

public TableRow[] getRows()
Returns an array of rows for this table.


getID

public java.lang.String getID()
Description copied from interface: HTMLElement
Returns the ID associated with this element. IDs are unique throughout the HTML document.

Specified by:
getID in interface HTMLElement

getClassName

public java.lang.String getClassName()
Description copied from interface: HTMLElement
Returns the class associated with this element.

Specified by:
getClassName in interface HTMLElement

getTitle

public java.lang.String getTitle()
Description copied from interface: HTMLElement
Returns the title associated with this element.

Specified by:
getTitle in interface HTMLElement

getName

public java.lang.String getName()
Description copied from interface: HTMLElement
Returns the name associated with this element.

Specified by:
getName in interface HTMLElement

getScriptableDelegate

public ScriptableDelegate getScriptableDelegate()
Returns a scriptable object which can act as a proxy for this control.

Specified by:
getScriptableDelegate in interface HTMLElement

getText

public java.lang.String getText()
Returns the text value of this block.

Specified by:
getText in interface HTMLElement

getTagName

public java.lang.String getTagName()
Description copied from interface: HTMLElement
Returns the tag name of this node.

Specified by:
getTagName in interface HTMLElement

getAttribute

public java.lang.String getAttribute(java.lang.String name)
Description copied from interface: HTMLElement
Returns the value of the attribute of this element with the specified name. Returns the empty string if no such attribute exists.

Specified by:
getAttribute in interface HTMLElement

isSupportedAttribute

public boolean isSupportedAttribute(java.lang.String name)
Description copied from interface: HTMLElement
Returns true if this element may have an attribute with the specified name.

Specified by:
isSupportedAttribute in interface HTMLElement

getAttribute

protected java.lang.String getAttribute(java.lang.String name,
                                        java.lang.String defaultValue)

getNode

protected org.w3c.dom.Node getNode()

supportAttribute

protected void supportAttribute(java.lang.String name)

Copyright © 2000-2006 Russell Gold. See license agreement for rights granted.