org.eclipse.ui.intro.config
Interface IIntroContentProvider
-
All Known Subinterfaces:
-
IIntroXHTMLContentProvider
-
All Known Implementing Classes:
-
AlwaysWelcomeCheckbox
-
public interface IIntroContentProvider
A content provider for dynamic intro content. It is initialized with the
content provider site because a typical content provider would need to update
its contents dynamically at runtime. And so, the site can be informed of a
need to redraw its content through a call to its reflow(..) method.
The life cycle of an IIntroContentProvider is as follows:
void init(
IIntroContentProviderSite site)
- Initializes the content provider. An IIntroContentProviderSite is passed,
which will be called on to recompute or layout the content when the
content becomes stale.
-
-
Parameters:
-
site
- the site of this IIntroContentProvider
createContent
void createContent(
String id,
PrintWriter out)
- Creates HTML content in the provided PrintWriter. This content will be
included in the generated HTML page when embedded HTML widget is used to
render intro content.
-
-
Parameters:
-
id
- the unique identifier of the content element. The same content
provider class can be reused for several elements and the id
can be used to tell them apart. -
out
- the output print writer to generate HTML content into
createContent
void createContent(
String id,
Composite parent,
FormToolkit toolkit)
- Creates SWT content in the provided Composite. This method is called when
Eclipse Forms are used to render intro content.
-
-
Parameters:
-
id
- the unique identifier of the content element -
parent
- the parent composite that should be used when creating SWT
widgets -
toolkit
- the form toolkit that should be used when creating new widgets
dispose
void dispose()
- Dispose of the ContentProvider. This will only be called when the Intro
view is closed. In other words, the content provider will not be disposed
of until the last possible minute. This gives the implementor the chance
to cache content and avoid regenerating content on every page switch.
-
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.