|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
jsky.util.gui.ProgressPanel
public class ProgressPanel
A panel to display while a download or other background operation is in progress.
This class is designed to be usable from any threadand all GUI access is done synchronously in the event dispatching thread.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JPanel |
---|
JPanel.AccessibleJPanel |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
---|---|
protected JLabel |
iconLabel
Displays the active GIF icon |
protected boolean |
interrupted
Set to true if the stop button was pressed |
protected ProgressBarFilterInputStream |
loggedInputStream
If set, this is the current input stream being monitored |
protected static ProgressPanel |
newPanel
Used to create a new progress panel in the event dispatching thread |
protected Component |
parent
Parent of this window (frame or internal frame), used to close the window |
protected StatusPanel |
statusPanel
Displays the progress bar and status text |
protected JButton |
stopButton
Button to interrupt the task |
protected String |
title
The title string |
protected JLabel |
titleLabel
Displays the title |
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
ProgressPanel()
Default constructor |
|
ProgressPanel(Component parent,
String title)
Initialize a progress panel with the given title string. |
Method Summary | |
---|---|
void |
actionPerformed(ActionEvent e)
Called when the Stop button is pressed. |
void |
addActionListener(ActionListener l)
Add a listener to be called when the user presses the stop button. |
ProgressBarFilterInputStream |
getLoggedInputStream(InputStream in,
int size)
Return a input stream that will generate log messages showing the progress of the read from the given stream. |
ProgressBarFilterInputStream |
getLoggedInputStream(URL url)
Return an input stream to use for reading from the given URL that will generate log messages showing the progress of the read. |
StatusPanel |
getStatusPanel()
Return the status panel (displays the progress bar and text field). |
protected void |
init()
Initialize the progreass panel. |
protected static void |
invokeAndWait(Runnable r)
Run the given Runnable synchronously in the event dispatching thread. |
boolean |
isInterrupted()
Return true if the stop button was pressed |
void |
logMessage(String msg)
Log or display the given message |
static ProgressPanel |
makeProgressPanel()
Make a ProgressPanel and frame (or internal frame) and return the panel. |
static ProgressPanel |
makeProgressPanel(String title)
Make a ProgressPanel and frame (or internal frame) and return the panel. |
static ProgressPanel |
makeProgressPanel(String title,
Component window)
Make a ProgressPanel and frame (or internal frame) and return the panel. |
URLConnection |
openConnection(URL url)
Return a connection to the given URL and log messages before and after opening the connection. |
void |
setParent(Component parent)
Set the parent frame or internal frame, used to close the window |
void |
setProgress(int percent)
Set the percent done. |
void |
setText(String s)
Set the status text to display. |
void |
setTitle(String title)
Set the title string. |
void |
start()
Display the progress panel. |
void |
stop()
Stop displaying the progress panel. |
void |
stopLoggingInputStream(ProgressBarFilterInputStream in)
Stop logging reads from the input stream returned from an earlier call to getLoggedInputStream(). |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected Component parent
protected String title
protected JLabel titleLabel
protected JLabel iconLabel
protected JButton stopButton
protected StatusPanel statusPanel
protected ProgressBarFilterInputStream loggedInputStream
protected boolean interrupted
protected static ProgressPanel newPanel
Constructor Detail |
---|
public ProgressPanel(Component parent, String title)
parent
- the parent frame or internal frame, used to close the windowthe
- title stringpublic ProgressPanel()
Method Detail |
---|
protected void init()
protected static void invokeAndWait(Runnable r)
public void setParent(Component parent)
public void setTitle(String title)
public void logMessage(String msg)
logMessage
in interface StatusLogger
public void setText(String s)
public void addActionListener(ActionListener l)
public StatusPanel getStatusPanel()
public void actionPerformed(ActionEvent e)
actionPerformed
in interface ActionListener
public boolean isInterrupted()
public URLConnection openConnection(URL url) throws IOException
openConnection
in interface StatusLogger
IOException
public void start()
public void stop()
public static ProgressPanel makeProgressPanel(String title, Component window)
title
- the title stringwindow
- window to display the dialog over, may be nullpublic static ProgressPanel makeProgressPanel(String title)
title
- the title stringpublic static ProgressPanel makeProgressPanel()
the
- title stringpublic void setProgress(int percent)
setProgress
in interface StatusLogger
public ProgressBarFilterInputStream getLoggedInputStream(InputStream in, int size) throws IOException
getLoggedInputStream
in interface StatusLogger
in
- the input stream to be monitoredsize
- the size in bytes of the date to be read, or 0 if not known
IOException
public ProgressBarFilterInputStream getLoggedInputStream(URL url) throws IOException
getLoggedInputStream
in interface StatusLogger
url
- the URL to read
IOException
public void stopLoggingInputStream(ProgressBarFilterInputStream in) throws IOException
stopLoggingInputStream
in interface StatusLogger
in
- an input stream returned from getLoggedInputStream()
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |