net.infonode.docking.mouse

Class DockingWindowActionMouseButtonListener

public class DockingWindowActionMouseButtonListener extends Object implements MouseButtonListener, Serializable

A MouseButtonListener that performs a DockingWindowAction. The action is not performed if the mouse button event has been consumed.

Since: IDW 1.3.0

Version: $Revision: 1.9 $

Author: $Author: jesper $

Field Summary
static MouseButtonListenerMIDDLE_BUTTON_CLOSE_LISTENER
A listener that closes a window when its tab is clicked with the middle mouse button.
Constructor Summary
DockingWindowActionMouseButtonListener(int button, DockingWindowAction action)
Creates a listener which performs an action when a mouse button is clicked.
DockingWindowActionMouseButtonListener(int eventId, int button, DockingWindowAction action)
Creates a listener which performs an action when a mouse button is pressed, released or clicked.
DockingWindowActionMouseButtonListener(int eventId, int button, int keyMask, DockingWindowAction action, boolean consumeEvent)
Creates a listener which performs an action when a mouse button is pressed, released or clicked, with an additional key mask.
Method Summary
voidmouseButtonEvent(MouseEvent event)

Field Detail

MIDDLE_BUTTON_CLOSE_LISTENER

public static final MouseButtonListener MIDDLE_BUTTON_CLOSE_LISTENER
A listener that closes a window when its tab is clicked with the middle mouse button.

Constructor Detail

DockingWindowActionMouseButtonListener

public DockingWindowActionMouseButtonListener(int button, DockingWindowAction action)
Creates a listener which performs an action when a mouse button is clicked. The event is not consumed when the action is performed.

Parameters: button when this mouse button is clicked the action is performed , must be MouseEvent#BUTTON1, MouseEvent#BUTTON2 or MouseEvent#BUTTON3 action the action to perform

DockingWindowActionMouseButtonListener

public DockingWindowActionMouseButtonListener(int eventId, int button, DockingWindowAction action)
Creates a listener which performs an action when a mouse button is pressed, released or clicked. The event is not consumed when the action is performed.

Parameters: eventId the event type for which to perform the action, must be MouseEvent#MOUSE_PRESSED, MouseEvent#MOUSE_RELEASED or MouseEvent#MOUSE_CLICKED button when this mouse button for which the action is performed , must be MouseEvent#BUTTON1, MouseEvent#BUTTON2 or MouseEvent#BUTTON3 action the action to perform

DockingWindowActionMouseButtonListener

public DockingWindowActionMouseButtonListener(int eventId, int button, int keyMask, DockingWindowAction action, boolean consumeEvent)
Creates a listener which performs an action when a mouse button is pressed, released or clicked, with an additional key mask.

Parameters: eventId the event type for which to perform the action, must be MouseEvent#MOUSE_PRESSED, MouseEvent#MOUSE_RELEASED or MouseEvent#MOUSE_CLICKED button when this mouse button for which the action is performed , must be MouseEvent#BUTTON1, MouseEvent#BUTTON2 or MouseEvent#BUTTON3 keyMask the keys that must be pressed for the action to be performed, must be 0 or an or'ed combination of the key down masks found in InputEvent. action the action to perform consumeEvent if true the event is consumed when the action is performed

Method Detail

mouseButtonEvent

public void mouseButtonEvent(MouseEvent event)