oracle.dss.datautil.gui
Class DefaultBuilderContext

java.lang.Object
  |
  +--oracle.dss.datautil.gui.DefaultGuiContext
        |
        +--oracle.dss.datautil.gui.DefaultComponentContext
              |
              +--oracle.dss.datautil.gui.DefaultBuilderContext

All Implemented Interfaces:

BuilderContext, ComponentContext, ErrorHandlerCallback, GuiContext

Direct Known Subclasses:

CalcBuilder, QueryBuilder

public class DefaultBuilderContext

extends DefaultComponentContext

implements BuilderContext, ErrorHandlerCallback

The default implementation of the BuilderContext interface.

Fields inherited from interface oracle.dss.datautil.gui.BuilderContext

APPLY_MEASURE_FILTER, EVALUATE_MEASURE_DIMENSION, TABBED, WIZARD

Constructor Summary

DefaultBuilderContext()
Deprecated. As of 2.6.0.21, replaced by DefaultBuilderContext(Dialog) or by DefaultBuilderContext(Frame).

DefaultBuilderContext(java.awt.Dialog owner)
Constructor that specifies the dialog that serves as the parent for the DefaultBuilderContext.

DefaultBuilderContext(java.awt.Frame owner)
Constructor that specifies the frame that serves as the parent for the DefaultBuilderContext.

Method Summary

void	addErrorHandler(ErrorHandler errorHandler) Adds an ErrorHandler object to this DefaultBuilderContext object.
boolean	addPanel(StandardPanel panel, java.lang.String panelId) Adds a panel to this Builder object after the other panels.
boolean	doApply() Signals the occurrence of the Apply event.
boolean	doCancel() Signals the occurrence of the Cancel event.
boolean	doOK() Signals the occurrence of the OK event.
java.lang.Object	getBuilderContent() Retrieves the content that is associated with the BuilderContext.
BuilderDialog	getContainer() Retrieves the container that is associated with the BuilderContext object.
java.lang.String	getDefaultPanelId() Retrieves the identifier for the default panel in the Builder instance.
ErrorHandler	getErrorHandler() Retrieves the current error handler.
oracle.bali.ewt.help.HelpProvider	getHelpProvider() Retrieves the HelpProvider for the Builder instance.
java.util.Locale	getLocale() Retrieves the locale for this Builder object.
java.lang.String	getMode() Retrieves the mode for the Builder instance.
StandardPanel	getPanel(java.lang.String panelId) Retrieves the panel with the specified identifier.
java.util.Vector	getPanelList() Retrieves the list of panels for the Builder instance.
java.lang.String	getResourcesLocation() Retrieves the string location of the resource bundle of the Builder object that extends this default implementation of the BuilderContext.
java.awt.Dimension	getSize() Retrieves the size for the Builder instance.
java.lang.String	getTitle() Retrieves the title for the Builder instance.
boolean	initialize() Signals the Builder to create the graphical components.
boolean	isPanelVisible(java.lang.String panelId) Indicates whether the panel with the specified identifier is visible.
boolean	isShowWelcomeNextTime() Indicates whether the Welcome panel is displayed the next time that the wizard is displayed.
void	removeErrorHandler() Overrides a previously set ErrorHandler object in this DefaultBuilderContext object with a default one.
boolean	removePanel(java.lang.String panelId) Removes the panel from the list of panels in the panel context.
boolean	run() Signals the Builder to run the dialog.
void	setBuilderContent(java.lang.Object builderContent) Specifies the content that is associated with the BuilderContext.
void	setContainer(BuilderDialog container) Specifies the container that is associated with the BuilderContext.
void	setDefaultPanelId(java.lang.String defaultPanelId) Specifies the identifier for the default panel in the Builder instance.
void	setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider) Specifies the HelpProvider in the Builder instance.
void	setLocale(java.util.Locale locale) Specifies the locale for this Builder instance.
void	setMode(java.lang.String builderMode) Specifies the mode for the Builder instance.
boolean	setPanelVisible(java.lang.String panelId, boolean bVisible) Specifies whether a panel is to be shown or hidden.
void	setShowWelcomeNextTime(boolean bVisible) Specifies whether the Welcome panel is displayed the next time that the wizard is displayed.
void	setSize(java.awt.Dimension size) Specifies the size for the Builder instance.
void	setTitle(java.lang.String title) Specifies the title for the Builder instance.

Methods inherited from class oracle.dss.datautil.gui.DefaultComponentContext

getDimensionContext, getDisplayLabelType, getDisplayMemberLabelType, getMeasureContext, getParent, getPopupItemCount, setDimensionContext, setDisplayLabelType, setDisplayMemberLabelType, setMeasureContext, setParent, setPopupItemCount

Methods inherited from class oracle.dss.datautil.gui.DefaultGuiContext

getMetadataManager, getParentFrame, getQueryContext, setMetadataManager, setParentFrame, setQueryContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.datautil.gui.ComponentContext

getDimensionContext, getDisplayLabelType, getDisplayMemberLabelType, getMeasureContext, getParent, getPopupItemCount, setDimensionContext, setDisplayLabelType, setDisplayMemberLabelType, setMeasureContext, setParent, setPopupItemCount

Methods inherited from interface oracle.dss.datautil.gui.GuiContext

getMetadataManager, getParentFrame, getQueryContext, setMetadataManager, setParentFrame, setQueryContext

Constructor Detail

DefaultBuilderContext

public DefaultBuilderContext()

Deprecated. As of 2.6.0.21, replaced by DefaultBuilderContext(Dialog) or by DefaultBuilderContext(Frame).

A DefaultBuilderContext should have a parent dialog or frame associated with it to ensure proper focus handling.

DefaultBuilderContext

public DefaultBuilderContext(java.awt.Dialog owner)

Constructor that specifies the dialog that serves as the parent for the DefaultBuilderContext.

Parameters:

owner - The dialog to serve as the parent.

DefaultBuilderContext

public DefaultBuilderContext(java.awt.Frame owner)

Constructor that specifies the frame that serves as the parent for the DefaultBuilderContext.

Parameters:

owner - The frame to serve as the parent.

Method Detail

addPanel

public boolean addPanel(StandardPanel panel,
                        java.lang.String panelId)

Adds a panel to this Builder object after the other panels.

Specified by:

addPanel in interface BuilderContext

Parameters:

panel - The panel to add.

panelId - The identifier of the panel that will come after the new panel.

doApply

public boolean doApply()
                throws DataUtilException

Signals the occurrence of the Apply event.

Specified by:

doApply in interface BuilderContext

Returns:

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

Throws:

DataUtilException - if an error is encountered.

doCancel

public boolean doCancel()

Signals the occurrence of the Cancel event.

Specified by:

doCancel in interface BuilderContext

Returns:

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

doOK

public boolean doOK()
             throws DataUtilException

Signals the occurrence of the OK event.

Specified by:

doOK in interface BuilderContext

Returns:

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

Throws:

DataUtilException - if an error is encountered.

getBuilderContent

public java.lang.Object getBuilderContent()

Retrieves the content that is associated with the BuilderContext.

Specified by:

getBuilderContent in interface BuilderContext

Returns:

The content that is associated with the BuilderContext.

getContainer

public BuilderDialog getContainer()

Retrieves the container that is associated with the BuilderContext object.

Specified by:

getContainer in interface BuilderContext

Returns:

A reference to the BuilderDialog interface.

getDefaultPanelId

public java.lang.String getDefaultPanelId()

Retrieves the identifier for the default panel in the Builder instance.

Specified by:

getDefaultPanelId in interface BuilderContext

Returns:

The identifier for the default panel in the Builder instance.

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()

Retrieves the HelpProvider for the Builder instance.

Specified by:

getHelpProvider in interface BuilderContext

Returns:

The HelpProvider for the Builder instance.

getLocale

public java.util.Locale getLocale()

Retrieves the locale for this Builder object. If no locale has been specified, then it retrieves the default locale.

Specified by:

getLocale in interface BuilderContext

Returns:

The Locale object for this Builder object.

getMode

public java.lang.String getMode()

Retrieves the mode for the Builder instance.

Specified by:

getMode in interface BuilderContext

Returns:

The mode for the Builder instance. Valid values are BuilderContext.TABBED and BuilderContext.WIZARD.

See Also:

BuilderContext.TABBED, BuilderContext.WIZARD

getPanel

public StandardPanel getPanel(java.lang.String panelId)

Retrieves the panel with the specified identifier.

Specified by:

getPanel in interface BuilderContext

Returns:

The panel with the specified identifier.

getPanelList

public java.util.Vector getPanelList()

Retrieves the list of panels for the Builder instance.

Specified by:

getPanelList in interface BuilderContext

Returns:

The list of panels for the Builder instance.

getSize

public java.awt.Dimension getSize()

Retrieves the size for the Builder instance.

Specified by:

getSize in interface BuilderContext

Returns:

The size for the Builder instance.

getTitle

public java.lang.String getTitle()

Retrieves the title for the Builder instance.

Specified by:

getTitle in interface BuilderContext

Returns:

The title for the Builder instance.

initialize

public boolean initialize()

Signals the Builder to create the graphical components.

Specified by:

initialize in interface BuilderContext

Returns:

true if no problems were encountered; false a problem was encountered.

Throws:

Exception - if an error is encountered.

isPanelVisible

public boolean isPanelVisible(java.lang.String panelId)

Indicates whether the panel with the specified identifier is visible.

Specified by:

isPanelVisible in interface BuilderContext

Returns:

true if the panel is visible; false if the panel is not visible.

removePanel

public boolean removePanel(java.lang.String panelId)

Removes the panel from the list of panels in the panel context.

Specified by:

removePanel in interface BuilderContext

Parameters:

panelId - The identifier of the panel to be removed.

Returns:

true if the remove operation is successful; false if the remove operation is not successful.

run

public boolean run()
            throws java.lang.Exception

Signals the Builder to run the dialog.

Specified by:

run in interface BuilderContext

Returns:

true if the dialog was dismissed with an OK command, false if the dialog was cancelled.

Throws:

Exception - if an error is encountered.

setBuilderContent

public void setBuilderContent(java.lang.Object builderContent)

Specifies the content that is associated with the BuilderContext.

Specified by:

setBuilderContent in interface BuilderContext

Parameters:

builderContent - The content that is associated with the BuilderContext.

setContainer

public void setContainer(BuilderDialog container)

Specifies the container that is associated with the BuilderContext.

Specified by:

setContainer in interface BuilderContext

Parameters:

builderDialog - A reference to the BuilderDialog.

setDefaultPanelId

public void setDefaultPanelId(java.lang.String defaultPanelId)

Specifies the identifier for the default panel in the Builder instance.

Specified by:

setDefaultPanelId in interface BuilderContext

Parameters:

defaultPanelId - The identifier for the default panel in the Builder instance.

setHelpProvider

public void setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider)

Specifies the HelpProvider in the Builder instance.

Specified by:

setHelpProvider in interface BuilderContext

Parameters:

helpProvider - The HelpProvider in the Builder instance.

setLocale

public void setLocale(java.util.Locale locale)

Specifies the locale for this Builder instance.

Specified by:

setLocale in interface BuilderContext

Parameters:

locale - The Locale object for this Builder instance.

setMode

public void setMode(java.lang.String builderMode)

Specifies the mode for the Builder instance.

Specified by:

setMode in interface BuilderContext

Parameters:

builderMode - The mode for the Builder instance.

setPanelVisible

public boolean setPanelVisible(java.lang.String panelId,
                               boolean bVisible)

Specifies whether a panel is to be shown or hidden.

Specified by:

setPanelVisible in interface BuilderContext

Parameters:

panelId - The identifier of the specified panel.

bVisible - true if the panel is to be marked visible; false if the panel is to be hidden.

Returns:

true if the panel was marked visible, false if the operation failed.

setSize

public void setSize(java.awt.Dimension size)

Specifies the size for the Builder instance.

Specified by:

setSize in interface BuilderContext

Parameters:

size - The size for the Builder instance.

setTitle

public void setTitle(java.lang.String title)

Specifies the title for the Builder instance.

Specified by:

setTitle in interface BuilderContext

Parameters:

title - The title for the Builder instance.

addErrorHandler

public void addErrorHandler(ErrorHandler errorHandler)

Adds an ErrorHandler object to this DefaultBuilderContext object. The ErrorHandler object will be called when the visual component traps an error from other parts of the system.

Specified by:

addErrorHandler in interface ErrorHandlerCallback

Parameters:

errorHandler - The ErrorHandler object.

getErrorHandler

public ErrorHandler getErrorHandler()

Retrieves the current error handler.

Returns:

ErrorHandler that represents the current error handler.

getResourcesLocation

public java.lang.String getResourcesLocation()

Retrieves the string location of the resource bundle of the Builder object that extends this default implementation of the BuilderContext.

Returns:

The string that specifies the location of the resource bundle.

removeErrorHandler

public void removeErrorHandler()

Overrides a previously set ErrorHandler object in this DefaultBuilderContext object with a default one.

Specified by:

removeErrorHandler in interface ErrorHandlerCallback

setShowWelcomeNextTime

public void setShowWelcomeNextTime(boolean bVisible)

Specifies whether the Welcome panel is displayed the next time that the wizard is displayed.

Parameters:

bVisible - true if the panel is to be displayed; false if the panel is not to be displayed.

isShowWelcomeNextTime

public boolean isShowWelcomeNextTime()

Indicates whether the Welcome panel is displayed the next time that the wizard is displayed.

Returns:

true if the panel is to be displayed; false if the panel is not to be displayed.