IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester Proxy SDK Reference

Project Version 2.3

com.rational.test.ft.domain.java.swt
Class ScrollableProxy

java.lang.Object   extended by com.rational.test.ft.sys.RegisteredObject       extended by com.rational.test.ft.domain.ProxyTestObject
          extended by com.rational.test.ft.domain.java.JavaProxy
              extended by com.rational.test.ft.domain.java.JavaGuiProxy
                  extended by com.rational.test.ft.domain.java.swt.ControlProxy
                      extended by com.rational.test.ft.domain.java.swt.ScrollableProxy
All Implemented Interfaces:
IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, com.rational.test.ft.object.interfaces.IGraphical
Direct Known Subclasses:
CompositeProxy, CoolBarProxy, ScrollableSwtGraphicalSubitemProxy, TextProxy

public class ScrollableProxy
extends ControlProxy

This is the proxy class for org.eclipse.swt.widgets.Control.Scrollable.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.swt.ControlProxy
ControlProxy.ChildEnumerator, ControlProxy.ImmediateChildEnumerator
 
Field Summary
 
Fields inherited from class com.rational.test.ft.domain.java.swt.ControlProxy
childrenEnumerated, CLASSINDEX, CLASSINDEXWEIGHT, clickArgs, currentMethod, GROUPTEXT, GROUPTEXTWEIGHT, HANDLE, MAPPABLECLASSINDEX, MAPPABLECLASSINDEXWEIGHT, MAX_NAME, predownScreenRect, PRIORLABEL, PRIORLABELWEIGHT, TOOLTIPTEXT, TOOLTIPTEXTWEIGHT
 
Fields inherited from class com.rational.test.ft.domain.java.JavaGuiProxy
LEFT, preDownState, processMouseEventHandler, ROLEINDEX, ROLEINDEXWEIGHT, TESTDATA_SPECIALFRAMESTATE, TESTDATA_SPECIALFRAMESTATE_DESCRIPTION, topLevelWindow
 
Fields inherited from class com.rational.test.ft.domain.java.JavaProxy
debug, uniqueId
 
Fields inherited from class com.rational.test.ft.domain.ProxyTestObject
BROWSERTABTESTOBJECT_CLASSNAME, BROWSERTESTOBJECT_CLASSNAME, COLORDIALOGTESTOBJECT_CLASSNAME, CROSSDOMAINCONTAINER_CLASSNAME, DOCUMENTTESTOBJECT_CLASSNAME, DOMAINTESTOBJECT_CLASSNAME, ECLIPSETOPLEVELTESTOBJECT_CLASSNAME, EMBEDDEDBROWSERTESTOBJECT_CLASSNAME, FILEDIALOGTESTOBJECT_CLASSNAME, FRAMESUBITEMTESTOBJECT_CLASSNAME, FRAMETESTOBJECT_CLASSNAME, GEFEDITPARTTESTOBJECT_CLASSNAME, GUISUBITEMTESTOBJECT_CLASSNAME, GUITESTOBJECT_CLASSNAME, INTERNALFRAMETESTOBJECT_CLASSNAME, MESSAGEBOXTESTOBJECT_CLASSNAME, PALETTEGUISUBITEMTESTOBJECT_CLASSNAME, PROCESSTESTOBJECT_CLASSNAME, SCROLLSUBITEMTESTOBJECT_CLASSNAME, SCROLLTESTOBJECT_CLASSNAME, SELECTGUISUBITEMTESTOBJECT_CLASSNAME, SELECTSCROLLGUISUBITEMTESTOBJECT_CLASSNAME, SHELLTESTOBJECT_CLASSNAME, STATELESSGUISUBITEMTESTOBJECT_CLASSNAME, SUBITEMTESTOBJECT_CLASSNAME, TABITEMTESTOBJECT_CLASSNAME, TESTOBJECT_CLASSNAME, TEXTGUISUBITEMTESTOBJECT_CLASSNAME, TEXTGUITESTOBJECT_CLASSNAME, TEXTSCROLLTESTOBJECT_CLASSNAME, TEXTSELECTGUISUBITEMTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle
 
Fields inherited from class com.rational.test.ft.sys.RegisteredObject
theTestObject
 
Fields inherited from interface com.rational.test.ft.domain.IDataDriven
INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS
 
Constructor Summary
ScrollableProxy(java.lang.Object theObjectInTheSUT)
          This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.
 
Method Summary
 boolean canBeScrolled()
          Returns true if the object is associated with scrollbar(s).
 org.eclipse.swt.graphics.Rectangle getClientArea()
          Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").
 org.eclipse.swt.widgets.ScrollBar getHorizontalBar()
          Gets the horizontal Scroll Bar.
 java.lang.String getTestObjectClassName()
          Returns the classname of a scrollable test object.
 org.eclipse.swt.widgets.ScrollBar getVerticalBar()
          Gets the vertical Scroll Bar.
 void hScroll(int value)
          This method scrolls the control horizontally.
 void hScrollTo(int value)
          This method scrolls the control horizontally.
 boolean isHorizontalScrollable(int style)
           
protected  boolean isPointInClientArea(java.awt.Point pt)
           
 boolean isScrollable(int style)
           
 boolean isVerticalScrollable(int style)
           
 void processSingleMouseEvent(IMouseActionInfo action)
           
 void scrollLineDown()
          Moves a vertical scrollbar one line (also called a unit) down in position.
 void scrollLineLeft()
          Moves a horizontal scrollbar one line (also called a unit) left in position.
 void scrollLineRight()
          Moves a horizontal scrollbar one line (also called a unit) right in position.
 void scrollLineUp()
          Moves a vertical scrollbar one line (also called a unit) up in position.
 void scrollPageDown()
          This action moves a vertical scrollbar one page (also called a block) down in position.
 void scrollPageLeft()
          This action moves a horizontal scrollbar one page (also called a block) left in position.
 void scrollPageRight()
          This action moves a horizontal scrollbar one page (also called a block) right in position.
 void scrollPageUp()
          This action moves a vertical scrollbar one page (also called a block) up in position.
 void scrollRectToVisible(java.awt.Rectangle rect)
          Scrolls so that given rectangle becomes visible.
 void vScroll(int value)
          This method scrolls the control vertically.
 void vScrollTo(int value)
          This method scrolls the control vertically.
 
Methods inherited from class com.rational.test.ft.domain.java.swt.ControlProxy
childConstructed, getActionArgs, getChannel, getChildProxy, getChildrenEnumeration, getClippedScreenRectangle, getDefaultActionArgs, getDescriptiveName, getHandle, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParentObject, getProperty, getReorderedChildren, getRole, getScreenRectangle, getStyle, getToolTipText, getTopMappableParent, getTopParent, getVisualClippedRectangle, hasFocus, isEnabled, isGTK, isLabelled, isObjectMoved, isShell, isShowing, processHoverMouseEvent, processPreDownMouseEvent, processPreUpMouseEvent, setClickArgs, setDownPointArgs, setDrag, setMethodSpecification, setMultiClickAction, setRecordCache
 
Methods inherited from class com.rational.test.ft.domain.java.JavaGuiProxy
activateTopWindow, click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getChildAtPoint, getClippedRect, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isOpaque, isPointInObject, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processMouseEvent, setProcessMouseEventHandler, setTopLevelWindow, shouldBeMapped
 
Methods inherited from class com.rational.test.ft.domain.java.JavaProxy
addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMappableChildren, getMethods, getNonValueProperties, getProperties, getRecognitionProperties, getRecognitionPropertyWeight, getStandardProperties, getTestDataTypes, getTestDomain, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, isRecognitionProperty, setIndexer, setProperty
 
Methods inherited from class com.rational.test.ft.domain.ProxyTestObject
addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChildren, getDataDrivableCommand, getDataDrivableCommands, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getTestData, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction, updateTestData
 
Methods inherited from class com.rational.test.ft.sys.RegisteredObject
addProxyReference, dereference, getObject, getRegisteredId, getTransactionId, isReferenced, isReleaseRequired, register, registerTransiently, release, toString, unregister
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScrollableProxy

public ScrollableProxy(java.lang.Object theObjectInTheSUT)
This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy. All interactions with the supplied object are performed through this class.

Method Detail

getTestObjectClassName

public java.lang.String getTestObjectClassName()
Returns the classname of a scrollable test object.

Specified by:
getTestObjectClassName in interface IProxyBase
Overrides:
getTestObjectClassName in class JavaGuiProxy
Returns:
The default test object class full name.

getHorizontalBar

public org.eclipse.swt.widgets.ScrollBar getHorizontalBar()
Gets the horizontal Scroll Bar.

Returns:
the horizontal Scroll Bar (or null)

getVerticalBar

public org.eclipse.swt.widgets.ScrollBar getVerticalBar()
Gets the vertical Scroll Bar.

Returns:
the vertical Scroll Bar (or null)

getClientArea

public org.eclipse.swt.graphics.Rectangle getClientArea()
Returns a rectangle which describes the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings").

Returns:
the client area

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)
Overrides:
processSingleMouseEvent in class JavaGuiProxy

hScrollTo

public void hScrollTo(int value)
This method scrolls the control horizontally.

Parameters:
value - The position of the vertical scrollbar after this action is completed.
See Also:
hScrollTo(int)

hScroll

public void hScroll(int value)
This method scrolls the control horizontally.

Parameters:
value - The position of the vertical scrollbar after this action is completed.
See Also:
hScrollTo(int)

vScrollTo

public void vScrollTo(int value)
This method scrolls the control vertically.

Parameters:
value - The position of the horizontal scrollbar after this action is completed.
See Also:
vScrollTo(int)

vScroll

public void vScroll(int value)
This method scrolls the control vertically.

Parameters:
value - The position of the horizontal scrollbar after this action is completed.
See Also:
vScrollTo(int)

scrollPageUp

public void scrollPageUp()
This action moves a vertical scrollbar one page (also called a block) up in position.


scrollPageDown

public void scrollPageDown()
This action moves a vertical scrollbar one page (also called a block) down in position.


scrollPageLeft

public void scrollPageLeft()
This action moves a horizontal scrollbar one page (also called a block) left in position.


scrollPageRight

public void scrollPageRight()
This action moves a horizontal scrollbar one page (also called a block) right in position.


scrollLineUp

public void scrollLineUp()
Moves a vertical scrollbar one line (also called a unit) up in position.


scrollLineDown

public void scrollLineDown()
Moves a vertical scrollbar one line (also called a unit) down in position.


scrollLineLeft

public void scrollLineLeft()
Moves a horizontal scrollbar one line (also called a unit) left in position.


scrollLineRight

public void scrollLineRight()
Moves a horizontal scrollbar one line (also called a unit) right in position.


canBeScrolled

public boolean canBeScrolled()
Returns true if the object is associated with scrollbar(s). By default, it returns false<\b>.

Returns:
true if the object is associated with scrollbar(s).

isPointInClientArea

protected boolean isPointInClientArea(java.awt.Point pt)

isScrollable

public boolean isScrollable(int style)

isHorizontalScrollable

public boolean isHorizontalScrollable(int style)

isVerticalScrollable

public boolean isVerticalScrollable(int style)

scrollRectToVisible

public void scrollRectToVisible(java.awt.Rectangle rect)
Scrolls so that given rectangle becomes visible.

Overrides:
scrollRectToVisible in class ControlProxy