ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDEFormEditorContributor.java - pde/eclipse.pde.ui - Git at Google

 /*******************************************************************************
  * Copyright (c) 2003, 2015 IBM Corporation and others.
  *
  * 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:
  *     IBM Corporation - initial API and implementation
  *     Joern Dinkla <devnull@dinkla.com> - bug 197821
  *******************************************************************************/
 package org.eclipse.pde.internal.ui.editor;

 import java.util.Hashtable;
 import org.eclipse.jface.action.*;
 import org.eclipse.jface.viewers.ISelection;
 import org.eclipse.pde.core.IBaseModel;
 import org.eclipse.pde.core.IEditable;
 import org.eclipse.pde.internal.ui.PDEPlugin;
 import org.eclipse.pde.internal.ui.PDEUIMessages;
 import org.eclipse.ui.*;
 import org.eclipse.ui.actions.ActionFactory;
 import org.eclipse.ui.forms.editor.IFormPage;
 import org.eclipse.ui.ide.IDEActionFactory;
 import org.eclipse.ui.part.MultiPageEditorActionBarContributor;
 import org.eclipse.ui.texteditor.IUpdate;

 public class PDEFormEditorContributor extends MultiPageEditorActionBarContributor {

 	protected PDEFormEditor fEditor;

 	protected IFormPage fPage;

 	private SaveAction fSaveAction;

 	protected RevertAction fRevertAction;

 	private ClipboardAction fCutAction;

 	private ClipboardAction fCopyAction;

 	private ClipboardAction fPasteAction;

 	private SelectAllAction fSelectAllAction;

 	private Hashtable<String, Action> fGlobalActions = new Hashtable<>();

 	private ISharedImages fSharedImages;

 	class GlobalAction extends Action implements IUpdate {
 		private String id;

 		public GlobalAction(String id) {
 			this.id = id;
 		}

 		@Override
 		public void run() {
 			fEditor.performGlobalAction(id);
 			updateSelectableActions(fEditor.getSelection());
 		}

 		@Override
 		public void update() {
 			getActionBars().updateActionBars();
 		}
 	}

 	class ClipboardAction extends GlobalAction {
 		public ClipboardAction(String id) {
 			super(id);
 			setEnabled(false);
 		}

 		public void selectionChanged(ISelection selection) {
 		}

 		public boolean isEditable() {
 			if (fEditor == null)
 				return false;
 			IBaseModel model = fEditor.getAggregateModel();
 			return model instanceof IEditable ? ((IEditable) model).isEditable() : false;
 		}
 	}

 	class CutAction extends ClipboardAction {
 		public CutAction() {
 			super(ActionFactory.CUT.getId());
 			setText(PDEUIMessages.EditorActions_cut);
 			setImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_CUT));
 			setDisabledImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_CUT_DISABLED));
 			setActionDefinitionId(ActionFactory.CUT.getCommandId());
 		}

 		@Override
 		public void selectionChanged(ISelection selection) {
 			setEnabled(isEditable() && fEditor.canCut(selection));
 		}
 	}

 	class CopyAction extends ClipboardAction {
 		public CopyAction() {
 			super(ActionFactory.COPY.getId());
 			setText(PDEUIMessages.EditorActions_copy);
 			setImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_COPY));
 			setDisabledImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_COPY_DISABLED));
 			setActionDefinitionId(ActionFactory.COPY.getCommandId());
 		}

 		@Override
 		public void selectionChanged(ISelection selection) {
 			setEnabled(fEditor.canCopy(selection));
 		}
 	}

 	class PasteAction extends ClipboardAction {
 		public PasteAction() {
 			super(ActionFactory.PASTE.getId());
 			setText(PDEUIMessages.EditorActions_paste);
 			setImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_PASTE));
 			setDisabledImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_PASTE_DISABLED));
 			setActionDefinitionId(ActionFactory.PASTE.getCommandId());
 		}

 		@Override
 		public void selectionChanged(ISelection selection) {
 			setEnabled(isEditable() && fEditor.canPasteFromClipboard());
 		}
 	}

 	class SelectAllAction extends ClipboardAction {
 		public SelectAllAction() {
 			super(ActionFactory.SELECT_ALL.getId());
 			setText(PDEUIMessages.EditorActions_selectall);
 			setActionDefinitionId(ActionFactory.SELECT_ALL.getCommandId());
 			setEnabled(true);
 		}
 	}

 	class SaveAction extends Action implements IUpdate {
 		public SaveAction() {
 		}

 		@Override
 		public void run() {
 			if (fEditor != null)
 				PDEPlugin.getActivePage().saveEditor(fEditor, false);
 		}

 		@Override
 		public void update() {
 			setEnabled(fEditor != null ? fEditor.isDirty() : false);
 		}
 	}

 	class RevertAction extends Action implements IUpdate {
 		public RevertAction() {
 		}

 		@Override
 		public void run() {
 			if (fEditor != null)
 				fEditor.doRevert();
 		}

 		@Override
 		public void update() {
 			setEnabled(fEditor != null ? fEditor.isDirty() : false);
 		}
 	}

 	public PDEFormEditorContributor(String menuName) {
 	}

 	private void addGlobalAction(String id) {
 		GlobalAction action = new GlobalAction(id);
 		addGlobalAction(id, action);
 	}

 	private void addGlobalAction(String id, Action action) {
 		fGlobalActions.put(id, action);
 		getActionBars().setGlobalActionHandler(id, action);
 	}

 	public void addClipboardActions(IMenuManager mng) {
 		mng.add(fCutAction);
 		mng.add(fCopyAction);
 		mng.add(fPasteAction);
 		mng.add(new Separator());
 		mng.add(fSelectAllAction);
 		mng.add(new Separator());
 		mng.add(fRevertAction);
 	}

 	public void contextMenuAboutToShow(IMenuManager mng) {
 		contextMenuAboutToShow(mng, true);
 	}

 	public void contextMenuAboutToShow(IMenuManager mng, boolean addClipboard) {
 		if (fEditor != null)
 			updateSelectableActions(fEditor.getSelection());
 		if (addClipboard)
 			addClipboardActions(mng);
 		mng.add(fSaveAction);
 	}

 	@Override
 	public void contributeToMenu(IMenuManager mm) {
 	}

 	@Override
 	public void contributeToStatusLine(IStatusLineManager slm) {
 	}

 	@Override
 	public void contributeToToolBar(IToolBarManager tbm) {
 	}

 	@Override
 	public void contributeToCoolBar(ICoolBarManager cbm) {
 	}

 	public PDEFormEditor getEditor() {
 		return fEditor;
 	}

 	public IAction getGlobalAction(String id) {
 		return fGlobalActions.get(id);
 	}

 	public IAction getSaveAction() {
 		return fSaveAction;
 	}

 	public IAction getRevertAction() {
 		return fRevertAction;
 	}

 	public IStatusLineManager getStatusLineManager() {
 		return getActionBars().getStatusLineManager();
 	}

 	protected void makeActions() {
 		// clipboard actions
 		fCutAction = new CutAction();
 		fCopyAction = new CopyAction();
 		fPasteAction = new PasteAction();
 		fSelectAllAction = new SelectAllAction();
 		addGlobalAction(ActionFactory.CUT.getId(), fCutAction);
 		addGlobalAction(ActionFactory.COPY.getId(), fCopyAction);
 		addGlobalAction(ActionFactory.PASTE.getId(), fPasteAction);
 		addGlobalAction(ActionFactory.DELETE.getId());
 		// undo/redo
 		addGlobalAction(ActionFactory.UNDO.getId());
 		addGlobalAction(ActionFactory.REDO.getId());
 		// select/find
 		addGlobalAction(ActionFactory.SELECT_ALL.getId(), fSelectAllAction);
 		addGlobalAction(ActionFactory.FIND.getId());
 		// bookmark
 		addGlobalAction(IDEActionFactory.BOOKMARK.getId());
 		// save/revert
 		fSaveAction = new SaveAction();
 		fSaveAction.setText(PDEUIMessages.EditorActions_save);
 		fRevertAction = new RevertAction();
 		fRevertAction.setText(PDEUIMessages.EditorActions_revert);
 		addGlobalAction(ActionFactory.REVERT.getId(), fRevertAction);
 	}

 	@Override
 	public void setActiveEditor(IEditorPart targetEditor) {
 		if (targetEditor instanceof PDESourcePage) {
 			// Fixing the 'goto line' problem -
 			// the action is thinking that source page
 			// is a standalone editor and tries to activate it
 			// #19361
 			PDESourcePage page = (PDESourcePage) targetEditor;
 			PDEPlugin.getActivePage().activate(page.getEditor());
 			return;
 		}
 		if (!(targetEditor instanceof PDEFormEditor))
 			return;

 		fEditor = (PDEFormEditor) targetEditor;
 		fEditor.updateUndo(getGlobalAction(ActionFactory.UNDO.getId()), getGlobalAction(ActionFactory.REDO.getId()));
 		setActivePage(fEditor.getActiveEditor());
 		updateSelectableActions(fEditor.getSelection());
 	}

 	@Override
 	public void setActivePage(IEditorPart newEditor) {
 		if (fEditor == null)
 			return;
 		IFormPage oldPage = fPage;
 		fPage = fEditor.getActivePageInstance();
 		if (fPage != null) {
 			updateActions();
 			if (oldPage != null && !oldPage.isEditor() && !fPage.isEditor()) {
 				getActionBars().updateActionBars();
 			}
 		}
 	}

 	public void updateActions() {
 		fSaveAction.update();
 		fRevertAction.update();
 	}

 	public void updateSelectableActions(ISelection selection) {
 		if (fEditor != null) {
 			fCutAction.selectionChanged(selection);
 			fCopyAction.selectionChanged(selection);
 			fPasteAction.selectionChanged(selection);
 		}
 	}

 	public IEditorActionBarContributor getSourceContributor() {
 		return null;
 	}

 	@Override
 	public void init(IActionBars bars) {
 		super.init(bars);
 		makeActions();
 	}

 	protected ISharedImages getSharedImages() {
 		if (fSharedImages == null)
 			fSharedImages = getPage().getWorkbenchWindow().getWorkbench().getSharedImages();
 		return fSharedImages;
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2003, 2015 IBM Corporation and others.
	*
	* 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:
	* IBM Corporation - initial API and implementation
	* Joern Dinkla <devnull@dinkla.com> - bug 197821
	*******************************************************************************/
	package org.eclipse.pde.internal.ui.editor;

	import java.util.Hashtable;
	import org.eclipse.jface.action.*;
	import org.eclipse.jface.viewers.ISelection;
	import org.eclipse.pde.core.IBaseModel;
	import org.eclipse.pde.core.IEditable;
	import org.eclipse.pde.internal.ui.PDEPlugin;
	import org.eclipse.pde.internal.ui.PDEUIMessages;
	import org.eclipse.ui.*;
	import org.eclipse.ui.actions.ActionFactory;
	import org.eclipse.ui.forms.editor.IFormPage;
	import org.eclipse.ui.ide.IDEActionFactory;
	import org.eclipse.ui.part.MultiPageEditorActionBarContributor;
	import org.eclipse.ui.texteditor.IUpdate;

	public class PDEFormEditorContributor extends MultiPageEditorActionBarContributor {

	protected PDEFormEditor fEditor;

	protected IFormPage fPage;

	private SaveAction fSaveAction;

	protected RevertAction fRevertAction;

	private ClipboardAction fCutAction;

	private ClipboardAction fCopyAction;

	private ClipboardAction fPasteAction;

	private SelectAllAction fSelectAllAction;

	private Hashtable<String, Action> fGlobalActions = new Hashtable<>();

	private ISharedImages fSharedImages;

	class GlobalAction extends Action implements IUpdate {
	private String id;

	public GlobalAction(String id) {
	this.id = id;
	}

	@Override
	public void run() {
	fEditor.performGlobalAction(id);
	updateSelectableActions(fEditor.getSelection());
	}

	@Override
	public void update() {
	getActionBars().updateActionBars();
	}
	}

	class ClipboardAction extends GlobalAction {
	public ClipboardAction(String id) {
	super(id);
	setEnabled(false);
	}

	public void selectionChanged(ISelection selection) {
	}

	public boolean isEditable() {
	if (fEditor == null)
	return false;
	IBaseModel model = fEditor.getAggregateModel();
	return model instanceof IEditable ? ((IEditable) model).isEditable() : false;
	}
	}

	class CutAction extends ClipboardAction {
	public CutAction() {
	super(ActionFactory.CUT.getId());
	setText(PDEUIMessages.EditorActions_cut);
	setImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_CUT));
	setDisabledImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_CUT_DISABLED));
	setActionDefinitionId(ActionFactory.CUT.getCommandId());
	}

	@Override
	public void selectionChanged(ISelection selection) {
	setEnabled(isEditable() && fEditor.canCut(selection));
	}
	}

	class CopyAction extends ClipboardAction {
	public CopyAction() {
	super(ActionFactory.COPY.getId());
	setText(PDEUIMessages.EditorActions_copy);
	setImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_COPY));
	setDisabledImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_COPY_DISABLED));
	setActionDefinitionId(ActionFactory.COPY.getCommandId());
	}

	@Override
	public void selectionChanged(ISelection selection) {
	setEnabled(fEditor.canCopy(selection));
	}
	}

	class PasteAction extends ClipboardAction {
	public PasteAction() {
	super(ActionFactory.PASTE.getId());
	setText(PDEUIMessages.EditorActions_paste);
	setImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_PASTE));
	setDisabledImageDescriptor(getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_PASTE_DISABLED));
	setActionDefinitionId(ActionFactory.PASTE.getCommandId());
	}

	@Override
	public void selectionChanged(ISelection selection) {
	setEnabled(isEditable() && fEditor.canPasteFromClipboard());
	}
	}

	class SelectAllAction extends ClipboardAction {
	public SelectAllAction() {
	super(ActionFactory.SELECT_ALL.getId());
	setText(PDEUIMessages.EditorActions_selectall);
	setActionDefinitionId(ActionFactory.SELECT_ALL.getCommandId());
	setEnabled(true);
	}
	}

	class SaveAction extends Action implements IUpdate {
	public SaveAction() {
	}

	@Override
	public void run() {
	if (fEditor != null)
	PDEPlugin.getActivePage().saveEditor(fEditor, false);
	}

	@Override
	public void update() {
	setEnabled(fEditor != null ? fEditor.isDirty() : false);
	}
	}

	class RevertAction extends Action implements IUpdate {
	public RevertAction() {
	}

	@Override
	public void run() {
	if (fEditor != null)
	fEditor.doRevert();
	}

	@Override
	public void update() {
	setEnabled(fEditor != null ? fEditor.isDirty() : false);
	}
	}

	public PDEFormEditorContributor(String menuName) {
	}

	private void addGlobalAction(String id) {
	GlobalAction action = new GlobalAction(id);
	addGlobalAction(id, action);
	}

	private void addGlobalAction(String id, Action action) {
	fGlobalActions.put(id, action);
	getActionBars().setGlobalActionHandler(id, action);
	}

	public void addClipboardActions(IMenuManager mng) {
	mng.add(fCutAction);
	mng.add(fCopyAction);
	mng.add(fPasteAction);
	mng.add(new Separator());
	mng.add(fSelectAllAction);
	mng.add(new Separator());
	mng.add(fRevertAction);
	}

	public void contextMenuAboutToShow(IMenuManager mng) {
	contextMenuAboutToShow(mng, true);
	}

	public void contextMenuAboutToShow(IMenuManager mng, boolean addClipboard) {
	if (fEditor != null)
	updateSelectableActions(fEditor.getSelection());
	if (addClipboard)
	addClipboardActions(mng);
	mng.add(fSaveAction);
	}

	@Override
	public void contributeToMenu(IMenuManager mm) {
	}

	@Override
	public void contributeToStatusLine(IStatusLineManager slm) {
	}

	@Override
	public void contributeToToolBar(IToolBarManager tbm) {
	}

	@Override
	public void contributeToCoolBar(ICoolBarManager cbm) {
	}

	public PDEFormEditor getEditor() {
	return fEditor;
	}

	public IAction getGlobalAction(String id) {
	return fGlobalActions.get(id);
	}

	public IAction getSaveAction() {
	return fSaveAction;
	}

	public IAction getRevertAction() {
	return fRevertAction;
	}

	public IStatusLineManager getStatusLineManager() {
	return getActionBars().getStatusLineManager();
	}

	protected void makeActions() {
	// clipboard actions
	fCutAction = new CutAction();
	fCopyAction = new CopyAction();
	fPasteAction = new PasteAction();
	fSelectAllAction = new SelectAllAction();
	addGlobalAction(ActionFactory.CUT.getId(), fCutAction);
	addGlobalAction(ActionFactory.COPY.getId(), fCopyAction);
	addGlobalAction(ActionFactory.PASTE.getId(), fPasteAction);
	addGlobalAction(ActionFactory.DELETE.getId());
	// undo/redo
	addGlobalAction(ActionFactory.UNDO.getId());
	addGlobalAction(ActionFactory.REDO.getId());
	// select/find
	addGlobalAction(ActionFactory.SELECT_ALL.getId(), fSelectAllAction);
	addGlobalAction(ActionFactory.FIND.getId());
	// bookmark
	addGlobalAction(IDEActionFactory.BOOKMARK.getId());
	// save/revert
	fSaveAction = new SaveAction();
	fSaveAction.setText(PDEUIMessages.EditorActions_save);
	fRevertAction = new RevertAction();
	fRevertAction.setText(PDEUIMessages.EditorActions_revert);
	addGlobalAction(ActionFactory.REVERT.getId(), fRevertAction);
	}

	@Override
	public void setActiveEditor(IEditorPart targetEditor) {
	if (targetEditor instanceof PDESourcePage) {
	// Fixing the 'goto line' problem -
	// the action is thinking that source page
	// is a standalone editor and tries to activate it
	// #19361
	PDESourcePage page = (PDESourcePage) targetEditor;
	PDEPlugin.getActivePage().activate(page.getEditor());
	return;
	}
	if (!(targetEditor instanceof PDEFormEditor))
	return;

	fEditor = (PDEFormEditor) targetEditor;
	fEditor.updateUndo(getGlobalAction(ActionFactory.UNDO.getId()), getGlobalAction(ActionFactory.REDO.getId()));
	setActivePage(fEditor.getActiveEditor());
	updateSelectableActions(fEditor.getSelection());
	}

	@Override
	public void setActivePage(IEditorPart newEditor) {
	if (fEditor == null)
	return;
	IFormPage oldPage = fPage;
	fPage = fEditor.getActivePageInstance();
	if (fPage != null) {
	updateActions();
	if (oldPage != null && !oldPage.isEditor() && !fPage.isEditor()) {
	getActionBars().updateActionBars();
	}
	}
	}

	public void updateActions() {
	fSaveAction.update();
	fRevertAction.update();
	}

	public void updateSelectableActions(ISelection selection) {
	if (fEditor != null) {
	fCutAction.selectionChanged(selection);
	fCopyAction.selectionChanged(selection);
	fPasteAction.selectionChanged(selection);
	}
	}

	public IEditorActionBarContributor getSourceContributor() {
	return null;
	}

	@Override
	public void init(IActionBars bars) {
	super.init(bars);
	makeActions();
	}

	protected ISharedImages getSharedImages() {
	if (fSharedImages == null)
	fSharedImages = getPage().getWorkbenchWindow().getWorkbench().getSharedImages();
	return fSharedImages;
	}
	}