net.sf.jguiraffe.gui.builder.components.model

Interface ProgressBarHandler

All Superinterfaces:

ComponentHandler<Integer>

public interface ProgressBarHandler
extends ComponentHandler<Integer>

A specialized component handler that represents a progress bar component.

The most important property of a progress bar is its current value. This is an integer value indicating the progress of the operation that is visualized by the bar. It is also possible to set a text value, which will be displayed in front of the progress bar (as far as the used GUI library supports this feature). A text will only be displayed if support for texts was enabled when the progress bar component was created.

Version:

$Id: ProgressBarHandler.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

Method Summary

Modifier and Type	Method and Description
String	getProgressText() Returns the text of the progress bar.
int	getValue() Returns the current value of the progress bar.
void	setProgressText(String s) Sets the text of the progress bar.
void	setValue(int v) Sets the current value of the progress bar.

Methods inherited from interface net.sf.jguiraffe.gui.forms.ComponentHandler

getComponent, getData, getOuterComponent, getType, isEnabled, setData, setEnabled

Method Detail

getValue

int getValue()

Returns the current value of the progress bar.

Returns:

the current value

setValue

void setValue(int v)

Sets the current value of the progress bar. This value will determine the length of the bar. It should be between the minimum and the maximum value defined during creation of the component.

Parameters:

v - the current value

getProgressText

String getProgressText()

Returns the text of the progress bar.

Returns:

the current progress text

setProgressText

void setProgressText(String s)

Sets the text of the progress bar. This text will be displayed in front of the progress bar if this allowed.

Parameters:

s - the progress text