com.lf.commons.dialog

Class DownloadDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.lf.commons.dialog.DownloadDialog

All Implemented Interfaces:

ConfigurableUnit, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class DownloadDialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener, ConfigurableUnit

Select URLs to be downloaded.

Since:

1.6

Version:

$Revision: 1.24 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTON_CANCEL Represents the CANCEL button.
static int	BUTTON_OK Represents the OK button.
protected java.lang.Runnable	checker Instance to check the network resources.
protected int	exitbutton Code of the pressed button, -1 = not exited.
protected java.lang.String	helpID Identifier to call the help system (optional).
protected javax.swing.tree.DefaultTreeModel	model Model of the URL list.
protected java.awt.event.HierarchyBoundsListener	resizeListener Displays the dimension if resized.
protected java.lang.Class[]	tableClasses Column name.
protected java.lang.String[]	tableColumns Column name.
protected java.lang.Object[][]	tableData List of URLs currently displayed by the list.
protected TypeProvider	typeProvider Helper to get file types, icons etc.

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 javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
DownloadDialog() Constructor method for the dialog (modeless).
DownloadDialog(java.awt.Dialog owner) Constructor method for the dialog.
DownloadDialog(java.awt.Frame owner) Constructor method for the dialog.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Reacts on component interaction.
void	addToList(org.apache.commons.vfs2.FileObject url, boolean selected) Adds the given URL to the list.
void	allowEscapeOnKeyStroke(int strokeval) Adds a keyboard action to escape (close) the dialog (e.g. on escape).
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
static DownloadDialog	createDefaultDialog(java.awt.Component comp, java.lang.String title, java.lang.String bordertitle) Convenience method to create a preconfigured dialog instance.
int	execute() Shows the dialog on the screen and returns the code of the pressed button.
javax.swing.JButton	getButtonCancel() Provides the cancel button.
javax.swing.JButton	getButtonOK() Provides the OK button.
int	getExitCode() Provides the exit code.
int	getItemCount() Provides the number of items shown by the list.
org.apache.commons.vfs2.FileObject[]	getSelectedURLs() Provides the list of selected URLs.
StatusBar	getStatusBar() Provides the status bar.
javax.swing.JTable	getTable() Provides the table.
boolean	isFlagSelected() Provides the state of the optional flag shown at the bottom of the dialog.
boolean	isURLSelected(org.apache.commons.vfs2.FileObject item) Checks if the given URL is selected or not.
void	setBorderTitle(java.lang.String title) Sets the title displayed by the titled border.
void	setEnabledURLs(org.apache.commons.vfs2.FileObject[] selection) Sets the selected URLs.
void	setFlagSelected(boolean enable) Sets the state of the optional flag shown at the bottom of the dialog.
void	setFlagText(java.lang.String text, boolean selected) Sets the text of the optional flag shown at the bottom of the dialog.
void	setHelpID(java.lang.String helpid) Sets the optional help link to call the help system.
void	setTypeProvider(TypeProvider provider) Sets the helper providing the URL types.
void	setURLCandidates(java.lang.String[] candidates, boolean selected) Sets the list of URLs to be displayed.
void	setURLChecker(java.lang.Runnable checker) Sets an object responsible for setting the candidate URLs.
void	setURLs(org.apache.commons.vfs2.FileObject[] urls, boolean selected) Sets the list of URL to be displayed.
void	setVisible(boolean visible) Activates or deactivates the dialog.
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.
protected void	updateButtons() Refreshes the button states.

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, 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, getPeer, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, 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

Field Detail

BUTTON_OK

public static final int BUTTON_OK

Represents the OK button.

See Also:

Constant Field Values

BUTTON_CANCEL

public static final int BUTTON_CANCEL

Represents the CANCEL button.

See Also:

Constant Field Values

tableColumns

protected java.lang.String[] tableColumns

Column name.

tableClasses

protected java.lang.Class[] tableClasses

Column name.

tableData

protected java.lang.Object[][] tableData

List of URLs currently displayed by the list.

model

protected javax.swing.tree.DefaultTreeModel model

Model of the URL list.

resizeListener

protected java.awt.event.HierarchyBoundsListener resizeListener

Displays the dimension if resized.

typeProvider

protected TypeProvider typeProvider

Helper to get file types, icons etc.

exitbutton

protected int exitbutton

Code of the pressed button, -1 = not exited.

checker

protected java.lang.Runnable checker

Instance to check the network resources.

helpID

protected java.lang.String helpID

Identifier to call the help system (optional).

Constructor Detail

DownloadDialog

public DownloadDialog()

Constructor method for the dialog (modeless).

Since:

1.6

DownloadDialog

public DownloadDialog(java.awt.Frame owner)

Constructor method for the dialog.

Parameters:

owner - The owner frame

Since:

1.6

DownloadDialog

public DownloadDialog(java.awt.Dialog owner)

Constructor method for the dialog.

Parameters:

owner - The owner dialog

Since:

1.6

Method Detail

allowEscapeOnKeyStroke

public void allowEscapeOnKeyStroke(int strokeval)

Adds a keyboard action to escape (close) the dialog (e.g. on escape).

The dialog is not disposed here since it may be recycled by an application. If the dialog can be closed by an escape character it also can be closed with the "X" window button. Normally this functionality is disabled.

Parameters:

strokeval - The desired escape key stroke like KeyEvent.VK_ESCAPE

Since:

1.6

setBorderTitle

public void setBorderTitle(java.lang.String title)

Sets the title displayed by the titled border.

Parameters:

title - Title displayed by the titled border, may be null

Since:

1.6

setFlagText

public void setFlagText(java.lang.String text,
               boolean selected)

Sets the text of the optional flag shown at the bottom of the dialog.

Parameters:

text - Text for the optional flag, null deactivates flag (default)

selected - Shall the flag be selected?

Since:

1.6

setFlagSelected

public void setFlagSelected(boolean enable)

Sets the state of the optional flag shown at the bottom of the dialog.

Parameters:

enable - Set the flag?

Since:

1.6

isFlagSelected

public boolean isFlagSelected()

Provides the state of the optional flag shown at the bottom of the dialog.

Returns:

Flag selected?

Since:

1.6

execute

public int execute()

Shows the dialog on the screen and returns the code of the pressed button.

Returns:

Code of the pressed button

setVisible

public void setVisible(boolean visible)

Activates or deactivates the dialog.

Overrides:

setVisible in class java.awt.Dialog

Parameters:

visible - The state of the dialog

Since:

1.6

setURLs

public void setURLs(org.apache.commons.vfs2.FileObject[] urls,
           boolean selected)

Sets the list of URL to be displayed.

Here, the given URL are anticipated as existing. No checking is performed.

Parameters:

urls - The list of URLs

selected - Auto-select the items?

Throws:

java.lang.NullPointerException - If a parameter is null

setURLCandidates

public void setURLCandidates(java.lang.String[] candidates,
                    boolean selected)

Sets the list of URLs to be displayed.

Here, the given addresses are checked whether the resources do exist. If a candidate URL does not exist, then it is not added to the list. The user is entertained while the resources are being checked (cancel is possible).

Parameters:

candidates - The list of URL candidates to be checked

selected - Auto-select the items?

Throws:

java.lang.NullPointerException - If a parameter is null

setURLChecker

public void setURLChecker(java.lang.Runnable checker)

Sets an object responsible for setting the candidate URLs.

This method is appropriate if there are steps to do before the downloads start. The dialog may then be used as user entertainer while the checking is done.

Parameters:

checker - The code to set the candidates list

Throws:

java.lang.NullPointerException - If a parameter is null

addToList

public void addToList(org.apache.commons.vfs2.FileObject url,
             boolean selected)

Adds the given URL to the list.

Parameters:

url - The list of URLs to be selected

selected - Auto-select the new item?

setTypeProvider

public void setTypeProvider(TypeProvider provider)

Sets the helper providing the URL types.

Parameters:

provider - The type provider

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

setEnabledURLs

public void setEnabledURLs(org.apache.commons.vfs2.FileObject[] selection)

Sets the selected URLs.

Parameters:

selection - The list of URLs to be selected

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

getSelectedURLs

public org.apache.commons.vfs2.FileObject[] getSelectedURLs()

Provides the list of selected URLs.

Returns:

The selection, may have zero-length

createDefaultDialog

public static DownloadDialog createDefaultDialog(java.awt.Component comp,
                                 java.lang.String title,
                                 java.lang.String bordertitle)

Convenience method to create a preconfigured dialog instance.

If the parent window cannot be determined the dialog is created modeless instead. All texts and buttons have to be added manually.

Parameters:

comp - The component to search the parental window

title - The text displayed by window decoration

bordertitle - The text displayed by the top border, may be null

Returns:

The dialog

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

setHelpID

public void setHelpID(java.lang.String helpid)

Sets the optional help link to call the help system.

Parameters:

helpid - The help system link

Since:

1.6

getButtonOK

public javax.swing.JButton getButtonOK()

Provides the OK button.

Returns:

The OK button

Since:

1.6

getButtonCancel

public javax.swing.JButton getButtonCancel()

Provides the cancel button.

Returns:

The cancel button

Since:

1.6

updateButtons

protected void updateButtons()

Refreshes the button states.

Since:

1.6

getTable

public javax.swing.JTable getTable()

Provides the table.

Returns:

The table

Since:

1.6

getStatusBar

public StatusBar getStatusBar()

Provides the status bar.

Returns:

The status bar

Since:

1.6

isURLSelected

public boolean isURLSelected(org.apache.commons.vfs2.FileObject item)

Checks if the given URL is selected or not.

Parameters:

item - The desired item

Returns:

Selected?

Since:

1.6

getItemCount

public int getItemCount()

Provides the number of items shown by the list.

Returns:

The number of items

Since:

1.6

getExitCode

public int getExitCode()

Provides the exit code.

Returns:

The exit code, -1 = not exited

Since:

1.6

actionPerformed

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

Reacts on component interaction.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - Event to be processed

Since:

1.6