|
IBM Rational Functional Tester Version 8.1.1000 IBM Rational Functional Tester API Reference Project Version 2.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.rational.test.ft.script.DatapoolScriptSupport com.rational.test.ft.script.SubitemFactory
public class SubitemFactory
A collection of static methods that create subitems. These methods are part of every script and are separated out for ease of documentation.
Field Summary |
---|
Fields inherited from class com.rational.test.ft.script.DatapoolScriptSupport |
---|
DP_ALL, DP_DEFAULT_EQUIVALENCE_CLASS, DP_SHARE_CURRENT_RECORD |
Constructor Summary | |
---|---|
SubitemFactory()
|
Method Summary | |
---|---|
static java.lang.String |
_S(java.lang.String key)
Look up a localized string table entry based on the provided key |
static Area |
atArea(Subitem area)
Returns an Area subitem. |
static Button |
atButton(java.lang.String name)
Returns an Button subitem. |
static Button |
atButton(Subitem item)
Returns an Button subitem. |
static Cell |
atCell(Column c, Row r)
Returns a Cell subitem. |
static Cell |
atCell(Row r, Column c)
Returns a Cell subitem. |
static Anchor |
atChild(Property[] properties)
Returns an Anchor subitem. |
static Anchor |
atChild(java.lang.String propName, java.lang.Object propValue)
Returns an Anchor subitem. |
static Anchor |
atChild(java.lang.String propName1, java.lang.Object propValue1, java.lang.String propName2, java.lang.Object propValue2)
Returns an Anchor subitem. |
static java.awt.Color |
atColor(int red, int blue, int green)
Returns a java.awt.Color subitem for the given color. |
static Column |
atColumn(Index i)
Returns a Column subitem. |
static Column |
atColumn(int i)
Returns a Column subitem. |
static Column |
atColumn(java.lang.String headerName)
Returns a Column subitem. |
static Column |
atColumn(java.lang.String key, java.lang.Object val)
Returns a Column subitem. |
static Column |
atColumn(java.lang.String key1, java.lang.Object val1, java.lang.String key2, java.lang.Object val2)
Returns a Column subitem. |
static Column |
atColumn(java.lang.String key1, java.lang.Object val1, java.lang.String key2, java.lang.Object val2, java.lang.String key3, java.lang.Object val3)
Returns a Column subitem. |
static Column |
atColumn(Subitem specifier)
Returns a Column subitem. |
static ColumnHeader |
atColumnHeader(Subitem header)
Returns an ColumnHeader subitem. |
static Date |
atDate(int mm, int yyyy)
Returns a Date subitem. |
static Date |
atDate(int mm, int dd, int yyyy)
Returns a Date subitem. |
static Anchor |
atDescendant(Property[] properties)
Returns an Anchor subitem. |
static Anchor |
atDescendant(java.lang.String propName, java.lang.Object propValue)
Returns an Anchor subitem. |
static Anchor |
atDescendant(java.lang.String propName1, java.lang.Object propValue1, java.lang.String propName2, java.lang.Object propValue2)
Returns an Anchor subitem. |
static DPoint |
atDPoint(double x, double y)
Returns a DPoint value. |
static DPosition |
atDPosition(double position)
Returns a Position subitem. |
static java.lang.String |
atFile(java.lang.String directory)
Returns a file path into a file name. |
static java.lang.String |
atFile(java.lang.String directory, java.lang.String file)
Combines a directory path and file path into a file name. |
static Header |
atHeader(Subitem header)
Returns an Header subitem. |
static Href |
atHref(java.lang.String url)
Returns an Href subitem. |
static Id |
atId(long id)
Returns an Id subitem. |
static Image |
atImage(java.lang.String tag)
Returns a Image subitem. |
static Image |
atImage(java.lang.String tag, int index)
Returns a Image subitem. |
static Index |
atIndex(int index)
Returns an Index subitem. |
static Link |
atLink(java.lang.String text)
Returns a Link subitem. |
static Link |
atLink(java.lang.String text, int index)
Returns a Link subitem. |
static List |
atList(Subitem s1)
Returns a List of one subitem. |
static List |
atList(Subitem[] subitems)
Returns a List consisting of an array of subitems. |
static List |
atList(Subitem s1, Subitem s2)
Returns a List of two subitems. |
static List |
atList(Subitem s1, Subitem s2, Subitem s3)
Returns a List of three subitems. |
static List |
atList(Subitem s1, Subitem s2, Subitem s3, Subitem s4)
Returns a List of four subitems. |
static Location |
atLocation(java.lang.String location)
Returns a Location subitem. |
static MouseModifiers |
atModifiers(int modifiers)
Returns a MouseModifiers subitem. |
static Name |
atName(java.lang.String name)
Returns a Name subitem. |
static Name |
atName(java.lang.String name, int index)
Returns an indexed Name subitem. |
static List |
atPath(java.lang.String path)
Returns a List that is a pathname. |
static java.awt.Point |
atPoint(int x, int y)
Returns a Point subitem. |
static Position |
atPosition(int position)
Returns a Position subitem. |
static Property |
atProperty(java.lang.String propertyName, java.lang.Object propertyValue)
Returns a Property subitem. |
static RecognitionIndex |
atRecognitionIndex(int index)
Returns an RecognitionIndex subitem. |
static Row |
atRow(Index i)
Returns a Row subitem. |
static Row |
atRow(int i)
Returns a Row subitem. |
static Row |
atRow(java.lang.String headerName)
Returns a Row subitem. |
static Row |
atRow(java.lang.String key, java.lang.Object val)
Returns a Row subitem. |
static Row |
atRow(java.lang.String key1, java.lang.Object val1, java.lang.String key2, java.lang.Object val2)
Returns a Row subitem. |
static Row |
atRow(java.lang.String key1, java.lang.Object val1, java.lang.String key2, java.lang.Object val2, java.lang.String key3, java.lang.Object val3)
Returns a Row subitem. |
static Row |
atRow(Subitem specifier)
Returns a Row subitem. |
static RowColumnIndex |
atRowColumnIndex(int rowIndex, int colIndex)
|
static RowHeader |
atRowHeader(Subitem header)
Returns an Header subitem. |
static Separator |
atSeparator(int separator)
Returns a Separator subitem. |
static Text |
atText(java.lang.String text)
Returns a Text subitem. |
static Text |
atText(java.lang.String text, int index)
Returns an indexed Text subitem. |
static TextPosition |
atTextPosition(int textPosition)
Returns a TextPosition subitem. |
static ToolTipText |
atToolTipText(java.lang.String text)
Returns a ToolTipText subitem. |
static ToolTipText |
atToolTipText(java.lang.String text, int index)
Returns an indexed ToolTipText subitem. |
static TopLeftHeader |
atTopLeftHeader(Subitem header)
Returns an ColumnHeader subitem. |
static Value |
atValue(java.lang.Object value)
Returns a Value subitem. |
static Week |
atWeek(int week, int mm, int yyyy)
Returns a Date subitem. |
static WeekDay |
atWeekDay(int mm, int dayofweek, int yyyy)
Returns a Date subitem. |
static LowLevelEvent |
delay(int millis)
Returns a LowLevelEvent representing a low level delay event. |
static LowLevelKeyEvent |
keyDown(java.lang.String key)
Returns a LowLevelEvent representing a low level key down event. |
static LowLevelKeyEvent |
keyUp(java.lang.String key)
Returns a LowLevelEvent representing a low level key up event. |
static LowLevelEvent |
leftMouseButtonDown()
Returns a LowLevelEvent representing a mouse left button down
event at the current cursor position. |
static LowLevelEvent |
leftMouseButtonUp()
Returns a LowLevelEvent representing a mouse left button up
event at the current cursor position. |
static LowLevelEvent |
middleMouseButtonDown()
Returns a LowLevelEvent representing a mouse middle button down
event at the current cursor position. |
static LowLevelEvent |
middleMouseButtonUp()
Returns a LowLevelEvent representing a mouse middle button up event at the current cursor position. |
static LowLevelEvent |
mouseMove(java.awt.Point pt)
Returns a LowLevelEvent representing a mouse movement. |
static LowLevelEvent |
mouseWheel(int numClicks)
Returns a LowLevelEvent representing a mouse wheel movement. |
static LowLevelEvent |
rightMouseButtonDown()
Returns a LowLevelEvent representing a mouse right button down
event at the current cursor position. |
static LowLevelEvent |
rightMouseButtonUp()
Returns a LowLevelEvent representing a mouse right button up
event at the current cursor position. |
static java.awt.Point |
toScreenPoint(int x, int y)
Returns a Point . |
Methods inherited from class com.rational.test.ft.script.DatapoolScriptSupport |
---|
dpBoolean, dpBoolean, dpBoolean, dpByte, dpByte, dpByte, dpChar, dpChar, dpChar, dpCurrent, dpDone, dpDouble, dpDouble, dpDouble, dpFactory, dpFloat, dpFloat, dpFloat, dpInitialization, dpInitialization, dpInitialize, dpInt, dpInt, dpInt, dpLong, dpLong, dpLong, dpNext, dpReset, dpShort, dpShort, dpShort, dpString, dpString, dpString, dpTermination, dpValue, dpValue, dpValue, getDatapool, setCurrentdp, setDatapool, storeDatapool, unsetDatapool |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SubitemFactory()
Method Detail |
---|
public static java.awt.Point atPoint(int x, int y)
Point
subitem.
public static DPoint atDPoint(double x, double y)
DPoint
value.
public static Index atIndex(int index)
Index
subitem.
public static RecognitionIndex atRecognitionIndex(int index)
RecognitionIndex
subitem.
public static Text atText(java.lang.String text)
Text
subitem.
public static Text atText(java.lang.String text, int index)
Text
subitem.
public static Date atDate(int mm, int dd, int yyyy)
Date
subitem.
public static Date atDate(int mm, int yyyy)
Date
subitem.
public static WeekDay atWeekDay(int mm, int dayofweek, int yyyy)
Date
subitem.
public static Week atWeek(int week, int mm, int yyyy)
Date
subitem.
public static ToolTipText atToolTipText(java.lang.String text)
ToolTipText
subitem.
public static ToolTipText atToolTipText(java.lang.String text, int index)
ToolTipText
subitem.
public static Name atName(java.lang.String name)
Name
subitem.
public static Name atName(java.lang.String name, int index)
Name
subitem.
public static Id atId(long id)
Id
subitem.
public static Href atHref(java.lang.String url)
Href
subitem.
public static Area atArea(Subitem area)
Area
subitem.
public static Header atHeader(Subitem header)
Header
subitem.
public static ColumnHeader atColumnHeader(Subitem header)
ColumnHeader
subitem.
public static TopLeftHeader atTopLeftHeader(Subitem header)
ColumnHeader
subitem.
public static RowHeader atRowHeader(Subitem header)
Header
subitem.
public static TextPosition atTextPosition(int textPosition)
TextPosition
subitem.
public static Value atValue(java.lang.Object value)
Value
subitem.
public static Location atLocation(java.lang.String location)
Location
subitem.
public static DPosition atDPosition(double position)
Position
subitem.
public static Position atPosition(int position)
Position
subitem.
public static List atList(Subitem s1)
List
of one subitem.
public static List atList(Subitem s1, Subitem s2)
List
of two subitems.
public static List atList(Subitem s1, Subitem s2, Subitem s3)
List
of three subitems.
public static List atList(Subitem s1, Subitem s2, Subitem s3, Subitem s4)
List
of four subitems.
public static List atList(Subitem[] subitems)
List
consisting of an array of subitems.
public static List atPath(java.lang.String path)
List
that is a pathname.
public static Separator atSeparator(int separator)
Separator
subitem.
public static Cell atCell(Column c, Row r)
Cell
subitem.
public static Cell atCell(Row r, Column c)
Cell
subitem.
public static Column atColumn(java.lang.String headerName)
Column
subitem.
public static Column atColumn(Index i)
Column
subitem.
public static Column atColumn(int i)
Column
subitem.
public static Column atColumn(java.lang.String key, java.lang.Object val)
Column
subitem.
public static Column atColumn(java.lang.String key1, java.lang.Object val1, java.lang.String key2, java.lang.Object val2)
Column
subitem.
public static Column atColumn(java.lang.String key1, java.lang.Object val1, java.lang.String key2, java.lang.Object val2, java.lang.String key3, java.lang.Object val3)
Column
subitem.
public static Column atColumn(Subitem specifier)
Column
subitem.
public static Row atRow(java.lang.String headerName)
Row
subitem.
public static Row atRow(Index i)
Row
subitem.
public static Row atRow(int i)
Row
subitem.
public static Row atRow(java.lang.String key, java.lang.Object val)
Row
subitem.
public static Row atRow(java.lang.String key1, java.lang.Object val1, java.lang.String key2, java.lang.Object val2)
Row
subitem.
public static Row atRow(java.lang.String key1, java.lang.Object val1, java.lang.String key2, java.lang.Object val2, java.lang.String key3, java.lang.Object val3)
Row
subitem.
public static Row atRow(Subitem specifier)
Row
subitem.
public static RowColumnIndex atRowColumnIndex(int rowIndex, int colIndex)
public static java.lang.String atFile(java.lang.String directory, java.lang.String file)
public static java.lang.String atFile(java.lang.String directory)
public static MouseModifiers atModifiers(int modifiers)
MouseModifiers
subitem.
public static java.awt.Point toScreenPoint(int x, int y)
Point
.
It is used to specify the target of a dragToScreenPoint
operation.
public static Property atProperty(java.lang.String propertyName, java.lang.Object propertyValue)
Property
subitem.
propertyName
- the canonical property namepropertyValue
- the property valuepublic static Anchor atChild(java.lang.String propName, java.lang.Object propValue)
Anchor
subitem.
propName
- the property namepropValue
- the property valuepublic static Anchor atDescendant(java.lang.String propName, java.lang.Object propValue)
Anchor
subitem.
propName
- the property namepropValue
- the property valuepublic static Anchor atChild(java.lang.String propName1, java.lang.Object propValue1, java.lang.String propName2, java.lang.Object propValue2)
Anchor
subitem.
propName1
- the property namepropValue1
- the property valuepropName2
- the property namepropValue2
- the property valuepublic static Anchor atDescendant(java.lang.String propName1, java.lang.Object propValue1, java.lang.String propName2, java.lang.Object propValue2)
Anchor
subitem.
propName1
- the property namepropValue1
- the property valuepropName2
- the property namepropValue2
- the property valuepublic static Anchor atChild(Property[] properties)
Anchor
subitem.
properties
- the array of propertiespublic static Anchor atDescendant(Property[] properties)
Anchor
subitem.
properties
- the array of propertiespublic static Button atButton(java.lang.String name)
Button
subitem.
name
- the name of the buttonpublic static Button atButton(Subitem item)
Button
subitem.
item
- the subitem for the buttonpublic static Image atImage(java.lang.String tag)
Image
subitem.
public static Image atImage(java.lang.String tag, int index)
Image
subitem.
public static Link atLink(java.lang.String text)
Link
subitem.
public static Link atLink(java.lang.String text, int index)
Link
subitem.
public static LowLevelEvent mouseWheel(int numClicks)
LowLevelEvent
representing a mouse wheel movement.
numClicks
- the number of mouse wheel clicks to move. A postive value
indicates the wheel was moved forward (up) and a negative value indicates the wheel was moved backward (down).public static LowLevelEvent mouseMove(java.awt.Point pt)
LowLevelEvent
representing a mouse movement.
pt
- the point to move the mouse cursor to.public static LowLevelEvent leftMouseButtonDown()
LowLevelEvent
representing a mouse left button down
event at the current cursor position.
public static LowLevelEvent leftMouseButtonUp()
LowLevelEvent
representing a mouse left button up
event at the current cursor position.
public static LowLevelEvent middleMouseButtonDown()
LowLevelEvent
representing a mouse middle button down
event at the current cursor position.
public static LowLevelEvent middleMouseButtonUp()
LowLevelEvent
representing a mouse middle button up event at the current cursor position.
public static LowLevelEvent rightMouseButtonDown()
LowLevelEvent
representing a mouse right button down
event at the current cursor position.
public static LowLevelEvent rightMouseButtonUp()
LowLevelEvent
representing a mouse right button up
event at the current cursor position.
public static LowLevelEvent delay(int millis)
LowLevelEvent
representing a low level delay event.
During playback of low level events this inserts a delay at least millis
long since the previous event was queued up. If the time for the prior event to be consumed is longer than millis
no additional delay will be taken.
millis
- the minimum delay in milliseconds to waitpublic static LowLevelKeyEvent keyDown(java.lang.String key)
LowLevelEvent
representing a low level key down event.
key
- this can either be a literal character to playback (i.e. "a") or a tool given name representing non-printable characters. The list follows: {CAPSLOCK}
{NUMLOCK}
{SCROLLLOCK}
{ESCAPE} {ESC}
{ENTER}
{HELP}
{PRTSC}
{TAB}
{BREAK}
{CLEAR}
{BACKSPACE} {BS} {BKSP}
{DELETE} {DEL}
{INSERT}
{LEFT}
{RIGHT}
{UP}
{DOWN}
{PGUP}
{PGDN}
{HOME}
{END}
{F1}
{F2}
{F3}
{F4}
{F5}
{F6}
{F7}
{F8}
{F9}
{F10}
{F11}
{F12}
{F13}
{F14}
{F15}
{F16}
{APPS}
{Win}
{LEFTWIN}
{RIGHTWIN}
{CTRL}
{SHIFT}
{ALT}
{LEFTCTRL}
{LEFTSHIFT}
{LEFTALT}
{RIGHTCTRL}
{RIGHTSHIFT}
{RIGHTALT}
{ExtDelete}
{ExtInsert}
{ExtLeft}
{ExtRight}
{ExtUp}
{ExtDown}
{ExtPgUp}
{ExtPgDn}
{ExtHome}
{ExtEnd}
{NumDelete}
{NumInsert}
{NumLeft}
{NumRight}
{NumUp}
{NumDown}
{NumPgUp}
{NumPgDn}
{NumHome}
{NumEnd}
{Num}
{Num-}
{Num/}
{Num+}
{Num~}
{NumEnter}
{Num0}
{Num1}
{Num2}
{Num3}
{Num4}
{Num5}
{Num6}
{Num7}
{Num8}
{Num9}
{Num.}public static LowLevelKeyEvent keyUp(java.lang.String key)
LowLevelEvent
representing a low level key up event.
key
- this can either be a literal character to playback (i.e. "a") or a tool given name representing non-printable characters.keyDown(String)
public static java.lang.String _S(java.lang.String key)
key:
- the key into the string table key
if
it could not be found.StringTableService
public static java.awt.Color atColor(int red, int blue, int green)
java.awt.Color
subitem for the given color.
red
- int The green colorblue
- int The blue colorgreen
- int The green color
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |