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