Class marimba.gui.ProgressIndicatorWidget
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class marimba.gui.ProgressIndicatorWidget

java.lang.Object
   |
   +----marimba.gui.Widget
           |
           +----marimba.gui.ValueWidget
                   |
                   +----marimba.gui.ProgressIndicatorWidget

public class ProgressIndicatorWidget
extends ValueWidget
A progress indicator widget. A progress indicator can be used to show the percentage of completion of a lengthy operation. It consists of a rectangular bar that 'fills' from left to right.
Version:
1.18, 01/08/97
Author:
Klaas Waslander

Variable Index

 o barColor
The color of the bar.
 o blockMode
The progress indicator can use blocks to indicate the progress.
 o blockWidth
When blockMode is used, this determines the width of the blocks.
 o filled
A progress indicator can be filled.
 o showPercent
A progress indicator can show its percentage in the middle.

Constructor Index

 o ProgressIndicatorWidget()
Constructor.
 o ProgressIndicatorWidget(int, int, int)
Constructor; sets minValue, maxValue and value.

Method Index

 o getBarColor()
Get the color of the bar.
 o getBlockMode()
Check whether the progress indicator uses blocks.
 o getBlockWidth()
Get the width of the blocks.
 o getPercentage()
Get the current percentage of the progress indicator.
 o getProperties(PropertyList)
Get the properties of the ProgressIndicatorWidget.
 o getStringPercentage()
Get the current percentage as a string, for example "50%".
 o isFilled()
Check whether the progress indicator is filled.
 o paint(Graphics)
Paint the progress indicator.
 o paramString(StringBuffer)
Debugging.
 o repaintFor(int, int, int)
Assumes the given values are valid.
 o setBarColor(Color)
Set the color of the bar.
 o setBlockMode(boolean)
Let the progress indicator use blocks or not.
 o setBlockWidth(int)
Set the width of the blocks to a certain no.
 o setFilled(boolean)
Let the progress indicator fill itself or not.
 o setProperties(PropertyList)
Set the properties of the ProgressIndicatorWidget.
 o showPercent(boolean)
Let the progress indicator show its percentage or not.
 o showsPercent()
Check whether the progress indicator shows its pecentage
 o squareBlockWidth()
Determine the width of the blocks to let them be as square as possible.
 o valueToPixels(int)
The value translated into pixels.

Variables

 o blockMode
  public boolean blockMode
The progress indicator can use blocks to indicate the progress.
See Also:
getBlockMode, setBlockMode
 o blockWidth
  public int blockWidth
When blockMode is used, this determines the width of the blocks. If the blockWidth is zero, the blocks are painted as square as possible, using the method squareBlockWidth().
See Also:
getBlockWidth, setBlockWidth, squareBlockWidth
 o barColor
  public Color barColor
The color of the bar.
See Also:
getBarColor, setBarColor
 o showPercent
  public boolean showPercent
A progress indicator can show its percentage in the middle.
See Also:
getPercentage, setPercentage
 o filled
  public boolean filled
A progress indicator can be filled.
See Also:
isFilled, setFilled

Constructors

 o ProgressIndicatorWidget
  public ProgressIndicatorWidget()
Constructor.
 o ProgressIndicatorWidget
  public ProgressIndicatorWidget(int min,
                                 int max,
                                 int val)
Constructor; sets minValue, maxValue and value.

Methods

 o getProperties
  public void getProperties(PropertyList list)
Get the properties of the ProgressIndicatorWidget.
Overrides:
getProperties in class ValueWidget
 o setProperties
  public void setProperties(PropertyList list)
Set the properties of the ProgressIndicatorWidget.
Overrides:
setProperties in class ValueWidget
 o isFilled
  public boolean isFilled()
Check whether the progress indicator is filled.
See Also:
filled
 o setFilled
  public void setFilled(boolean filled)
Let the progress indicator fill itself or not.
See Also:
filled
 o getBlockMode
  public boolean getBlockMode()
Check whether the progress indicator uses blocks.
Returns:
true when blocks are being used, false otherwise.
See Also:
blockMode
 o setBlockMode
  public void setBlockMode(boolean blockMode)
Let the progress indicator use blocks or not.
See Also:
blockMode
 o getBlockWidth
  public int getBlockWidth()
Get the width of the blocks.
See Also:
blockWidth
 o setBlockWidth
  public void setBlockWidth(int blockWidth)
Set the width of the blocks to a certain no. of pixels. The width is not changed when the given blockwidth is less then zero.
See Also:
blockWidth
 o getBarColor
  public Color getBarColor()
Get the color of the bar.
See Also:
barColor
 o setBarColor
  public void setBarColor(Color barColor)
Set the color of the bar. If the passed color is null, the barColor is set to the default.
See Also:
barColor
 o showsPercent
  public boolean showsPercent()
Check whether the progress indicator shows its pecentage
See Also:
showPercent
 o showPercent
  public void showPercent(boolean showPercent)
Let the progress indicator show its percentage or not.
See Also:
showPercent
 o getPercentage
  public int getPercentage()
Get the current percentage of the progress indicator.
See Also:
getStringPercentage, showPercent
 o getStringPercentage
  public String getStringPercentage()
Get the current percentage as a string, for example "50%".
See Also:
getPercentage, showPercent
 o squareBlockWidth
  public int squareBlockWidth()
Determine the width of the blocks to let them be as square as possible.
See Also:
blockWidth
 o valueToPixels
  public int valueToPixels(int value)
The value translated into pixels.
 o repaintFor
  protected boolean repaintFor(int newValue,
                               int newMin,
                               int newMax)
Assumes the given values are valid. Checks whether these values would result in a new look that requires a repaint.
Overrides:
repaintFor in class ValueWidget
 o paint
  public void paint(Graphics g)
Paint the progress indicator.
Overrides:
paint in class Widget
 o paramString
  public void paramString(StringBuffer buf)
Debugging.
Overrides:
paramString in class ValueWidget

All Packages  Class Hierarchy  This Package  Previous  Next  Index