com.pentec.gui.widgets
Class AProgress

java.lang.Object
  com.pentec.gui.widgets.AProgress

public class AProgress
extends java.lang.Object

This class provides a generic output dialog for progress reporting.

Author:

Pender Technology

Field Summary

boolean	isCanceled Set to true if "Cancel" is pressed
boolean	isTriggered Set to true if "Trigger" is pressed
private javax.swing.JDialog	jd
private javax.swing.JLabel	jlProgress
private javax.swing.JPanel	jpButtons

Constructor Summary

AProgress(javax.swing.JFrame ownerFrame, java.lang.String $WindowTitle, java.lang.String $InitText)
The AProgress constructor sets up the dialog box and action listeners.

AProgress(javax.swing.JFrame ownerFrame, java.lang.String $WindowTitle, java.lang.String $InitText, boolean showCancel)
The AProgress constructor sets up the dialog box and action listeners.

Method Summary

void	addTrigger(java.lang.String $ButtonText) Add a trigger button to the progress dialog box
void	close() Close the progress dialog box
void	removeTrigger() Remove the trigger button from the progress dialog box
private void	sendNetworkTrigger()
void	setText(java.lang.String $NewText) Set the progress text
void	setTitle(java.lang.String $Title) Set the progress window title bar text

Methods inherited from class java.lang.Object

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

Field Detail

isCanceled

public boolean isCanceled

Set to true if "Cancel" is pressed

isTriggered

public boolean isTriggered

Set to true if "Trigger" is pressed

jd

private javax.swing.JDialog jd

jlProgress

private javax.swing.JLabel jlProgress

jpButtons

private javax.swing.JPanel jpButtons

Constructor Detail

AProgress

public AProgress(javax.swing.JFrame ownerFrame,
                 java.lang.String $WindowTitle,
                 java.lang.String $InitText)

The AProgress constructor sets up the dialog box and action listeners.

Parameters:

ownerFrame - the JFrame that owns this method

$WindowTitle - the window title

$InitText - the initial progress text

AProgress

public AProgress(javax.swing.JFrame ownerFrame,
                 java.lang.String $WindowTitle,
                 java.lang.String $InitText,
                 boolean showCancel)

The AProgress constructor sets up the dialog box and action listeners.

Parameters:

ownerFrame - the JFrame that owns this method

$WindowTitle - the window title

$InitText - the initial progress text

showCancel - if true, a Cancel button is added to the dialog

Method Detail

addTrigger

public void addTrigger(java.lang.String $ButtonText)

Add a trigger button to the progress dialog box

Parameters:

$ButtonText - the text to use for the trigger button

close

public void close()

Close the progress dialog box

removeTrigger

public void removeTrigger()

Remove the trigger button from the progress dialog box

sendNetworkTrigger

private void sendNetworkTrigger()

setText

public void setText(java.lang.String $NewText)

Set the progress text

Parameters:

$NewText - the text to set the progress label to

setTitle

public void setTitle(java.lang.String $Title)

Set the progress window title bar text

Parameters:

$Title - the text to set in the window title bar