Package org.eclipse.ui.intro.quicklinks

Class QuicklinksViewer

java.lang.Object

org.eclipse.ui.intro.quicklinks.QuicklinksViewer

All Implemented Interfaces:

IIntroContentProvider

public class QuicklinksViewer
extends Object
implements IIntroContentProvider

An Intro content provider that populates a list of frequently-used commands from an extension point. The appearance of these quicklinks is normally taken from the command metadata, including the image icon, but can be tailored. These tailorings can be made optional depending on the current theme. This implementation is still experimental and subject to change. Feedback welcome as a bug report on the Eclipse Bugzilla against Platform/User Assistance.

Constructor Summary

Constructors

Constructor	Description
QuicklinksViewer()

Method Summary

Modifier and Type	Method	Description
void	createContent(String id, PrintWriter out)	Creates HTML content in the provided PrintWriter.
void	createContent(String id, Composite parent, FormToolkit toolkit)	Creates SWT content in the provided Composite.
void	dispose()	Dispose of the ContentProvider.
protected String	getCurrentThemeId()	Find the current Welcome/Intro identifier
void	init(IIntroContentProviderSite site)	Initializes the content provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QuicklinksViewer

public QuicklinksViewer()

Method Details

init

public void init(IIntroContentProviderSite site)

Description copied from interface: IIntroContentProvider

Initializes the content provider. An IIntroContentProviderSite is passed, which will be called on to recompute or layout the content when the content becomes stale.

Specified by:

init in interface IIntroContentProvider

Parameters:

site - the site of this IIntroContentProvider

getCurrentThemeId

protected String getCurrentThemeId()

Find the current Welcome/Intro identifier

Returns:

the current identifier or null if no theme

createContent

public void createContent(String id,
 PrintWriter out)

Description copied from interface: IIntroContentProvider

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.

Specified by:

createContent in interface IIntroContentProvider

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

public void createContent(String id,
 Composite parent,
 FormToolkit toolkit)

Description copied from interface: IIntroContentProvider

Creates SWT content in the provided Composite. This method is called when Eclipse Forms are used to render intro content.

Specified by:

createContent in interface IIntroContentProvider

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

public void dispose()

Description copied from interface: IIntroContentProvider

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.

Specified by:

dispose in interface IIntroContentProvider