Package org.eclipse.ui.handlers
Class HandlerUtil
java.lang.Object
org.eclipse.ui.handlers.HandlerUtil
Some common utilities for working with handlers in Platform UI.
Note: this class should not be instantiated or extended by clients.
- Since:
- 3.3
- Restriction:
- This class is not intended to be subclassed by clients.
- Restriction:
- This class is not intended to be instantiated by clients.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Collection
getActiveContexts
(ExecutionEvent event) Return the active contexts.static Collection
Return the active contexts.static IEditorPart
getActiveEditor
(ExecutionEvent event) Return the active editor.static IEditorPart
Return the active editor.static String
getActiveEditorId
(ExecutionEvent event) Return the part id of the active editor.static String
Return the part id of the active editor.static IEditorInput
Return the input of the active editor.static IEditorInput
Return the input of the active editor.static ISelection
Return the active menu editor input, if available.static ISelection
Return the active menu editor input.static Collection
getActiveMenus
(ExecutionEvent event) Return the menu IDs that were applied to the registered context menu.static Collection
Return the menu IDs that were applied to the registered context menu.static ISelection
Return the active menu selection.static ISelection
Return the active menu selection.static IWorkbenchPart
getActivePart
(ExecutionEvent event) Return the active part.static IWorkbenchPart
Return the active part.static String
getActivePartId
(ExecutionEvent event) Return the part id of the active part.static String
Return the part id of the active part.static Shell
getActiveShell
(ExecutionEvent event) Return the active shell.static Shell
Return the active shell.static IWorkbenchSite
getActiveSite
(ExecutionEvent event) Return the active part site.static IWorkbenchSite
Return the active part site.static IWorkbenchWindow
Return the active workbench window.static IWorkbenchWindow
Return the active workbench window.static ISelection
Return the current selection.static ISelection
Return the current selection.static IStructuredSelection
Return the current structured selection, orStructuredSelection.EMPTY
if the current selection is not a structured selection ornull
.static Object
getShowInInput
(ExecutionEvent event) Return the ShowInContext input.static Object
Return the ShowInContext input.static ISelection
getShowInSelection
(ExecutionEvent event) Return the ShowInContext selection.static ISelection
Return the ShowInContext selection.static Object
getVariable
(Object context, String name) Extract the variable.static Object
getVariable
(ExecutionEvent event, String name) Extract the variable.static Object
getVariableChecked
(ExecutionEvent event, String name) Extract the variable.static boolean
matchesRadioState
(ExecutionEvent event) Checks whether the radio state of the command is same as the radio state parameter's valuestatic boolean
toggleCommandState
(Command command) Toggles the command's state.static void
updateRadioState
(Command command, String newState) Updates the radio state of the command to the given value
-
Constructor Details
-
HandlerUtil
public HandlerUtil()
-
-
Method Details
-
getVariable
Extract the variable.- Parameters:
event
- The execution event that contains the application contextname
- The variable name to extract.- Returns:
- The object from the application context, or
null
if it could not be found.
-
getVariableChecked
public static Object getVariableChecked(ExecutionEvent event, String name) throws ExecutionException Extract the variable.- Parameters:
event
- The execution event that contains the application contextname
- The variable name to extract.- Returns:
- The object from the application context. Will not return
null
. - Throws:
ExecutionException
- if the variable is not found.
-
getVariable
Extract the variable.- Parameters:
context
- The IEvaluationContext ornull
name
- The variable name to extract.- Returns:
- The object from the application context, or
null
if it could not be found. - Since:
- 3.4
-
getActiveContexts
Return the active contexts.- Parameters:
event
- The execution event that contains the application context- Returns:
- a collection of String contextIds, or
null
.
-
getActiveContextsChecked
Return the active contexts.- Parameters:
event
- The execution event that contains the application context- Returns:
- a collection of String contextIds. Will not return
null
. - Throws:
ExecutionException
- If the context variable is not found.
-
getActiveShell
Return the active shell. Is not necessarily the active workbench window shell.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active shell, or
null
.
-
getActiveShellChecked
Return the active shell. Is not necessarily the active workbench window shell.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active shell. Will not return
null
. - Throws:
ExecutionException
- If the active shell variable is not found.
-
getActiveWorkbenchWindow
Return the active workbench window.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active workbench window, or
null
.
-
getActiveWorkbenchWindowChecked
public static IWorkbenchWindow getActiveWorkbenchWindowChecked(ExecutionEvent event) throws ExecutionException Return the active workbench window.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active workbench window. Will not return
null
. - Throws:
ExecutionException
- If the active workbench window variable is not found.
-
getActiveEditor
Return the active editor.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active editor, or
null
.
-
getActiveEditorChecked
Return the active editor.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active editor. Will not return
null
. - Throws:
ExecutionException
- If the active editor variable is not found.
-
getActiveEditorId
Return the part id of the active editor.- Parameters:
event
- The execution event that contains the application context- Returns:
- the part id of the active editor, or
null
.
-
getActiveEditorIdChecked
Return the part id of the active editor.- Parameters:
event
- The execution event that contains the application context- Returns:
- the part id of the active editor. Will not return
null
. - Throws:
ExecutionException
- If the active editor id variable is not found.
-
getActiveEditorInput
Return the input of the active editor.- Parameters:
event
- The execution event that contains the application context- Returns:
- the input of the active editor, or
null
. - Since:
- 3.7
-
getActiveEditorInputChecked
public static IEditorInput getActiveEditorInputChecked(ExecutionEvent event) throws ExecutionException Return the input of the active editor.- Parameters:
event
- The execution event that contains the application context- Returns:
- the input of the active editor. Will not return
null
. - Throws:
ExecutionException
- If the active editor input variable is not found.- Since:
- 3.7
-
getActivePart
Return the active part.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active part, or
null
.
-
getActivePartChecked
Return the active part.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active part. Will not return
null
. - Throws:
ExecutionException
- If the active part variable is not found.
-
getActivePartId
Return the part id of the active part.- Parameters:
event
- The execution event that contains the application context- Returns:
- the part id of the active part, or
null
.
-
getActivePartIdChecked
Return the part id of the active part.- Parameters:
event
- The execution event that contains the application context- Returns:
- the part id of the active part. Will not return
null
. - Throws:
ExecutionException
- If the active part id variable is not found.
-
getActiveSite
Return the active part site.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active part site, or
null
.
-
getActiveSiteChecked
Return the active part site.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active part site. Will not return
null
. - Throws:
ExecutionException
- If the active part site variable is not found.
-
getCurrentSelection
Return the current selection.- Parameters:
event
- The execution event that contains the application context- Returns:
- the current selection, or
null
.
-
getCurrentStructuredSelection
Return the current structured selection, orStructuredSelection.EMPTY
if the current selection is not a structured selection ornull
.- Parameters:
event
- The execution event that contains the application context- Returns:
- the current IStructuredSelection, or
StructuredSelection.EMPTY
. - Since:
- 3.108
-
getCurrentSelectionChecked
Return the current selection.- Parameters:
event
- The execution event that contains the application context- Returns:
- the current selection. Will not return
null
. - Throws:
ExecutionException
- If the current selection variable is not found.
-
getActiveMenus
Return the menu IDs that were applied to the registered context menu. For example, #CompilationUnitEditorContext.- Parameters:
event
- The execution event that contains the application context- Returns:
- the menu IDs, or
null
.
-
getActiveMenusChecked
Return the menu IDs that were applied to the registered context menu. For example, #CompilationUnitEditorContext.- Parameters:
event
- The execution event that contains the application context- Returns:
- the menu IDs. Will not return
null
. - Throws:
ExecutionException
- If the active menus variable is not found.
-
getActiveMenuSelection
Return the active menu selection. The active menu is a registered context menu.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active menu selection, or
null
.
-
getActiveMenuSelectionChecked
public static ISelection getActiveMenuSelectionChecked(ExecutionEvent event) throws ExecutionException Return the active menu selection. The active menu is a registered context menu.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active menu selection. Will not return
null
. - Throws:
ExecutionException
- If the active menu selection variable is not found.
-
getActiveMenuEditorInput
Return the active menu editor input, if available. The active menu is a registered context menu.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active menu editor, or
null
.
-
getActiveMenuEditorInputChecked
public static ISelection getActiveMenuEditorInputChecked(ExecutionEvent event) throws ExecutionException Return the active menu editor input. The active menu is a registered context menu. Some context menus do not include the editor input which will throw an exception.- Parameters:
event
- The execution event that contains the application context- Returns:
- the active menu editor input. Will not return
null
. - Throws:
ExecutionException
- If the active menu editor input variable is not found.
-
getShowInSelection
Return the ShowInContext selection.- Parameters:
event
- The execution event that contains the application context- Returns:
- the show in selection, or
null
. - Since:
- 3.4
-
getShowInSelectionChecked
Return the ShowInContext selection. Will not returnnull
.- Parameters:
event
- The execution event that contains the application context- Returns:
- the show in selection, or
null
. - Throws:
ExecutionException
- If the show in selection variable is not found.- Since:
- 3.4
-
getShowInInput
Return the ShowInContext input.- Parameters:
event
- The execution event that contains the application context- Returns:
- the show in input, or
null
. - Since:
- 3.4
-
getShowInInputChecked
Return the ShowInContext input. Will not returnnull
.- Parameters:
event
- The execution event that contains the application context- Returns:
- the show in input, or
null
. - Throws:
ExecutionException
- If the show in input variable is not found.- Since:
- 3.4
-
toggleCommandState
Toggles the command's state.- Parameters:
command
- The command whose state needs to be toggled- Returns:
- the original value before toggling
- Throws:
ExecutionException
- When the command doesn't contain the toggle state or when the state doesn't contain a boolean value- Since:
- 3.5
-
matchesRadioState
Checks whether the radio state of the command is same as the radio state parameter's value- Parameters:
event
- The execution event that contains the application context- Returns:
true
whe the values are same,false
otherwise- Throws:
ExecutionException
- When the command doesn't have the radio state or the event doesn't have the radio state parameter- Since:
- 3.5
-
updateRadioState
Updates the radio state of the command to the given value- Parameters:
command
- the command whose state should be updatednewState
- the new state- Throws:
ExecutionException
- When the command doesn't have a radio state- Since:
- 3.5
-