| /********************************************************************** |
| * Copyright (c) 2011, 2018 Ericsson |
| * |
| * All rights reserved. This program and the accompanying materials are |
| * made available under the terms of the Eclipse Public License 2.0 which |
| * accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * Bernd Hufmann - Initial API and implementation |
| **********************************************************************/ |
| package org.eclipse.tracecompass.tmf.ui.views.uml2sd.handlers; |
| |
| import java.util.ArrayList; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Set; |
| |
| import org.eclipse.core.commands.AbstractHandler; |
| import org.eclipse.core.commands.ExecutionEvent; |
| import org.eclipse.core.commands.ExecutionException; |
| import org.eclipse.tracecompass.tmf.ui.views.uml2sd.SDView; |
| import org.eclipse.tracecompass.tmf.ui.views.uml2sd.util.Messages; |
| import org.eclipse.ui.IWorkbenchWindow; |
| import org.eclipse.ui.PlatformUI; |
| import org.eclipse.ui.handlers.IHandlerActivation; |
| import org.eclipse.ui.handlers.IHandlerService; |
| |
| /** |
| * <p> |
| * Singleton class that manages key-bindings for certain commands across multiple sequence |
| * diagram view instances. |
| * </p> |
| * |
| * @version 1.0 |
| * @author Bernd Hufmann |
| * |
| */ |
| public class KeyBindingsManager { |
| |
| // ------------------------------------------------------------------------ |
| // Attributes |
| // ------------------------------------------------------------------------ |
| |
| /** |
| * The singleton instance. |
| */ |
| private static KeyBindingsManager fInstance = null; |
| /** |
| * The list of view names. |
| */ |
| private Set<String> fViews = new HashSet<>(); |
| /** |
| * The list of activations Activations to store |
| */ |
| private List<IHandlerActivation> fHandlerActivations = new ArrayList<>(); |
| /** |
| * The action reference for moving to a message in view. |
| */ |
| private MoveToMessage fGoToMessageForKeyBinding; |
| /** |
| * The action reference for opening the find dialog. |
| */ |
| private OpenSDFindDialog fFindForKeyBinding; |
| /** |
| * The action reference for moving up in view. |
| */ |
| private MoveSDUp fMoveUpForKeyBinding; |
| /** |
| * The action reference for moving down in view. |
| */ |
| private MoveSDDown fMoveDownForKeyBinding; |
| /** |
| * The action reference for moving left in view. |
| */ |
| private MoveSDLeft fMoveLeftForKeyBinding; |
| /** |
| * The action reference for moving right in view. |
| */ |
| private MoveSDRight fMoveRightForKeyBinding; |
| /** |
| * The action reference for showing node start. |
| */ |
| private ShowNodeStart fShowNodeStartForKeyBinding; |
| /** |
| * The action reference for showing node end. |
| */ |
| private ShowNodeEnd fShowNodeEndForKeyBinding; |
| |
| // ------------------------------------------------------------------------ |
| // Constructor |
| // ------------------------------------------------------------------------ |
| |
| /** |
| * Constructor |
| */ |
| protected KeyBindingsManager() { |
| } |
| |
| // ------------------------------------------------------------------------ |
| // Methods |
| // ------------------------------------------------------------------------ |
| /** |
| * Returns the KeyBindingsManager singleton instance. |
| * |
| * @return the KeyBindingsManager singleton instance |
| */ |
| public static synchronized KeyBindingsManager getInstance() { |
| if (fInstance == null) { |
| fInstance = new KeyBindingsManager(); |
| } |
| return fInstance; |
| } |
| |
| /** |
| * Adds a view list of managed view list. |
| * |
| * @param viewId Id of SD view to add and to manage |
| */ |
| public void add(String viewId) { |
| |
| if (fViews.isEmpty()) { |
| initialize(); |
| } |
| |
| if(!fViews.contains(viewId)) { |
| fViews.add(viewId); |
| } |
| } |
| |
| /** |
| * Removes a view from managed view list |
| * |
| * @param viewId Id of SD view to remove |
| */ |
| public void remove(String viewId) { |
| if (fViews.contains(viewId)) { |
| fViews.remove(viewId); |
| } |
| if (fViews.isEmpty()) { |
| dispose(); |
| } |
| } |
| |
| /* |
| * Initialized the KeyBindingsManager. |
| */ |
| private void initialize() { |
| fGoToMessageForKeyBinding = new MoveToMessage(); |
| Object serviceObject = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getService(IHandlerService.class); |
| IHandlerService service = (IHandlerService) serviceObject; |
| AbstractHandler handler = new AbstractHandler() { |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| fGoToMessageForKeyBinding.run(); |
| return null; |
| } |
| }; |
| IHandlerActivation activation = service.activateHandler(fGoToMessageForKeyBinding.getActionDefinitionId(), handler); |
| fHandlerActivations.add(activation); |
| |
| fMoveUpForKeyBinding = new MoveSDUp(); |
| handler = new AbstractHandler() { |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| fMoveUpForKeyBinding.run(); |
| return null; |
| } |
| }; |
| activation = service.activateHandler(fMoveUpForKeyBinding.getActionDefinitionId(), handler); |
| fHandlerActivations.add(activation); |
| |
| fMoveDownForKeyBinding = new MoveSDDown(); |
| handler = new AbstractHandler() { |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| fMoveDownForKeyBinding.run(); |
| return null; |
| } |
| }; |
| activation = service.activateHandler(fMoveDownForKeyBinding.getActionDefinitionId(), handler); |
| fHandlerActivations.add(activation); |
| |
| fMoveLeftForKeyBinding = new MoveSDLeft(); |
| handler = new AbstractHandler() { |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| fMoveLeftForKeyBinding.run(); |
| return null; |
| } |
| }; |
| activation = service.activateHandler(fMoveLeftForKeyBinding.getActionDefinitionId(), handler); |
| fHandlerActivations.add(activation); |
| |
| fMoveRightForKeyBinding = new MoveSDRight(); |
| handler = new AbstractHandler() { |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| fMoveRightForKeyBinding.run(); |
| return null; |
| } |
| }; |
| activation = service.activateHandler(fMoveRightForKeyBinding.getActionDefinitionId(), handler); |
| fHandlerActivations.add(activation); |
| |
| fFindForKeyBinding = new OpenSDFindDialog(); |
| handler = new AbstractHandler() { |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| fFindForKeyBinding.run(); |
| return null; |
| } |
| }; |
| activation = service.activateHandler(fFindForKeyBinding.getActionDefinitionId(), handler); |
| fFindForKeyBinding.setEnabled(false); |
| fHandlerActivations.add(activation); |
| |
| fShowNodeStartForKeyBinding = new ShowNodeStart(); |
| fShowNodeStartForKeyBinding.setText(Messages.SequenceDiagram_ShowNodeStart); |
| |
| fShowNodeStartForKeyBinding.setId("org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.ShowNodeStart");//$NON-NLS-1$ |
| fShowNodeStartForKeyBinding.setActionDefinitionId("org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.ShowNodeStart");//$NON-NLS-1$ |
| |
| handler = new AbstractHandler() { |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| fShowNodeStartForKeyBinding.run(); |
| return null; |
| } |
| }; |
| activation = service.activateHandler(fShowNodeStartForKeyBinding.getActionDefinitionId(), handler); |
| fHandlerActivations.add(activation); |
| |
| fShowNodeEndForKeyBinding = new ShowNodeEnd(); |
| fShowNodeEndForKeyBinding.setText(Messages.SequenceDiagram_ShowNodeEnd); |
| fShowNodeEndForKeyBinding.setId("org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.ShowNodeEnd");//$NON-NLS-1$ |
| fShowNodeEndForKeyBinding.setActionDefinitionId("org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.ShowNodeEnd");//$NON-NLS-1$ |
| |
| handler = new AbstractHandler() { |
| @Override |
| public Object execute(ExecutionEvent event) throws ExecutionException { |
| fShowNodeEndForKeyBinding.run(); |
| return null; |
| } |
| }; |
| activation = service.activateHandler(fShowNodeEndForKeyBinding.getActionDefinitionId(), handler); |
| fHandlerActivations.add(activation); |
| |
| } |
| |
| /* |
| * Disposes the KeyBindingsManager |
| */ |
| private void dispose() { |
| IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow(); |
| if (window == null) { |
| //During Eclipse shutdown the active workbench window is null |
| return; |
| } |
| Object serviceObject = window.getService(IHandlerService.class); |
| IHandlerService service = (IHandlerService) serviceObject; |
| for (IHandlerActivation activation : fHandlerActivations) { |
| service.deactivateHandler(activation); |
| } |
| fHandlerActivations.clear(); |
| |
| fGoToMessageForKeyBinding = null; |
| fFindForKeyBinding = null; |
| fMoveUpForKeyBinding = null; |
| fMoveDownForKeyBinding = null; |
| fMoveLeftForKeyBinding = null; |
| fMoveRightForKeyBinding = null; |
| fShowNodeStartForKeyBinding = null; |
| fShowNodeEndForKeyBinding = null; |
| } |
| |
| /** |
| * Set the view in all supported actions |
| * |
| * @param view to set in global actions |
| */ |
| public void setSdView(SDView view) { |
| if (!fViews.isEmpty()) { |
| fGoToMessageForKeyBinding.setView(view); |
| fFindForKeyBinding.setView(view); |
| fMoveUpForKeyBinding.setView(view); |
| fMoveDownForKeyBinding.setView(view); |
| fMoveLeftForKeyBinding.setView(view); |
| fMoveRightForKeyBinding.setView(view); |
| fShowNodeStartForKeyBinding.setView(view); |
| fShowNodeEndForKeyBinding.setView(view); |
| } |
| } |
| |
| /** |
| * Enable / disable find action |
| * |
| * @param enabled <code>true</code> for enabling else <code>false</code> |
| */ |
| public void setFindEnabled(boolean enabled) { |
| if (fFindForKeyBinding != null) { |
| fFindForKeyBinding.setEnabled(enabled); |
| } |
| } |
| } |