com.klg.jclass.higrid
Class MouseActionInitiator

java.lang.Object
  |
  +--com.klg.jclass.higrid.MouseActionInitiator

All Implemented Interfaces:

ActionInitiator, Serializable

public class MouseActionInitiator

extends Object

implements ActionInitiator, Serializable

A MouseActionInitiator is used by HiGridAction to associate a combination of mouse button and modifier to a specific action on HiGrid.

See Also:

Serialized Form

Field Summary

static int	ANY_BUTTON_MASK
int	button_mask Mouse button code.
int	modifier Modifier for the mouse button.

Fields inherited from interface com.klg.jclass.higrid.ActionInitiator

ANY_MODIFIER_MASK, NO_MODIFIER_MASK

Constructor Summary

MouseActionInitiator(int button_mask, int modifier)
Creates a new MouseActionInitiator given a mouse button and modifier.

Method Summary

boolean	isMatch(AWTEvent e) Returns true if the given event matches the ActionInitiator settings.
String	toString() Convert to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

button_mask

public int button_mask

Mouse button code.

modifier

public int modifier

Modifier for the mouse button.

ANY_BUTTON_MASK

public static final int ANY_BUTTON_MASK

See Also:

Constant Field Values

Constructor Detail

MouseActionInitiator

public MouseActionInitiator(int button_mask,
                            int modifier)

Creates a new MouseActionInitiator given a mouse button and modifier.

Valid buttons are:

• MouseEvent.BUTTON1_MASK
• MouseEvent.BUTTON2_MASK
• MouseEvent.BUTTON3_MASK
• MouseActionInitiator.ANY_BUTTON_MASK

Valid modifiers are:

• InputEvent.ALT_GRAPH_MASK
• InputEvent.ALT_MASK
• InputEvent.CTRL_MASK
• InputEvent.META_MASK
• InputEvent.SHIFT_MASK
• ActionInitiator.NO_MODIFIER_MASK
• ActionInitiator.ANY_MODIFIER_MASK

Method Detail

isMatch

public boolean isMatch(AWTEvent e)

Returns true if the given event matches the ActionInitiator settings.

Specified by:

isMatch in interface ActionInitiator

toString

public String toString()

Convert to a string.

Overrides:

toString in class Object