com.alee.utils

Class EventUtils

java.lang.Object

com.alee.utils.EventUtils

public final class EventUtils
extends java.lang.Object

This class provides a set of utilities to work with various Swing events.

Constructor Summary

Constructors

Constructor and Description
EventUtils()

Method Summary

Modifier and Type	Method and Description
static com.alee.utils.general.Pair<DocumentChangeListener,java.beans.PropertyChangeListener>	onChange(javax.swing.text.JTextComponent textComponent, DocumentEventRunnable runnable) Shortcut method for document change event.
static PopOverAdapter	onClose(WebPopOver popOver, PopOverEventRunnable runnable) Shortcut method for popover close event.
static WindowCloseAdapter	onClose(java.awt.Window window, ComponentEventRunnable runnable) Shortcut method for window close event.
static java.awt.event.WindowAdapter	onClosing(java.awt.Window window, WindowEventRunnable runnable) Shortcut method for window closing event.
static PopOverAdapter	onDetach(WebPopOver popOver, PopOverEventRunnable runnable) Shortcut method for popover detach event.
static <T extends DocumentData> DocumentAdapter<T>	onDocumentClose(WebDocumentPane<T> documentPane, DocumentDataRunnable<T> runnable) Shortcut method for document close event.
static <T extends DocumentData> DocumentAdapter<T>	onDocumentClosing(WebDocumentPane<T> documentPane, DocumentDataCancellableRunnable<T> runnable) Shortcut method for document closing event.
static <T extends DocumentData> DocumentAdapter<T>	onDocumentOpen(WebDocumentPane<T> documentPane, DocumentDataRunnable<T> runnable) Shortcut method for document open event.
static <T extends DocumentData> DocumentAdapter<T>	onDocumentSelection(WebDocumentPane<T> documentPane, DocumentDataRunnable<T> runnable) Shortcut method for document selection event.
static java.awt.event.MouseAdapter	onDoubleClick(java.awt.Component component, MouseEventRunnable runnable) Shortcut method for double-click mouse event.
static java.awt.event.FocusAdapter	onFocusGain(java.awt.Component component, FocusEventRunnable runnable) Shortcut method for focus gain event.
static java.awt.event.FocusAdapter	onFocusLoss(java.awt.Component component, FocusEventRunnable runnable) Shortcut method for focus loss event.
static java.awt.event.KeyAdapter	onKeyPress(java.awt.Component component, HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key press event.
static java.awt.event.KeyAdapter	onKeyPress(java.awt.Component component, KeyEventRunnable runnable) Shortcut method for key press event.
static java.awt.event.KeyAdapter	onKeyRelease(java.awt.Component component, HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key release event.
static java.awt.event.KeyAdapter	onKeyRelease(java.awt.Component component, KeyEventRunnable runnable) Shortcut method for key release event.
static java.awt.event.KeyAdapter	onKeyType(java.awt.Component component, HotkeyData hotkey, KeyEventRunnable runnable) Shortcut method for key type event.
static java.awt.event.KeyAdapter	onKeyType(java.awt.Component component, KeyEventRunnable runnable) Shortcut method for key type event.
static java.awt.event.MouseAdapter	onMenuTrigger(java.awt.Component component, MouseEventRunnable runnable) Shortcut method for mouse event triggering popup menu.
static java.awt.event.MouseAdapter	onMouseClick(java.awt.Component component, MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for mouse click event.
static java.awt.event.MouseAdapter	onMouseClick(java.awt.Component component, MouseEventRunnable runnable) Shortcut method for mouse click event.
static java.awt.event.MouseAdapter	onMouseDrag(java.awt.Component component, MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for mouse drag event.
static java.awt.event.MouseAdapter	onMouseDrag(java.awt.Component component, MouseEventRunnable runnable) Shortcut method for mouse drag event.
static java.awt.event.MouseAdapter	onMouseEnter(java.awt.Component component, MouseEventRunnable runnable) Shortcut method for mouse enter event.
static java.awt.event.MouseAdapter	onMouseExit(java.awt.Component component, MouseEventRunnable runnable) Shortcut method for mouse exit event.
static java.awt.event.MouseAdapter	onMousePress(java.awt.Component component, MouseButton mouseButton, MouseEventRunnable runnable) Shortcut method for double-click mouse event.
static java.awt.event.MouseAdapter	onMousePress(java.awt.Component component, MouseEventRunnable runnable) Shortcut method for double-click mouse event.
static PopOverAdapter	onOpen(WebPopOver popOver, PopOverEventRunnable runnable) Shortcut method for popover open event.
static PopOverAdapter	onReopen(WebPopOver popOver, PopOverEventRunnable runnable) Shortcut method for popover reopen event.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventUtils

public EventUtils()

Method Detail

onMousePress

public static java.awt.event.MouseAdapter onMousePress(java.awt.Component component,
                                                       MouseEventRunnable runnable)

Shortcut method for double-click mouse event.

Parameters:

component - component to handle events for

runnable - mouse event runnable

Returns:

used mouse adapter

onMousePress

public static java.awt.event.MouseAdapter onMousePress(java.awt.Component component,
                                                       MouseButton mouseButton,
                                                       MouseEventRunnable runnable)

Shortcut method for double-click mouse event.

Parameters:

component - component to handle events for

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseEnter

public static java.awt.event.MouseAdapter onMouseEnter(java.awt.Component component,
                                                       MouseEventRunnable runnable)

Shortcut method for mouse enter event.

Parameters:

component - component to handle events for

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseExit

public static java.awt.event.MouseAdapter onMouseExit(java.awt.Component component,
                                                      MouseEventRunnable runnable)

Shortcut method for mouse exit event.

Parameters:

component - component to handle events for

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseDrag

public static java.awt.event.MouseAdapter onMouseDrag(java.awt.Component component,
                                                      MouseEventRunnable runnable)

Shortcut method for mouse drag event.

Parameters:

component - component to handle events for

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseDrag

public static java.awt.event.MouseAdapter onMouseDrag(java.awt.Component component,
                                                      MouseButton mouseButton,
                                                      MouseEventRunnable runnable)

Shortcut method for mouse drag event.

Parameters:

component - component to handle events for

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseClick

public static java.awt.event.MouseAdapter onMouseClick(java.awt.Component component,
                                                       MouseEventRunnable runnable)

Shortcut method for mouse click event.

Parameters:

component - component to handle events for

runnable - mouse event runnable

Returns:

used mouse adapter

onMouseClick

public static java.awt.event.MouseAdapter onMouseClick(java.awt.Component component,
                                                       MouseButton mouseButton,
                                                       MouseEventRunnable runnable)

Shortcut method for mouse click event.

Parameters:

component - component to handle events for

mouseButton - mouse button filter

runnable - mouse event runnable

Returns:

used mouse adapter

onDoubleClick

public static java.awt.event.MouseAdapter onDoubleClick(java.awt.Component component,
                                                        MouseEventRunnable runnable)

Shortcut method for double-click mouse event.

Parameters:

component - component to handle events for

runnable - mouse event runnable

Returns:

used mouse adapter

onMenuTrigger

public static java.awt.event.MouseAdapter onMenuTrigger(java.awt.Component component,
                                                        MouseEventRunnable runnable)

Shortcut method for mouse event triggering popup menu.

Parameters:

component - component to handle events for

runnable - mouse event runnable

Returns:

used mouse adapter

onKeyType

public static java.awt.event.KeyAdapter onKeyType(java.awt.Component component,
                                                  KeyEventRunnable runnable)

Shortcut method for key type event.

Parameters:

component - component to handle events for

runnable - key event runnable

Returns:

used key adapter

onKeyType

public static java.awt.event.KeyAdapter onKeyType(java.awt.Component component,
                                                  HotkeyData hotkey,
                                                  KeyEventRunnable runnable)

Shortcut method for key type event.

Parameters:

component - component to handle events for

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onKeyPress

public static java.awt.event.KeyAdapter onKeyPress(java.awt.Component component,
                                                   KeyEventRunnable runnable)

Shortcut method for key press event.

Parameters:

component - component to handle events for

runnable - key event runnable

Returns:

used key adapter

onKeyPress

public static java.awt.event.KeyAdapter onKeyPress(java.awt.Component component,
                                                   HotkeyData hotkey,
                                                   KeyEventRunnable runnable)

Shortcut method for key press event.

Parameters:

component - component to handle events for

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onKeyRelease

public static java.awt.event.KeyAdapter onKeyRelease(java.awt.Component component,
                                                     KeyEventRunnable runnable)

Shortcut method for key release event.

Parameters:

component - component to handle events for

runnable - key event runnable

Returns:

used key adapter

onKeyRelease

public static java.awt.event.KeyAdapter onKeyRelease(java.awt.Component component,
                                                     HotkeyData hotkey,
                                                     KeyEventRunnable runnable)

Shortcut method for key release event.

Parameters:

component - component to handle events for

hotkey - hotkey filter

runnable - key event runnable

Returns:

used key adapter

onFocusGain

public static java.awt.event.FocusAdapter onFocusGain(java.awt.Component component,
                                                      FocusEventRunnable runnable)

Shortcut method for focus gain event.

Parameters:

component - component to handle events for

runnable - focus event runnable

Returns:

used focus adapter

onFocusLoss

public static java.awt.event.FocusAdapter onFocusLoss(java.awt.Component component,
                                                      FocusEventRunnable runnable)

Shortcut method for focus loss event.

Parameters:

component - component to handle events for

runnable - focus event runnable

Returns:

used focus adapter

onClosing

public static java.awt.event.WindowAdapter onClosing(java.awt.Window window,
                                                     WindowEventRunnable runnable)

Shortcut method for window closing event.

Parameters:

window - window to handle events for

runnable - window event runnable

Returns:

used window adapter

onClose

public static WindowCloseAdapter onClose(java.awt.Window window,
                                         ComponentEventRunnable runnable)

Shortcut method for window close event.

Parameters:

window - window to handle events for

runnable - component event runnable

Returns:

used window close adapter

onChange

public static com.alee.utils.general.Pair<DocumentChangeListener,java.beans.PropertyChangeListener> onChange(javax.swing.text.JTextComponent textComponent,
                                                                                                             DocumentEventRunnable runnable)

Shortcut method for document change event.

Parameters:

textComponent - text component to handle events for

runnable - document event runnable

Returns:

used document change and property change listeners

onOpen

public static PopOverAdapter onOpen(WebPopOver popOver,
                                    PopOverEventRunnable runnable)

Shortcut method for popover open event.

Parameters:

popOver - popover to handle events for

runnable - popover event runnable

Returns:

used popover adapter

onReopen

public static PopOverAdapter onReopen(WebPopOver popOver,
                                      PopOverEventRunnable runnable)

Shortcut method for popover reopen event.

Parameters:

popOver - popover to handle events for

runnable - popover event runnable

Returns:

used popover adapter

onDetach

public static PopOverAdapter onDetach(WebPopOver popOver,
                                      PopOverEventRunnable runnable)

Shortcut method for popover detach event.

Parameters:

popOver - popover to handle events for

runnable - popover event runnable

Returns:

used popover adapter

onClose

public static PopOverAdapter onClose(WebPopOver popOver,
                                     PopOverEventRunnable runnable)

Shortcut method for popover close event.

Parameters:

popOver - popover to handle events for

runnable - popover event runnable

Returns:

used popover adapter

onDocumentOpen

public static <T extends DocumentData> DocumentAdapter<T> onDocumentOpen(WebDocumentPane<T> documentPane,
                                                                         DocumentDataRunnable<T> runnable)

Shortcut method for document open event.

Parameters:

documentPane - document pane to handle events for

runnable - document data runnable

Returns:

used document adapter

onDocumentSelection

public static <T extends DocumentData> DocumentAdapter<T> onDocumentSelection(WebDocumentPane<T> documentPane,
                                                                              DocumentDataRunnable<T> runnable)

Shortcut method for document selection event.

Parameters:

documentPane - document pane to handle events for

runnable - document data runnable

Returns:

used document adapter

onDocumentClosing

public static <T extends DocumentData> DocumentAdapter<T> onDocumentClosing(WebDocumentPane<T> documentPane,
                                                                            DocumentDataCancellableRunnable<T> runnable)

Shortcut method for document closing event.

Parameters:

documentPane - document pane to handle events for

runnable - document data cancellable runnable

Returns:

used document adapter

onDocumentClose

public static <T extends DocumentData> DocumentAdapter<T> onDocumentClose(WebDocumentPane<T> documentPane,
                                                                          DocumentDataRunnable<T> runnable)

Shortcut method for document close event.

Parameters:

documentPane - document pane to handle events for

runnable - document data runnable

Returns:

used document adapter