org.safs

Class SAFSPlus.ScrollBar

java.lang.Object

org.safs.SAFSPlus.Component

org.safs.SAFSPlus.ScrollBar

Direct Known Subclasses:

SeleniumPlus.ScrollBar

Enclosing class:

SAFSPlus

public static class SAFSPlus.ScrollBar
extends SAFSPlus.Component

Wrapper class providing APIs to handle ScrollBar keywords, like OneDown, PageDown, PageUp etc.

Constructor Summary

Constructors

Constructor and Description
ScrollBar()

Method Summary

Modifier and Type	Method and Description
static boolean	OneDown(Component scrollbar, java.lang.String... params) Attempts to perform a ScrollLineDown on a scrollbar.
static boolean	OneLeft(Component scrollbar, java.lang.String... params) Attempts to perform a ScrollLeft on a scrollbar.
static boolean	OneRight(Component scrollbar, java.lang.String... params) Attempts to perform a ScrollRight on a scrollbar.
static boolean	OneUp(Component scrollbar, java.lang.String... params) Attempts to perform a ScrollLineUp on a scrollbar.
static boolean	PageDown(Component scrollbar, java.lang.String... params) Attempts to perform a ScrollPageDown on a scrollbar.
static boolean	PageLeft(Component scrollbar, java.lang.String... params) Attempts to perform a ScrollPageLeft on a scrollbar.
static boolean	PageRight(Component scrollbar, java.lang.String... params) Attempts to perform a ScrollPageRight on a scrollbar.
static boolean	PageUp(Component scrollbar, java.lang.String... params) Attempts to perform a ScrollPageUp on a scrollbar.

Methods inherited from class org.safs.SAFSPlus.Component

AltLeftDrag, AssignPropertyVariable, CaptureObjectDataToFile, CapturePropertiesToFile, CapturePropertyToFile, ClearCache, Click, CtrlAltLeftDrag, CtrlClick, CtrlLeftDrag, CtrlRightClick, CtrlShiftLeftDrag, DoubleClick, DragTo, ExecuteScript, GetComputedStyle, GetGUIImage, GetTextFromGUI, GUIDoesExist, GUIDoesNotExist, HoverMouse, HoverScreenLocation, InputCharacters, InputKeys, IsPropertyExist, IsPropertyExist, LeftDrag, LocateScreenImage, RightClick, RightDrag, SaveTextFromGUI, ShiftClick, ShiftLeftDrag, ShowOnPage, TypeChars, TypeEncryption, TypeKeys, VerifyBinaryFileToFile, VerifyComputedStyle, VerifyFileToFile, VerifyGUIImageToFile, VerifyObjectDataToFile, VerifyPropertiesSubsetToFile, VerifyPropertiesToFile, VerifyProperty, VerifyPropertyContains, VerifyPropertyContains, VerifyPropertyToFile, VerifyTextFileToFile, VerifyValueContains, VerifyValueContainsIgnoreCase, VerifyValueDoesNotContain, VerifyValues, VerifyValuesIgnoreCase, VerifyValuesNotEqual

Methods inherited from class java.lang.Object

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

Constructor Detail

ScrollBar

public ScrollBar()

Method Detail

OneDown

public static boolean OneDown(Component scrollbar,
                              java.lang.String... params)

Attempts to perform a ScrollLineDown on a scrollbar.

See Detailed Reference

Parameters:

scrollbar - Component (from App Map), a vertical scrollbar.

params - optional

params[0] steps int, The steps to scroll, must be positive.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ScrollBar.OneDown(Map.Window.ScrollBar);//move 1 step down
 boolean success = ScrollBar.OneDown(Map.Window.ScrollBar, "5");//move 5 steps down
 
 

OneUp

public static boolean OneUp(Component scrollbar,
                            java.lang.String... params)

Attempts to perform a ScrollLineUp on a scrollbar.

See Detailed Reference

Parameters:

scrollbar - Component (from App Map), a vertical scrollbar.

params - optional

params[0] steps int, The steps to scroll, must be positive.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ScrollBar.OneUp(Map.Window.ScrollBar);//move 1 step up
 boolean success = ScrollBar.OneUp(Map.Window.ScrollBar, "5");//move 5 steps up
 
 

OneLeft

public static boolean OneLeft(Component scrollbar,
                              java.lang.String... params)

Attempts to perform a ScrollLeft on a scrollbar.

See Detailed Reference

Parameters:

scrollbar - Component (from App Map), a horizontal scrollbar.

params - optional

params[0] steps int, The steps to scroll, must be positive.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ScrollBar.OneLeft(Map.Window.ScrollBar);//move 1 step Left
 boolean success = ScrollBar.OneLeft(Map.Window.ScrollBar, "5");//move 5 steps Left
 
 

OneRight

public static boolean OneRight(Component scrollbar,
                               java.lang.String... params)

Attempts to perform a ScrollRight on a scrollbar.

See Detailed Reference

Parameters:

scrollbar - Component (from App Map), a horizontal scrollbar.

params - optional

params[0] steps int, The steps to scroll, must be positive.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ScrollBar.OneRight(Map.Window.ScrollBar);//move 1 step Right
 boolean success = ScrollBar.OneRight(Map.Window.ScrollBar, "5");//move 5 steps Right
 
 

PageDown

public static boolean PageDown(Component scrollbar,
                               java.lang.String... params)

Attempts to perform a ScrollPageDown on a scrollbar.

See Detailed Reference

Parameters:

scrollbar - Component (from App Map), a vertical scrollbar.

params - optional

params[0] pages int, The pages to scroll, must be positive.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ScrollBar.PageDown(Map.Window.ScrollBar);//move 1 page down
 boolean success = ScrollBar.PageDown(Map.Window.ScrollBar, "5");//move 5 pages down
 
 

PageUp

public static boolean PageUp(Component scrollbar,
                             java.lang.String... params)

Attempts to perform a ScrollPageUp on a scrollbar.

See Detailed Reference

Parameters:

scrollbar - Component (from App Map), a vertical scrollbar.

params - optional

params[0] pages int, The pages to scroll, must be positive.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ScrollBar.PageUp(Map.Window.ScrollBar);//move 1 page up
 boolean success = ScrollBar.PageUp(Map.Window.ScrollBar, "5");//move 5 pages up
 
 

PageLeft

public static boolean PageLeft(Component scrollbar,
                               java.lang.String... params)

Attempts to perform a ScrollPageLeft on a scrollbar.

See Detailed Reference

Parameters:

scrollbar - Component (from App Map), a horizontal scrollbar.

params - optional

params[0] pages int, The pages to scroll, must be positive.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ScrollBar.PageLeft(Map.Window.ScrollBar);//move 1 page Left
 boolean success = ScrollBar.PageLeft(Map.Window.ScrollBar, "5");//move 5 pages Left
 
 

PageRight

public static boolean PageRight(Component scrollbar,
                                java.lang.String... params)

Attempts to perform a ScrollPageRight on a scrollbar.

See Detailed Reference

Parameters:

scrollbar - Component (from App Map), a horizontal scrollbar.

params - optional

params[0] pages int, The pages to scroll, must be positive.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ScrollBar.PageRight(Map.Window.ScrollBar);//move 1 page Right
 boolean success = ScrollBar.PageRight(Map.Window.ScrollBar, "5");//move 5 pages Right