org.eclipse.ui.help.ViewContextComputer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of workbench Show documentation

This plug-in contains the bulk of the Workbench implementation, and depends on JFace, SWT, and Core Runtime. It cannot be used independently from org.eclipse.ui. Workbench client plug-ins should not depend directly on this plug-in.

The newest version!

/*******************************************************************************
 * 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.ui.help;

import java.util.ArrayList;

import org.eclipse.core.runtime.Assert;
import org.eclipse.help.IContext;
import org.eclipse.swt.events.HelpEvent;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.IViewPart;

/**
 * For determining the help context for controls in a view.
 * 
 * This class may be instantiated; it is not intended to be subclassed.
 * 
 * @deprecated nested contexts are no longer supported by the help support system
 */
public class ViewContextComputer implements IContextComputer {
    private IViewPart view;

    private ArrayList contextList;

    private Object context;

    /**
     * Creates a new context computer for the given view and help context.
     *
     * @param viewPart the view
     * @param helpContext a single help context id (type String) or
     *  help context object (type IContext)
     */
    public ViewContextComputer(IViewPart viewPart, Object helpContext) {
        Assert.isTrue(helpContext instanceof String
                || helpContext instanceof IContext);
        view = viewPart;
        context = helpContext;
    }

    /**
     * Add the contexts to the context list.
     *
     * @param object the contexts (Object[] or IContextComputer)
     * @param event the help event 
     */
    private void addContexts(Object object, HelpEvent event) {
        Assert.isTrue(object instanceof Object[]
                || object instanceof IContextComputer
                || object instanceof String);

        if (object instanceof String) {
            contextList.add(object);
            return;
        }

        Object[] contexts;
        if (object instanceof IContextComputer) {
			// get local contexts
            contexts = ((IContextComputer) object).getLocalContexts(event);
		} else {
			contexts = (Object[]) object;
		}

        // copy the contexts into our list	
        for (int i = 0; i < contexts.length; i++) {
			contextList.add(contexts[i]);
		}
    }

    /**
     * Add the contexts for the given control to the context list.
     *
     * @param control the control from which to obtain the contexts
     * @param event the help event 
     */
    private void addContextsForControl(Control control, HelpEvent event) {
        // See if there is are help contexts on the control
        Object object = WorkbenchHelp.getHelp(control);

        if (object == null || object == this) {
			// We need to check for this in order to avoid recursion
            return;
		}

        addContexts(object, event);
    }

    /* (non-Javadoc)
     * Method declared on IContextComputer.
     */
    public Object[] computeContexts(HelpEvent event) {
        contextList = new ArrayList();

        // Add the local context
        contextList.add(context);

        // Add the contexts for the window shell	
        addContextsForControl(view.getSite().getShell(), event);

        // Return the contexts
        return contextList.toArray();
    }

    /* (non-Javadoc)
     * Method declared on IContextComputer.
     */
    public Object[] getLocalContexts(HelpEvent event) {
        return new Object[] { context };
    }
}