| org.eclipse.ui.internal.keys.KeyAssistDialog
| KeyAssistDialog | | final class KeyAssistDialog extends PopupDialog (Code) | |
A dialog displaying a list of key bindings. The dialog will execute a command
if it is selected.
The methods on this class are not thread-safe and must be run from the UI
thread.
since:
3.1 |
| Method Summary | |
| final void | clearRememberedState()
Clears out the remembered state of the key assist dialog. | | final public boolean | close()
Closes this shell, but first remembers some state of the dialog. | | final public boolean | close(boolean rememberState)
Closes this shell, but first remembers some state of the dialog. | | final protected Control | createDialogArea(Composite parent)
Creates the content area for the key assistant. | | final public int | open()
Opens this dialog. | | final public int | open(Collection bindings)
Opens this dialog with the list of bindings for the user to select from. | | final protected void | setParentShell(Shell newParentShell)
Exposing this within the keys package. |
| KeyAssistDialog | | KeyAssistDialog(IWorkbench workbench, WorkbenchKeyboard associatedKeyboard, KeyBindingState associatedState)(Code) | | Constructs a new instance of KeyAssistDialog. When the
dialog is first constructed, it contains no widgets. The dialog is first
created with no parent. If a parent is required, call
setParentShell(). Also, between uses, it might be
necessary to call setParentShell() as well.
Parameters:
workbench - The workbench in which this dialog is created; must not benull.
Parameters:
associatedKeyboard - The key binding listener for the workbench; must not benull.
Parameters:
associatedState - The key binding state associated with the workbench; must notbe null. |
| clearRememberedState | | final void clearRememberedState()(Code) | | Clears out the remembered state of the key assist dialog. This includes
its width, as well as the selected binding.
|
| close | | final public boolean close()(Code) | | Closes this shell, but first remembers some state of the dialog. This way
it will have a response if asked to open the dialog again or if asked to
open the keys preference page. This does not remember the internal state.
Whether the shell was already closed. |
| close | | final public boolean close(boolean rememberState)(Code) | | Closes this shell, but first remembers some state of the dialog. This way
it will have a response if asked to open the dialog again or if asked to
open the keys preference page.
Parameters:
rememberState - Whether the internal state should be remembered. Whether the shell was already closed. |
| createDialogArea | | final protected Control createDialogArea(Composite parent)(Code) | | Creates the content area for the key assistant. This creates a table and
places it inside the composite. The composite will contain a list of all
the key bindings.
Parameters:
parent - The parent composite to contain the dialog area; must not benull. |
| open | | final public int open()(Code) | | Opens this dialog. This method can be called multiple times on the same
dialog. This only opens the dialog if there is no remembered state; if
there is remembered state, then it tries to open the preference page
instead.
The return code from this dialog. |
| open | | final public int open(Collection bindings)(Code) | | Opens this dialog with the list of bindings for the user to select from.
The return code from this dialog.
since:
3.3 |
| setParentShell | | final protected void setParentShell(Shell newParentShell)(Code) | | Exposing this within the keys package.
Parameters:
newParentShell - The new parent shell; this value may be null ifthere is to be no parent. |
|
|