org.eclipse.ui.views.IViewRegistry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation

This is org.eclipse.ui.workbench jar used by Scout SDK

There is a newer version: 3.108.0.v20160602-1232

Show newest version

/*******************************************************************************
 * Copyright (c) 2000, 2008 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
 *     Jan-Hendrik Diederich, Bredex GmbH - bug 201052
 *******************************************************************************/
package org.eclipse.ui.views;


/**
 * The view registry maintains a list of views explicitly registered
 * against the view extension point..
 * 
 * The description of a given view is kept in a IViewDescriptor.
 * 
 * 
 * This interface is not intended to be implemented by clients.
 * 
 *
 * @see org.eclipse.ui.views.IViewDescriptor
 * @see org.eclipse.ui.views.IStickyViewDescriptor
 * @since 3.1
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IViewRegistry {
    /**
     * Return a view descriptor with the given extension id.  If no view exists
     * with the id return null.
     * Will also return null if the view descriptor exists, but
     * is filtered by an expression-based activity.
     *
     * @param id the id to search for
     * @return the descriptor or null
     */
    public IViewDescriptor find(String id);

    /**
     * Returns an array of view categories.
     *
     * @return the categories.  Never null.
     */
    public IViewCategory[] getCategories();

    /**
     * Return a list of views defined in the registry.
     *
     * @return the views.  Never null.
     */
    public IViewDescriptor[] getViews();

    /**
     * Return a list of sticky views defined in the registry.
     *
     * @return the sticky views.  Never null.
     */
    public IStickyViewDescriptor[] getStickyViews();
}