oracle.ide.help
Class AboutBoxFactory

java.lang.Object
  oracle.ide.help.AboutBoxFactory

public class AboutBoxFactory
extends java.lang.Object

A factory that creates the product about box using an AboutBoxModel. Generally, you should retrieve the IDE's default AboutBoxFactory using the getAboutBoxFactory() method rather than constructing instances of this class directly.

Extensions may add pages to the about box by calling addPage(Class), passing a subclass of AboutBoxPage.

showAboutBox() displays the about dialog.

Since:

10.1.3

Constructor Summary

AboutBoxFactory()

Method Summary

void	addPage(java.lang.Class pageClass) Add a page to the about box.
static AboutBoxFactory	getAboutBoxFactory() Get the about box factory instance.
void	removePage(java.lang.Class pageClass) Remove a page from the about box.
static void	setAboutBoxFactory(AboutBoxFactory factory) Set the about box factory.
void	setModel(AboutBoxModel model) Set the model for the about box.
void	showAboutBox() Show the about box in a dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

AboutBoxFactory

public AboutBoxFactory()

Method Detail

getAboutBoxFactory

public static final AboutBoxFactory getAboutBoxFactory()

Get the about box factory instance.

Returns:

the about box factory instance.

setAboutBoxFactory

public static final void setAboutBoxFactory(AboutBoxFactory factory)

Set the about box factory. Generally, extension developers should not call this method. It is intended for products built on top of the IDE framework to customize the appearance of the About dialog.

Parameters:

factory - the factory responsible for creating AboutBox instances.

setModel

public void setModel(AboutBoxModel model)

Set the model for the about box.

Parameters:

model - the model for the about box.

addPage

public final void addPage(java.lang.Class pageClass)

Add a page to the about box.

Parameters:

pageClass - the class of an AboutBoxPage. Must not be null.

removePage

public final void removePage(java.lang.Class pageClass)

Remove a page from the about box.

Parameters:

pageClass - the class of the page to remove.

showAboutBox

public void showAboutBox()

Show the about box in a dialog.