icy.gui.frame.progress

Class ProgressFrame

java.lang.Object

icy.gui.frame.IcyFrame

icy.gui.frame.progress.TaskFrame

icy.gui.frame.progress.ProgressFrame

All Implemented Interfaces:

ProgressListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.beans.PropertyChangeListener, java.lang.Runnable, java.util.EventListener, javax.swing.event.InternalFrameListener

Direct Known Subclasses:

CancelableProgressFrame

public class ProgressFrame
extends TaskFrame
implements ProgressListener, java.lang.Runnable

A progress TaskFrame (thread safe)

Author:

fab & stephane

Nested Class Summary

Nested classes/interfaces inherited from class icy.gui.frame.IcyFrame

IcyFrame.IcyFrameState

Field Summary

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ProgressFrame(java.lang.String message) internals

Method Summary

Methods

Modifier and Type	Method and Description
double	getLength()
java.lang.String	getMessage()
double	getPosition()
void	incPosition() increment progress position
boolean	notifyProgress(double position, double length) Notify progression of the current task
void	refresh()
void	run()
void	setLength(double value)
void	setMessage(java.lang.String value)
void	setPosition(double value)
void	setProgress(int value) Deprecated. use setPosition(double) instead
void	setToolTipText(java.lang.String value) Implement setToolTipText method (only for internalized frame)

Methods inherited from class icy.gui.frame.progress.TaskFrame

canRemove, close, internalClose, isCanBeRemoved, stateChanged

Methods inherited from class icy.gui.frame.IcyFrame

add, add, add, addComponentListener, addFrameListener, addKeyListener, addTo, addTo, addTo, addToDesktopPane, addToDesktopPane, addToMainDesktopPane, attach, center, detach, dispose, externalize, findIcyFrame, frameClosed, getActionMap, getAllFrames, getAllFrames, getBorder, getBounds, getBoundsExternal, getBoundsInternal, getContentPane, getDefaultSystemMenu, getExternalFrame, getFrame, getHeight, getHeightExternal, getHeightInternal, getIcyExternalFrame, getIcyInternalFrame, getInputMap, getInternalFrame, getJMenuBar, getLocation, getLocationExternal, getLocationInternal, getMaximumSize, getMaximumSizeExternal, getMaximumSizeInternal, getMinimumSize, getMinimumSizeExternal, getMinimumSizeInternal, getMousePosition, getParent, getPreferredSize, getPreferredSizeExternal, getPreferredSizeInternal, getRootPane, getSize, getSizeExternal, getSizeInternal, getSwitchStateAction, getSystemMenuCallback, getTitle, getTitleBarVisible, getToolkit, getVisibleRect, getWidth, getWidthExternal, getWidthInternal, getX, getXExternal, getXInternal, getY, getYExternal, getYInternal, hasFocus, imageUpdate, internalFrameActivated, internalFrameClosed, internalFrameClosing, internalFrameDeactivated, internalFrameDeiconified, internalFrameIconified, internalFrameOpened, internalize, isActive, isAlwaysOnTop, isClosable, isExternalized, isInternalized, isMaximized, isMaximizedExternal, isMaximizedInternal, isMinimized, isMinimizedExternal, isMinimizedInternal, isResizable, isSwitchStateItemVisible, isSyncProcess, isVisible, onClosed, pack, propertyChange, remove, removeAll, removeComponentListener, removeFrameListener, removeFrom, removeFromMainDesktopPane, removeKeyListener, repaint, requestFocus, revalidate, setAlwaysOnTop, setBackground, setBorder, setBounds, setClosable, setContentPane, setDefaultCloseOperation, setFocusable, setForeground, setJMenuBar, setLayout, setLocation, setLocation, setLocationExternal, setLocationExternal, setLocationInternal, setLocationInternal, setMaximisable, setMaximized, setMaximizedExternal, setMaximizedInternal, setMaximumSize, setMaximumSizeExternal, setMaximumSizeInternal, setMinimized, setMinimizedExternal, setMinimizedInternal, setMinimumSize, setMinimumSizeExternal, setMinimumSizeInternal, setPreferredSize, setPreferredSizeExternal, setPreferredSizeInternal, setResizable, setSize, setSize, setSizeExternal, setSizeExternal, setSizeInternal, setSizeInternal, setSwitchStateItemVisible, setSyncProcess, setSystemMenuCallback, setTitle, setTitleBarVisible, setVisible, switchState, toBack, toFront, updateSystemMenu, updateUI, validate, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressFrame

public ProgressFrame(java.lang.String message)

internals

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

refresh

public void refresh()

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String value)

setToolTipText

public void setToolTipText(java.lang.String value)

Description copied from class: IcyFrame

Implement setToolTipText method (only for internalized frame)

Overrides:

setToolTipText in class IcyFrame

getLength

public double getLength()

Returns:

the length

setLength

public void setLength(double value)

Parameters:

value - the length to set

getPosition

public double getPosition()

Returns:

the position

incPosition

public void incPosition()

increment progress position

setPosition

public void setPosition(double value)

Parameters:

value - the position to set

setProgress

@Deprecated
public void setProgress(int value)

Deprecated. use setPosition(double) instead

notifyProgress

public boolean notifyProgress(double position,
                     double length)

Description copied from interface: ProgressListener

Notify progression of the current task

Specified by:

notifyProgress in interface ProgressListener

Parameters:

position - current position of completion

length - final position of completion

Returns:

false if the cancellation of the task has been requested, true otherwise