com.ontimize.dms.client
Class ODMSStatusBar

java.lang.Object
  com.ontimize.gui.MainApplication.StatusBar
      com.ontimize.dms.client.ODMSStatusBar

public class ODMSStatusBar
extends com.ontimize.gui.MainApplication.StatusBar

Field Summary

protected javax.swing.JPanel	iconPanel
protected int	lastPaintPosition
protected javax.swing.JProgressBar	progressBar
protected javax.swing.JLabel	statusText
protected TransferStatusPanel	transferStatusPanel

Constructor Summary

ODMSStatusBar()

Method Summary

void	addMouseListenerToStatusIcon(java.lang.String iconId, java.awt.event.MouseListener mouseListener) Registers a mouse listener to the specified icon
void	addStatusIcon(java.lang.String iconId, javax.swing.ImageIcon icon) Adds a icon to the right in the status bar.
javax.swing.JLabel	getIconLabel(java.lang.String iconId) Returns the JLabel used to show the icon referenced by IconId
double	getPercentComplete() Returns the complete percentage shown in the progress bar.
TransferStatusPanel	getTransferStatusPanel()
void	removeMouseListenerFromStatusIcon(java.lang.String iconId, java.awt.event.MouseListener mouseListener) Removes a mouse listener from an status icon
void	removeStatusIcon(java.lang.String iconId) Remove the icon with the specified identifier
void	setProgressMaximum(int maxProgress) Sets the maximum progress bar value.
void	setProgressPosition(int position) Sets the current progress bar position and paints it immediately.
void	setProgressPosition(int position, boolean paintImmediately) Sets the current progress bar position.
void	setProgressText(java.lang.String text) Sets the progress text, usually to show the operations that are being performed.
void	setStatusIconToolTip(java.lang.String iconId, java.lang.String toolTip) Sets the tip text for the icon identified by 'iconId'
void	setStatusText(java.lang.String text) Sets the text to show in the status bar.

Methods inherited from class java.lang.Object

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

Field Detail

lastPaintPosition

protected int lastPaintPosition

iconPanel

protected javax.swing.JPanel iconPanel

statusText

protected javax.swing.JLabel statusText

progressBar

protected javax.swing.JProgressBar progressBar

transferStatusPanel

protected TransferStatusPanel transferStatusPanel

Constructor Detail

ODMSStatusBar

public ODMSStatusBar()

Method Detail

getTransferStatusPanel

public TransferStatusPanel getTransferStatusPanel()

setStatusIconToolTip

public void setStatusIconToolTip(java.lang.String iconId,
                                 java.lang.String toolTip)

Sets the tip text for the icon identified by 'iconId'

Parameters:

iconId - icon identifier

toolTip - tooltip text to show

addMouseListenerToStatusIcon

public void addMouseListenerToStatusIcon(java.lang.String iconId,
                                         java.awt.event.MouseListener mouseListener)

Registers a mouse listener to the specified icon

Parameters:

iconId - the icon identifier

mouseListener - the mouse listener

removeMouseListenerFromStatusIcon

public void removeMouseListenerFromStatusIcon(java.lang.String iconId,
                                              java.awt.event.MouseListener mouseListener)

Removes a mouse listener from an status icon

Parameters:

iconId - the icon identifier

mouseListener -

getIconLabel

public javax.swing.JLabel getIconLabel(java.lang.String iconId)

Returns the JLabel used to show the icon referenced by IconId

Parameters:

iconId - the icon identifier

Returns:

the JLabel related to the identified icon or null in case the icon can-t be found

addStatusIcon

public void addStatusIcon(java.lang.String iconId,
                          javax.swing.ImageIcon icon)

Adds a icon to the right in the status bar. The parameter iconId is the icon identifier. If an icon with this identifier already exists then this icon is replaced with the new one

Parameters:

iconId -

icon -

removeStatusIcon

public void removeStatusIcon(java.lang.String iconId)

Remove the icon with the specified identifier

Parameters:

iconId - Icon identifier

setStatusText

public void setStatusText(java.lang.String text)

Sets the text to show in the status bar.

Parameters:

text - the text to show or null in case the current text must be removed

setProgressText

public void setProgressText(java.lang.String text)

Sets the progress text, usually to show the operations that are being performed.

Parameters:

text -

getPercentComplete

public double getPercentComplete()

Returns the complete percentage shown in the progress bar.

Returns:

the progress bar percentage complete

setProgressMaximum

public void setProgressMaximum(int maxProgress)

Sets the maximum progress bar value.

Parameters:

maxProgress - the maximum progress bar value

setProgressPosition

public void setProgressPosition(int position)

Sets the current progress bar position and paints it immediately.

Parameters:

position -

setProgressPosition

public void setProgressPosition(int position,
                                boolean paintImmediately)

Sets the current progress bar position.

Parameters:

position -

paintImmediately - if true the progress bar will be repainted immediately