com.ihr.xbrl.gui.interfaces

Interface DTSLoadingBarInterface

public interface DTSLoadingBarInterface

The Interface DTSLoadingBarInterface.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
void	endProgressSection() inform the bar a section has reach the section end.
float	getValue() Access to the status bar value.
boolean	isVisible() Checks if is visible.
void	popMessage() Restores the last message in the stack.
void	pushMessage() Stores current message in an internal stack so a call to popMessage() can restore it later.
void	setMessage(java.lang.String msg, java.lang.String toolTipText) Sets a new message in the label at the bottom.
void	setStopable(Stopable stopable) Sets the container this loading bar is going to work with.
void	setValue(float value) Value must be a float between 0 and 100 if it is in the range 1-99 then the rolling icon will be visible moving on the right.
void	setVisible(boolean b) Sets the visible.
void	startProgressSection(float max) The setValue(float) method accepts a value between 0 and 100.

Method Detail

setMessage

void setMessage(java.lang.String msg,
                java.lang.String toolTipText)

Sets a new message in the label at the bottom.

Parameters:

msg - String

toolTipText - String

setValue

void setValue(float value)

Value must be a float between 0 and 100 if it is in the range 1-99 then the rolling icon will be visible moving on the right.

Parameters:

value - the new value

isVisible

boolean isVisible()

Checks if is visible.

Returns:

boolean value

setVisible

void setVisible(boolean b)

Sets the visible.

Parameters:

b - boolean value

setStopable

void setStopable(Stopable stopable)

Sets the container this loading bar is going to work with. Setting it to null disables the Stop button. Setting it to not null enables the stop button.

Parameters:

stopable - the new container

getValue

float getValue()

Access to the status bar value. This is a value between 0 and 100

Returns:

integer

startProgressSection

void startProgressSection(float max)

The setValue(float) method accepts a value between 0 and 100. This method creates a section that will transform the values sent to setValue(float) into values that covers the section size.

When the section is finished, a call to endProgressSection() is required in order to remove internal section value mappings.

Multiple nested calls to startProgressSection(float) are allowed. They divide current section into smaller sub-sections.

Paired calls to startProgressSection(float) and endProgressSection() belongs to the same level. The sum of all section sizes at the same level shall be equal to 100.

Parameters:

max - the max

See Also:

setValue(float), endProgressSection()

endProgressSection

void endProgressSection()

inform the bar a section has reach the section end.

See Also:

startProgressSection(float)

pushMessage

void pushMessage()

Stores current message in an internal stack so a call to popMessage() can restore it later.

popMessage

void popMessage()

Restores the last message in the stack.

See Also:

pushMessage()