com.rational.test.ft.domain.java.jfc
Class JScrollBarProxy

java.lang.Object   com.rational.test.ft.sys.RegisteredObject       com.rational.test.ft.domain.ProxyTestObject
          com.rational.test.ft.domain.java.JavaProxy
              com.rational.test.ft.domain.java.JavaGuiProxy
                  com.rational.test.ft.domain.java.awt.ComponentProxy
                      com.rational.test.ft.domain.java.jfc.JComponentProxy
                          com.rational.test.ft.domain.java.jfc.JfcGraphicalSubitemProxy
                              com.rational.test.ft.domain.java.jfc.JScrollBarProxy

All Implemented Interfaces:

IChannelObject, IDataDriven, IProxyBase, IPropertyFilter, ISetParent, com.rational.test.ft.object.interfaces.IGraphical, com.rational.test.ft.object.interfaces.IGraphicalSubitem, com.rational.test.ft.object.interfaces.ISubitem

public class JScrollBarProxy
extends JfcGraphicalSubitemProxy
implements com.rational.test.ft.object.interfaces.ISubitem

Proxy class for javax.swing.JScrollBar.

• TestObject interface:
  GuiSubitemTestObject
  
  

• Default Recognition Properties:
  

  Property	Usage
  .class	The Java full class name of the test object.
  .classIndex	The zero-based index of the class relative to the immediate parent in the object map.
  .priorLabel	The text of a preceding label. Suppressed if there is no preceding label.
  accessibleContext.accessibleName	A programmatically defined name for the component.
  name	The name property, suppressed if default formatted (default form = className+count).
  orientation	Integer value Adjustable.VERTICAL or Adjustable.HORIZONTAL depending on the layout of the component.
  toolTipText	The text from the associated tool tip, omitted if there is no associated tool tip.

  
  

• Supported Subitems:
  

  Subitem	Usage
  Location	Defines the scrollbar subobject to act upon. Note that only scrollbar related Location items are supported.

  
  

Nested Class Summary

Nested classes/interfaces inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

ComponentProxy.ChildEnumerator, ComponentProxy.ImmediateChildEnumerator

Field Summary

protected static int	HORIZONTAL Horizontal orientation.
protected static int	VERTICAL Vertical orientation.

Fields inherited from class com.rational.test.ft.domain.java.jfc.JComponentProxy

TAB_INDEX, TAB_TEXT

Fields inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

childrenEnumerated, CLASSINDEX, CLASSINDEXWEIGHT, MAX_NAME, NAMEPROPERTY, NAMEPROPERTYWEIGHT, PRIORLABEL, PRIORLABELWEIGHT

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

JScrollBarProxy(java.lang.Object theObjectInTheSUT)
This sole constructor for all proxy objects sets the SUT object as a member variable for the proxy.

Method Summary

ProxyTestObject	getAssociateProxy() Return the proxy we want to record the actions against.
ProxyTestObject[]	getChildren() Return null for JScrollBarProxy.
java.util.Enumeration	getChildrenEnumeration() Return an enumeration of proxies for the children of this object.
protected int	getMaximum() Returns data model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.
com.rational.test.ft.sys.MethodSpecification	getMethodSpecForPoint(java.awt.Point pt) Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates.
protected int	getMinimum() Returns the minimum value supported by the scrollbar.
protected int	getOrientation() Returns the scrollbar's orientation (horizontal or vertical).
java.lang.Object	getProperty(java.lang.String propertyName) Get the value for a specific property.
java.lang.String	getRole() Returns TestObjectRole.ROLE_SCROLL_BAR.
java.awt.Rectangle	getScreenRectangle(com.rational.test.ft.script.Subitem subitem) Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen.
java.lang.Object	getSubitem(com.rational.test.ft.script.Subitem subitem) Returns an object that represents the specified subitem in the associated test object.
protected int	getUnitIncrement(int direction) Returns the amount to change the scrollbar's value by given a unit up/down request(which is usually performed when there's mouse click on the arrow button.
protected int	getValue() Returns the current value of the scrollbar.
boolean	isHScroll() Returns true if the object is a Horizontal scrollbar.
boolean	isVScroll() Returns true if the object is a Vertical scrollbar.
void	processSingleMouseEvent(IMouseActionInfo action) Return a MethodSpecification for the specified mouse event.
void	setState(com.rational.test.ft.script.Action action) This method performs a specific action against the JScrollBar.
void	setState(com.rational.test.ft.script.Action action, com.rational.test.ft.script.Subitem item) This method performs a specific action against the subitem at a specified index.
void	setState(com.rational.test.ft.script.Action action, com.rational.test.ft.script.Subitem start, com.rational.test.ft.script.Subitem end) This method performs a specific action against the subitem range defined by the specified indices.
void	setValue(int value) Set the JScrollBar's current value.

Methods inherited from class com.rational.test.ft.domain.java.jfc.JfcGraphicalSubitemProxy

click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getScreenPoint, getScreenPoint, getTestObjectClassName, hover, hover, hover, hover, mouseMove, mouseMove, mouseMove, mouseMove, nClick, nClickDrag, nClickDrag, nClickDragToScreenPoint, nClickDragToScreenPoint

Methods inherited from class com.rational.test.ft.domain.java.jfc.JComponentProxy

getBorderTitle, getClippedRect, getClippedScreenRectangle, getDescriptiveName, getProperties, getStandardProperties, getText, getVisibleRectangle, getVisualClippedRectangle, hasFocus, isOpaque, isPointInObject, isType, scrollRectToVisible

Methods inherited from class com.rational.test.ft.domain.java.awt.ComponentProxy

canBeScrolled, childConstructed, getChildAtPoint, getChildProxy, getComponentChildren, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableChildren, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParent2, getParentObject, getScreenRectangle, getTopParent, getWindow, isDopeyDynamicName, isEnabled, isLabelled, isRecognitionProperty, isShowing, setParent

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, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, hover, hover, hover, isDrag, isPointInObject, modifiersChanged, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint, processHoverMouseEvent, processMouseEvent, setProcessMouseEventHandler, setTopLevelWindow, shouldBeMapped

Methods inherited from class com.rational.test.ft.domain.java.JavaProxy

addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getIndexer, getIndexers, getMethods, getNonValueProperties, getRecognitionProperties, getRecognitionPropertyWeight, getTestDataTypes, getTestDomain, getTopMappableParent, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, setIndexer, setProperty

Methods inherited from class com.rational.test.ft.domain.ProxyTestObject

addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChannel, 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

Field Detail

HORIZONTAL

protected static final int HORIZONTAL

Horizontal orientation.

See Also:

Constant Field Values

VERTICAL

protected static final int VERTICAL

Vertical orientation.

See Also:

Constant Field Values

Constructor Detail

JScrollBarProxy

public JScrollBarProxy(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

getRole

public java.lang.String getRole()

Returns TestObjectRole.ROLE_SCROLL_BAR.

Overrides:

getRole in class JComponentProxy

Returns:

A brief type name that describes the role this object plays in the UI.

Since:

RFT1.0

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Get the value for a specific property.

Overrides:

getProperty in class JComponentProxy

Parameters:

propertyName - The name of the property to fetch.

Returns:

The active value of the specified property for the associated test object.

See Also:

ProxyTestObject.getProperties(), ProxyTestObject.setProperty(String,Object), ProxyTestObject.getRecognitionProperties(), ProxyTestObject.addRecognitionProperty(String,Object,int)

getChildrenEnumeration

public java.util.Enumeration getChildrenEnumeration()

Return an enumeration of proxies for the children of this object. Return null for JScrollBarProxy.

Overrides:

getChildrenEnumeration in class ComponentProxy

Returns:

null

getChildren

public ProxyTestObject[] getChildren()

Return null for JScrollBarProxy.

Overrides:

getChildren in class JavaProxy

Returns:

null

getOrientation

protected int getOrientation()

Returns the scrollbar's orientation (horizontal or vertical).

Returns:

VERTICAL or HORIZONTAL

getSubitem

public java.lang.Object getSubitem(com.rational.test.ft.script.Subitem subitem)

Returns an object that represents the specified subitem in the associated test object. SubitemNotFoundException will be thrown if the specified subitem is invalid relative to the associated test object. null may be returned if the subitem does not have an object association that can be returned.

Specified by:

getSubitem in interface com.rational.test.ft.object.interfaces.IGraphicalSubitem

Overrides:

getSubitem in class JfcGraphicalSubitemProxy

Parameters:

subitem - The subitem to fetch an object for.

Returns:

An object representation of the subitem.

isVScroll

public boolean isVScroll()

Returns true if the object is a Vertical scrollbar. By default, it returns false<\b>.

Overrides:

isVScroll in class ComponentProxy

Returns:

true if the object is a Vertical scrollbar.

isHScroll

public boolean isHScroll()

Returns true if the object is a Horizontal scrollbar. By default, it returns false<\b>.

Overrides:

isHScroll in class ComponentProxy

Returns:

true if the object is a Horizontal scrollbar.

getMaximum

protected int getMaximum()

Returns data model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.

Returns:

data model that handles the scrollbar's four fundamental properties

getMinimum

protected int getMinimum()

Returns the minimum value supported by the scrollbar.

Returns:

the value of the model's minimum property

getValue

protected int getValue()

Returns the current value of the scrollbar.

Returns:

Returns the scrollbar's value.

setValue

public void setValue(int value)

Set the JScrollBar's current value.

getUnitIncrement

protected int getUnitIncrement(int direction)

Returns the amount to change the scrollbar's value by given a unit up/down request(which is usually performed when there's mouse click on the arrow button. *

Parameters:

direction - -1 or 1 for up/down respectively

Returns:

the value of the unitIncrement property of the testObject

setState

public void setState(com.rational.test.ft.script.Action action)

This method performs a specific action against the JScrollBar.

Specified by:

setState in interface com.rational.test.ft.object.interfaces.ISubitem

Parameters:

action - The action that should be performed.

setState

public void setState(com.rational.test.ft.script.Action action,                      com.rational.test.ft.script.Subitem item)

This method performs a specific action against the subitem at a specified index.

Specified by:

setState in interface com.rational.test.ft.object.interfaces.ISubitem

Parameters:

item - The item to act upon.

action - The action that should be performed.

setState

public void setState(com.rational.test.ft.script.Action action,                      com.rational.test.ft.script.Subitem start,                      com.rational.test.ft.script.Subitem end)

This method performs a specific action against the subitem range defined by the specified indices.

Specified by:

setState in interface com.rational.test.ft.object.interfaces.ISubitem

Parameters:

start - The first item to act upon.

end - The last item to act upon.

action - The action that should be performed.

getScreenRectangle

public java.awt.Rectangle getScreenRectangle(com.rational.test.ft.script.Subitem subitem)

Returns the rectangle that contains the component being evaluated relative to the top left corner of the screen. This will commonly be two operations (getScreenRectangle for the parent object and then adjusting for the specified subitem) combined into a single operation. The rectangle is exposed so that actions may be directly scripted against a visible subitem. null is returned if the subitem is not showing.

Specified by:

getScreenRectangle in interface com.rational.test.ft.object.interfaces.IGraphicalSubitem

Specified by:

getScreenRectangle in class JfcGraphicalSubitemProxy

Returns:

The adjusted rectangle surrounding subitem relative to the screen. null is returned if the subitem is not showing.

getMethodSpecForPoint

public com.rational.test.ft.sys.MethodSpecification getMethodSpecForPoint(java.awt.Point pt)

Return a MethodSpecification for a method that returns a java.awt.Point for the specified coordinates. By default a method specification for IGraphical.getScreenPoint will be returned. However, if a proxy can find

Overrides:

getMethodSpecForPoint in class JavaGuiProxy

Parameters:

x - The screen relative x coordinate.

y - The screen relative y coordinate.

See Also:

MethodSpecification

getAssociateProxy

public ProxyTestObject getAssociateProxy()

Return the proxy we want to record the actions against.

processSingleMouseEvent

public void processSingleMouseEvent(IMouseActionInfo action)

Return a MethodSpecification for the specified mouse event. This is the primary record interface for mouse events against a particular control.

Overrides:

processSingleMouseEvent in class JavaGuiProxy

Parameters:

action - The event cache and other mouse state information for this mouse action.