blob: 7a2aaca5e483d95bbfad137e56017d30b31b2424 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation and others.
* 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:
* IBM Corporation - initial API and implementation
*
*******************************************************************************/
package org.eclipse.wst.xsd.ui.internal.refactor.actions;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.jface.util.Assert;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
/**
* Action that dispatches the <code>IAction#run()</code> and the
* <code>ISelectionChangedListener#selectionChanged</code>
* according to the type of the selection.
*
* <ul>
* <li>if selection is of type <code>ITextSelection</code> then
* <code>run(ITextSelection)</code> and <code>selectionChanged(ITextSelection)</code>
* is called.</li>
* <li>if selection is of type <code>IStructuredSelection</code> then
* <code>run(IStructuredSelection)</code> and <code>
* selectionChanged(IStructuredSelection)</code> is called.</li>
* <li>default is to call <code>run(ISelection)</code> and <code>
* selectionChanged(ISelection)</code>.</li>
* </ul>
*
* <p>
* adapted from <code>org.eclipse.jdt.ui.actions.SelectionDispatchAction</code>
* </p>
*
*
*/
public abstract class SelectionDispatchAction extends Action implements ISelectionChangedListener {
private ISelection selection;
private Object model;
protected SelectionDispatchAction(ISelection selection) {
Assert.isNotNull(selection);
this.selection = selection;
}
/**
* Returns the selection provided by the site owning this action.
*
* @return the site's selection
*/
public ISelection getSelection() {
return selection;
}
/**
* Updates the action's enablement state according to the given selection. This
* default implementation calls one of the <code>selectionChanged</code>
* methods depending on the type of the passed selection.
*
* @param selection the selection this action is working on
*/
public void update(ISelection selection) {
dispatchSelectionChanged(selection);
}
/**
* Notifies this action that the given structured selection has changed. This default
* implementation calls <code>selectionChanged(ISelection selection)</code>.
*
* @param selection the new selection
*/
public void selectionChanged(IStructuredSelection selection) {
if (selection.size() == 1) {
Object object = selection.getFirstElement();
setEnabled(canEnable(object));
}
else{
setEnabled(false);
}
}
protected boolean canEnable(Object selectedObject){
return false;
}
/**
* Executes this actions with the given structured selection. This default implementation
* calls <code>run(ISelection selection)</code>.
*/
public void run(IStructuredSelection selection) {
run((ISelection)selection);
}
/**
* Notifies this action that the given text selection has changed. This default
* implementation calls <code>selectionChanged(ISelection selection)</code>.
*
* @param selection the new selection
*/
public void selectionChanged(ITextSelection selection) {
selectionChanged((ISelection)selection);
}
/**
* Executes this actions with the given text selection. This default implementation
* calls <code>run(ISelection selection)</code>.
*/
public void run(ITextSelection selection) {
run((ISelection)selection);
}
/**
* Notifies this action that the given selection has changed. This default
* implementation sets the action's enablement state to <code>false</code>.
*
* @param selection the new selection
*/
public void selectionChanged(ISelection selection) {
setEnabled(false);
}
/**
* Executes this actions with the given selection. This default implementation
* does nothing.
*/
public void run(ISelection selection) {
}
/* (non-Javadoc)
* Method declared on IAction.
*/
public void run() {
dispatchRun(getSelection());
}
/* (non-Javadoc)
* Method declared on ISelectionChangedListener.
*/
public void selectionChanged(SelectionChangedEvent event) {
dispatchSelectionChanged(event.getSelection());
}
private void dispatchSelectionChanged(ISelection selection) {
if (selection instanceof IStructuredSelection) {
selectionChanged((IStructuredSelection)selection);
} else if (selection instanceof ITextSelection) {
selectionChanged((ITextSelection)selection);
} else {
selectionChanged(selection);
}
}
protected void dispatchRun(ISelection selection) {
if (selection instanceof IStructuredSelection) {
run((IStructuredSelection)selection);
} else if (selection instanceof ITextSelection) {
run((ITextSelection)selection);
} else {
run(selection);
}
}
public final Object getModel()
{
return model;
}
public final void setModel(Object model)
{
this.model = model;
}
public boolean canRun() {
return true;
}
}