org.jpedal.io

Class StatusBar

java.lang.Object

org.jpedal.io.StatusBar

public class StatusBar
extends Object

encapsulates a status bar to display progess of a page decode and messages for a GUI client and methods to access it - See org.examples.jpedal.viewer.Viewer for example of usage

Field Summary

Fields

Modifier and Type	Field and Description
float	percentageDone amount done on decode

Constructor Summary

Constructors

Constructor and Description
StatusBar() Initialises statusbar using default colors.
StatusBar(Color newColor) Initialises statusbar using default colors.

Method Summary

Modifier and Type	Method and Description
Component	getStatusObject() Return handle on status bar so it can be displayed.
void	initialiseStatus(String current) Initiate status bar.
boolean	isDone()
boolean	isEnabled()
boolean	isVisible()
void	resetStatus(String current) Reset status bar.
void	setClientDisplay() set client flag to display
void	setEnabled(boolean enable)
void	setProgress(int size) Set progress value (called internally as page decoded).
void	setProgress(String message, int size) set progress value (called internally as page decoded)
void	setVisible(boolean visible)
void	updateStatus(String progress_bar, int debug_level_to_use) Update status if client being used also writes to log (called internally as file decoded).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

percentageDone

public float percentageDone

amount done on decode

Constructor Detail

StatusBar

public StatusBar()

Initialises statusbar using default colors.

StatusBar

public StatusBar(Color newColor)

Initialises statusbar using default colors.

Parameters:

newColor - is of type Color

Method Detail

initialiseStatus

public final void initialiseStatus(String current)

Initiate status bar.

Parameters:

current - is of type String

updateStatus

public final void updateStatus(String progress_bar,
                               int debug_level_to_use)

Update status if client being used also writes to log (called internally as file decoded).

Parameters:

progress_bar - is of type String

debug_level_to_use - is of type int

getStatusObject

public final Component getStatusObject()

Return handle on status bar so it can be displayed.

Returns:

Component

setProgress

public final void setProgress(int size)

Set progress value (called internally as page decoded).

Parameters:

size - is of type int

setProgress

public final void setProgress(String message,
                              int size)

set progress value (called internally as page decoded)

Parameters:

message - The message displayed while the page decoding progresses

size - The size of page decoding progress

resetStatus

public final void resetStatus(String current)

Reset status bar.

Parameters:

current - is of type String

setClientDisplay

public final void setClientDisplay()

set client flag to display

setVisible

public void setVisible(boolean visible)

setEnabled

public void setEnabled(boolean enable)

isVisible

public boolean isVisible()

isEnabled

public boolean isEnabled()

isDone

public boolean isDone()