Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> greenstone >> gatherer >> [ collection overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.greenstone.gatherer.collection
Class ExportCollectionPrompt  

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.greenstone.gatherer.gui.ModalDialog
                          org.greenstone.gatherer.collection.ExportCollectionPrompt

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, org.greenstone.gatherer.shell.GShellListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

---

public class ExportCollectionPrompt

extends org.greenstone.gatherer.gui.ModalDialog

implements org.greenstone.gatherer.shell.GShellListener

This class provides the functionality to export current collections from the GSDLHOME/collect/ directory to CDROM. The user chooses the collection from a list, where each entry also displays details about itself, confirms the delete of a collection by checking a checkbox then presses the ok button to actually delete the collection. Copied from DeleteCollectionPrompt

Version:

2.3

---

Nested Class Summary
private  class	ExportCollectionPrompt.CancelButtonListener           A button listener implementation, which listens for actions on the close button and disposes of the dialog when detected.
private  class	ExportCollectionPrompt.CollectionListListener           This private class listens for selection events in from the list and then displays the appropriate details for that collection.
private  class	ExportCollectionPrompt.OKButtonListener           The OK button listener implementation.
private  class	ExportCollectionPrompt.ResultDialog

 

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  java.util.ArrayList	all_collections
private  java.lang.String[]	args
private  javax.swing.JButton	cancel_button           The close button, which exits the prompt without deleting anything.
private  java.lang.String	cd_title
private  BasicCollectionConfiguration	collection           The currently selected collection for deletion.
private  javax.swing.JLabel	details_label           The label above details.
private  javax.swing.JTextArea	details_textarea           The text area used to display details about the collection selected.
private  java.lang.StringBuffer	error_message           the error message if any
private  boolean	exporting           whether we are trying to export or not
private  javax.swing.JTextArea	instructions_textarea           The text area used to display instructions for the export
private  org.greenstone.gatherer.checklist.CheckList	list           The list of collections to export
private  javax.swing.JLabel	list_label           The label above the list.
private  javax.swing.DefaultListModel	list_model           The model behind the list.
private  javax.swing.JButton	ok_button           The ok button which causes the selected collection to be deleted.
private  ExportCollectionPrompt.OKButtonListener	ok_button_listener
private  ExportCollectionPrompt	prompt           A reference to ourself so any inner-classes can dispose of us.
private  java.util.ArrayList	selected_collections
static java.awt.Dimension	SIZE           The size of the export prompt screen.
private  boolean	successful           whether the exporting was successful or not
private  javax.swing.JTextField	title_field           A string array used to pass arguments to the phrase retrieval method.
private  javax.swing.JLabel	title_label

 

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

ExportCollectionPrompt()           Constructor.

 

Method Summary
void	destroy()           Destructor.
boolean	display()           This method causes the modal prompt to be displayed.
void	exportCollections()           This method calls the builcol.pl scripts via a GShell so as to not lock up the processor.
void	message(org.greenstone.gatherer.shell.GShellEvent event)           All implementation of GShellListener must include this method so the listener can be informed of messages from the GShell.
void	processBegun(org.greenstone.gatherer.shell.GShellEvent event)           All implementation of GShellListener must include this method so the listener can be informed when a GShell begins its task.
void	processComplete(org.greenstone.gatherer.shell.GShellEvent event)           All implementation of GShellListener must include this method so the listener can be informed when a GShell completes its task.
void	resultPrompt(boolean success, java.lang.String extra)           Shows an export complete prompt.
private  void	scanForCollections()           Method to scan the collect directory retrieving and reloading each collection it finds, while building the list of known collections.

 

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

ok_button_listener

private ExportCollectionPrompt.OKButtonListener ok_button_listener

---

all_collections

private java.util.ArrayList all_collections

---

selected_collections

private java.util.ArrayList selected_collections

---

list

private org.greenstone.gatherer.checklist.CheckList list

The list of collections to export

---

collection

private BasicCollectionConfiguration collection

The currently selected collection for deletion.

---

list_model

private javax.swing.DefaultListModel list_model

The model behind the list.

---

prompt

private ExportCollectionPrompt prompt

A reference to ourself so any inner-classes can dispose of us.

---

cancel_button

private javax.swing.JButton cancel_button

The close button, which exits the prompt without deleting anything.

---

ok_button

private javax.swing.JButton ok_button

The ok button which causes the selected collection to be deleted.

---

details_label

private javax.swing.JLabel details_label

The label above details.

---

list_label

private javax.swing.JLabel list_label

The label above the list.

---

details_textarea

private javax.swing.JTextArea details_textarea

The text area used to display details about the collection selected.

---

instructions_textarea

private javax.swing.JTextArea instructions_textarea

The text area used to display instructions for the export

---

title_field

private javax.swing.JTextField title_field

A string array used to pass arguments to the phrase retrieval method.

---

title_label

private javax.swing.JLabel title_label

---

args

private java.lang.String[] args

---

cd_title

private java.lang.String cd_title

---

successful

private boolean successful

whether the exporting was successful or not

---

exporting

private boolean exporting

whether we are trying to export or not

---

error_message

private java.lang.StringBuffer error_message

the error message if any

---

SIZE

public static final java.awt.Dimension SIZE

The size of the export prompt screen.

Constructor Detail

ExportCollectionPrompt

public ExportCollectionPrompt()

Constructor.

Method Detail

destroy

public void destroy()

Destructor.

---

display

public boolean display()

This method causes the modal prompt to be displayed. returns true if it has exported the collections that are currently selected

---

exportCollections

public void exportCollections()

This method calls the builcol.pl scripts via a GShell so as to not lock up the processor.

---

resultPrompt

public void resultPrompt(boolean success,
                         java.lang.String extra)

Shows an export complete prompt.

---

scanForCollections

private void scanForCollections()

Method to scan the collect directory retrieving and reloading each collection it finds, while building the list of known collections.

---

message

public void message(org.greenstone.gatherer.shell.GShellEvent event)

All implementation of GShellListener must include this method so the listener can be informed of messages from the GShell.

Specified by:

message in interface org.greenstone.gatherer.shell.GShellListener

---

processBegun

public void processBegun(org.greenstone.gatherer.shell.GShellEvent event)

All implementation of GShellListener must include this method so the listener can be informed when a GShell begins its task. Implementation side-effect, not actually used.

Specified by:

processBegun in interface org.greenstone.gatherer.shell.GShellListener

---

processComplete

public void processComplete(org.greenstone.gatherer.shell.GShellEvent event)

All implementation of GShellListener must include this method so the listener can be informed when a GShell completes its task.

Specified by:

processComplete in interface org.greenstone.gatherer.shell.GShellListener

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> greenstone >> gatherer >> [ collection overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---