oracle.ide.help

Class AboutBoxPage

java.lang.Object

oracle.ide.help.AboutBoxPage

public abstract class AboutBoxPage
extends java.lang.Object

A page in the about box. Extension writers may register a new page with the about box by creating a subclass of AboutBoxPage and registering it with the AboutBoxFactory.

Since:

10.1.3

Constructor Summary

Constructors

Constructor and Description
AboutBoxPage()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	dump() Dumps information about this page to a (human readable) String.
java.awt.Component	getComponent() Get the component for this page.
java.awt.Component	getInitialFocus() Get the initial focus component for this page.
java.lang.String	getName() Get the name of this page.
protected abstract void	populate() Populate this page.
void	setComponent(java.awt.Component component) Set the component to display on this page.
void	setInitialFocus(java.awt.Component initialFocus) Set the initial focus component.
void	setName(java.lang.String name) Set the name of this page.

Methods inherited from class java.lang.Object

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

Constructor Detail

AboutBoxPage

public AboutBoxPage()

Method Detail

setComponent

public void setComponent(java.awt.Component component)

Set the component to display on this page.

Parameters:

component - the component to display on this page.

getComponent

public java.awt.Component getComponent()

Get the component for this page.

Returns:

the component.

setInitialFocus

public final void setInitialFocus(java.awt.Component initialFocus)

Set the initial focus component.

Parameters:

initialFocus - the initial focus component, may be null.

getInitialFocus

public final java.awt.Component getInitialFocus()

Get the initial focus component for this page.

Returns:

the initial focus component.

setName

public final void setName(java.lang.String name)

Set the name of this page.

Parameters:

name - the (human readable) name of this page.

getName

public final java.lang.String getName()

Get the name of this page.

Returns:

the name of this page.

populate

protected abstract void populate()

Populate this page. This is called the first time the page is selected.

dump

public java.lang.String dump()

Dumps information about this page to a (human readable) String. This method is called when the user clicks the "Save As..." button to save the contents of the about box to a file.

The page is guaranteed to have been populated and the getComponent() method will have been called prior to any call to dump(). This implementation returns the empty String.

Returns:

a string containing all information displayed in this page.

Since:

11.1.1