icy.gui.frame.progress

Class CancelableProgressFrame

java.lang.Object

icy.gui.frame.IcyFrame

icy.gui.frame.progress.TaskFrame

icy.gui.frame.progress.ProgressFrame

icy.gui.frame.progress.CancelableProgressFrame

All Implemented Interfaces:

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

Direct Known Subclasses:

DownloadFrame, FileFrame

public class CancelableProgressFrame
extends ProgressFrame
implements java.awt.event.ActionListener

Author:

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
CancelableProgressFrame(java.lang.String message)

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
void	cancel() Request cancel and close the frame
boolean	isCancelRequested()
boolean	notifyProgress(double position, double length) Notify progression of the current task
void	onClosed() easy onClosed job
void	setCancelEnabled(boolean enabled)

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

getLength, getMessage, getPosition, incPosition, refresh, run, setLength, setMessage, setPosition, setProgress, setToolTipText

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, 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, 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

CancelableProgressFrame

public CancelableProgressFrame(java.lang.String message)

Parameters:

message -

Method Detail

onClosed

public void onClosed()

Description copied from class: IcyFrame

easy onClosed job

Overrides:

onClosed in class IcyFrame

cancel

public void cancel()

Request cancel and close the frame

isCancelRequested

public boolean isCancelRequested()

Returns:

the cancelRequested

setCancelEnabled

public void setCancelEnabled(boolean enabled)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

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

Overrides:

notifyProgress in class ProgressFrame

Parameters:

position - current position of completion

length - final position of completion

Returns:

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