repicea.io.tools

Class REpiceaExportToolDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

repicea.gui.REpiceaDialog

repicea.io.tools.REpiceaExportToolDialog

All Implemented Interfaces:

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, Refreshable, REpiceaEventFireComponent, REpiceaWindow, SynchronizedListening

public class REpiceaExportToolDialog
extends REpiceaDialog
implements java.awt.event.ActionListener

The REpiceaExportToolDialog class is the user interface of the REpiceaExportTool class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	REpiceaExportToolDialog.MessageID

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
protected javax.swing.JTextField	filenameField
protected javax.swing.JList<?>	optionList
protected javax.swing.JLabel	optionTitleLabel
protected javax.swing.JTextArea	selectAnOptionTextArea
protected boolean	triggerRecordSetAndSaveManually

Fields inherited from class repicea.gui.REpiceaDialog

askUserBeforeExit, cancelOnClose

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

Modifier	Constructor and Description
protected	REpiceaExportToolDialog(REpiceaExportTool caller, java.awt.Window parent) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent arg0)
void	cancelAction()
protected boolean	checkFileValidity() This method checks if the filename is valid.
void	doNotListenToAnymore() This method remove the listeners.
protected REpiceaExportTool	getCaller()
protected javax.swing.JPanel	getTopLeftPanel()
protected javax.swing.JPanel	getTopPanels()
protected javax.swing.JPanel	getTopRightPanel()
protected void	init() The init method instantiates the members of this class.
protected void	initUI() This method creates the UI, i.e.
void	listenTo() This method specifies who is listening to whom.
void	okAction() The okAction method checks if the filename is valid, then creates the record set and finally save the file.
protected void	refreshTitle()
void	setTriggerRecordSetAndSaveManually(boolean triggerRecordSetAndSaveManually) This method makes it possible to just save the filename and wait to trigger the createRecordSet and save methods manually.
protected void	showProgressBar(java.util.Map<java.lang.Enum,REpiceaExportTool.InternalSwingWorkerForRecordSet> workers, boolean isCreatingDataset)

Methods inherited from class repicea.gui.REpiceaDialog

askUserBeforeExit, firePropertyChange, getBufferedImage, helpAction, isCancelOnClose, refreshInterface, setCancelOnClose, setIcon, setVisible

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

Methods inherited from interface repicea.gui.REpiceaWindow

setTitle

Field Detail

filenameField

protected javax.swing.JTextField filenameField

optionList

protected javax.swing.JList<?> optionList

selectAnOptionTextArea

protected javax.swing.JTextArea selectAnOptionTextArea

optionTitleLabel

protected javax.swing.JLabel optionTitleLabel

triggerRecordSetAndSaveManually

protected boolean triggerRecordSetAndSaveManually

Constructor Detail

REpiceaExportToolDialog

protected REpiceaExportToolDialog(REpiceaExportTool caller,
                                  java.awt.Window parent)

Constructor.

Parameters:

caller - an ExportTool instance

parent - the Window that owns this dialog (can be null)

Method Detail

init

protected void init()

The init method instantiates the members of this class.

initUI

protected void initUI()

Description copied from class: REpiceaDialog

This method creates the UI, i.e. it puts the components at their proper location and so on. The components should have be previously instantiated.

Specified by:

initUI in class REpiceaDialog

getTopLeftPanel

protected javax.swing.JPanel getTopLeftPanel()

getTopRightPanel

protected javax.swing.JPanel getTopRightPanel()

getTopPanels

protected javax.swing.JPanel getTopPanels()

okAction

public void okAction()

The okAction method checks if the filename is valid, then creates the record set and finally save the file.

Specified by:

okAction in interface REpiceaWindow

Overrides:

okAction in class REpiceaDialog

checkFileValidity

protected boolean checkFileValidity()
                             throws java.io.IOException,
                                    java.lang.IllegalArgumentException,
                                    java.lang.Exception

This method checks if the filename is valid. In case the file already exists, it asks for confirmation before deleting it.

Returns:

a boolean true means everything is fine false means the user does not want to write over that file.

Throws:

java.io.IOException - if the filename is invalid

java.lang.IllegalArgumentException - if the deletion failed

java.lang.Exception - other exceptions

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

cancelAction

public void cancelAction()

Specified by:

cancelAction in interface REpiceaWindow

Overrides:

cancelAction in class REpiceaDialog

refreshTitle

protected void refreshTitle()

getCaller

protected REpiceaExportTool getCaller()

setTriggerRecordSetAndSaveManually

public void setTriggerRecordSetAndSaveManually(boolean triggerRecordSetAndSaveManually)

This method makes it possible to just save the filename and wait to trigger the createRecordSet and save methods manually.

Parameters:

triggerRecordSetAndSaveManually - a boolean

showProgressBar

protected void showProgressBar(java.util.Map<java.lang.Enum,REpiceaExportTool.InternalSwingWorkerForRecordSet> workers,
                               boolean isCreatingDataset)

doNotListenToAnymore

public void doNotListenToAnymore()

Description copied from interface: SynchronizedListening

This method remove the listeners. It should be consistent with the listenTo method. It should be called just after calling the component is set to visible(false).

Specified by:

doNotListenToAnymore in interface SynchronizedListening

listenTo

public void listenTo()

Description copied from interface: SynchronizedListening

This method specifies who is listening to whom. It should be called just before the component is set to visible.

Specified by:

listenTo in interface SynchronizedListening