junit.extensions.jfcunit.eventdata
Class JTableMouseEventData

java.lang.Object
  extended byjunit.extensions.jfcunit.eventdata.AbstractEventData
      extended byjunit.extensions.jfcunit.eventdata.AbstractMouseEventData
          extended byjunit.extensions.jfcunit.eventdata.JTableMouseEventData
All Implemented Interfaces:
EventDataConstants

public class JTableMouseEventData
extends AbstractMouseEventData

Data container class that holds all the data necessary for jfcUnit to fire mouse events. This class is specific to events on a JTable.

Author:
Vijay Aravamudhan : ThoughtWorks Inc.

Field Summary
private  int m_columnIndex
          The zero-based column index of the specific cell on which to trigger the event.
private  int m_rowIndex
          The zero-based row index of the specific cell on which to trigger the event.
private  javax.swing.JTable m_table
          The JTable 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_ISPOPUPTRIGGER, 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
JTableMouseEventData()
          Constructor.
JTableMouseEventData(JFCTestCase testCase, javax.swing.JTable table, int rowIndex, int columnIndex, int numberOfClicks)
          Constructor.
JTableMouseEventData(JFCTestCase testCase, javax.swing.JTable table, int rowIndex, int columnIndex, int numberOfClicks, boolean isPopupTrigger)
          Constructor.
JTableMouseEventData(JFCTestCase testCase, javax.swing.JTable table, int rowIndex, int columnIndex, int numberOfClicks, boolean isPopupTrigger, long sleepTime)
          Constructor.
JTableMouseEventData(JFCTestCase testCase, javax.swing.JTable table, int rowIndex, int columnIndex, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime)
          Constructor.
JTableMouseEventData(JFCTestCase testCase, javax.swing.JTable table, int rowIndex, int columnIndex, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position)
          Constructor.
JTableMouseEventData(JFCTestCase testCase, javax.swing.JTable table, int rowIndex, int columnIndex, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position, java.awt.Point referencePoint)
          Constructor.
JTableMouseEventData(JFCTestCase testCase, javax.swing.JTable table, int rowIndex, int columnIndex, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, java.awt.Point referencePoint)
          Constructor.
JTableMouseEventData(JFCTestCase testCase, javax.swing.JTable table, int rowIndex, int columnIndex, int numberOfClicks, long sleepTime)
          Constructor.
 
Method Summary
 boolean canConsume(java.awt.AWTEvent ae)
          Check if this event can consume the event given.
 boolean consume(java.awt.AWTEvent ae)
          Consume the event.
 boolean equals(java.lang.Object o)
          Compare to event datas and deterime if they are equal.
 int getColumnIndex()
          Get the attribute value.
 java.awt.Component getComponent()
          The component on which the event has to be fired.
 int getRowIndex()
          Get the attribute value.
 javax.swing.JTable getSource()
          Get the attribute value.
 int hashCode()
          Get the hashCode.
 void populate(org.w3c.dom.Element e)
          Populate the XML Element with this objects attributes.
 boolean prepareComponent()
          Prepare the component to receive the event.
 void setColumnIndex(int columnIndex)
          Set the attribute value.
 void setRowIndex(int rowIndex)
          Set the attribute value.
 void setSource(javax.swing.JTable table)
          Set the attribute value.
 java.lang.String toString()
          Get string description of event.
 
Methods inherited from class junit.extensions.jfcunit.eventdata.AbstractMouseEventData
getDefaultModifiers, getDefaultModifiers, getDefaultNumberOfClicks, getDefaultPopupTrigger, getModifierText, getNumberOfClicks, getPopupTrigger, sameSource, setNumberOfClicks, setPopupTrigger
 
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

m_table

private javax.swing.JTable m_table
The JTable on which to trigger the event.


m_columnIndex

private int m_columnIndex
The zero-based column index of the specific cell on which to trigger the event.


m_rowIndex

private int m_rowIndex
The zero-based row index of the specific cell on which to trigger the event.

Constructor Detail

JTableMouseEventData

public JTableMouseEventData()
Constructor.


JTableMouseEventData

public JTableMouseEventData(JFCTestCase testCase,
                            javax.swing.JTable table,
                            int rowIndex,
                            int columnIndex,
                            int numberOfClicks)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
table - The component on which to trigger the event.
rowIndex - The zero-based row index of the specific cell on which to trigger the event.
columnIndex - The zero-based column index of the specific cell on which to trigger the event.
numberOfClicks - Number of clicks in the MouseEvent (1 for single-click, 2 for double clicks)

JTableMouseEventData

public JTableMouseEventData(JFCTestCase testCase,
                            javax.swing.JTable table,
                            int rowIndex,
                            int columnIndex,
                            int numberOfClicks,
                            long sleepTime)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
table - The component on which to trigger the event.
rowIndex - The zero-based row index of the specific cell on which to trigger the event.
columnIndex - The zero-based column index of the specific cell 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.

JTableMouseEventData

public JTableMouseEventData(JFCTestCase testCase,
                            javax.swing.JTable table,
                            int rowIndex,
                            int columnIndex,
                            int numberOfClicks,
                            boolean isPopupTrigger)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
table - The component on which to trigger the event.
rowIndex - The zero-based row index of the specific cell on which to trigger the event.
columnIndex - The zero-based column index of the specific cell 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.

JTableMouseEventData

public JTableMouseEventData(JFCTestCase testCase,
                            javax.swing.JTable table,
                            int rowIndex,
                            int columnIndex,
                            int numberOfClicks,
                            boolean isPopupTrigger,
                            long sleepTime)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
table - The component on which to trigger the event.
rowIndex - The zero-based row index of the specific cell on which to trigger the event.
columnIndex - The zero-based column index of the specific cell 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.

JTableMouseEventData

public JTableMouseEventData(JFCTestCase testCase,
                            javax.swing.JTable table,
                            int rowIndex,
                            int columnIndex,
                            int numberOfClicks,
                            int modifiers,
                            boolean isPopupTrigger,
                            long sleepTime)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
table - The component on which to trigger the event.
rowIndex - The zero-based row index of the specific cell on which to trigger the event.
columnIndex - The zero-based column index of the specific cell 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.

JTableMouseEventData

public JTableMouseEventData(JFCTestCase testCase,
                            javax.swing.JTable table,
                            int rowIndex,
                            int columnIndex,
                            int numberOfClicks,
                            int modifiers,
                            boolean isPopupTrigger,
                            long sleepTime,
                            int position)
Constructor.

Parameters:
testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.
table - The component on which to trigger the event.
rowIndex - The zero-based row index of the specific cell on which to trigger the event.
columnIndex - The zero-based column index of the specific cell 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.

JTableMouseEventData

public JTableMouseEventData(JFCTestCase testCase,
                            javax.swing.JTable table,
                            int rowIndex,
                            int columnIndex,
                            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.
table - The component on which to trigger the event.
rowIndex - The zero-based row index of the specific cell on which to trigger the event.
columnIndex - The zero-based column index of the specific cell 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.

JTableMouseEventData

public JTableMouseEventData(JFCTestCase testCase,
                            javax.swing.JTable table,
                            int rowIndex,
                            int columnIndex,
                            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.
table - The component on which to trigger the event.
rowIndex - The zero-based row index of the specific cell on which to trigger the event.
columnIndex - The zero-based column index of the specific cell 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

setColumnIndex

public final void setColumnIndex(int columnIndex)
Set the attribute value.

Parameters:
columnIndex - The new value of the attribute

getColumnIndex

public final int getColumnIndex()
Get the attribute value.

Returns:
int The value of the attribute

setRowIndex

public final void setRowIndex(int rowIndex)
Set the attribute value.

Parameters:
rowIndex - The new value of the attribute

getRowIndex

public final int getRowIndex()
Get the attribute value.

Returns:
int The value of the attribute

setSource

public final void setSource(javax.swing.JTable table)
Set the attribute value.

Parameters:
table - The new value of the attribute

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

getSource

public javax.swing.JTable getSource()
Get the attribute value.

Returns:
JTable The value of the attribute

canConsume

public boolean canConsume(java.awt.AWTEvent ae)
Check if this event can consume the event given.

Overrides:
canConsume in class AbstractMouseEventData
Parameters:
ae - AWTEvent to be consumed.
Returns:
true if the event may be 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 datas 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 attributes.

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

prepareComponent

public boolean prepareComponent()
Prepare the component to receive the event.

Overrides:
prepareComponent in class AbstractEventData
Returns:
true if the component is ready to receive the event.

toString

public java.lang.String toString()
Get string description of event.

Overrides:
toString in class AbstractMouseEventData
Returns:
String description of event.


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