com.leafdigital.ui.api
Interface Progress

All Superinterfaces:
Widget

public interface Progress
extends Widget

Interface for progress bars


Method Summary
 int getProgress()
           
 int getRange()
           
 boolean isIndeterminate()
           
 void setIndeterminate()
          Puts the progress bar into indeterminate mode.
 void setProgress(int progress)
          Sets progress.
 void setRange(int max)
          Sets the range of the progress bar.
 
Methods inherited from interface com.leafdigital.ui.api.Widget
getID, getOwner, informClosed, isVisible, setOwner, setVisible
 

Method Detail

setRange

void setRange(int max)
Sets the range of the progress bar. Automatically clears progress to zero.

Parameters:
max - Maximum value that corresponds to 100%

getRange

int getRange()
Returns:
Maximum value that corresponds to 100%

setProgress

void setProgress(int progress)
Sets progress.

Parameters:
progress - New progress value

getProgress

int getProgress()
Returns:
Progress toward range

setIndeterminate

void setIndeterminate()
Puts the progress bar into indeterminate mode. Calling setRange turns this off.


isIndeterminate

boolean isIndeterminate()
Returns:
True if bar is indeterminate


Copyright © 2011 Samuel Marshall. All rights reserved.