|
Business Components | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.JPanel | +--oracle.jbo.uicli.controls.JUStatusBar
JUStatusBar
Implements the JUStatusBar control to display the status of a rowset.
When a dataItemName is specified, it tracks the status of the rowset to which it is bound; otherwise, it tracks the status of the data bound control (Rowset) which currently has the focus.
The JUStatusBar has six indicators:
The default display state for each indicator is:
Inner Class Summary |
Type | Class |
---|---|
class |
JUStatusBar.StatusBarLabelControl
|
class |
JUStatusBar.StatusBarProgressControl
A derivative of JProgressBar that listens to three DataItems. |
Inner classes inherited from class javax.swing.JPanel |
javax.swing.JPanel.AccessibleJPanel |
Inner classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
Inner classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent |
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 java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary |
JUStatusBar()
Create a new StatusBar. |
Method Summary |
Type | Method |
---|---|
protected void |
_updateIndicators()
|
protected void |
_updateIndicatorValues()
|
static JUIteratorBinding |
createPanelBinding(JUPanelBinding formBinding,
JUStatusBar control)
|
static JUIteratorBinding |
createViewBinding(JUPanelBinding formBinding,
java.lang.String voInstanceName,
java.lang.String voRSIName,
java.lang.String voRSIBindingName)
|
void |
displayStatus(JUIteratorBinding iterBinding,
java.lang.String msgId,
java.lang.Object[] params)
This event is sent out by the framework to display a message in oracle.jbo.uicli.UIMessageBundle of the given msgId with the given set of parameters. |
void |
displayStatus(java.lang.String msg)
Applications can invoke to display any custom messages in the status bar(s). |
void |
focusGained(JUIteratorBinding iterBinding,
JUControlBinding binding,
int attrIndex)
This event is sent out by a JUControlBinding when the associated control comes into focus. |
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.awt.Font |
getFont()
StatusBar override. |
boolean |
getHasCurrentRow()
Indicates whether the Current Row 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. |
javax.swing.border.Border |
getIndicatorBorderStyle()
Returns the border sytle used by the status bar's indicators. |
java.awt.LayoutManager |
getLayout()
Returns the LayoutManger used by the StatusBar. |
java.awt.Dimension |
getMaximumSize()
StatusBar 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()
StatusBar override. |
JUIteratorBinding |
getModel()
|
static JUIteratorBinding |
getModelInstance(JUPanelBinding formBinding,
JUStatusBar control)
|
static JUIteratorBinding |
getModelInstance(JUPanelBinding formBinding,
java.lang.String voInstanceName,
java.lang.String voRSIName,
java.lang.String voRSIBindingName)
|
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()
StatusBar 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. |
java.lang.String |
getStatusMessageText()
|
void |
navigated(NavigationEvent event)
Invoked when the current-row designation changes. |
void |
rangeRefreshed(RangeRefreshEvent event)
Invoked when the range changes. |
void |
rangeScrolled(ScrollEvent event)
Invoked when the range is scrolled. |
void |
rowDeleted(DeleteEvent event)
Invoked when a row has been deleted. |
void |
rowInserted(InsertEvent event)
Invoked when a row has been inserted. |
void |
rowUpdated(UpdateEvent event)
Invoked when an attribute of the row has been changed. |
void |
setBackground(java.awt.Color c)
StatusBar 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 |
setFont(java.awt.Font nuFont)
StatusBar override. |
void |
setForeground(java.awt.Color c)
StatusBar override. |
void |
setHasCurrentRow(boolean showIt)
Determines whether the current row 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 |
setIndicatorBorderStyle(javax.swing.border.Border indicatorBorderStyle)
Sets the border sytle for the status bar's indicators. |
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 |
setModel(JUIteratorBinding bind)
|
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 |
transactionStateChanged(boolean state)
Invoked when the BC4J transaction is either marked dirty or clean. |
Methods inherited from class javax.swing.JPanel |
getAccessibleContext, getUIClassID, paramString, 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, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics,
getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, 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, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren,
printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener,
removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions,
setDoubleBuffered, setEnabled, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, insets, invalidate, isAncestorOf, layout,
list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, validate, validateTree |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage,
createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, 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, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent,
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 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public JUStatusBar()
Method Detail |
public static JUIteratorBinding createViewBinding(JUPanelBinding formBinding, java.lang.String voInstanceName, java.lang.String voRSIName, java.lang.String voRSIBindingName)
public static JUIteratorBinding getModelInstance(JUPanelBinding formBinding, java.lang.String voInstanceName, java.lang.String voRSIName, java.lang.String voRSIBindingName)
public static JUIteratorBinding createPanelBinding(JUPanelBinding formBinding, JUStatusBar control)
public static JUIteratorBinding getModelInstance(JUPanelBinding formBinding, JUStatusBar control)
public JUIteratorBinding getModel()
public void setModel(JUIteratorBinding bind)
public java.awt.LayoutManager getLayout()
The StatusBar only uses a GridBag layout manager defined in its constructor.
getLayout
in class java.awt.Container
public void setLayout(java.awt.LayoutManager l)
setLayout
in class java.awt.Container
l
- A LayoutManger that will be ignored by the StatusBar.public void setProgressBarSize(java.awt.Dimension progressBarSize)
progressBarSize
- The desired size of the progress indicator.getProgressBarSize()
public java.awt.Dimension getProgressBarSize()
setProgressBarSize(Dimension progressBarSize)
public void setIndicatorBorderStyle(javax.swing.border.Border indicatorBorderStyle)
indicatorBorderStyle
- The border sytle for the status bar's
indicators.getIndicatorBorderStyle()
public javax.swing.border.Border getIndicatorBorderStyle()
setIndicatorBorderStyle(Border indicatorBorderStyle)
public void setFont(java.awt.Font nuFont)
Sets the font for the status bar and all contained components.
setFont
in class javax.swing.JComponent
nuFont
- The font to use for the status bar and all contained
componentsgetFont()
public java.awt.Font getFont()
Returns the font for the status bar and all contained conponents.
getFont
in class java.awt.Component
setFont(Font nuFont)
public void setForeground(java.awt.Color c)
setForeground
in class javax.swing.JComponent
c
- The foreground color for the StatusBar.public void setBackground(java.awt.Color c)
setBackground
in class javax.swing.JComponent
c
- The background color for the StatusBar.public java.awt.Dimension getMaximumSize()
getMaximumSize
in class javax.swing.JComponent
public void setMaximumSize(java.awt.Dimension dim)
setMaximumSize
in class javax.swing.JComponent
public java.awt.Dimension getMinimumSize()
getMinimumSize
in class javax.swing.JComponent
public void setMinimumSize(java.awt.Dimension dim)
setMinimumSize
in class javax.swing.JComponent
public java.awt.Dimension getPreferredSize()
getPreferredSize
in class javax.swing.JComponent
public void setPreferredSize(java.awt.Dimension dim)
setPreferredSize
in class javax.swing.JComponent
public void setCurrentRowFormatter(Formatter currentRowFormatter)
currentRowFormatter
- Formatter for formatting the CurrentRow
status label.getCurrentRowFormatter()
public Formatter getCurrentRowFormatter()
setCurrentRowFormatter(Formatter
currentRowFormatter)
public void setRowCountFormatter(Formatter rowCountFormatter)
rowCountFormatter
- Formatter for formatting the RowCount
status label.getRowCountFormatter()
public Formatter getRowCountFormatter()
setRowCountFormatter(Formatter RowCountFormatter)
public void setModifiedFlagFormatter(Formatter modifiedFlagFormatter)
modifiedFlagFormatter
- Formatter for formatting the ModifiedFlag
status label.getModifiedFlagFormatter()
public Formatter getModifiedFlagFormatter()
setModifiedFlagFormatter(Formatter
ModifiedFlagFormatter)
public void setMessageAreaFormatter(Formatter messageAreaFormatter)
messageAreaFormatter
- Formatter for formatting the MessageArea
status label.getMessageAreaFormatter()
public Formatter getMessageAreaFormatter()
setMessageAreaFormatter(Formatter
messageAreaFormatter)
public void setPercentDoneFormatter(Formatter percentDoneFormatter)
percentDoneFormatter
- Formatter for formatting the PercentDone
status label.getPercentDoneFormatter()
public Formatter getPercentDoneFormatter()
setPercentDoneFormatter(Formatter
percentDoneFormatter)
public void setCurrentRowFormatString(java.lang.String currentRowFormatString)
currentRowFormatString
- Format string for formatting the
CurrentRow status label.getCurrentRowFormatString()
public java.lang.String getCurrentRowFormatString()
setCurrentRowFormatString(String
currentRowFormatString)
public void setRowCountFormatString(java.lang.String rowCountFormatString)
rowCountFormatString
- Format string for formatting the RowCount
status label.getRowCountFormatString()
public java.lang.String getRowCountFormatString()
setRowCountFormatString(String RowCountFormatString)
public void setModifiedFlagFormatString(java.lang.String modifiedFlagFormatString)
modifiedFlagFormatString
- Format string for formatting the
ModifiedFlag status label.getModifiedFlagFormatString()
public java.lang.String getModifiedFlagFormatString()
setModifiedFlagFormatString(String
ModifiedFlagFormatString)
public void setMessageAreaFormatString(java.lang.String messageAreaFormatString)
messageAreaFormatString
- Format string for formatting the
MessageArea status label.getMessageAreaFormatString()
public java.lang.String getMessageAreaFormatString()
setMessageAreaFormatString(String
messageAreaFormatString)
public void setPercentDoneFormatString(java.lang.String percentDoneFormatString)
percentDoneFormatString
- Format string for formatting the
PercentDone status label.getPercentDoneFormatString()
public java.lang.String getPercentDoneFormatString()
setPercentDoneFormatString(String
percentDoneFormatString)
public boolean getHasModifiedFlag()
A status reporting method that informs the caller whether or not the message area of the StatusBar is displayed.
setHasModifiedFlag(boolean showIt)
public void setHasModifiedFlag(boolean showIt)
Allows the caller to show or hide the message area in the StatusBar.
showIt
- If TRUE, then the modified flag will be shown.getHasModifiedFlag()
public boolean getHasMessageArea()
A status reporting method that informs the caller whether or not the message area of the StatusBar is displayed.
setHasMessageArea(boolean showIt)
public void setHasMessageArea(boolean showIt)
Allows the caller to show or hide the message area in the StatusBar.
showIt
- If TRUE, then the message area will be shown.getHasMessageArea()
public boolean getHasCurrentRow()
A status reporting method that informs the caller whether or not the Current Row indicator on the StatusBar is displayed.
setHasCurrentRow(boolean showIt)
public void setHasCurrentRow(boolean showIt)
Allows the caller to show or hide the current row indicator in the StatusBar.
showIt
- if TRUE, then the current row indicator is showngetHasCurrentRow()
public boolean getHasRowCount()
A status reporting method that informs the caller whether or not the Row Count indicator on the StatusBar is displayed.
setHasRowCount(boolean showIt)
public void setHasRowCount(boolean showIt)
Allows the caller to show or hide the row count indicator in the StatusBar.
showIt
- if TRUE, then the row count indicator is showngetHasRowCount()
public boolean getHasPercentDone()
A status reporting method that informs the caller whether or not the Percent Done indicator on the StatusBar is displayed.
setHasPercentDone(boolean showIt)
public void setHasPercentDone(boolean showIt)
Allows the caller to show or hide the percent done indicator in the StatusBar.
showIt
- if TRUE, then the percent done indicator is shown.getHasPercentDone()
public void transactionStateChanged(boolean state)
JUTransactionStateListener
transactionStateChanged
in interface JUTransactionStateListener
oracle.jbo.uicli.binding.JUTransactionStateListener
state
- Indicates if the transaction was marked clean (true) or dirty (false).
Controls like NavigationBar then disables/enables the Save button to indicate
there are changes that need to be saved/committed to the database.public void focusGained(JUIteratorBinding iterBinding, JUControlBinding binding, int attrIndex)
JUStatusBarInterface
focusGained
in interface JUStatusBarInterface
oracle.jbo.uicli.binding.JUStatusBarInterface
iterBinding
- The Iterator that the control-binding is working with.controlBinding
- Identifies which control is coming into focus.attrIndex
- Index of the attribute in the JUControlBinding
that is current/in focus.
The value for this index could be -1 if a composite control that is working with a ViewObject
or RowIterator comes in focus (like a JTree/JTable/JUNavigationBar).public java.lang.String getStatusMessageText()
public void displayStatus(JUIteratorBinding iterBinding, java.lang.String msgId, java.lang.Object[] params)
JUStatusBarInterface
displayStatus
in interface JUStatusBarInterface
oracle.jbo.uicli.binding.JUStatusBarInterface
iterBinding
- Current IteratorBinding object for the control that sends this message.msgId
- String ID of a message from UIMessageBundle to display.params
- Parameters that the message
needs to format an appropriate display.public void displayStatus(java.lang.String msg)
JUStatusBarInterface
displayStatus
in interface JUStatusBarInterface
public void navigated(NavigationEvent event)
RowSetListener
navigated
in interface RowSetListener
oracle.jbo.RowSetListener
event
- a description of the new and previous current rows.public void rangeRefreshed(RangeRefreshEvent event)
RowSetListener
rangeRefreshed
in interface RowSetListener
oracle.jbo.RowSetListener
event
- a description of the new ranges.public void rangeScrolled(ScrollEvent event)
RowSetListener
rangeScrolled
in interface RowSetListener
oracle.jbo.RowSetListener
event
- a description of the new range.public void rowDeleted(DeleteEvent event)
RowSetListener
rowDeleted
in interface RowSetListener
oracle.jbo.RowSetListener
event
- a description of the deleted Row object.public void rowInserted(InsertEvent event)
RowSetListener
rowInserted
in interface RowSetListener
oracle.jbo.RowSetListener
event
- a description of the new Row object.public void rowUpdated(UpdateEvent event)
RowSetListener
rowUpdated
in interface RowSetListener
oracle.jbo.RowSetListener
event
- a description of the modified Row object.protected void _updateIndicators()
protected void _updateIndicatorValues()
|
Business Components | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |