Package org.gvsig.utils.swing.threads

Class UndefinedProgressMonitor

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.gvsig.utils.swing.threads.UndefinedProgressMonitor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, IProgressMonitorIF

public class UndefinedProgressMonitor
extends JDialog
implements IProgressMonitorIF

Dialog that shows the evolution of the execution of a ITask. If this ITask is a defined task (we know the number of steps it must do) it shows a progress bar. If it doesnt, progress bar is filling and emptying

Author:

azabala

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
UndefinedProgressMonitor()	This is the default constructor
UndefinedProgressMonitor(Frame parent, String title)	Constructor which specify the dialog title (for example:processing, etc)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Sends cancel message to monitored task.
void	close()	Closes associated GUI component
int	getCurrentStep()
int	getInitialStep()
int	getLastStep()
boolean	isCanceled()	Returns if has received cancel message
boolean	isIndeterminated()
void	open()	Sets associated gui component visible
void	setBarString(String barString)	Sets complementary text to progress bar.
void	setBarStringDrawed(boolean stringDrawed)	Sets if the progress bar associated to monitor must draw a complementary text to progress bar
void	setCurrentStep(int step)	sets current step number of the task monitored
void	setIndeterminated(boolean indeterminated)	Sets if the monitored task is defined (known number of steps) or undefined (unknown)
void	setInitialStep(int step)	sets initial step number of the task monitored
void	setLastStep(int step)	sets final step number of the task monitored
void	setMainTitleLabel(String text)	Set main text of GUI component
void	setNote(String note)

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

UndefinedProgressMonitor

public UndefinedProgressMonitor()

This is the default constructor

UndefinedProgressMonitor

public UndefinedProgressMonitor(Frame parent,
 String title)

Constructor which specify the dialog title (for example:processing, etc)

Parameters:

parent -

title -

Method Details

setInitialStep

public void setInitialStep(int step)

Description copied from interface: IProgressMonitorIF

sets initial step number of the task monitored

Specified by:

setInitialStep in interface IProgressMonitorIF

Parameters:

step -

setLastStep

public void setLastStep(int step)

Description copied from interface: IProgressMonitorIF

sets final step number of the task monitored

Specified by:

setLastStep in interface IProgressMonitorIF

Parameters:

step -

setCurrentStep

public void setCurrentStep(int step)

Description copied from interface: IProgressMonitorIF

sets current step number of the task monitored

Specified by:

setCurrentStep in interface IProgressMonitorIF

Parameters:

step -

getInitialStep

public int getInitialStep()

Specified by:

getInitialStep in interface IProgressMonitorIF

getLastStep

public int getLastStep()

Specified by:

getLastStep in interface IProgressMonitorIF

getCurrentStep

public int getCurrentStep()

Specified by:

getCurrentStep in interface IProgressMonitorIF

setIndeterminated

public void setIndeterminated(boolean indeterminated)

Description copied from interface: IProgressMonitorIF

Sets if the monitored task is defined (known number of steps) or undefined (unknown)

Specified by:

setIndeterminated in interface IProgressMonitorIF

Parameters:

indeterminated -

isIndeterminated

public boolean isIndeterminated()

Specified by:

isIndeterminated in interface IProgressMonitorIF

setBarStringDrawed

public void setBarStringDrawed(boolean stringDrawed)

Description copied from interface: IProgressMonitorIF

Sets if the progress bar associated to monitor must draw a complementary text to progress bar

Specified by:

setBarStringDrawed in interface IProgressMonitorIF

Parameters:

stringDrawed -

setBarString

public void setBarString(String barString)

Description copied from interface: IProgressMonitorIF

Sets complementary text to progress bar.

Specified by:

setBarString in interface IProgressMonitorIF

Parameters:

barString -

setMainTitleLabel

public void setMainTitleLabel(String text)

Description copied from interface: IProgressMonitorIF

Set main text of GUI component

Specified by:

setMainTitleLabel in interface IProgressMonitorIF

Parameters:

text -

setNote

public void setNote(String note)

Specified by:

setNote in interface IProgressMonitorIF

cancel

public void cancel()

Description copied from interface: IProgressMonitorIF

Sends cancel message to monitored task.

Specified by:

cancel in interface IProgressMonitorIF

isCanceled

public boolean isCanceled()

Description copied from interface: IProgressMonitorIF

Returns if has received cancel message

Specified by:

isCanceled in interface IProgressMonitorIF

Returns:

close

public void close()

Description copied from interface: IProgressMonitorIF

Closes associated GUI component

Specified by:

close in interface IProgressMonitorIF

open

public void open()

Description copied from interface: IProgressMonitorIF

Sets associated gui component visible

Specified by:

open in interface IProgressMonitorIF