net.awesomecontrols.subwindow

Class SubWindow.CloseShortcut

java.lang.Object

com.vaadin.event.Action

com.vaadin.event.ShortcutAction

com.vaadin.event.ShortcutListener

net.awesomecontrols.subwindow.SubWindow.CloseShortcut

All Implemented Interfaces:

com.vaadin.event.Action.Listener, Serializable

Enclosing class:

SubWindow

public static class SubWindow.CloseShortcut
extends com.vaadin.event.ShortcutListener

A ShortcutListener specifically made to define a keyboard shortcut that closes the subwindow.

 
  // within the subwindow using helper
  subwindow.setCloseShortcut(KeyCode.ESCAPE, null);

  // or globally
  getUI().addAction(new Window.CloseShortcut(subwindow, KeyCode.ESCAPE));
 
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.event.ShortcutAction

com.vaadin.event.ShortcutAction.KeyCode, com.vaadin.event.ShortcutAction.ModifierKey

Nested classes/interfaces inherited from class com.vaadin.event.Action

com.vaadin.event.Action.Container, com.vaadin.event.Action.Handler, com.vaadin.event.Action.Listener, com.vaadin.event.Action.Notifier, com.vaadin.event.Action.ShortcutNotifier

Field Summary

Fields

Modifier and Type	Field and Description
protected SubWindow	window

Fields inherited from class com.vaadin.event.ShortcutAction

SHORTHAND_CHAR_ALT, SHORTHAND_CHAR_CTRL, SHORTHAND_CHAR_SHIFT

Constructor Summary

Constructors

Constructor and Description
CloseShortcut(SubWindow window, int keyCode) Creates a keyboard shortcut for closing the given subwindow using the given ShortcutAction.KeyCode.
CloseShortcut(SubWindow window, int keyCode, int... modifiers) Creates a keyboard shortcut for closing the given subwindow using the given ShortcutAction.KeyCode and ShortcutAction.ModifierKeys.
CloseShortcut(SubWindow window, String shorthandCaption) Creates a keyboard shortcut for closing the given subwindow using the shorthand notation defined in ShortcutAction.

Method Summary

Modifier and Type	Method and Description
boolean	equals(int keyCode, int... modifiers)
void	handleAction(Object sender, Object target)

Methods inherited from class com.vaadin.event.ShortcutAction

getKeyCode, getModifiers

Methods inherited from class com.vaadin.event.Action

getCaption, getIcon, setCaption, setIcon

Methods inherited from class java.lang.Object

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

Field Detail

window

protected SubWindow window

Constructor Detail

CloseShortcut

public CloseShortcut(SubWindow window,
                     String shorthandCaption)

Creates a keyboard shortcut for closing the given subwindow using the shorthand notation defined in ShortcutAction.

Parameters:

window -

shorthandCaption - the caption with shortcut keycode and modifiers indicated

CloseShortcut

public CloseShortcut(SubWindow window,
                     int keyCode,
                     int... modifiers)

Creates a keyboard shortcut for closing the given subwindow using the given ShortcutAction.KeyCode and ShortcutAction.ModifierKeys.

Parameters:

window -

keyCode - KeyCode to react to

modifiers - optional modifiers for shortcut

CloseShortcut

public CloseShortcut(SubWindow window,
                     int keyCode)

Creates a keyboard shortcut for closing the given subwindow using the given ShortcutAction.KeyCode.

Parameters:

window -

keyCode - KeyCode to react to

Method Detail

handleAction

public void handleAction(Object sender,
                         Object target)

Specified by:

handleAction in interface com.vaadin.event.Action.Listener

Specified by:

handleAction in class com.vaadin.event.ShortcutListener

Parameters:

sender - sender

target - target

equals

public boolean equals(int keyCode,
                      int... modifiers)

Parameters:

keyCode - keyCode

modifiers - modifiers

Returns: