org.jpedal.io
Class StatusBar

java.lang.Object
  org.jpedal.io.StatusBar

public class StatusBar
extends java.lang.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.simpleviewer.SimpleViewer for example of usage

Field Summary

float

percentageDone amount done on decode

Constructor Summary

StatusBar()
initialises statusbar using default colors

StatusBar(java.awt.Color newColor)
initialises statusbar using specified color

Method Summary

java.awt.Component	getStatusObject() return handle on status bar so it can be displayed
void	initialiseStatus(java.lang.String current) initiate status bar
boolean	isDone()
boolean	isEnabled()
boolean	isVisible()
void	resetStatus(java.lang.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(java.lang.String message, int size) set progress value (called internally as page decoded)
void	setVisible(boolean visible)
void	updateStatus(java.lang.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

equals, 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(java.awt.Color newColor)

initialises statusbar using specified color

Method Detail

initialiseStatus

public final void initialiseStatus(java.lang.String current)

initiate status bar

updateStatus

public final void updateStatus(java.lang.String progress_bar,
                               int debug_level_to_use)

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

getStatusObject

public final java.awt.Component getStatusObject()

return handle on status bar so it can be displayed

setProgress

public final void setProgress(int size)

set progress value (called internally as page decoded)

setProgress

public final void setProgress(java.lang.String message,
                              int size)

set progress value (called internally as page decoded)

resetStatus

public final void resetStatus(java.lang.String current)

reset status bar

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()