Class AwtUIProgress

public class AwtUIProgress extends AwtUIControl
{
  // Constructors
  public AwtUIProgress();
  public AwtUIProgress(int range);
  public AwtUIProgress(int range, int pos);

  // Methods
  public IUIComponent getBase();
  public int getPos();
  public int getRange();
  public void setPos(int pos);
  public void setRange(int range);
}

This class implements the functionality of a UIProgress object in an AWT-based control. An AwtUIProgress control is an AwtUIHost component whose associated root container holds a UIProgress object. By hosting this object, an AwtUIProgress control integrates AFC with AWT. Although an AwtUIProgress control is fully compatible with AWT, a UIProgress control is optimized for performance and size.

Panel
  |
  +--AwtUIHost
    |
    +--AwtUIControl
      |
      +--AwtUIProgress

Constructors

AwtUIProgress

public AwtUIProgress();

Creates an AWT-based progress control.

Remarks:

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

AwtUIProgress

public AwtUIProgress(int range);

Creates an AWT-based 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.

AwtUIProgress

public AwtUIProgress(int range, int pos);

Creates an AWT-based 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

getBase

public IUIComponent getBase();

Retrieves the UI component that the control is based on.

Return Value:

Returns the UIProgress object associated with the control.

Remarks:

When the AWT-based control is first created, it is associated with a UIProgress object.

getPos

public int getPos();

Retrieves the current position of the control within its range.

Return Value:

Returns the control's position.

getRange

public int getRange();

Retrieves the range of the control.

Return Value:

Returns the maximum value in the control's range.

setPos

public void setPos(int pos);

Sets the position of the control within its range.

Return Value:

No return value.

Parameter	Description
pos	The new position of the control.

setRange

public void setRange(int range);

Sets the range of the control.

Return Value:

No return value.

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