junit.extensions.jfcunit.eventdata
Class JMenuMouseEventData

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

All Implemented Interfaces:

EventDataConstants

public class JMenuMouseEventData

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

Author:

Vijay Aravamudhan : ThoughtWorks Inc.

Field Summary

private int[]	m_elementIndexes The zero-based index of the specific menu elements on which to trigger the event.
private javax.swing.JComponent	m_menu The JMenuBar 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

JMenuMouseEventData()
Constructor.

JMenuMouseEventData(JFCTestCase testCase, javax.swing.JComponent menu, int[] elementIndexes)
Constructor.

JMenuMouseEventData(JFCTestCase testCase, javax.swing.JComponent menu, int[] elementIndexes, int numberOfClicks, int modifiers, boolean isPopupTrigger, long sleepTime)
Constructor.

Method Summary

boolean	canConsume(java.awt.AWTEvent ae) Returns true if the event can be consumed by this instance of event data.
boolean	consume(java.awt.AWTEvent ae) Consume the event.
boolean	equals(java.lang.Object o) Compare to event datas and determine if they are equal.
java.awt.Component	getComponent() The component on which the event has to be fired.
int[]	getElementIndexes() Get the attribute value.
javax.swing.JComponent	getSource() Get the attribute value.
int	hashCode() Get the hashCode.
void	populate(org.w3c.dom.Element e) Populate the JComboBoxMouseEventData XML element.
boolean	prepareComponent() Prepare the Component to receive the event.
void	setElementIndexes(int[] elementIndexes) Set the attribute value.
void	setSource(javax.swing.JComponent menu) 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_menu

private javax.swing.JComponent m_menu

The JMenuBar on which to trigger the event.

m_elementIndexes

private int[] m_elementIndexes

The zero-based index of the specific menu elements on which to trigger the event.

Constructor Detail

JMenuMouseEventData

public JMenuMouseEventData()

Constructor.

JMenuMouseEventData

public JMenuMouseEventData(JFCTestCase testCase,
                           javax.swing.JComponent menu,
                           int[] elementIndexes)

Constructor.

Parameters:

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

menu - The JMenu on which to trigger the event.

elementIndexes - The zero-based index of the menu items to select.

JMenuMouseEventData

public JMenuMouseEventData(JFCTestCase testCase,
                           javax.swing.JComponent menu,
                           int[] elementIndexes,
                           int numberOfClicks,
                           int modifiers,
                           boolean isPopupTrigger,
                           long sleepTime)

Constructor.

Parameters:

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

menu - The JMenu on which to trigger the event.

elementIndexes - The zero-based index of the menu items to select.

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.

Method Detail

setSource

public void setSource(javax.swing.JComponent menu)

Set the attribute value.

Parameters:

menu - The new value of the attribute.

getSource

public final javax.swing.JComponent getSource()

Get the attribute value.

Returns:

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

setElementIndexes

public final void setElementIndexes(int[] elementIndexes)

Set the attribute value.

Parameters:

elementIndexes - The new value of the attribute.

getElementIndexes

public final int[] getElementIndexes()

Get the attribute value.

Returns:

int The value of the attribute.

canConsume

public boolean canConsume(java.awt.AWTEvent ae)

Returns true if the event can be consumed by this instance 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 datas and determine 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 JComboBoxMouseEventData XML element.

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.