org.jowidgets.tools.model.item

Class MenuModelKeyBinding

java.lang.Object

org.jowidgets.tools.model.item.MenuModelKeyBinding

public final class MenuModelKeyBinding
extends java.lang.Object

This class helps to bind all actions of a given menu to theirs accelerator keys

Constructor Summary

Constructors

Constructor and Description
MenuModelKeyBinding(java.util.Collection<? extends IMenuModel> menus, IComponent component) Creates a new binding for a collection of menus and a component that contains the menu.
MenuModelKeyBinding(java.util.Collection<? extends IMenuModel> menus, IKeyObservable sourceKeyObservable, IWidget source) Creates a new key binding for collection of menus and a given key observable
MenuModelKeyBinding(IMenuModel menu, IComponent component) Creates a new binding for a menu and a component that contains the menu.
MenuModelKeyBinding(IMenuModel menu, IKeyObservable sourceKeyObservable, IWidget source) Creates a new key binding for menu and a given key observable

Method Summary

Methods

Modifier and Type	Method and Description
void	addMenu(IMenuModel menu) Adds a menu to the key binding
static MenuModelKeyBinding	bind(java.util.Collection<? extends IMenuModel> menus, IComponent component) Binds a collection of menus to a component When bound all key events of the component (recursive, if component is a IContainer) will be checked against the key accelerators of the menu and the actions will be performed if accelerator matches.
static MenuModelKeyBinding	bind(IMenuModel menu, IComponent component) Binds a menu to a component When bound all key events of the component (recursive, if component is a IContainer) will be checked against the key accelerators of the menu and the actions will be performed if accelerator matches.
void	dispose() Disposes the key binding

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuModelKeyBinding

public MenuModelKeyBinding(IMenuModel menu,
                   IComponent component)

Creates a new binding for a menu and a component that contains the menu. If the given component is a container, a recursive key lister will be added, otherwise a 'normal' key listener will be used for the key binding. If the component will be disposed, the binding will be disposed also

Parameters:

menu - The menu which actions should be bound

component - The component which receives the key events

MenuModelKeyBinding

public MenuModelKeyBinding(java.util.Collection<? extends IMenuModel> menus,
                   IComponent component)

Creates a new binding for a collection of menus and a component that contains the menu. If the given component is a container, a recursive key lister will be added, otherwise a 'normal' key listener will be used for the key binding. If the component will be disposed, the binding will be disposed also

Parameters:

menu - The menu which actions should be bound

component - The component which receives the key events

MenuModelKeyBinding

public MenuModelKeyBinding(IMenuModel menu,
                   IKeyObservable sourceKeyObservable,
                   IWidget source)

Creates a new key binding for menu and a given key observable

Parameters:

menu - The menu for the key binding

sourceKeyObservable - The key observable that receives the key events

source - The source widget that will be used for the execution context

MenuModelKeyBinding

public MenuModelKeyBinding(java.util.Collection<? extends IMenuModel> menus,
                   IKeyObservable sourceKeyObservable,
                   IWidget source)

Creates a new key binding for collection of menus and a given key observable

Parameters:

menu - The menu for the key binding

sourceKeyObservable - The key observable that receives the key events

source - The source widget that will be used for the execution context

Method Detail

bind

public static MenuModelKeyBinding bind(java.util.Collection<? extends IMenuModel> menus,
                       IComponent component)

Binds a collection of menus to a component When bound all key events of the component (recursive, if component is a IContainer) will be checked against the key accelerators of the menu and the actions will be performed if accelerator matches. If the component will be disposed, the binding will be disposed too

Parameters:

menus - The menus to bind

component - The component to bind to

Returns:

The KeyBinding

bind

public static MenuModelKeyBinding bind(IMenuModel menu,
                       IComponent component)

Binds a menu to a component When bound all key events of the component (recursive, if component is a IContainer) will be checked against the key accelerators of the menu and the actions will be performed if accelerator matches. If the component will be disposed, the binding will be disposed too

Parameters:

menus - The menus to bind

component - The component to bind to

Returns:

The KeyBinding

addMenu

public void addMenu(IMenuModel menu)

Adds a menu to the key binding

Parameters:

menu -

dispose

public void dispose()

Disposes the key binding