/*******************************************************************************
- * Copyright (c) 2009, 2010, 2012 Ericsson
- *
+ * Copyright (c) 2009, 2012 Ericsson
+ *
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
- *
+ *
* Contributors:
* Francois Chouinard - Initial API and implementation
+ * Bernd Hufmann - Added possibility to pin view
*******************************************************************************/
package org.eclipse.linuxtools.tmf.ui.views;
+import org.eclipse.jface.action.IToolBarManager;
+import org.eclipse.jface.action.Separator;
import org.eclipse.linuxtools.tmf.core.component.ITmfComponent;
import org.eclipse.linuxtools.tmf.core.signal.TmfSignal;
import org.eclipse.linuxtools.tmf.core.signal.TmfSignalManager;
+import org.eclipse.ui.IWorkbenchActionConstants;
import org.eclipse.ui.part.ViewPart;
/**
* Basic abstract TMF view class implementation.
- *
+ *
* It registers any sub class to the signal manager for receiving and sending
- * TMF signals.
- *
- * @version 1.0
+ * TMF signals.
+ *
+ * @version 1.2
* @author Francois Chouinard
*/
public abstract class TmfView extends ViewPart implements ITmfComponent {
private final String fName;
-
+ /**
+ * Action class for pinning of TmfView.
+ * @since 2.0
+ */
+ protected PinTmfViewAction fPinAction;
+
// ------------------------------------------------------------------------
// Constructor
// ------------------------------------------------------------------------
/**
* Constructor. Creates a TMF view and registers to the signal manager.
- *
+ *
* @param viewName A view name
*/
public TmfView(String viewName) {
}
/**
- * Disposes this view and deregisters itself from the signal manager
+ * Disposes this view and de-registers itself from the signal manager
+ *
* @see org.eclipse.ui.part.WorkbenchPart#dispose()
*/
@Override
public String getName() {
return fName;
}
-
+
/*
* (non-Javadoc)
* @see org.eclipse.linuxtools.tmf.core.component.ITmfComponent#broadcast(org.eclipse.linuxtools.tmf.core.signal.TmfSignal)
TmfSignalManager.dispatchSignal(signal);
}
-}
\ No newline at end of file
+ // ------------------------------------------------------------------------
+ // View pinning support
+ // ------------------------------------------------------------------------
+
+ /**
+ * Returns whether the pin flag is set.
+ * For example, this flag can be used to ignore time synchronization signals from other TmfViews.
+ *
+ * @return pin flag
+ * @since 2.0
+ */
+ public boolean isPinned() {
+ return ((fPinAction != null) && (fPinAction.isChecked()));
+ }
+
+ /**
+ * Method adds a pin action to the TmfView. The pin action allows to toggle the <code>fIsPinned</code> flag.
+ * For example, this flag can be used to ignore time synchronization signals from other TmfViews.
+ *
+ * @since 2.0
+ */
+ protected void contributePinActionToToolBar() {
+ if (fPinAction == null) {
+ fPinAction = new PinTmfViewAction();
+
+ IToolBarManager toolBarManager = getViewSite().getActionBars()
+ .getToolBarManager();
+ toolBarManager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));
+ toolBarManager.add(fPinAction);
+ }
+ }
+
+}