Action (HCL OneTest UI)

java.lang.Object
- com.rational.test.ft.script.Action

```
public class Action
extends java.lang.Object
```
Defines values that can be passed to various setState or getState methods of TestObjects that implement ISubitem. These values describe changes in the state of the object in the software under test. TestObject, which is the base class for all TestObjects, does not support the setState or getState methods.

Since:

RFT1.0

Method Summary

Methods
Modifier and Type	Method and Description
`static Action`	`check()` Creates a `CHECK` action object.
`static Action`	`collapse()` Creates a `COLLAPSE` action object.
`static Action`	`collapseAndExtendSelect()` Creates a `COLLAPSE_AND_EXTENDSELECT` action object.
`static Action`	`collapseAndSelect()` Creates a `COLLAPSE_AND_SELECT` action object.
`static Action`	`construct(int action, int value)` Serializes an `Action` object; this method should not be used directly.
`static Action`	`deselect()` Creates a `DESELECT` action object.
`static Action`	`deselectAll()` Creates a `DESELECT_ALL` action object.
`static Action`	`expand()` Creates an `EXPAND` action object.
`static Action`	`expandAndExtendSelect()` Creates an `EXPAND_AND_EXTENDSELECT` action object.
`static Action`	`expandAndSelect()` Creates an `EXPAND_AND_SELECT` action object.
`static Action`	`extendSelect()` Creates an `EXTEND_SELECT` action object.
`int`	`getAction()` Serializes an `Action` object; this method should not be used directly.
`java.lang.String`	`getActionImage()` Accesses the subitem value.
`int`	`getHScrollPosition()` Returns the target scroll position for a horizontal scroll action.
`int`	`getValue()` Serializes a `Value` object; this method should not be used directly.
`int`	`getVScrollPosition()` Returns the target scroll position for a vertical scroll action.
`static Action`	`hScroll(int toPosition)` Creates an `HSCROLL` (that is, horizontal scroll) action object.
`boolean`	`isCheck()` Returns `true` if this action represents a `CHECK` action.
`boolean`	`isCollapse()` Returns `true` if this action represents a `COLLAPSE` action.
`boolean`	`isCollapseAndExtendSelect()` Returns `true` if this action represents a `COLLAPSE_AND_EXTENDSELECT` action.
`boolean`	`isCollapseAndSelect()` Returns `true` if this action represents a `COLLAPSE_AND_SELECT` action.
`boolean`	`isDeselect()` Returns `true` if this action represents a `DESELECT` action.
`boolean`	`isDeselectAll()` Returns `true` if this action represents a `DESELECT_ALL` action.
`boolean`	`isExpand()` Returns `true` if this action represents an `EXPAND` action.
`boolean`	`isExpandAndExtendSelect()` Returns `true` if this action represents an `EXPAND_AND_EXTENDSELECT` action.
`boolean`	`isExpandAndSelect()` Returns `true` if this action represents an `EXPAND_AND_SELECT` action.
`boolean`	`isExtendSelect()` Returns `true` if this action represents an `EXTEND_SELECT` action.
`boolean`	`isHScroll()` Returns `true` if this action represents an `HSCROLL` action.
`boolean`	`isScrollAction()` Returns `true` if this action represents any of the scrolling actions.
`boolean`	`isScrollLineDown()` Returns `true` if this action represents a `SCROLL_LINEDOWN` action.
`boolean`	`isScrollLineLeft()` Returns `true` if this action represents a `SCROLL_LINELEFT` action.
`boolean`	`isScrollLineRight()` Returns `true` if this action represents a `SCROLL_LINERIGHT` action object.
`boolean`	`isScrollLineUp()` Returns `true` if this action represents a `SCROLL_LINEUP` action.
`boolean`	`isScrollPageDown()` Returns `true` if this action represents a `SCROLL_PAGEDOWN` action.
`boolean`	`isScrollPageLeft()` Returns `true` if this action represents a `SCROLL_PAGELEFT` action.
`boolean`	`isScrollPageRight()` Returns `true` if this action represents a `SCROLL_PAGERIGHT` action.
`boolean`	`isScrollPageUp()` Returns `true` if this action represents a `SCROLL_PAGEUP` action.
`boolean`	`isSelect()` Returns `true` if this action represents a `SELECT` action.
`boolean`	`isUncheck()` Returns `true` if this action represents an `UNCHECK` action.
`boolean`	`isUndetermined()` Returns `true` if this action represents an `UNDETERMINED` action.
`boolean`	`isVScroll()` Returns `true` if this action represents a `VSCROLL` action.
`static Action`	`scrollLineDown()` Creates a `SCROLL_LINEDOWN` action object.
`static Action`	`scrollLineLeft()` Creates a `SCROLL_LINELEFT` action object.
`static Action`	`scrollLineRight()` Creates a `SCROLL_LINERIGHT` action object.
`static Action`	`scrollLineUp()` Creates a `SCROLL_LINEUP` action object.
`static Action`	`scrollPageDown()` Creates a `SCROLL_PAGEDOWN` action object.
`static Action`	`scrollPageLeft()` Creates a `SCROLL_PAGELEFT` action object.
`static Action`	`scrollPageRight()` Creates a `SCROLL_PAGERIGHT` action object.
`static Action`	`scrollPageUp()` Creates a `SCROLL_PAGEUP` action object.
`static Action`	`select()` Creates a `SINGLE_SELECT` action object.
`java.lang.String`	`toString()` Sets `toString` to the value that this class represents.
`static Action`	`uncheck()` Creates an `UNCHECK` action object.
`static Action`	`undetermined()` Creates an `UNDETERMINED` action object.
`static Action`	`vScroll(int toPosition)` Creates a `VSCROLL` (that is, vertical scroll) action object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getActionImage
```
public java.lang.String getActionImage()
```
    Accesses the subitem value.
    
    Since:
    
    RFT1.0
  - select
```
public static Action select()
```
    Creates a SINGLE_SELECT action object.
    
    Since:
    
    RFT1.0
  - isSelect
```
public boolean isSelect()
```
    Returns true if this action represents a SELECT action.
    
    Since:
    
    RFT1.0
  - deselect
```
public static Action deselect()
```
    Creates a DESELECT action object.
    
    Since:
    
    RFT1.0
  - isDeselect
```
public boolean isDeselect()
```
    Returns true if this action represents a DESELECT action.
  - extendSelect
```
public static Action extendSelect()
```
    Creates an EXTEND_SELECT action object.
    
    Since:
    
    RFT1.0
  - isExtendSelect
```
public boolean isExtendSelect()
```
    Returns true if this action represents an EXTEND_SELECT action.
  - deselectAll
```
public static Action deselectAll()
```
    Creates a DESELECT_ALL action object.
    
    Since:
    
    RFT1.0
  - isDeselectAll
```
public boolean isDeselectAll()
```
    Returns true if this action represents a DESELECT_ALL action.
  - check
```
public static Action check()
```
    Creates a CHECK action object.
    
    Since:
    
    RFT1.0
  - isCheck
```
public boolean isCheck()
```
    Returns true if this action represents a CHECK action.
    
    Since:
    
    RFT1.0
  - uncheck
```
public static Action uncheck()
```
    Creates an UNCHECK action object.
    
    Since:
    
    RFT1.0
  - isUncheck
```
public boolean isUncheck()
```
    Returns true if this action represents an UNCHECK action.
    
    Since:
    
    RFT1.0
  - undetermined
```
public static Action undetermined()
```
    Creates an UNDETERMINED action object.
    
    Since:
    
    RFT1.0
  - isUndetermined
```
public boolean isUndetermined()
```
    Returns true if this action represents an UNDETERMINED action.
    
    Since:
    
    RFT1.0
  - isScrollAction
```
public boolean isScrollAction()
```
    Returns true if this action represents any of the scrolling actions.
    
    Since:
    
    RFT1.0
  - vScroll
```
public static Action vScroll(int toPosition)
```
    Creates a VSCROLL (that is, vertical scroll) action object.
    
    Since:
    
    RFT1.0
  - isVScroll
```
public boolean isVScroll()
```
    Returns true if this action represents a VSCROLL action.
    
    Since:
    
    RFT1.0
  - getVScrollPosition
```
public int getVScrollPosition()
```
    Returns the target scroll position for a vertical scroll action.
    
    Since:
    
    RFT1.0
  - hScroll
```
public static Action hScroll(int toPosition)
```
    Creates an HSCROLL (that is, horizontal scroll) action object.
    
    Since:
    
    RFT1.0
  - isHScroll
```
public boolean isHScroll()
```
    Returns true if this action represents an HSCROLL action.
    
    Since:
    
    RFT1.0
  - getHScrollPosition
```
public int getHScrollPosition()
```
    Returns the target scroll position for a horizontal scroll action.
    
    Since:
    
    RFT1.0
  - scrollPageUp
```
public static Action scrollPageUp()
```
    Creates a SCROLL_PAGEUP action object.
    
    Since:
    
    RFT1.0
  - isScrollPageUp
```
public boolean isScrollPageUp()
```
    Returns true if this action represents a SCROLL_PAGEUP action.
    
    Since:
    
    RFT1.0
  - scrollPageDown
```
public static Action scrollPageDown()
```
    Creates a SCROLL_PAGEDOWN action object.
    
    Since:
    
    RFT1.0
  - isScrollPageDown
```
public boolean isScrollPageDown()
```
    Returns true if this action represents a SCROLL_PAGEDOWN action.
    
    Since:
    
    RFT1.0
  - scrollPageLeft
```
public static Action scrollPageLeft()
```
    Creates a SCROLL_PAGELEFT action object.
    
    Since:
    
    RFT1.0
  - isScrollPageLeft
```
public boolean isScrollPageLeft()
```
    Returns true if this action represents a SCROLL_PAGELEFT action.
    
    Since:
    
    RFT1.0
  - scrollPageRight
```
public static Action scrollPageRight()
```
    Creates a SCROLL_PAGERIGHT action object.
    
    Since:
    
    RFT1.0
  - isScrollPageRight
```
public boolean isScrollPageRight()
```
    Returns true if this action represents a SCROLL_PAGERIGHT action.
    
    Since:
    
    RFT1.0
  - scrollLineUp
```
public static Action scrollLineUp()
```
    Creates a SCROLL_LINEUP action object.
    
    Since:
    
    RFT1.0
  - isScrollLineUp
```
public boolean isScrollLineUp()
```
    Returns true if this action represents a SCROLL_LINEUP action.
    
    Since:
    
    RFT1.0
  - scrollLineDown
```
public static Action scrollLineDown()
```
    Creates a SCROLL_LINEDOWN action object.
    
    Since:
    
    RFT1.0
  - isScrollLineDown
```
public boolean isScrollLineDown()
```
    Returns true if this action represents a SCROLL_LINEDOWN action.
    
    Since:
    
    RFT1.0
  - scrollLineLeft
```
public static Action scrollLineLeft()
```
    Creates a SCROLL_LINELEFT action object.
    
    Since:
    
    RFT1.0
  - isScrollLineLeft
```
public boolean isScrollLineLeft()
```
    Returns true if this action represents a SCROLL_LINELEFT action.
    
    Since:
    
    RFT1.0
  - scrollLineRight
```
public static Action scrollLineRight()
```
    Creates a SCROLL_LINERIGHT action object.
    
    Since:
    
    RFT1.0
  - isScrollLineRight
```
public boolean isScrollLineRight()
```
    Returns true if this action represents a SCROLL_LINERIGHT action object.
    
    Since:
    
    RFT1.0
  - expand
```
public static Action expand()
```
    Creates an EXPAND action object.
    
    Since:
    
    RFT1.0
  - isExpand
```
public boolean isExpand()
```
    Returns true if this action represents an EXPAND action.
    
    Since:
    
    RFT1.0
  - expandAndSelect
```
public static Action expandAndSelect()
```
    Creates an EXPAND_AND_SELECT action object.
    
    Since:
    
    RFT1.0
  - isExpandAndSelect
```
public boolean isExpandAndSelect()
```
    Returns true if this action represents an EXPAND_AND_SELECT action.
    
    Since:
    
    RFT1.0
  - expandAndExtendSelect
```
public static Action expandAndExtendSelect()
```
    Creates an EXPAND_AND_EXTENDSELECT action object.
    
    Since:
    
    RFT1.0
  - isExpandAndExtendSelect
```
public boolean isExpandAndExtendSelect()
```
    Returns true if this action represents an EXPAND_AND_EXTENDSELECT action.
    
    Since:
    
    RFT1.0
  - collapse
```
public static Action collapse()
```
    Creates a COLLAPSE action object.
    
    Since:
    
    RFT1.0
  - isCollapse
```
public boolean isCollapse()
```
    Returns true if this action represents a COLLAPSE action.
    
    Since:
    
    RFT1.0
  - collapseAndSelect
```
public static Action collapseAndSelect()
```
    Creates a COLLAPSE_AND_SELECT action object.
    
    Since:
    
    RFT1.0
  - isCollapseAndSelect
```
public boolean isCollapseAndSelect()
```
    Returns true if this action represents a COLLAPSE_AND_SELECT action.
    
    Since:
    
    RFT1.0
  - collapseAndExtendSelect
```
public static Action collapseAndExtendSelect()
```
    Creates a COLLAPSE_AND_EXTENDSELECT action object.
    
    Since:
    
    RFT1.0
  - isCollapseAndExtendSelect
```
public boolean isCollapseAndExtendSelect()
```
    Returns true if this action represents a COLLAPSE_AND_EXTENDSELECT action.
    
    Since:
    
    RFT1.0
  - construct
```
public static Action construct(int action,
               int value)
```
    Serializes an Action object; this method should not be used directly.
    
    Since:
    
    RFT1.0
  - getAction
```
public int getAction()
```
    Serializes an Action object; this method should not be used directly.
    
    Since:
    
    RFT1.0
  - getValue
```
public int getValue()
```
    Serializes a Value object; this method should not be used directly.
    
    Since:
    
    RFT1.0
  - toString
```
public java.lang.String toString()
```
    Sets toString to the value that this class represents.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Since:
    
    RFT1.0

Class Action

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getActionImage

select

isSelect

deselect

isDeselect

extendSelect

isExtendSelect

deselectAll

isDeselectAll

check

isCheck

uncheck

isUncheck

undetermined

isUndetermined

isScrollAction

vScroll

isVScroll

getVScrollPosition

hScroll

isHScroll

getHScrollPosition

scrollPageUp

isScrollPageUp

scrollPageDown

isScrollPageDown

scrollPageLeft

isScrollPageLeft

scrollPageRight

isScrollPageRight

scrollLineUp

isScrollLineUp

scrollLineDown

isScrollLineDown

scrollLineLeft

isScrollLineLeft

scrollLineRight

isScrollLineRight

expand

isExpand

expandAndSelect

isExpandAndSelect

expandAndExtendSelect

isExpandAndExtendSelect

collapse

isCollapse

collapseAndSelect

isCollapseAndSelect

collapseAndExtendSelect

isCollapseAndExtendSelect

construct

getAction

getValue

toString