Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.greenstone.gatherer.msm
Class ExportMDSPrompt  view ExportMDSPrompt download ExportMDSPrompt.java

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended byorg.greenstone.gatherer.gui.ModalDialog
                          extended byorg.greenstone.gatherer.msm.ExportMDSPrompt
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.event.KeyListener, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public final class ExportMDSPrompt
extends org.greenstone.gatherer.gui.ModalDialog
implements java.awt.event.ActionListener, java.awt.event.KeyListener

A GUI component for allowing the user to export a metadata set, based on certain conditions, and to a certain file (not necessarily a .mds file).

Version:
2.3

Nested Class Summary
 
Nested classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
private  int action
          The action the user has chosen from the dialog (either -1, if cancelled, or EXPORT).
private  javax.swing.JRadioButton all_values
          Ths button that, if selected, signifies you wish to export the metadata set with all values.
private  javax.swing.JButton browse_button
          The button used to browse the local file system.
private  javax.swing.JButton cancel_button
          Used to cancel the dialog.
private  boolean export
          Is this an export prompt or an import one?
static int EXPORT
          The default export action (there are several depending on how much information you wish to export).
private  javax.swing.JButton export_button
          Used to initiate the export, then dispose of the dialog.
static java.awt.Dimension EXPORT_SIZE
          The default size for this dialog window.
private  java.io.File file
          The file we wish to export the metadata set to.
private  javax.swing.JTextField file_name
          The destination file name as a string.
static java.awt.Dimension IMPORT_SIZE
          The default size for this dialog window.
private  MetadataSetManager manager
          A reference to the metadata set manager.
private  javax.swing.JRadioButton no_values
          The button that, if selected, signifies you wish to export the metadata set without any values (ie no mdv files).
private  javax.swing.JComboBox sets
          The metadata sets available for export.
private  javax.swing.JRadioButton structure_only
          The button that, if selected, signifies you wish to export the metadata set with only those values that are subject nodes in the hierarchy.
 
Fields inherited from class org.greenstone.gatherer.gui.ModalDialog
modal, waiting
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Dialog
 
Fields inherited from class java.awt.Window
 
Fields inherited from class java.awt.Container
 
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
ExportMDSPrompt(MetadataSetManager manager, boolean export)
          Constructor.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent event)
          Whenever one of the buttons in the dialog is actioned this method is called to trigger the appropriate effects.
 int display()
          Show the prompt and get the user input.
 int getSelectedCondition()
          Get the current value of condition.
 java.io.File getSelectedFile()
          Get the current value of file.
 MetadataSet getSelectedSet()
          Get the current value of set.
 void keyPressed(java.awt.event.KeyEvent event)
          Any implementation of KeyListener must include this method so that we can be informed when a key has been pressed.
 void keyReleased(java.awt.event.KeyEvent event)
          Any implementation of KeyListener must include this method so that we can be informed once a key has been released.
 void keyTyped(java.awt.event.KeyEvent event)
          Any implementation of KeyListener must include this method so that we can be informed when a key has been typed.
 
Methods inherited from class org.greenstone.gatherer.gui.ModalDialog
setModal, setVisible
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getPreferredSize, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusOwner, getGraphicsConfiguration, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setLocationRelativeTo, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, swapComponents, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, 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

export

private boolean export
Is this an export prompt or an import one?


file

private java.io.File file
The file we wish to export the metadata set to.


action

private int action
The action the user has chosen from the dialog (either -1, if cancelled, or EXPORT).


browse_button

private javax.swing.JButton browse_button
The button used to browse the local file system.


cancel_button

private javax.swing.JButton cancel_button
Used to cancel the dialog.


export_button

private javax.swing.JButton export_button
Used to initiate the export, then dispose of the dialog.


sets

private javax.swing.JComboBox sets
The metadata sets available for export.


file_name

private javax.swing.JTextField file_name
The destination file name as a string.


all_values

private javax.swing.JRadioButton all_values
Ths button that, if selected, signifies you wish to export the metadata set with all values.


no_values

private javax.swing.JRadioButton no_values
The button that, if selected, signifies you wish to export the metadata set without any values (ie no mdv files).


structure_only

private javax.swing.JRadioButton structure_only
The button that, if selected, signifies you wish to export the metadata set with only those values that are subject nodes in the hierarchy.


manager

private MetadataSetManager manager
A reference to the metadata set manager.


EXPORT_SIZE

public static final java.awt.Dimension EXPORT_SIZE
The default size for this dialog window.


IMPORT_SIZE

public static final java.awt.Dimension IMPORT_SIZE
The default size for this dialog window.


EXPORT

public static final int EXPORT
The default export action (there are several depending on how much information you wish to export).

See Also:
Constant Field Values
Constructor Detail

ExportMDSPrompt

public ExportMDSPrompt(MetadataSetManager manager,
                       boolean export)
Constructor.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)
Whenever one of the buttons in the dialog is actioned this method is called to trigger the appropriate effects.

Specified by:
actionPerformed in interface java.awt.event.ActionListener

display

public int display()
Show the prompt and get the user input.


getSelectedCondition

public int getSelectedCondition()
Get the current value of condition.


getSelectedFile

public java.io.File getSelectedFile()
Get the current value of file.


getSelectedSet

public MetadataSet getSelectedSet()
Get the current value of set.


keyPressed

public void keyPressed(java.awt.event.KeyEvent event)
Any implementation of KeyListener must include this method so that we can be informed when a key has been pressed. In this case we ignore it.

Specified by:
keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent event)
Any implementation of KeyListener must include this method so that we can be informed once a key has been released. This is the earliest the VK code becomes stable and usable, so we will check if the file named in file_name can be written to and if so enable the export button.

Specified by:
keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent event)
Any implementation of KeyListener must include this method so that we can be informed when a key has been typed. In this case we ignore it.

Specified by:
keyTyped in interface java.awt.event.KeyListener