junit.extensions.jfcunit.eventdata
Class JTableHeaderMouseEventData

java.lang.Object
  junit.extensions.jfcunit.eventdata.AbstractEventData
      junit.extensions.jfcunit.eventdata.AbstractMouseEventData
          junit.extensions.jfcunit.eventdata.JTableHeaderMouseEventData

All Implemented Interfaces:

EventDataConstants

public class JTableHeaderMouseEventData

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 JTableHeader.

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 javax.swing.table.JTableHeader	m_header The JTableHeader 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

JTableHeaderMouseEventData()
Constructor.

JTableHeaderMouseEventData(JFCTestCase testCase, javax.swing.table.JTableHeader header, int columnIndex, int numberOfClicks)
Constructor.

JTableHeaderMouseEventData(JFCTestCase testCase, javax.swing.table.JTableHeader header, int columnIndex, int numberOfClicks, boolean isPopupTrigger)
Constructor.

JTableHeaderMouseEventData(JFCTestCase testCase, javax.swing.table.JTableHeader header, int columnIndex, int numberOfClicks, boolean isPopupTrigger, long sleepTime)
Constructor.

JTableHeaderMouseEventData(JFCTestCase testCase, javax.swing.table.JTableHeader header, int columnIndex, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime)
Constructor.

JTableHeaderMouseEventData(JFCTestCase testCase, javax.swing.table.JTableHeader header, int columnIndex, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position)
Constructor.

JTableHeaderMouseEventData(JFCTestCase testCase, javax.swing.table.JTableHeader header, int columnIndex, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position, java.awt.Point referencePoint)
Constructor.

JTableHeaderMouseEventData(JFCTestCase testCase, javax.swing.table.JTableHeader header, int columnIndex, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, java.awt.Point referencePoint)
Constructor.

JTableHeaderMouseEventData(JFCTestCase testCase, javax.swing.table.JTableHeader header, 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.
javax.swing.table.JTableHeader	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	setSource(javax.swing.table.JTableHeader header) 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_header

private javax.swing.table.JTableHeader m_header

The JTableHeader 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.

Constructor Detail

JTableHeaderMouseEventData

public JTableHeaderMouseEventData()

Constructor.

JTableHeaderMouseEventData

public JTableHeaderMouseEventData(JFCTestCase testCase,
                                  javax.swing.table.JTableHeader header,
                                  int columnIndex,
                                  int numberOfClicks)

Constructor.

Parameters:

testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.

header - The component 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)

JTableHeaderMouseEventData

public JTableHeaderMouseEventData(JFCTestCase testCase,
                                  javax.swing.table.JTableHeader header,
                                  int columnIndex,
                                  int numberOfClicks,
                                  long sleepTime)

Constructor.

Parameters:

testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.

header - The component 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.

JTableHeaderMouseEventData

public JTableHeaderMouseEventData(JFCTestCase testCase,
                                  javax.swing.table.JTableHeader header,
                                  int columnIndex,
                                  int numberOfClicks,
                                  boolean isPopupTrigger)

Constructor.

Parameters:

testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.

header - The component 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.

JTableHeaderMouseEventData

public JTableHeaderMouseEventData(JFCTestCase testCase,
                                  javax.swing.table.JTableHeader header,
                                  int columnIndex,
                                  int numberOfClicks,
                                  boolean isPopupTrigger,
                                  long sleepTime)

Constructor.

Parameters:

testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.

header - The component on which to trigger the event.

columnIndex - The zero-based column of index 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.

JTableHeaderMouseEventData

public JTableHeaderMouseEventData(JFCTestCase testCase,
                                  javax.swing.table.JTableHeader header,
                                  int columnIndex,
                                  int numberOfClicks,
                                  int modifiers,
                                  boolean isPopupTrigger,
                                  long sleepTime)

Constructor.

Parameters:

testCase - The JFCTestCase on whose thread awtSleep() has to be invoked.

header - The component 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.

JTableHeaderMouseEventData

public JTableHeaderMouseEventData(JFCTestCase testCase,
                                  javax.swing.table.JTableHeader header,
                                  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.

header - The component 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.

JTableHeaderMouseEventData

public JTableHeaderMouseEventData(JFCTestCase testCase,
                                  javax.swing.table.JTableHeader header,
                                  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.

header - The component 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.

JTableHeaderMouseEventData

public JTableHeaderMouseEventData(JFCTestCase testCase,
                                  javax.swing.table.JTableHeader header,
                                  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.

header - The component 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.

setSource

public final void setSource(javax.swing.table.JTableHeader header)

Set the attribute value.

Parameters:

header - The new value of the attribute.

getSource

public final javax.swing.table.JTableHeader getSource()

Get the attribute value.

Returns:

JTableHeader The 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.

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.