org.kepler.monitor.figure

Class ProgressBarFigure

java.lang.Object

diva.canvas.AbstractFigure

diva.canvas.AbstractFigureContainer

diva.canvas.CompositeFigure

org.kepler.monitor.figure.BaseFigure

org.kepler.monitor.figure.ProgressBarFigure

All Implemented Interfaces:

diva.canvas.CanvasComponent, diva.canvas.Figure, diva.canvas.FigureContainer, diva.canvas.FigureSet, diva.canvas.VisibleComponent, diva.util.UserObjectContainer

public class ProgressBarFigure
extends BaseFigure

A "progress bar" monitor figure. This figure has some similar functionality as that of JProgressBar.

By default, the progress bar will be indeterminate. In this case, an animation is set up to show a bouncing box within the given displayable area.

Author:

Carlos Rueda

See Also:

ActorWithProgressBar

Nested Class Summary

Nested classes/interfaces inherited from class org.kepler.monitor.figure.BaseFigure

BaseFigure.Orientation

Field Summary

Fields inherited from class org.kepler.monitor.figure.BaseFigure

_lastUpdate, _orientation, _shape, isDebugging, log

Constructor Summary

Constructors

Constructor and Description
ProgressBarFigure(java.awt.geom.RectangularShape shape) Creates an horizontal and indeterminate progress bar figure.

Method Summary

Modifier and Type	Method and Description
protected void	_update() Updates the appearance of this progress bar.
java.awt.Color	getBackgroundColor()
int	getCurrentValue() Gets the current value associated for a determinate progress bar.
java.awt.Color	getForegroundColor()
int	getMaximum() Gets the maximum value in the range associated for a determinate progress bar.
int	getMinimum() Gets the minimum value in the range associated for a determinate progress bar.
boolean	isIndeterminate() Tells if this progress bar is indeterminate.
void	setBackgroundColor(java.awt.Color backgroundColor)
void	setForegroundColor(java.awt.Color foregroundColor)
void	setIndeterminate(boolean indeterminate) Set the indeterminate flag of this progress bar figure.
void	setMaximum(int n) Sets the maximum value, which is meaningful only for a determinate progress bar.
void	setMinimum(int n) Sets the minimum value, which is meaningful only for a determinate progress bar.
void	setOrientation(BaseFigure.Orientation orientation) Sets the orientation and calls BaseFigure.update() if the orientation changes.
void	setShape(java.awt.geom.RectangularShape shape) Sets the rectangular shape for this figure.
void	setStarted(boolean started)
void	setValue(int n) Sets the current value, which is meaningful only for a determinate progress bar.

Methods inherited from class org.kepler.monitor.figure.BaseFigure

getOrientation, update

Methods inherited from class diva.canvas.CompositeFigure

add, add, contains, figures, figuresFromBack, figuresFromFront, get, getBackgroundFigure, getBounds, getChildren, getFigureCount, getOrigin, getShape, getTransformContext, indexOf, intersects, invalidateCachedBounds, paint, paint, pick, pick, remove, remove, repaint, replaceChild, setBackgroundFigure, setIndex, toString, transform, translate

Methods inherited from class diva.canvas.AbstractFigureContainer

decorate, undecorate

Methods inherited from class diva.canvas.AbstractFigure

contains, getInteractor, getLayer, getParent, getToolTipText, getUserObject, hit, isVisible, repaint, setInteractor, setParent, setToolTipText, setUserObject, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface diva.canvas.VisibleComponent

isVisible, setVisible

Methods inherited from interface diva.canvas.CanvasComponent

getParent, repaint

Constructor Detail

ProgressBarFigure

public ProgressBarFigure(java.awt.geom.RectangularShape shape)

Creates an horizontal and indeterminate progress bar figure.

Parameters:

shape - Rectangular shape for the progress bar.

Method Detail

setOrientation

public void setOrientation(BaseFigure.Orientation orientation)

Sets the orientation and calls BaseFigure.update() if the orientation changes.

Overrides:

setOrientation in class BaseFigure

Parameters:

orientation - the orientation.

setIndeterminate

public void setIndeterminate(boolean indeterminate)

Set the indeterminate flag of this progress bar figure.

Parameters:

indeterminate - true for indeterminate, false for determinate.

setMaximum

public void setMaximum(int n)

Sets the maximum value, which is meaningful only for a determinate progress bar.

Parameters:

n - the maximum value.

setMinimum

public void setMinimum(int n)

Sets the minimum value, which is meaningful only for a determinate progress bar.

Parameters:

n - the minimum value.

setValue

public void setValue(int n)

Sets the current value, which is meaningful only for a determinate progress bar.

Parameters:

n - the current value.

isIndeterminate

public boolean isIndeterminate()

Tells if this progress bar is indeterminate.

Returns:

true iff this progress bar is indeterminate.

getCurrentValue

public int getCurrentValue()

Gets the current value associated for a determinate progress bar.

Returns:

current value.

getMaximum

public int getMaximum()

Gets the maximum value in the range associated for a determinate progress bar.

Returns:

maximum value in range.

getMinimum

public int getMinimum()

Gets the minimum value in the range associated for a determinate progress bar.

Returns:

minimum value in range.

getBackgroundColor

public java.awt.Color getBackgroundColor()

Returns:

the backgroundColor

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)

Parameters:

backgroundColor - the backgroundColor to set

getForegroundColor

public java.awt.Color getForegroundColor()

Returns:

the foregroundColor

setForegroundColor

public void setForegroundColor(java.awt.Color foregroundColor)

Parameters:

foregroundColor - the foregroundColor to set

setShape

public void setShape(java.awt.geom.RectangularShape shape)

Sets the rectangular shape for this figure.

Parameters:

shape -

setStarted

public void setStarted(boolean started)

_update

protected void _update()

Updates the appearance of this progress bar.

Specified by:

_update in class BaseFigure