IVMAdapter.java example

Explorer
cdt-tests-runner-master
/*******************************************************************************
 * Copyright (c) 2006, 2009 Wind River Systems 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:
 *     Wind River Systems - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.dsf.ui.viewmodel;

import org.eclipse.cdt.dsf.concurrent.ThreadSafe;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IColumnPresentationFactory;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IElementContentProvider;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IModelProxyFactory;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IViewerInputProvider;

/**
 * The View Model adapter handles the layout of a given data model within a 
 * set of viewers.  This adapter should be returned by an adapter factory for 
 * the input object of the viewer, and this adapter implementation will then 
 * populate the view contents.  
 * 
 * @since 1.0
 */
@ThreadSafe
public interface IVMAdapter
    extends IElementContentProvider, IModelProxyFactory, IColumnPresentationFactory, IViewerInputProvider 
{
    /**
     * Returns the View Model Provider that is registered for the given presentation
     * context.  Returns <code>null</code> if there is none.
     */
    public IVMProvider getVMProvider(IPresentationContext presentationContext);

    /**
     * Retrieves the currently active VM providers in this adapter.
     * 
     * @return array of VM providers
     * 
     * @since 2.0
     */
    public IVMProvider[] getActiveProviders();

}