Class UIProgress

public class UIProgress extends UIStatus
{
  // Constructors
  public UIProgress();
  public UIProgress(int range);
  public UIProgress(int range, int pos);

  // Methods
  public int getPos();
  public int getRange();
  public int getRoleCode();
  public void paint(FxGraphics g);
  public void setPos(int pos);
  public void setRange(int range);
  public void update(FxGraphics g);
}

This class implements a progress monitoring control.

UIComponent
  |
  +--UIContainer
    |
    +--UIStateContainer
      |
      +--UISingleContainer
        |
        +--UIStatus
          |
          +--UIProgress

Constructors

UIProgress

public UIProgress();

Creates a progress control.

Remarks:

By default, the control has a range from 0 to 100. The control's initial position is set to 0.

UIProgress

public UIProgress(int range);

Creates a progress control with the specified range and an initial position of 0.

Parameter	Description
range	The maximum range value of the control. The control's range is from 0 to range.

UIProgress

public UIProgress(int range, int pos);

Creates a progress control with the specified range and initial position.

Parameter	Description
range	The maximum range value of the control. The control's range is from 0 to range.
pos	The initial position of the progress control.

Methods

getPos

public int getPos();

Retrieves the position of the progress control within its range.

Return Value:

Returns the control's current position.

getRange

public int getRange();

Retrieves the range of the progress control.

Return Value:

Returns the maximum value in the control's range.

getRoleCode

public int getRoleCode();

Retrieves the ROLE_SYSTEM code that best describes the role of the progress control.

Return Value:

Returns the ROLE_SYSTEM_PROGRESSBAR code.

Overrides:

getRoleCode() in UIStatus.

paint

public void paint(FxGraphics g);

Draws the progress control.

Return Value:

No return value.

Parameter	Description
g	The graphics context.

setPos

public void setPos(int pos);

Sets the position of the progress control within its range.

Return Value:

No return value.

Parameter	Description
pos	The new position of the progress control.

setRange

public void setRange(int range);

Sets the range of the progress control.

Parameter	Description
range	The maximum range value of the control. The control's range is from 0 to range.

update

public void update(FxGraphics g);

Calls paint to draw the progress control.

Return Value:

No return value.

Parameter	Description
g	The graphics context.