| java.lang.Object
 org.eclipse.ui.internal.keys.KeyBindingState
| KeyBindingState | | class KeyBindingState (Code) | |
The mutable state of the key binding architecture. This is the only piece of
the key binding architecture that changes (internally). It keeps track of
what partial key strokes the user has entered. In the case of functional
groups of key bindings, it allows the user to keep part of the key sequence
even after a match has been made. Only after releasing all of the modifier
keys would the sequence reset itself.
In the current implementation, a partial reset results in only one key
stroke being left in the sequence. However, this may change in the future.
since:
3.0 |
| Constructor Summary | |
| | KeyBindingState(IWorkbench workbenchToNotify)
Constructs a new instance of KeyBindingState with an
empty key sequence, set to reset fully. |
| KeyBindingState | | KeyBindingState(IWorkbench workbenchToNotify)(Code) | | Constructs a new instance of KeyBindingState with an
empty key sequence, set to reset fully.
Parameters:
workbenchToNotify - The workbench that this state should keep advised of changesto the key binding state; must not be null. |
| getAssociatedWindow | | IWorkbenchWindow getAssociatedWindow()(Code) | | An accessor for the workbench window associated with this state. This
should never be null, as the setting follows the last
workbench window to have focus.
The workbench window to which the key binding architecture iscurrently attached; should never be null. |
| getCurrentSequence | | KeySequence getCurrentSequence()(Code) | | An accessor for the current key sequence waiting for completion.
The current incomplete key sequence; never null,but may be empty. |
| getStatusLine | | StatusLineContributionItem getStatusLine()(Code) | | Gets the status line contribution item which the key binding
architecture uses to keep the user up-to-date as to the current state.
The status line contribution item, if any; null,if none. |
| reset | | void reset()(Code) | |
Resets the state based on the current properties. If the state is to
collapse fully or if there are no key strokes, then it sets the state to
have an empty key sequence. Otherwise, it leaves the first key stroke in
the sequence.
The workbench's status lines are updated, if appropriate.
|
| setAssociatedWindow | | void setAssociatedWindow(IWorkbenchWindow window)(Code) | | A mutator for the workbench window to which this state is associated.
Parameters:
window - The workbench window to associated; should never be null. |
| setCurrentSequence | | void setCurrentSequence(KeySequence sequence)(Code) | | A mutator for the partial sequence entered by the user.
Parameters:
sequence - The current key sequence; should not be null,but may be empty. |
|
|