com.aptana.ide.debug.internal.ui.actions.ShowConstantsActionDelegate.java Source code

Java tutorial

Introduction

Here is the source code for com.aptana.ide.debug.internal.ui.actions.ShowConstantsActionDelegate.java

Source

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */

package com.aptana.ide.debug.internal.ui.actions;

import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.ui.IDebugView;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.StructuredViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.swt.widgets.Event;
import org.eclipse.ui.IActionDelegate2;
import org.eclipse.ui.IViewActionDelegate;
import org.eclipse.ui.IViewPart;

import com.aptana.ide.debug.core.model.IJSVariable;
import com.aptana.ide.debug.internal.ui.IDebugUIConstants;
import com.aptana.ide.debug.ui.DebugUiPlugin;

/**
 * @author Max Stepanov
 */
public class ShowConstantsActionDelegate extends ViewerFilter implements IViewActionDelegate, IActionDelegate2 {
    private IViewPart fView;
    private IAction fAction;

    /**
     * @see org.eclipse.ui.IViewActionDelegate#init(org.eclipse.ui.IViewPart)
     */
    public void init(IViewPart view) {
        fView = view;
        StructuredViewer viewer = getStructuredViewer();
        ViewerFilter[] filters = viewer.getFilters();
        ViewerFilter filter = null;
        for (int i = 0; i < filters.length; i++) {
            if (filters[i] == this) {
                filter = filters[i];
                break;
            }
        }
        if (filter == null) {
            viewer.addFilter(this);
        }
        viewer.refresh();
        fAction.setChecked(getPreferenceValue(view));
    }

    /**
     * @see org.eclipse.ui.IActionDelegate2#dispose()
     */
    public void dispose() {
    }

    /**
     * @see org.eclipse.ui.IActionDelegate2#init(org.eclipse.jface.action.IAction)
     */
    public void init(IAction action) {
        fAction = action;
    }

    /**
     * @see org.eclipse.ui.IActionDelegate2#runWithEvent(org.eclipse.jface.action.IAction,
     *      org.eclipse.swt.widgets.Event)
     */
    public void runWithEvent(IAction action, Event event) {
        run(action);
    }

    /**
     * @see org.eclipse.ui.IActionDelegate#run(org.eclipse.jface.action.IAction)
     */
    public void run(IAction action) {
        IPreferenceStore store = getPreferenceStore();
        String key = fView.getSite().getId() + "." + getPreferenceKey(); //$NON-NLS-1$
        store.setValue(key, action.isChecked());
        DebugUiPlugin.getDefault().savePluginPreferences();
        getStructuredViewer().refresh();
    }

    /**
     * @see org.eclipse.ui.IActionDelegate#selectionChanged(org.eclipse.jface.action.IAction,
     *      org.eclipse.jface.viewers.ISelection)
     */
    public void selectionChanged(IAction action, ISelection selection) {
    }

    /**
     * @see org.eclipse.jface.viewers.ViewerFilter#select(org.eclipse.jface.viewers.Viewer, java.lang.Object,
     *      java.lang.Object)
     */
    public boolean select(Viewer viewer, Object parentElement, Object element) {
        if (element instanceof IJSVariable) {
            try {
                if (!getValue()) {
                    return !((IJSVariable) element).isConst();
                }
            } catch (DebugException e) {
                DebugUiPlugin.log(e);
            }
        }
        return true;
    }

    /**
     * getPreferenceStore
     * 
     * @return IPreferenceStore
     */
    protected IPreferenceStore getPreferenceStore() {
        return DebugUiPlugin.getDefault().getPreferenceStore();
    }

    /**
     * getPreferenceValue
     * 
     * @param part
     * @return boolean
     */
    protected boolean getPreferenceValue(IViewPart part) {
        String baseKey = getPreferenceKey();
        String viewKey = part.getSite().getId();
        String compositeKey = viewKey + "." + baseKey; //$NON-NLS-1$
        IPreferenceStore store = getPreferenceStore();
        boolean value = false;
        if (store.contains(compositeKey)) {
            value = store.getBoolean(compositeKey);
        } else {
            value = store.getBoolean(baseKey);
        }
        return value;
    }

    /**
     * getStructuredViewer
     * 
     * @return StructuredViewer
     */
    protected StructuredViewer getStructuredViewer() {
        IDebugView view = (IDebugView) fView.getAdapter(IDebugView.class);
        if (view != null) {
            Viewer viewer = view.getViewer();
            if (viewer instanceof StructuredViewer) {
                return (StructuredViewer) viewer;
            }
        }
        return null;
    }

    /**
     * Returns whether this action is seleted/checked.
     * 
     * @return whether this action is seleted/checked
     */
    protected boolean getValue() {
        return fAction.isChecked();
    }

    /**
     * getPreferenceKey
     * 
     * @return String
     */
    protected String getPreferenceKey() {
        return IDebugUIConstants.PREF_SHOW_CONSTANTS;
    }
}