oracle.dss.datautil.gui.panel
Interface StandardPanel

All Superinterfaces:

HelpContext

All Known Implementing Classes:

DefaultStandardPanel, NameTypePanel, SaveCalcPanel, TemplatePanel

public interface StandardPanel

extends HelpContext

Defines the methods to be implemented by a page that must be embedded in a container.

Method Summary

void	addPanelEventListener(PanelEventListener listener) Adds a listener for panel events.
void	cleanup() Cleans up any resources that were allocated by this panel.
BuilderContext	getBuilderContext() Retrieves the BuilderContext object that is associated with this panel.
java.awt.Component	getComponent() Retrieves the component that is associated with this panel.
java.awt.Component	getContainer() Retrieves the container that is associated with this panel.
java.lang.String	getId() Retrieves the identifier for this panel.
java.awt.Image	getImage() Retrieves the image for the panel.
javax.swing.ImageIcon	getImageIcon() Retrieves the image icon for this panel.
java.lang.Object	getPanelContent() Retrieves the content of this panel.
java.lang.String	getTitle() Retrieves the title of this panel.
void	removePanelEventListener(PanelEventListener listener) Removes a listener for the panel events.
boolean	setActive(boolean bIsActive) Specifies whether the panel is to be active or inactive.
void	setBuilderContext(BuilderContext builderContext) Specifies the BuilderContext instance for this panel.
void	setContainer(java.awt.Component container) Specifies the container that is associated with this panel.
void	setPanelContent(java.lang.Object panelContent) Specifies the content for this panel.
boolean	validateContents(java.lang.Object hintValidate) Validates the contents of the panel.

Methods inherited from interface oracle.dss.util.help.HelpContext

getHelpContextID, setHelpContextID

Method Detail

addPanelEventListener

public void addPanelEventListener(PanelEventListener listener)

Adds a listener for panel events.

Parameters:

listener - The listener for the panel events.

cleanup

public void cleanup()

Cleans up any resources that were allocated by this panel.

getBuilderContext

public BuilderContext getBuilderContext()

Retrieves the BuilderContext object that is associated with this panel.

Returns:

The BuilderContext object.

getComponent

public java.awt.Component getComponent()

Retrieves the component that is associated with this panel.

Returns:

The component for this panel.

getContainer

public java.awt.Component getContainer()

Retrieves the container that is associated with this panel.

Returns:

The container that is associated with this panel.

getId

public java.lang.String getId()

Retrieves the identifier for this panel.

Returns:

The identifier for this panel.

getImage

public java.awt.Image getImage()

Retrieves the image for the panel. Typically this image is displayed on the left side of a wizard.

Returns:

The image to be displayed for this panel.

getImageIcon

public javax.swing.ImageIcon getImageIcon()

Retrieves the image icon for this panel.

Returns:

The icon that is to be displayed for this panel.

getPanelContent

public java.lang.Object getPanelContent()

Retrieves the content of this panel.

Returns:

The panel content.

getTitle

public java.lang.String getTitle()

Retrieves the title of this panel.

Returns:

The panel title.

removePanelEventListener

public void removePanelEventListener(PanelEventListener listener)

Removes a listener for the panel events.

Parameters:

listener - The listener for the panel events.

setActive

public boolean setActive(boolean bIsActive)
                  throws DataUtilException

Specifies whether the panel is to be active or inactive.

Parameters:

bIsActive - true if the panel is to be active; false if the panel is to be inactive.

Returns:

true if the operation was successful, false if the operation was not successful.

Throws:

DataUtilException - if the operation is unsuccessful.

setBuilderContext

public void setBuilderContext(BuilderContext builderContext)

Specifies the BuilderContext instance for this panel.

Parameters:

The - BuilderContext instance.

setContainer

public void setContainer(java.awt.Component container)

Specifies the container that is associated with this panel.

Parameters:

container - The container.

setPanelContent

public void setPanelContent(java.lang.Object panelContent)

Specifies the content for this panel.

Parameters:

panelContent - The panel content.

validateContents

public boolean validateContents(java.lang.Object hintValidate)

Validates the contents of the panel.

Parameters:

hintValidate - A hint object to help in the validation process.

Returns:

true if the operation was successful, false if the operation was not successful.