com.meterware.httpunit
Class TextBlock

java.lang.Object
  extended by com.meterware.httpunit.BlockElement
      extended by com.meterware.httpunit.TextBlock
All Implemented Interfaces:
HTMLElement, HTMLSegment

public class TextBlock
extends BlockElement

A class which represents a block of text in a web page. Experimental.

Since:
1.6
Author:
Russell Gold

Field Summary
static HTMLElementPredicate MATCH_CLASS
          Predicate to match part or all of a block's class attribute.
static HTMLElementPredicate MATCH_TAG
          Predicate to match the tag associated with a block (case insensitive).
 
Constructor Summary
TextBlock(WebResponse response, FrameSelector frame, java.net.URL baseURL, java.lang.String baseTarget, org.w3c.dom.Node rootNode, java.lang.String characterSet)
           
 
Method Summary
 WebApplet[] getApplets()
          Returns a proxy for each applet found embedded in this page.
 java.lang.String[] getElementNames()
          Returns a list of HTML element names contained in this HTML section.
 HTMLElement[] getElementsWithAttribute(java.lang.String name, java.lang.String value)
          Returns the HTML elements with an attribute with the specified name and value.
 HTMLElement[] getElementsWithName(java.lang.String name)
          Returns the HTML elements with the specified name.
 HTMLElement getElementWithID(java.lang.String id)
          Returns the HTMLElement with the specified ID.
 WebForm getFirstMatchingForm(HTMLElementPredicate predicate, java.lang.Object criteria)
          Returns the first link found in the page matching the specified criteria.
 WebLink getFirstMatchingLink(HTMLElementPredicate predicate, java.lang.Object criteria)
          Returns the first link found in the page matching the specified criteria.
 WebTable getFirstMatchingTable(HTMLElementPredicate predicate, java.lang.Object criteria)
          Returns the first table in the response which matches the specified predicate and value.
 TextBlock getFirstMatchingTextBlock(HTMLElementPredicate predicate, java.lang.Object criteria)
          Returns the first text block found in the page which matches the specified predicate and value.
 WebForm[] getForms()
          Returns the forms found in the page in the order in which they appear.
 WebForm getFormWithID(java.lang.String id)
          Returns the form found in the page with the specified ID.
 WebForm getFormWithName(java.lang.String name)
          Returns the form found in the page with the specified name.
 com.meterware.httpunit.WebFrame[] getFrames()
          Returns the frames found in the page in the order in which they appear.
 WebImage[] getImages()
          Returns the images found in the page in the order in which they appear.
 WebImage getImageWithAltText(java.lang.String altText)
          Returns the first image found in the page with the specified alt attribute.
 WebImage getImageWithName(java.lang.String name)
          Returns the image found in the page with the specified name.
 WebImage getImageWithSource(java.lang.String source)
          Returns the first image found in the page with the specified src attribute.
 WebLink[] getLinks()
          Returns the links found in the page in the order in which they appear.
 WebLink getLinkWith(java.lang.String text)
          Returns the first link which contains the specified text.
 WebLink getLinkWithID(java.lang.String id)
          Returns the link found in the page with the specified ID.
 WebLink getLinkWithImageText(java.lang.String text)
          Returns the link which contains the first image with the specified text as its 'alt' attribute.
 WebLink getLinkWithName(java.lang.String name)
          Returns the link found in the page with the specified name.
 WebList[] getLists()
          Returns any lists embedded in this text block.
 WebForm[] getMatchingForms(HTMLElementPredicate predicate, java.lang.Object criteria)
          Returns all links found in the page matching the specified criteria.
 WebLink[] getMatchingLinks(HTMLElementPredicate predicate, java.lang.Object criteria)
          Returns all links found in the page matching the specified criteria.
 WebTable[] getMatchingTables(HTMLElementPredicate predicate, java.lang.Object criteria)
          Returns the tables in the response which match the specified predicate and value.
 TextBlock getNextTextBlock(TextBlock block)
           
 WebTable[] getTables()
          Returns the top-level tables found in the page in the order in which they appear.
 WebTable getTableStartingWith(java.lang.String text)
          Returns the first table in the response which has the specified text as the full text of its first non-blank row and non-blank column.
 WebTable getTableStartingWithPrefix(java.lang.String text)
          Returns the first table in the response which has the specified text as a prefix of the text in its first non-blank row and non-blank column.
 WebTable getTableWithID(java.lang.String ID)
          Returns the first table in the response which has the specified text as its ID attribute.
 WebTable getTableWithSummary(java.lang.String summary)
          Returns the first table in the response which has the specified text as its summary attribute.
 TextBlock[] getTextBlocks()
          Returns the top-level block elements found in the page in the order in which they appear.
 java.lang.String toString()
           
 
Methods inherited from class com.meterware.httpunit.BlockElement
equals, getAttribute, getAttributeValue, getClassName, getDOM, getID, getName, getScriptableDelegate, getTagName, getText, getTitle, hashCode, isSupportedAttribute
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.meterware.httpunit.HTMLSegment
getApplets, getElementNames, getElementsWithAttribute, getElementsWithName, getElementWithID, getFirstMatchingForm, getFirstMatchingLink, getFirstMatchingTable, getForms, getFormWithID, getFormWithName, getImages, getImageWithAltText, getImageWithName, getImageWithSource, getLinks, getLinkWith, getLinkWithImageText, getMatchingForms, getMatchingLinks, getMatchingTables, getTables, getTableStartingWith, getTableStartingWithPrefix, getTableWithID, getTableWithSummary, getTextBlocks
 

Field Detail

MATCH_CLASS

public static final HTMLElementPredicate MATCH_CLASS
Predicate to match part or all of a block's class attribute.


MATCH_TAG

public static final HTMLElementPredicate MATCH_TAG
Predicate to match the tag associated with a block (case insensitive).

Constructor Detail

TextBlock

public TextBlock(WebResponse response,
                 FrameSelector frame,
                 java.net.URL baseURL,
                 java.lang.String baseTarget,
                 org.w3c.dom.Node rootNode,
                 java.lang.String characterSet)
Method Detail

getLists

public WebList[] getLists()
Returns any lists embedded in this text block.


getForms

public WebForm[] getForms()
Returns the forms found in the page in the order in which they appear.


getLinks

public WebLink[] getLinks()
Returns the links found in the page in the order in which they appear.


getApplets

public WebApplet[] getApplets()
Returns a proxy for each applet found embedded in this page.


getImages

public WebImage[] getImages()
Returns the images found in the page in the order in which they appear.


getTextBlocks

public TextBlock[] getTextBlocks()
Returns the top-level block elements found in the page in the order in which they appear.


getFirstMatchingTextBlock

public TextBlock getFirstMatchingTextBlock(HTMLElementPredicate predicate,
                                           java.lang.Object criteria)
Returns the first text block found in the page which matches the specified predicate and value.


getNextTextBlock

public TextBlock getNextTextBlock(TextBlock block)

getTables

public WebTable[] getTables()
Returns the top-level tables found in the page in the order in which they appear.


getElementWithID

public HTMLElement getElementWithID(java.lang.String id)
Returns the HTMLElement with the specified ID.


getElementsWithName

public HTMLElement[] getElementsWithName(java.lang.String name)
Returns the HTML elements with the specified name.


getElementsWithAttribute

public HTMLElement[] getElementsWithAttribute(java.lang.String name,
                                              java.lang.String value)
Returns the HTML elements with an attribute with the specified name and value.


getElementNames

public java.lang.String[] getElementNames()
Returns a list of HTML element names contained in this HTML section.


getFormWithID

public WebForm getFormWithID(java.lang.String id)
Returns the form found in the page with the specified ID.


getLinkWithID

public WebLink getLinkWithID(java.lang.String id)
Returns the link found in the page with the specified ID.


getFirstMatchingForm

public WebForm getFirstMatchingForm(HTMLElementPredicate predicate,
                                    java.lang.Object criteria)
Returns the first link found in the page matching the specified criteria.


getMatchingForms

public WebForm[] getMatchingForms(HTMLElementPredicate predicate,
                                  java.lang.Object criteria)
Returns all links found in the page matching the specified criteria.


getFormWithName

public WebForm getFormWithName(java.lang.String name)
Returns the form found in the page with the specified name.


getLinkWith

public WebLink getLinkWith(java.lang.String text)
Returns the first link which contains the specified text.


getLinkWithImageText

public WebLink getLinkWithImageText(java.lang.String text)
Returns the link which contains the first image with the specified text as its 'alt' attribute.


getLinkWithName

public WebLink getLinkWithName(java.lang.String name)
Returns the link found in the page with the specified name.


getFirstMatchingLink

public WebLink getFirstMatchingLink(HTMLElementPredicate predicate,
                                    java.lang.Object criteria)
Returns the first link found in the page matching the specified criteria.


getMatchingLinks

public WebLink[] getMatchingLinks(HTMLElementPredicate predicate,
                                  java.lang.Object criteria)
Returns all links found in the page matching the specified criteria.


getImageWithName

public WebImage getImageWithName(java.lang.String name)
Returns the image found in the page with the specified name.


getImageWithSource

public WebImage getImageWithSource(java.lang.String source)
Returns the first image found in the page with the specified src attribute.


getImageWithAltText

public WebImage getImageWithAltText(java.lang.String altText)
Returns the first image found in the page with the specified alt attribute.


getFirstMatchingTable

public WebTable getFirstMatchingTable(HTMLElementPredicate predicate,
                                      java.lang.Object criteria)
Returns the first table in the response which matches the specified predicate and value. Will recurse into any nested tables, as needed.

Returns:
the selected table, or null if none is found

getMatchingTables

public WebTable[] getMatchingTables(HTMLElementPredicate predicate,
                                    java.lang.Object criteria)
Returns the tables in the response which match the specified predicate and value. Will recurse into any nested tables, as needed.

Returns:
the selected tables, or null if none are found

getTableStartingWith

public WebTable getTableStartingWith(java.lang.String text)
Returns the first table in the response which has the specified text as the full text of its first non-blank row and non-blank column. Will recurse into any nested tables, as needed.

Returns:
the selected table, or null if none is found

getTableStartingWithPrefix

public WebTable getTableStartingWithPrefix(java.lang.String text)
Returns the first table in the response which has the specified text as a prefix of the text in its first non-blank row and non-blank column. Will recurse into any nested tables, as needed.

Returns:
the selected table, or null if none is found

getTableWithSummary

public WebTable getTableWithSummary(java.lang.String summary)
Returns the first table in the response which has the specified text as its summary attribute. Will recurse into any nested tables, as needed.

Returns:
the selected table, or null if none is found

getTableWithID

public WebTable getTableWithID(java.lang.String ID)
Returns the first table in the response which has the specified text as its ID attribute. Will recurse into any nested tables, as needed.

Returns:
the selected table, or null if none is found

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getFrames

public com.meterware.httpunit.WebFrame[] getFrames()
Returns the frames found in the page in the order in which they appear.


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