com.rational.test.ft.script

Class CaptionText

java.lang.Object

com.rational.test.ft.script.CaptionText

public class CaptionText
extends java.lang.Object

Encapsulates a window caption. This class is needed so that comparisons can be performed against objects of this type. Captions can contain variable information, such as file names. The variable information that is used typically depends on the application switch settings. Using this class allows the variable information to be ignored when it follows common caption formats such as:

• Program Title - [variable text]
• [variable text] - Program Title
• Program Title : [variable text]
• [variable text] : Program Title

The colon and dash characters are searched for. When found, they are used to delineate variable text in the caption. Combined with RegularExpression support, common caption encodings can easily be compared in a meaningful way.

Since:

RFT1.0

Constructor Summary

Constructors

Constructor and Description
CaptionText(java.lang.String caption) Constructs a CaptionText wrapper class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object right) Overrides the default Object.equals to provide a more interesting caption-specific result.
java.lang.String	getCaption() Returns the caption text encapsulated by this class.
void	setCaption(java.lang.String caption) Overrides the previously defined caption text encapsulated by this class.
java.lang.String	toString() Overrides the default Object.toString to provide a more interesting caption-specific result.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptionText

public CaptionText(java.lang.String caption)

Constructs a CaptionText wrapper class. The caption text is wrapped so that more interesting kinds of comparisons can be performed on this text, rather than just straight character-by-character comparisons.

Since:

RFT1.0

Method Detail

getCaption

public java.lang.String getCaption()

Returns the caption text encapsulated by this class.

Since:

RFT1.0

setCaption

public void setCaption(java.lang.String caption)

Overrides the previously defined caption text encapsulated by this class.

Parameters:

caption - the caption text to be used

Since:

RFT1.0

equals

public boolean equals(java.lang.Object right)

Overrides the default Object.equals to provide a more interesting caption-specific result.

Overrides:

equals in class java.lang.Object

Parameters:

right - the right side of the equals comparison

Returns:

A caption-specific comparison

Since:

RFT1.0

toString

public java.lang.String toString()

Overrides the default Object.toString to provide a more interesting caption-specific result.

Overrides:

toString in class java.lang.Object

Returns:

The current caption text

Since:

RFT1.0