ilog.views.appframe.swing

Class IlvStatusBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ilog.views.appframe.swing.IlvStatusBar

All Implemented Interfaces:

MessageListener, ImageObserver, MenuContainer, Serializable, Accessible

public class IlvStatusBar
extends JPanel
implements MessageListener

Defines status bars to insert in the main window of an application.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIGURATION Name of the default component configuration set to status bar.
static String	PROGRESS_BAR_CONFIGURATION Name of the component configuration that displays a label and a progress bar.
static String	STATUS_LISTENER_NAME Name of the message listener used by the status bar to listen for application messages.

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
IlvStatusBar() Constructs a new status bar.

Method Summary

Modifier and Type	Method and Description
boolean	activateConfiguration(String configurationName) Activates the specified configuration.
void	addConfiguration(String configurationName, Component component, MessageListener listener) Adds a new configuration for this status bar.
boolean	deactivateConfiguration(String configurationName) Deactivates the specified configuration.
JPanel	getConfigurationsPanel() Gets the panel that contains the active configuration panel.
void	receiveMessage(MessageEvent event) Invoked when a message event is received.
void	setStatusText(String text) Sets the specified text to the status bar.
void	startProgressTask(String message, int minimum, int maximum) Starts a task display on the status bar.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIGURATION

public static final String DEFAULT_CONFIGURATION

Name of the default component configuration set to status bar.

See Also:

Constant Field Values

PROGRESS_BAR_CONFIGURATION

public static final String PROGRESS_BAR_CONFIGURATION

Name of the component configuration that displays a label and a progress bar.

See Also:

Constant Field Values

STATUS_LISTENER_NAME

public static final String STATUS_LISTENER_NAME

Name of the message listener used by the status bar to listen for application messages.

See Also:

Constant Field Values

Constructor Detail

IlvStatusBar

public IlvStatusBar()

Constructs a new status bar.

Method Detail

addConfiguration

public void addConfiguration(String configurationName,
                             Component component,
                             MessageListener listener)

Adds a new configuration for this status bar. When the specified configuration is activated, the specified panel is added to the configurations panel.

Parameters:

configurationName - The name of the configuration.

component - The component configuration.

listener - The message listener associated with the specified component. It may change the content of the component when receiving a specific message.

See Also:

getConfigurationsPanel()

activateConfiguration

public boolean activateConfiguration(String configurationName)

Activates the specified configuration. The panel associated with the specified configuration name is added to the configurations panel. The previously active configuration is saved and is restored when the specified configuration is deactivated.

Returns:

true if the specified configuration was previously added to this status bar using the method addConfiguration(java.lang.String, java.awt.Component, ilog.views.appframe.event.MessageListener); false otherwise.

See Also:

deactivateConfiguration(java.lang.String)

deactivateConfiguration

public boolean deactivateConfiguration(String configurationName)

Deactivates the specified configuration.

Returns:

true if the specified configuration has previously been activated with the method activateConfiguration(java.lang.String); false otherwise.

See Also:

activateConfiguration(java.lang.String)

getConfigurationsPanel

public JPanel getConfigurationsPanel()

Gets the panel that contains the active configuration panel.

setStatusText

public void setStatusText(String text)

Sets the specified text to the status bar. A message with the name IlvApplication.STATUS_MESSAGE is sent to the status bar with the specified text as the message parameter.

Parameters:

text - The text to set.

receiveMessage

public void receiveMessage(MessageEvent event)

Invoked when a message event is received.

Specified by:

receiveMessage in interface MessageListener

Parameters:

event - The message event.

See Also:

MessageEvent

startProgressTask

public void startProgressTask(String message,
                              int minimum,
                              int maximum)

Starts a task display on the status bar. A configuration is shown with the message.