KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > intro > config > IIntroContentProviderSite


1 /*******************************************************************************
2  * Copyright (c) 2004, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ui.intro.config;
12
13 /**
14  * An interface between a content provider and its parent container. A content
15  * provider is responsible for creating dynamic intro content, while the content
16  * provider site is responsible for reflowing the new content in the intro part.
17  * An intro content provider site may have more than one content provider. The
18  * id of the content provider can be used to distinguish the source of the
19  * reflow.
20  * <p>
21  * This interface is not intended to be implemented or extended by clients.
22  *
23  * @since 3.0.1
24  */
25 public interface IIntroContentProviderSite {
26     /**
27      * This method will be called when the IIntroContentProvider is notified
28      * that its content has become stale. For an HTML presentation, the whole
29      * page should be regenerated. An SWT presentation should cause the page's
30      * layout to be updated.
31      *
32      * @param provider
33      * the content provider that requests a reflow
34      * @param incremental
35      * if <code>true</code>, an attempt should be made to
36      * incrementally reflow the page. Otherwise, the page should be
37      * recreated from scratch. This is just a hint and the
38      * implementation of the interface can ignore it.
39      */
40     public void reflow(IIntroContentProvider provider, boolean incremental);
41 }
42
Popular Tags