junit.extensions.jfcunit.eventdata
Class JTextComponentMouseEventData

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

All Implemented Interfaces:

EventDataConstants

public class JTextComponentMouseEventData

extends AbstractMouseEventData

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

Author:

Vijay Aravamudhan : ThoughtWorks Inc.

Field Summary

private javax.swing.text.JTextComponent	m_comp The Component on which to trigger the event.
private int	m_offset Offset into the text component in characters.

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

JTextComponentMouseEventData()
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, boolean isPopupTrigger)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, boolean isPopupTrigger, long sleepTime)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, int modifiers)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, int modifiers, boolean isPopupTrigger)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position, int offset)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, int position, java.awt.Point referencePoint, int offset)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime, java.awt.Point referencePoint)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, int numberOfClicks, long sleepTime)
Constructor.

JTextComponentMouseEventData(JFCTestCase testCase, javax.swing.text.JTextComponent comp, 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.
java.awt.Component	getComponent() The component on which the event has to be fired.
int	getOffset() Get the offset.
javax.swing.text.JTextComponent	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	setOffset(int offset) Set the offset.
void	setSource(javax.swing.text.JTextComponent comp) 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_comp

private javax.swing.text.JTextComponent m_comp

The Component on which to trigger the event.

m_offset

private int m_offset

Offset into the text component in characters.

Constructor Detail

JTextComponentMouseEventData

public JTextComponentMouseEventData()

Constructor.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent comp)

Constructor.

Parameters:

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

comp - The component on which to trigger the event.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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)

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent comp,
                                    int numberOfClicks,
                                    int modifiers,
                                    boolean isPopupTrigger,
                                    long sleepTime,
                                    int position,
                                    int offset)

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 - This parameter will be ignored. It will be set to OFFSET.

offset - The offset into the text component.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent 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.

JTextComponentMouseEventData

public JTextComponentMouseEventData(JFCTestCase testCase,
                                    javax.swing.text.JTextComponent comp,
                                    int numberOfClicks,
                                    int modifiers,
                                    boolean isPopupTrigger,
                                    long sleepTime,
                                    int position,
                                    java.awt.Point referencePoint,
                                    int offset)

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.

offset - The character offset into the text component.

Method Detail

setOffset

public final void setOffset(int offset)

Set the offset.

Parameters:

offset - The new value of the offset

getOffset

public final int getOffset()

Get the offset.

Returns:

int The value of the offset

setSource

public final void setSource(javax.swing.text.JTextComponent comp)

Set the attribute value.

Parameters:

comp - The new value of the attribute

getSource

public final javax.swing.text.JTextComponent getSource()

Get the attribute value.

Returns:

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