StatusBarControl

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Data-aware Controls Reference

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.dacf.control.swing
Class StatusBarControl

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.dacf.control.swing.StatusBarControl

All Implemented Interfaces:: javax.accessibility.Accessible, oracle.dacf.activity.ActivityListener, Control, CurrencyListener, javax.infobus.DataItemChangeListener, java.awt.image.ImageObserver, InfoBusManagerListener, java.awt.MenuContainer, java.io.Serializable

public class StatusBarControl
extends javax.swing.JPanel
implements Control, CurrencyListener, oracle.dacf.activity.ActivityListener, InfoBusManagerListener

StatusBar

The StatusBar Control can display the status of a rowset.

When a dataItemName is specified, it tracks the status of the rowset it is bound to, otherwise, it tracks the status of the DAC control (Rowset) which currently has the focus.

The StatusBar has six indicators:

Progress bar: current row's percent "through" the result set
Current row number: row number of the current row
Row count: number of rows in the result ser
Fetched count: number of rows fetched from the database
Modified flag: true if one or more rows has been changed
Message area: displays the name of the current result set
Working icon: a graphic that is display when a long running activity begins

Each of these indicators can be hidden or shown by using the appropriate method call. The format of text displayed in each indicator can be controlled setting the value of the appropriate format string and formatter.

The default display state for each indicator is:

Progress bar: true
Current row number: true
Row count: true
Fetched count: false
Modified flag: true
Message area: true
Working icon: true

Version:: PUBLIC
See Also:: Serialized Form

Nested Class Summary
`class`	`StatusBarControl.StatusBarLabelControl`
`class`	`StatusBarControl.StatusBarProgressControl` A derivative of JProgressBar that listens to three DataItems.

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary
`static java.lang.String`	`DEFAULT_WORKING_ICON`
`static java.lang.String`	`WORKING_ICON_1`
`static java.lang.String`	`WORKING_ICON_2`
`static java.lang.String`	`WORKING_ICON_3`
`static java.lang.String`	`WORKING_ICON_4`

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, 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 oracle.dacf.control.Control

DEFAULT_INFOBUS_NAME, EVENT_PROPERTY_ROW, EVENT_PROPERTY_ROW_CHANGE, EVENT_PROPERTY_ROW_COUNT, EVENT_PROPERTY_VIEW_CHANGE, EVENT_PROPERTY_VIEW_REFRESHED, EVENT_PROPERTY_VIEW_SCROLLED, EXCLUDE, HIDE, SHOW

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary
`StatusBarControl()` Create a new StatusBarControl.

Method Summary
`protected java.lang.String`	`_getActiveRowset()` Get the active rowset.
`protected void`	`_updateIndicators()`
`protected void`	`_updateIndicatorValues()`
`void`	`activityStarted(oracle.dacf.activity.ActivityEvent event)` This method is called when a particular activity is started
`void`	`activityStopped(oracle.dacf.activity.ActivityEvent event)` This method is called when a particular activity is stopped
`void`	`addNavigatedListener(NavigatedListener listener)` This method is a no-op; it has no effect
`void`	`addNavigatingListener(NavigatingListener listener)` This method is a no-op; it has no effect
`void`	`currencyChanged(CurrencyChangedEvent e)` This method is used to track which control on the screen gets focus
`void`	`dataItemAdded(javax.infobus.DataItemAddedEvent event)` Indicates that a new item was added to the bound aggregate data item (e.g.
`void`	`dataItemChanged(java.lang.Object oldDataItem, java.lang.Object newDataItem)` Notifies the control that the bound InfoBus DataItem has changed.
`void`	`dataItemDeleted(javax.infobus.DataItemDeletedEvent event)` Indicates that an item was deleted from the bound aggregate data item (e.
`void`	`dataItemRevoked(javax.infobus.DataItemRevokedEvent event)` Indicates that the bound data item (and its sub-items, if any) has been revoked, and is temporarily unavailable.
`void`	`dataItemValueChanged(javax.infobus.DataItemValueChangedEvent event)` Indicates a changed value in the bound data item.
`java.awt.Component`	`getComponent()` Returns the AWT component associated with this control.
`java.lang.String`	`getCurrentRowFormatString()` Returns the format string for formatting the CurrentRow status label.
`Formatter`	`getCurrentRowFormatter()` Returns the formatter for formatting the CurrentRow status label.
`java.lang.Object`	`getDataItem()` Returns the InfoBus DataItem this control is bound to.
`java.lang.String`	`getDataItemName()` Returns the name of the InfoBus DataItem this control is bound to.
`java.awt.Font`	`getFont()` StatusBarControl override.
`boolean`	`getHasCurrentRow()` Indicates whether the Current Row indicator is shown.
`boolean`	`getHasHighWaterMark()` Indicates whether the High Water Mark indicator is shown.
`boolean`	`getHasMessageArea()` Reports whether the Message Area is shown.
`boolean`	`getHasModifiedFlag()` Reports whether the modified flag is shown.
`boolean`	`getHasPercentDone()` Indicates whether the Percent Done indicator is shown.
`boolean`	`getHasRowCount()` Indicates whether the Row Count indicator is shown.
`java.lang.String`	`getHighWaterMarkFormatString()` Returns the format string for formatting the HighWaterMark status label.
`Formatter`	`getHighWaterMarkFormatter()` Returns the formatter for formatting the HighWaterMark status label.
`javax.swing.border.Border`	`getIndicatorBorderStyle()` Returns the border sytle used by the status bar's indicators.
`java.lang.String`	`getInfoBusName()` Returns the name of the InfoBus this control is connected to.
`java.awt.LayoutManager`	`getLayout()` Returns the LayoutManger used by the StatusBarControl.
`java.awt.Dimension`	`getMaximumSize()` StatusBarControl override.
`java.lang.String`	`getMessageAreaFormatString()` Returns the format string for formatting the MessageArea status label.
`Formatter`	`getMessageAreaFormatter()` Returns the formatter for formatting the MessageArea status label.
`java.awt.Dimension`	`getMinimumSize()` StatusBarControl override.
`java.lang.String`	`getModifiedFlagFormatString()` Returns the format string for formatting the ModifiedFlag status label.
`Formatter`	`getModifiedFlagFormatter()` Returns the formatter for formatting the ModifiedFlag status label.
`java.lang.String`	`getPercentDoneFormatString()` Returns the format string for formatting the PercentDone status label.
`Formatter`	`getPercentDoneFormatter()` Returns the formatter for formatting the PercentDone status label.
`java.awt.Dimension`	`getPreferredSize()` StatusBarControl override.
`java.awt.Dimension`	`getProgressBarSize()` Returns the progress indicator's size.
`java.lang.String`	`getRowCountFormatString()` Returns the format string for formatting the RowCount status label.
`Formatter`	`getRowCountFormatter()` Returns the formatter for formatting the RowCount status label.
`protected javax.swing.Icon`	`getWorkingIcon()` Returns the actual Icon that will be displayed when a long running activity begins.
`java.lang.String`	`getWorkingIconFileName()` Gets the name of the icon shown when a long-running activity starts.
`boolean`	`hasWorkingIcon()` Inquires whether the working icon is shown.
`protected void`	`hideWorkingIcon()` A "hook" so that subclasses can change how the working icon is hidden.
`boolean`	`isFocusValidated()` Determines whether focus into this control causes validation to occur.
`void`	`processNavigatedEvent(NavigatedEvent event)` This method is a no-op; it has no effect
`void`	`processNavigatingEvent(NavigatingEvent event)` This method is a no-op in that it has no effect
`void`	`releaseResources(InfoBusManagerReleaseEvent e)` A signalling method used to indicate the the control should free all resources and unregister any listeners that it has registered.
`void`	`removeNavigatedListener(NavigatedListener listener)` This method is a no-op; it has no effect
`void`	`removeNavigatingListener(NavigatingListener listener)` This method is a no-op; it has no effect
`void`	`rowsetCursorMoved(javax.infobus.RowsetCursorMovedEvent event)` Indicates that the cursor for the bound `RowsetAccess` data item has changed rows.
`void`	`setBackground(java.awt.Color c)` StatusBarControl override.
`void`	`setCurrentRowFormatString(java.lang.String currentRowFormatString)` Sets the format string for formatting the CurrentRow status label.
`void`	`setCurrentRowFormatter(Formatter currentRowFormatter)` Sets the formatter for formatting the CurrentRow status label.
`void`	`setDataItemName(java.lang.String dataItemName)` Sets the name of the InfoBus DataItem this control is bound to.
`void`	`setEnabled(boolean b)` An override of java.awt.Component.setEnabled.
`void`	`setFocusValidated(boolean focusValidated)` This method is a no-op; it has no effect
`void`	`setFont(java.awt.Font nuFont)` StatusBarControl override.
`void`	`setForeground(java.awt.Color c)` StatusBarControl override.
`void`	`setHasCurrentRow(boolean showIt)` Determines whether the current row indicator is visible.
`void`	`setHasHighWaterMark(boolean showIt)` Determines whether the High Water Mark indicator is visible.
`void`	`setHasMessageArea(boolean showIt)` Determines whether the message are is visible.
`void`	`setHasModifiedFlag(boolean showIt)` Determines whether the modified flag is visible.
`void`	`setHasPercentDone(boolean showIt)` Determines whether the percent done indicator is visible.
`void`	`setHasRowCount(boolean showIt)` Determines whether the row count indicator is visible.
`void`	`setHighWaterMarkFormatString(java.lang.String highWaterMarkFormatString)` Sets the format string for formatting the HighWaterMark status label.
`void`	`setHighWaterMarkFormatter(Formatter highWaterMarkFormatter)` Sets the formatter for formatting the HighWaterMark status label.
`void`	`setIndicatorBorderStyle(javax.swing.border.Border indicatorBorderStyle)` Sets the border sytle for the status bar's indicators.
`void`	`setInfoBusName(java.lang.String infoBusName)` Sets the name of the InfoBus this control is connected to.
`void`	`setLayout(java.awt.LayoutManager l)` An override of the setLayout() inherited from java.awt.Container.
`void`	`setMaximumSize(java.awt.Dimension dim)`
`void`	`setMessageAreaFormatString(java.lang.String messageAreaFormatString)` Sets the format string for formatting the MessageArea status label.
`void`	`setMessageAreaFormatter(Formatter messageAreaFormatter)` Sets the formatter for formatting the MessageArea status label.
`void`	`setMinimumSize(java.awt.Dimension dim)`
`void`	`setModifiedFlagFormatString(java.lang.String modifiedFlagFormatString)` Sets the format string for formatting the ModifiedFlag status label.
`void`	`setModifiedFlagFormatter(Formatter modifiedFlagFormatter)` Sets the formatter for formatting the ModifiedFlag status label.
`void`	`setPercentDoneFormatString(java.lang.String percentDoneFormatString)` Sets the format string for formatting the PercentDone status label.
`void`	`setPercentDoneFormatter(Formatter percentDoneFormatter)` Sets the formatter for formatting the PercentDone status label.
`void`	`setPreferredSize(java.awt.Dimension dim)`
`void`	`setProgressBarSize(java.awt.Dimension progressBarSize)` Sets the progress indicator's size.
`void`	`setRowCountFormatString(java.lang.String rowCountFormatString)` Sets the format string for formatting the RowCount status label.
`void`	`setRowCountFormatter(Formatter rowCountFormatter)` Sets the formatter for formatting the RowCount status label.
`void`	`setShowWorkingIcon(boolean hasWorkingIcon)` Determines whether or not the working icon is shown.
`void`	`setWorkingIconFileName(java.lang.String workingIconFileName)` Sets the name of the icon shown when a long-running activity starts.
`protected void`	`showWorkingIcon()` A "hook" so that subclasses can change how the working icon is displayed.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

WORKING_ICON_1

public static final java.lang.String WORKING_ICON_1

See Also:: Constant Field Values

WORKING_ICON_2

public static final java.lang.String WORKING_ICON_2

See Also:: Constant Field Values

WORKING_ICON_3

public static final java.lang.String WORKING_ICON_3

See Also:: Constant Field Values

WORKING_ICON_4

public static final java.lang.String WORKING_ICON_4

See Also:: Constant Field Values

DEFAULT_WORKING_ICON

public static final java.lang.String DEFAULT_WORKING_ICON

See Also:: Constant Field Values

Constructor Detail

StatusBarControl

public StatusBarControl()

Create a new StatusBarControl.

Method Detail

getLayout

public java.awt.LayoutManager getLayout()

Returns the LayoutManger used by the StatusBarControl.

The StatusBarControl only uses a GridBag layout manager defined in its constructor.

Returns:: the LayoutManger used by the StatusBarControl.

setLayout

public void setLayout(java.awt.LayoutManager l)

An override of the setLayout() inherited from java.awt.Container.

Parameters:: l - a LayoutManger that will be ignored by the StatusBarControl.

setProgressBarSize

public void setProgressBarSize(java.awt.Dimension progressBarSize)

Sets the progress indicator's size.

Parameters:: progressBarSize - the desired size of the progress indicator
See Also:: getProgressBarSize()

getProgressBarSize

public java.awt.Dimension getProgressBarSize()

Returns the progress indicator's size.

Returns:: the progress indicator's size.
See Also:: setProgressBarSize(Dimension progressBarSize)

setIndicatorBorderStyle

public void setIndicatorBorderStyle(javax.swing.border.Border indicatorBorderStyle)

Sets the border sytle for the status bar's indicators.

Parameters:: indicatorBorderStyle - the border sytle for the status bar's indicators
See Also:: getIndicatorBorderStyle()

getIndicatorBorderStyle

public javax.swing.border.Border getIndicatorBorderStyle()

Returns the border sytle used by the status bar's indicators.

Returns:: the border sytle used by the status bar's indicators.
See Also:: setIndicatorBorderStyle(Border indicatorBorderStyle)

setFont

public void setFont(java.awt.Font nuFont)

StatusBarControl override.

Sets the font for the status bar and all contained conponents.

Parameters:: nuFont - the font to use for the status bar and all contained components
See Also:: getFont()

getFont

public java.awt.Font getFont()

StatusBarControl override.

Returns the font for the status bar and all contained conponents.

Specified by:: getFont in interface java.awt.MenuContainer

Returns:: the font used for the status bar and all contained components
See Also:: setFont(Font nuFont)

setForeground

public void setForeground(java.awt.Color c)

StatusBarControl override.

Parameters:: c - The foreground color for the StatusBar

setBackground

public void setBackground(java.awt.Color c)

StatusBarControl override.

Parameters:: c - The background color for the StatusBar

getMaximumSize

public java.awt.Dimension getMaximumSize()

StatusBarControl override.

Returns:: the maximum Dimensions of the StatusBar

setMaximumSize

public void setMaximumSize(java.awt.Dimension dim)

getMinimumSize

public java.awt.Dimension getMinimumSize()

StatusBarControl override.

Returns:: the minimum Dimensions of the StatusBar

setMinimumSize

public void setMinimumSize(java.awt.Dimension dim)

getPreferredSize

public java.awt.Dimension getPreferredSize()

StatusBarControl override.

Returns:: the preferred Dimensions of the StatusBar

setPreferredSize

public void setPreferredSize(java.awt.Dimension dim)

setCurrentRowFormatter

public void setCurrentRowFormatter(Formatter currentRowFormatter)

Sets the formatter for formatting the CurrentRow status label.

Parameters:: currentRowFormatter - formatter for formatting the CurrentRow status label
See Also:: getCurrentRowFormatter()

getCurrentRowFormatter

public Formatter getCurrentRowFormatter()

Returns the formatter for formatting the CurrentRow status label.

Returns:: the formatter for formatting the CurrentRow status label.
See Also:: setCurrentRowFormatter(Formatter currentRowFormatter)

setHighWaterMarkFormatter

public void setHighWaterMarkFormatter(Formatter highWaterMarkFormatter)

Sets the formatter for formatting the HighWaterMark status label.

Parameters:: highWaterMarkFormatter - formatter for formatting the HighWaterMark status label
See Also:: getHighWaterMarkFormatter()

getHighWaterMarkFormatter

public Formatter getHighWaterMarkFormatter()

Returns the formatter for formatting the HighWaterMark status label.

Returns:: the formatter for formatting the HighWaterMark status label.
See Also:: setHighWaterMarkFormatter(Formatter highWaterMarkFormatter)

setRowCountFormatter

public void setRowCountFormatter(Formatter rowCountFormatter)

Sets the formatter for formatting the RowCount status label.

Parameters:: rowCountFormatter - formatter for formatting the RowCount status label
See Also:: getRowCountFormatter()

getRowCountFormatter

public Formatter getRowCountFormatter()

Returns the formatter for formatting the RowCount status label.

Returns:: the formatter for formatting the RowCount status label.
See Also:: setRowCountFormatter(Formatter RowCountFormatter)

setModifiedFlagFormatter

public void setModifiedFlagFormatter(Formatter modifiedFlagFormatter)

Sets the formatter for formatting the ModifiedFlag status label.

Parameters:: modifiedFlagFormatter - formatter for formatting the ModifiedFlag status label
See Also:: getModifiedFlagFormatter()

getModifiedFlagFormatter

public Formatter getModifiedFlagFormatter()

Returns the formatter for formatting the ModifiedFlag status label.

Returns:: the formatter for formatting the ModifiedFlag status label.
See Also:: setModifiedFlagFormatter(Formatter ModifiedFlagFormatter)

setMessageAreaFormatter

public void setMessageAreaFormatter(Formatter messageAreaFormatter)

Sets the formatter for formatting the MessageArea status label.

Parameters:: messageAreaFormatter - formatter for formatting the MessageArea status label
See Also:: getMessageAreaFormatter()

getMessageAreaFormatter

public Formatter getMessageAreaFormatter()

Returns the formatter for formatting the MessageArea status label.

Returns:: the formatter for formatting the MessageArea status label.
See Also:: setMessageAreaFormatter(Formatter messageAreaFormatter)

setPercentDoneFormatter

public void setPercentDoneFormatter(Formatter percentDoneFormatter)

Sets the formatter for formatting the PercentDone status label.

Parameters:: percentDoneFormatter - formatter for formatting the PercentDone status label
See Also:: getPercentDoneFormatter()

getPercentDoneFormatter

public Formatter getPercentDoneFormatter()

Returns the formatter for formatting the PercentDone status label.

Returns:: the formatter for formatting the PercentDone status label.
See Also:: setPercentDoneFormatter(Formatter percentDoneFormatter)

setCurrentRowFormatString

public void setCurrentRowFormatString(java.lang.String currentRowFormatString)

Sets the format string for formatting the CurrentRow status label.

Parameters:: currentRowFormatString - format string for formatting the CurrentRow status label
See Also:: getCurrentRowFormatString()

getCurrentRowFormatString

public java.lang.String getCurrentRowFormatString()

Returns the format string for formatting the CurrentRow status label.

Returns:: the format string for formatting the CurrentRow status label.
See Also:: setCurrentRowFormatString(String currentRowFormatString)

setHighWaterMarkFormatString

public void setHighWaterMarkFormatString(java.lang.String highWaterMarkFormatString)

Sets the format string for formatting the HighWaterMark status label.

Parameters:: highWaterMarkFormatString - format string for formatting the HighWaterMark status label
See Also:: getHighWaterMarkFormatString()

getHighWaterMarkFormatString

public java.lang.String getHighWaterMarkFormatString()

Returns the format string for formatting the HighWaterMark status label.

Returns:: the format string for formatting the HighWaterMark status label.
See Also:: setHighWaterMarkFormatString(String highWaterMarkFormatString)

setRowCountFormatString

public void setRowCountFormatString(java.lang.String rowCountFormatString)

Sets the format string for formatting the RowCount status label.

Parameters:: rowCountFormatString - format string for formatting the RowCount status label
See Also:: getRowCountFormatString()

getRowCountFormatString

public java.lang.String getRowCountFormatString()

Returns the format string for formatting the RowCount status label.

Returns:: the format string for formatting the RowCount status label.
See Also:: setRowCountFormatString(String RowCountFormatString)

setModifiedFlagFormatString

public void setModifiedFlagFormatString(java.lang.String modifiedFlagFormatString)

Sets the format string for formatting the ModifiedFlag status label.

Parameters:: modifiedFlagFormatString - format string for formatting the ModifiedFlag status label
See Also:: getModifiedFlagFormatString()

getModifiedFlagFormatString

public java.lang.String getModifiedFlagFormatString()

Returns the format string for formatting the ModifiedFlag status label.

Returns:: the format string for formatting the ModifiedFlag status label.
See Also:: setModifiedFlagFormatString(String ModifiedFlagFormatString)

setMessageAreaFormatString

public void setMessageAreaFormatString(java.lang.String messageAreaFormatString)

Sets the format string for formatting the MessageArea status label.

Parameters:: messageAreaFormatString - format string for formatting the MessageArea status label
See Also:: getMessageAreaFormatString()

getMessageAreaFormatString

public java.lang.String getMessageAreaFormatString()

Returns the format string for formatting the MessageArea status label.

Returns:: the format string for formatting the MessageArea status label.
See Also:: setMessageAreaFormatString(String messageAreaFormatString)

setPercentDoneFormatString

public void setPercentDoneFormatString(java.lang.String percentDoneFormatString)

Sets the format string for formatting the PercentDone status label.

Parameters:: percentDoneFormatString - format string for formatting the PercentDone status label
See Also:: getPercentDoneFormatString()

getPercentDoneFormatString

public java.lang.String getPercentDoneFormatString()

Returns the format string for formatting the PercentDone status label.

Returns:: the format string for formatting the PercentDone status label.
See Also:: setPercentDoneFormatString(String percentDoneFormatString)

getHasModifiedFlag

public boolean getHasModifiedFlag()

Reports whether the modified flag is shown.

A status reporting method that informs the caller whether or not the message area of the StatusBar is displayed.

Returns:: TRUE if the modified flag is displayed.
See Also:: setHasModifiedFlag(boolean showIt)

setHasModifiedFlag

public void setHasModifiedFlag(boolean showIt)

Determines whether the modified flag is visible.

Allows the caller to show or hide the message area in the StatusBar.

Parameters:: showIt - If TRUE then the modified flag will be shown.
See Also:: getHasModifiedFlag()

getHasMessageArea

public boolean getHasMessageArea()

Reports whether the Message Area is shown.

A status reporting method that informs the caller whether or not the message area of the StatusBar is displayed.

Returns:: TRUE if the message area is displayed.
See Also:: setHasMessageArea(boolean showIt)

setHasMessageArea

public void setHasMessageArea(boolean showIt)

Determines whether the message are is visible.

Allows the caller to show or hide the message area in the StatusBar.

Parameters:: showIt - If TRUE then the message area will be shown.
See Also:: getHasMessageArea()

getHasCurrentRow

public boolean getHasCurrentRow()

Indicates whether the Current Row indicator is shown.

A status reporting method that informs the caller whether or not the Current Row indicator on the StatusBar is displayed.

Returns:: TRUE if the current row indicator is shown.
See Also:: setHasCurrentRow(boolean showIt)

setHasCurrentRow

public void setHasCurrentRow(boolean showIt)

Determines whether the current row indicator is visible.

Allows the caller to show or hide the current row indicator in the StatusBar.

Parameters:: showIt - if TRUE then the current row indicator is shown
See Also:: getHasCurrentRow()

getHasHighWaterMark

public boolean getHasHighWaterMark()

Indicates whether the High Water Mark indicator is shown.

A status reporting method that informs the caller whether or not the High Water Mark indicator on the StatusBar is displayed.

Returns:: TRUE if the High Water Mark indicator is shown.
See Also:: setHasHighWaterMark(boolean showIt)

setHasHighWaterMark

public void setHasHighWaterMark(boolean showIt)

Determines whether the High Water Mark indicator is visible.

Allows the caller to show or hide the High Water Mark indicator in the StatusBar.

Parameters:: showIt - TRUE to show the High Water Mark indicator
See Also:: getHasHighWaterMark()

getHasRowCount

public boolean getHasRowCount()

Indicates whether the Row Count indicator is shown.

A status reporting method that informs the caller whether or not the Row Count indicator on the StatusBar is displayed.

Returns:: TRUE if the row count indicator is shown.
See Also:: setHasRowCount(boolean showIt)

setHasRowCount

public void setHasRowCount(boolean showIt)

Determines whether the row count indicator is visible.

Allows the caller to show or hide the row count indicator in the StatusBar.

Parameters:: showIt - if TRUE then the row count indicator is shown
See Also:: getHasRowCount()

getHasPercentDone

public boolean getHasPercentDone()

Indicates whether the Percent Done indicator is shown.

A status reporting method that informs the caller whether or not the Percent Done indicator on the StatusBar is displayed.

Returns:: TRUE if the percent done indicator is shown.
See Also:: setHasPercentDone(boolean showIt)

setHasPercentDone

public void setHasPercentDone(boolean showIt)

Determines whether the percent done indicator is visible.

Allows the caller to show or hide the percent done indicator in the StatusBar.

Parameters:: showIt - if TRUE then the percent done indicator is shown
See Also:: getHasPercentDone()

setShowWorkingIcon

public void setShowWorkingIcon(boolean hasWorkingIcon)

Determines whether or not the working icon is shown.

See Also:: hasWorkingIcon()

hasWorkingIcon

public boolean hasWorkingIcon()

Inquires whether the working icon is shown.

Returns:: True if the working icon will be shown.
See Also:: setShowWorkingIcon(boolean showWorkingIcon)

setWorkingIconFileName

public void setWorkingIconFileName(java.lang.String workingIconFileName)

Sets the name of the icon shown when a long-running activity starts.

This method selects the icon that is displayed when the ActivityMonitor notifies the StatusBar that a long running activity has started.

Parameters:: workingIconFileName - the name of the icon shown when a long-running activity starts
See Also:: getWorkingIconFileName(), ActivityMonitor

getWorkingIconFileName

public java.lang.String getWorkingIconFileName()

Gets the name of the icon shown when a long-running activity starts.

This method returns the icon that is displayed when the ActivityMonitor notifies the StatusBar that a long running activity has started.

Returns:: the name of the icon shown when a long-running activity starts
See Also:: setWorkingIconFileName(String workingIconFileName)

getWorkingIcon

protected final javax.swing.Icon getWorkingIcon()

Returns the actual Icon that will be displayed when a long running activity begins.

This method is intended to be used by subclasses that implement overrides to showWorkingIcon() and hideWorkingIcon().

Returns:: The icon displayed when we need to indicate that its "working"
See Also:: showWorkingIcon(), hideWorkingIcon(), setWorkingIconFileName(String workingIconFileName), getWorkingIconFileName()

showWorkingIcon

protected void showWorkingIcon()

A "hook" so that subclasses can change how the working icon is displayed. The default behavior is to display it in the message area. A subclass could choose to display the working icon someplace else such as a non-modal dialog.

This method will be called when the working icon is to be displayed.

hideWorkingIcon

protected void hideWorkingIcon()

A "hook" so that subclasses can change how the working icon is hidden. The default behavior is to display it in the message area. A subclass could choose to display the working icon someplace else such as a non-modal dialog.

This method will be called when the working icon is to be hidden.

releaseResources

public void releaseResources(InfoBusManagerReleaseEvent e)

Description copied from interface: InfoBusManagerListener

A signalling method used to indicate the the control should free all resources and unregister any listeners that it has registered.

Specified by:: releaseResources in interface InfoBusManagerListener

activityStarted

public final void activityStarted(oracle.dacf.activity.ActivityEvent event)

This method is called when a particular activity is started

Specified by:: activityStarted in interface oracle.dacf.activity.ActivityListener

Parameters:: event - An ActivityEvent object describing the activity being started
See Also:: ActivityMonitor.activityStarted(java.lang.String)

activityStopped

public final void activityStopped(oracle.dacf.activity.ActivityEvent event)

This method is called when a particular activity is stopped

Specified by:: activityStopped in interface oracle.dacf.activity.ActivityListener

Parameters:: event - An ActivityEvent object describing the activity being stopped
See Also:: ActivityMonitor.activityStopped(int)

setEnabled

public void setEnabled(boolean b)

An override of java.awt.Component.setEnabled.

Specified by:: setEnabled in interface Control

Parameters:: b - boolean flag indicating whether the control is enabled

getInfoBusName

public final java.lang.String getInfoBusName()

Returns the name of the InfoBus this control is connected to.

Specified by:: getInfoBusName in interface Control

Returns:: The name of the InfoBus this control is connected to.
See Also:: StatusBarControl.StatusBarLabelControl.getInfoBusName()

setInfoBusName

public final void setInfoBusName(java.lang.String infoBusName)

Sets the name of the InfoBus this control is connected to.

By default, the control is connected to the default InfoBus, named Control.DEFAULT_INFOBUS_NAME.

If the named InfoBus does not exist, it is created automatically.

If the control is already connected to an InfoBus, it is disconnected first.

Specified by:: setInfoBusName in interface Control

Parameters:: infoBusName - The name of the InfoBus to connect to.
See Also:: Control.DEFAULT_INFOBUS_NAME, StatusBarControl.StatusBarLabelControl.setInfoBusName(java.lang.String)

getDataItemName

public final java.lang.String getDataItemName()

Returns the name of the InfoBus DataItem this control is bound to.

Specified by:: getDataItemName in interface Control

Returns:: The name of the InfoBus DataItem this control is bound to, or null if the control is unbound.
See Also:: getDataItem(), StatusBarControl.StatusBarLabelControl.getDataItemName()

setDataItemName

public final void setDataItemName(java.lang.String dataItemName)

Sets the name of the InfoBus DataItem this control is bound to.

The DataItem with the given name is searched for on the InfoBus, and if found, is bound to this control.

If the control is already bound to a DataItem, it is unbound first.

The StatusBar will now track the status of this rowset indicated by the dataItemName

Specified by:: setDataItemName in interface Control

Parameters:: dataItemName - The name of the DataItem to bind to.
See Also:: getDataItem(), StatusBarControl.StatusBarLabelControl.setDataItemName(java.lang.String)

getDataItem

public final java.lang.Object getDataItem()

Returns the InfoBus DataItem this control is bound to.

Specified by:: getDataItem in interface Control

Returns:: The InfoBus DataItem this control is bound to, or null if the control is unbound.
See Also:: StatusBarControl.StatusBarLabelControl.getDataItem()

dataItemChanged

public final void dataItemChanged(java.lang.Object oldDataItem,
                                  java.lang.Object newDataItem)

Notifies the control that the bound InfoBus DataItem has changed.

Specified by:: dataItemChanged in interface Control

Parameters:: oldDataItem - The formerly bound DataItem (can be null).; newDataItem - The newly bound DataItem (can be null).
See Also:: StatusBarControl.StatusBarLabelControl.dataItemChanged(java.lang.Object, java.lang.Object)

getComponent

public final java.awt.Component getComponent()

Returns the AWT component associated with this control.

Specified by:: getComponent in interface Control

Returns:: The AWT component for this control.
See Also:: StatusBarControl.StatusBarLabelControl.getComponent()

isFocusValidated

public final boolean isFocusValidated()

Determines whether focus into this control causes validation to occur.

Specified by:: isFocusValidated in interface Control

Returns:: Always false
See Also:: StatusBarControl.StatusBarLabelControl.isFocusValidated()