junit.extensions.jfcunit.eventdata
Class MouseEventData

java.lang.Object
  extended byjunit.extensions.jfcunit.eventdata.AbstractEventData
      extended byjunit.extensions.jfcunit.eventdata.AbstractMouseEventData
          extended byjunit.extensions.jfcunit.eventdata.MouseEventData
All Implemented Interfaces:
EventDataConstants
Direct Known Subclasses:
MouseWheelEventData

public class MouseEventData
extends AbstractMouseEventData

Data container class that holds all the data necessary for jfcUnit to fire mouse events.

Author:
Vijay Aravamudhan : ThoughtWorks Inc.

Field Summary
static boolean DEFAULT_ISPOPUPTRIGGER
          Default value specifying whether the mouse event being fired would trigger a popup or not.
private  java.awt.Component m_comp
          The Component on which to trigger the event.
 
Fields inherited from class junit.extensions.jfcunit.eventdata.AbstractMouseEventData
 
Fields inherited from class junit.extensions.jfcunit.eventdata.AbstractEventData
 
Fields inherited from interface junit.extensions.jfcunit.eventdata.EventDataConstants
CENTER, CUSTOM, DEFAULT_HOLDTIME, DEFAULT_KEY_MODIFIERS, DEFAULT_MOUSE_MODIFIERS, DEFAULT_NUMBEROFCLICKS, DEFAULT_POPUP_MODIFIERS, DEFAULT_POSITION, DEFAULT_SCROLL_AMOUNT, DEFAULT_SLEEPTIME, DEFAULT_WHEEL_ROTATION, DOWN_ARROW_SUBCOMPONENT, EAST, EDITOR_SUBCOMPONENT, INVALID_SUBCOMPONENT, INVALID_TEXT_OFFSET, NORTH, NORTH_EAST, NORTH_WEST, OFFSET, PERCENT, POSITIONSTRINGS, SOUTH, SOUTH_EAST, SOUTH_WEST, UP_ARROW_SUBCOMPONENT, WEST
 
Constructor Summary
MouseEventData()
          Default Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, boolean isPopupTrigger)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, boolean isPopupTrigger, long sleepTime)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, int modifiers)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, int modifiers, boolean isPopupTrigger)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position, java.awt.Point referencePoint)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, java.awt.Point referencePoint)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, int numberOfClicks, long sleepTime)
          Constructor.
MouseEventData(JFCTestCase testCase, java.awt.Component comp, long sleepTime)
          Constructor.
 
Method Summary
 boolean canConsume(java.awt.AWTEvent ae)
          Returns true if the event can be consumed by this instnace of event data.
 boolean consume(java.awt.AWTEvent ae)
          Consume the event.
 boolean equals(java.lang.Object o)
          Compare to event data and deterime if they are equal.
 java.awt.Component getComponent()
          The component on which the event has to be fired.
 java.awt.Component getSource()
          Get the attribute value.
 int hashCode()
          Get the hashCode.
 void insureVisibleLocation(java.awt.Point p)
          Insure the the point p is visible in the object.
 void populate(org.w3c.dom.Element e)
          Populate the XML Element with this objects data.
 boolean prepareComponent()
          Prepare the component for firing the mouse event.
 void setSource(java.awt.Component comp)
          Set the attribute value.
 
Methods inherited from class junit.extensions.jfcunit.eventdata.AbstractMouseEventData
getDefaultModifiers, getDefaultModifiers, getDefaultNumberOfClicks, getDefaultPopupTrigger, getModifierText, getNumberOfClicks, getPopupTrigger, sameSource, setNumberOfClicks, setPopupTrigger, toString
 
Methods inherited from class junit.extensions.jfcunit.eventdata.AbstractEventData
calculatePoint, getDefaultPosition, getDefaultSleepTime, getLocationOnScreen, getModifiers, getPosition, getReferencePoint, getRoot, getRoot, getSleepTime, getTestCase, isMetaChar, isValid, isValidForProcessing, setLocationOnScreen, setModifiers, setPosition, setReferencePoint, setSleepTime, setTestCase, setValid
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_ISPOPUPTRIGGER

public static final boolean DEFAULT_ISPOPUPTRIGGER
Default value specifying whether the mouse event being fired would trigger a popup or not.

See Also:
Constant Field Values

m_comp

private java.awt.Component m_comp
The Component on which to trigger the event.

Constructor Detail

MouseEventData

public MouseEventData()
Default Constructor.


MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      long sleepTime)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
sleepTime - The wait time in ms between each event.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      int modifiers)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
modifiers - The modifier key values that need to be passed onto the event.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      boolean isPopupTrigger)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
isPopupTrigger - boolean specifying whether this event will show a popup.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      long sleepTime)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
sleepTime - The wait time in ms between each event.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      int modifiers,
                      boolean isPopupTrigger)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
modifiers - The modifier key values that need to be passed onto the event.
isPopupTrigger - boolean specifying whether this event will show a popup.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      boolean isPopupTrigger,
                      long sleepTime)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
isPopupTrigger - boolean specifying whether this event will show a popup.
sleepTime - The wait time in ms between each event.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      int modifiers,
                      boolean isPopupTrigger,
                      long sleepTime)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
modifiers - The modifier key values that need to be passed onto the event.
isPopupTrigger - boolean specifying whether this event will show a popup.
sleepTime - The wait time in ms between each event.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      int modifiers,
                      boolean isPopupTrigger,
                      long sleepTime,
                      int position)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
modifiers - The modifier key values that need to be passed onto the event.
isPopupTrigger - boolean specifying whether this event will show a popup.
sleepTime - The wait time in ms between each event.
position - The relative mouse position within the cell.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      int modifiers,
                      boolean isPopupTrigger,
                      long sleepTime,
                      java.awt.Point referencePoint)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
modifiers - The modifier key values that need to be passed onto the event.
isPopupTrigger - boolean specifying whether this event will show a popup.
sleepTime - The wait time in ms between each event.
referencePoint - The CUSTOM mouse position within the cell.

MouseEventData

public MouseEventData(JFCTestCase testCase,
                      java.awt.Component comp,
                      int numberOfClicks,
                      int modifiers,
                      boolean isPopupTrigger,
                      long sleepTime,
                      int position,
                      java.awt.Point referencePoint)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
comp - The component on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)
modifiers - The modifier key values that need to be passed onto the event.
isPopupTrigger - boolean specifying whether this event will show a popup.
sleepTime - The wait time in ms between each event.
position - The relative mouse position within the cell.
referencePoint - If _position is CUSTOM then the point is a offset from the location of the component. If the _position is PERCENT then the location is a percentage offset of the hight and width. Otherwise, the _referencePoint is unused.
Method Detail

getComponent

public java.awt.Component getComponent()
The component on which the event has to be fired.

Specified by:
getComponent in class AbstractEventData
Returns:
The component.

setSource

public void setSource(java.awt.Component comp)
Set the attribute value.

Parameters:
comp - The new value of the attribute.

getSource

public java.awt.Component getSource()
Get the attribute value.

Returns:
Component The value of the attribute.

canConsume

public boolean canConsume(java.awt.AWTEvent ae)
Returns true if the event can be consumed by this instnace of event data.

Overrides:
canConsume in class AbstractMouseEventData
Parameters:
ae - Event to be consumed.
Returns:
true if the event was consumed.

consume

public boolean consume(java.awt.AWTEvent ae)
Consume the event.

Overrides:
consume in class AbstractMouseEventData
Parameters:
ae - AWTEvent to be consumed.
Returns:
boolean true if the event was consumed.

equals

public boolean equals(java.lang.Object o)
Compare to event data and deterime if they are equal.

Overrides:
equals in class AbstractMouseEventData
Parameters:
o - Object to be compared.
Returns:
true if the events are the same.

hashCode

public int hashCode()
Get the hashCode.

Overrides:
hashCode in class AbstractMouseEventData
Returns:
int hashCode.

populate

public void populate(org.w3c.dom.Element e)
Populate the XML Element with this objects data.

Overrides:
populate in class AbstractMouseEventData
Parameters:
e - XML Element to be populated.

prepareComponent

public boolean prepareComponent()
Prepare the component for firing the mouse event.

Overrides:
prepareComponent in class AbstractEventData
Returns:
boolean true if the component is ready.

insureVisibleLocation

public void insureVisibleLocation(java.awt.Point p)
Insure the the point p is visible in the object. If not then attempt to locate a viewport to make the point visible.

Parameters:
p - Point to be made visible.


Licensed under: GNU Lesser General Public License, Ver 2.1, February 1999