net.sf.mmm.client.ui.base

Class UiAccessKeyBindingImpl

java.lang.Object

net.sf.mmm.client.ui.base.UiAccessKeyBindingImpl

All Implemented Interfaces:

UiAccessKeyBinding

public class UiAccessKeyBindingImpl
extends Object
implements UiAccessKeyBinding

This is the default implementation of UiAccessKeyBinding.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private Map<Character,Collection<AbstractUiWidgetActive<?,?>>>	accessKey2WidgetsMap

Constructor Summary

Constructors

Constructor and Description
UiAccessKeyBindingImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
void	bindAccessKey(char key, UiWidgetActive widget) This method registers the given key for the given widget.
boolean	invokeAccessKey(char key) This method simulates the effect of pressing the access key programmatically.
private Collection<AbstractUiWidgetActive<?,?>>	requireWidgetsForAccessKey(char accessKey) Gets or creates the Collection with the widgets for the given accessKey.
boolean	unbindAccessKey(char key, UiWidgetActive widget) This method unregisters the given key for the given widget.
void	verifyUniqueAccessKeys() This method verifies that there are no conflicts with multiple bindings of the same access key.

Methods inherited from class java.lang.Object

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

Field Detail

accessKey2WidgetsMap

private Map<Character,Collection<AbstractUiWidgetActive<?,?>>> accessKey2WidgetsMap

See Also:

bindAccessKey(char, UiWidgetActive)

Constructor Detail

UiAccessKeyBindingImpl

public UiAccessKeyBindingImpl()

The constructor.

Method Detail

requireWidgetsForAccessKey

private Collection<AbstractUiWidgetActive<?,?>> requireWidgetsForAccessKey(char accessKey)

Gets or creates the Collection with the widgets for the given accessKey.

Parameters:

accessKey - is the access key.

Returns:

the requested Collection.

bindAccessKey

public void bindAccessKey(char key,
                          UiWidgetActive widget)

This method registers the given key for the given widget.

Specified by:

bindAccessKey in interface UiAccessKeyBinding

Parameters:

key - is the access key.

widget - is the active widget that has been bound to the access key.

unbindAccessKey

public boolean unbindAccessKey(char key,
                               UiWidgetActive widget)

This method unregisters the given key for the given widget.

Specified by:

unbindAccessKey in interface UiAccessKeyBinding

Parameters:

key - is the access key.

widget - is the active widget that has been unbound from the access key.

Returns:

true if the access key has been unbound successfully, false otherwise (it was not bound before).

invokeAccessKey

public boolean invokeAccessKey(char key)

This method simulates the effect of pressing the access key programmatically. It may be used for native toolkits that do not support access keys as well as for testing.

Specified by:

invokeAccessKey in interface UiAccessKeyBinding

Parameters:

key - is the access key.

Returns:

true if the access key has been invoked successfully (as it was bound to a widget currently visible), false otherwise.

verifyUniqueAccessKeys

public void verifyUniqueAccessKeys()

This method verifies that there are no conflicts with multiple bindings of the same access key.
ATTENTION:
It is totally legal to create multiple widgets with the same access key. However, there shall never be two widgets visible on the screen at the same time with the same access key. This is what this method verifies for the moment in time when it is called.

Specified by:

verifyUniqueAccessKeys in interface UiAccessKeyBinding