org.eclipse.ui.help.IContextComputer 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 org.eclipse.swt.events.HelpEvent;

/**
 * A content computer is used to dynamically calculate help support contexts at the
 * time the user requests help.
 * 
 * This interface may be implemented by clients.
 * 
 * @deprecated nested contexts are no longer supported by the help support system
 * 
 */
public interface IContextComputer {
    /**
     * Computes contexts for the help system.
     *
     * @param event the help event which triggered this request for help
     * @return a mixed-type array of context ids (type String)
     *   and/or help contexts (type IContext)
     * @see org.eclipse.help.IContext
     */
    public Object[] computeContexts(HelpEvent event);

    /**
     * Returns the local contexts for this context computer.
     * 
     * Typically this method is called by other instances of
     * IContextComputer in their computeContexts
     * method.
     * 
     * 
     * The important concept here is that the value returned by 
     * computeContexts represents the complete help
     * contexts and is passed directly to the help support system.
     * 
     * 
     * However the value returned by this method represents the
     * only the contexts for the particular control with which this
     * IContextComputer is associated.
     *  
     * @param event the help event which triggered this request for help
     * @return a mixed-type array of context ids (type String)
     *   and/or help contexts (type IContext)
     * @see org.eclipse.help.IContext
     */
    public Object[] getLocalContexts(HelpEvent event);
}