oracle.dss.datautil.gui.panel
Class DefaultStandardPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.datautil.gui.panel.DefaultStandardPanel

All Implemented Interfaces:

javax.accessibility.Accessible, HelpContext, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, StandardPanel

Direct Known Subclasses:

DimensionPanel, HiddenDimensionsPanel, ItemsPanel, NameTypePanel, QueryBuilderLayoutPanel, SaveCalcPanel, TemplatePanel, WelcomePanel

public abstract class DefaultStandardPanel

extends javax.swing.JPanel

implements StandardPanel, HelpContext

A default standard panel. Used as the superclass for many of the CalcBuilder and QueryBuilder panels. If you want to add a custom panel, then you can extend DefaultStandardPanel rather than implementing the entire StandardPanel interface.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int	PANELSTATE_ENABLED Indicates whether this panel state is enabled.
static int	PANELSTATE_ISDIRTY Indicates whether this panel state is dirty.

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

DefaultStandardPanel()
Constructor.

Method Summary

void	addPanelEventListener(PanelEventListener listener) Adds a listener for panel events.
void	cleanup() Cleans up any resources that were allocated by this panel.
boolean	firePanelEvent(java.util.EventObject panelEvent) Fires the supplied panel event to the registered listeners.
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	getHelpContextID() Retrieves the Help context ID for this panel.
abstract java.lang.String	getId() Retrieves the identifier for this panel.
java.awt.Image	getImage() Retrieves the image for this panel.
javax.swing.ImageIcon	getImageIcon() Retrieves the image icon for this panel.
java.lang.Object	getPanelContent() Retrieves the content of this panel.
boolean	getPanelState(int nPanelState) Retrieves the value of the panel state.
java.lang.String	getTitle() Retrieves the title of this panel.
void	initializeMembers() Initializes the class members.
boolean	initUIContent() Initializes the user interface content of the panel.
boolean	isDirty() Retrieves whether the panel is dirty or not.
boolean	isInitializing() Indicates whether the view is marked as being in the process of being initialized.
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	setDirty(boolean bIsDirty) Specifies whether the panel is dirty or not.
void	setHelpContextID(java.lang.String helpContextId) Specifies the Help context ID for this panel.
void	setInitializing(boolean bInitializing) Specifies whether the view is to be marked as being in the process of being initialized.
void	setPanelContent(java.lang.Object panelContent) Specifies the content for this panel.
void	setPanelState(int nPanelState, boolean bValue) Specifies the value of a panel state.
boolean	updateData(boolean bUpdateUI) Updates data from the user interface component to the underlying data structure and vice versa.
boolean	validateContents(java.lang.Object hintValidate) Validates the contents of the panel.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Field Detail

PANELSTATE_ISDIRTY

public static final int PANELSTATE_ISDIRTY

Indicates whether this panel state is dirty. Default is false.

PANELSTATE_ENABLED

public static final int PANELSTATE_ENABLED

Indicates whether this panel state is enabled. Default is true.

Constructor Detail

DefaultStandardPanel

public DefaultStandardPanel()

Constructor.

Method Detail

addPanelEventListener

public void addPanelEventListener(PanelEventListener listener)

Adds a listener for panel events.

Specified by:

addPanelEventListener in interface StandardPanel

Parameters:

listener - The listener for the panel events.

cleanup

public void cleanup()

Cleans up any resources that were allocated by this panel.

Specified by:

cleanup in interface StandardPanel

getBuilderContext

public BuilderContext getBuilderContext()

Retrieves the BuilderContext object that is associated with this panel.

Specified by:

getBuilderContext in interface StandardPanel

Returns:

The BuilderContext object.

getComponent

public java.awt.Component getComponent()

Retrieves the component that is associated with this panel.

Specified by:

getComponent in interface StandardPanel

Returns:

The component for this panel.

getContainer

public java.awt.Component getContainer()

Retrieves the container that is associated with this panel.

Specified by:

getContainer in interface StandardPanel

Returns:

The container that is associated with this panel.

getId

public abstract java.lang.String getId()

Retrieves the identifier for this panel.

Specified by:

getId in interface StandardPanel

Returns:

The identifier for this panel.

getImage

public java.awt.Image getImage()

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

Specified by:

getImage in interface StandardPanel

Returns:

The image to be displayed for this panel.

getImageIcon

public javax.swing.ImageIcon getImageIcon()

Retrieves the image icon for this panel.

Specified by:

getImageIcon in interface StandardPanel

Returns:

The icon that is to be displayed for this panel.

getPanelContent

public java.lang.Object getPanelContent()

Retrieves the content of this panel.

Specified by:

getPanelContent in interface StandardPanel

Returns:

The panel content.

getTitle

public java.lang.String getTitle()

Retrieves the title of this panel.

Specified by:

getTitle in interface StandardPanel

Returns:

The panel title.

isInitializing

public boolean isInitializing()

Indicates whether the view is marked as being in the process of being initialized.

Returns:

true if the view is marked as in the process of being initialized, false otherwise.

setInitializing

public void setInitializing(boolean bInitializing)

Specifies whether the view is to be marked as being in the process of being initialized.

Parameters:

bInitializing - true if the view is to be marked as in the process of being initialized, false otherwise.

getHelpContextID

public java.lang.String getHelpContextID()

Retrieves the Help context ID for this panel. The default Help context ID is the full class path for this panel. To set a different Help context ID, use the method setHelpContextID(String). The Help context ID that is used when listening for the user event that requests the display of Help for this panel.

Specified by:

getHelpContextID in interface HelpContext

Returns:

The Help context ID for this panel

setHelpContextID

public void setHelpContextID(java.lang.String helpContextId)

Specifies the Help context ID for this panel. This Help context ID is used when listening for the user event that requests the display of Help for this panel.

Specified by:

setHelpContextID in interface HelpContext

Parameters:

helpContextId - The Help context ID for this panel.

removePanelEventListener

public void removePanelEventListener(PanelEventListener listener)

Removes a listener for the panel events.

Specified by:

removePanelEventListener in interface StandardPanel

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.

Specified by:

setActive in interface StandardPanel

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.

Specified by:

setBuilderContext in interface StandardPanel

Parameters:

The - BuilderContext instance.

setContainer

public void setContainer(java.awt.Component container)

Specifies the container that is associated with this panel.

Specified by:

setContainer in interface StandardPanel

Parameters:

container - The container.

setPanelContent

public void setPanelContent(java.lang.Object panelContent)

Specifies the content for this panel.

Specified by:

setPanelContent in interface StandardPanel

Parameters:

panelContent - The panel content.

validateContents

public boolean validateContents(java.lang.Object hintValidate)

Validates the contents of the panel.

Specified by:

validateContents in interface StandardPanel

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.

firePanelEvent

public boolean firePanelEvent(java.util.EventObject panelEvent)

Fires the supplied panel event to the registered listeners.

Parameters:

panelEvent - The panel event to be fired.

getPanelState

public boolean getPanelState(int nPanelState)

Retrieves the value of the panel state.

Parameters:

nPanelState - The panel state whose value is to be checked.

Returns:

true if the panel state was set; false if the panel state was not set.

isDirty

public boolean isDirty()

Retrieves whether the panel is dirty or not.

Returns:

true if the panel is marked dirty; false otherwise.

initializeMembers

public void initializeMembers()

Initializes the class members.

initUIContent

public boolean initUIContent()
                      throws DataUtilException

Initializes the user interface content of the panel. Subclasses should override this method.

Returns:

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

Throws:

DataUtilException - if the operation is unsuccessful.

setDirty

public void setDirty(boolean bIsDirty)

Specifies whether the panel is dirty or not.

Parameters:

bIsDirty - true if the panel needs to be marked dirty; false if the panel does not need to be marked dirty.

setPanelState

public void setPanelState(int nPanelState,
                          boolean bValue)

Specifies the value of a panel state.

Parameters:

nPanelState - The panel state whose value is to be checked.

bValue - The value of the panel state. true if the panel state is to be set; false if the panel state is to be cleared.

updateData

public boolean updateData(boolean bUpdateUI)
                   throws DataUtilException

Updates data from the user interface component to the underlying data structure and vice versa.

Returns:

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

Throws:

DataUtilException - if the operation is unsuccessful.