net.sf.mmm.client.ui.base.binding

Interface UiAccessKeyBinding

All Known Implementing Classes:

UiAccessKeyBindingImpl

public interface UiAccessKeyBinding

This is the interface for a central manager of access keys.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

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.
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.

Method Detail

bindAccessKey

void bindAccessKey(char key,
                   UiWidgetActive widget)

This method registers the given key for the given widget.

Parameters:

key - is the access key.

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

unbindAccessKey

boolean unbindAccessKey(char key,
                        UiWidgetActive widget)

This method unregisters the given key for the given widget.

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

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.

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

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.