|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--java.awt.Window | +--java.awt.Dialog | +--javax.swing.JDialog | +--com.bigzip.plugin.support.ui.FileQueue
The FileQueue allows a user to select a multitude of files. The user can chooser files from different directories and/or file systems, and can remove files from the queue before it is dismissed.
An accessory component can be added to the dialog box to allow the user to chooser task-spacific options. Each file added to the queue has its own set of accessory options so different files in the queue can have different settings selected for it.
The file queue used in a number of ways:
Inner classes inherited from class javax.swing.JDialog |
javax.swing.JDialog.AccessibleJDialog |
Inner classes inherited from class java.awt.Dialog |
java.awt.Dialog.AccessibleAWTDialog |
Inner classes inherited from class java.awt.Window |
java.awt.Window.AccessibleAWTWindow |
Inner classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent |
Field Summary | |
protected FileQueueAccessory |
accessory
This is the accessory component to be displayed in the queue. |
protected javax.swing.JButton |
addAllButton
This is the button to add all the files in a directory to the queue. |
protected javax.swing.JButton |
addButton
This is the button to add a selected file to the queue. |
static int |
APPROVE_OPTION
Return value if approve (yes, ok) is chosen. |
protected javax.swing.JButton |
approveButton
This is the approve button. |
protected int |
approved
The approval status of the queue. |
static int |
CANCEL_OPTION
Return value if cancel is chosen. |
protected javax.swing.JButton |
cancelButton
This is the cancel button. |
protected java.lang.Object[][] |
chooserFiles
|
protected com.bigzip.plugin.support.ui.DirectoryChooserPane |
directoryChooserPane
This is the directory chooser pane. |
static int |
ERROR_OPTION
Return value if an error occured. |
protected com.bigzip.plugin.support.ui.BiGZiPTable |
fileChooserTable
This is the table which lists the files in directory so that a user can add one/them to the queue. |
protected javax.swing.JButton |
goHomeButton
This is the button to open the user's home directory in the directory chooser pane. |
protected java.awt.Frame |
parent
This is the parent of the chooser. |
protected java.util.Vector |
queueFiles
This is the list of FileQueueEntry objects that each hold a file and its accessory options for the files added to the queue. |
protected com.bigzip.plugin.support.ui.BiGZiPTable |
queueTable
This is the table which displays the FileQueueEntry objects in the queueFiles vector. |
protected javax.swing.JButton |
removeAllButton
This button removes all the queued files from the queue. |
protected javax.swing.JButton |
removeButton
This buttom removes the file selected in the queue table. |
protected com.bigzip.plugin.support.ui.FileQueue.TypeRenderer |
typeRenderer
This is a column renderer which used in the tables to render an icon to represent the types of the files in the table. |
Fields inherited from class javax.swing.JDialog |
accessibleContext, rootPane, rootPaneCheckingEnabled |
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, HIDE_ON_CLOSE |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
FileQueue()
Creates a new file queue with user's working directory open by default. |
|
FileQueue(java.io.File initialPath)
Creates a new file queue with directory refered to by the given path open by default. |
|
FileQueue(java.awt.Frame parent,
java.io.File initialPath)
Creates a new file queue with directory refered to by the given path open by default. |
|
FileQueue(java.awt.Frame parent,
java.lang.String initialPath)
Creates a new file queue with directory refered to by the given path open by default. |
|
FileQueue(java.lang.String initialPath)
Creates a new file queue with directory refered to by the given path open by default. |
Method Summary | |
protected javax.swing.JButton |
createDefaultAddAllButton()
Creates a button with the label "Add All", mnemonic 'd', and which calls calls the doAddAllAction method when clicked. |
protected javax.swing.JButton |
createDefaultAddButton()
Creates a button with the label "Add", mnemonic 'a', and which calls calls the doAddAction method when clicked. |
protected javax.swing.JButton |
createDefaultApproveButton()
Creates a button with the label "Ok", mnemonic 'o', and which calls the doApproveAction method when clicked. |
protected javax.swing.JButton |
createDefaultCancelButton()
Creates a button with the label "Cancel", mnemonic 'c', and which calls the doCancelAction method when clicked. |
protected javax.swing.JButton |
createDefaultGoHomeButton()
Creates a button with the default 'go home' icon for the current look'n'feel, mnemonic 'c', and which calls the doGoHomeAction method when clicked. |
protected javax.swing.JButton |
createDefaultRemoveAllButton()
Creates a button with the label "Remove All", mnemonic 'e', and which calls the doRemoveAllAction method when clicked. |
protected javax.swing.JButton |
createDefaultRemoveButton()
Creates a button with the label "Remove", mnemonic 'r', and which calls the doRemoveAction method when clicked. |
protected javax.swing.table.TableColumn |
createDirectoryColumn()
Creates a table column that is setup to display the directory path of file in the queue table. |
protected javax.swing.table.TableColumn |
createFilenameColumn()
Creates a table column that is setup to display the filename of the files in a table. |
protected javax.swing.table.TableColumn |
createOptionsColumn()
Creates a table column that is setup to display the options associated with a file in the queue table. |
protected javax.swing.table.TableColumn |
createTypeColumn()
Creates a table column that is setup to display the type icon for a file. |
protected void |
doAddAction()
Performs the standard response to the add button being clicked. |
protected void |
doAddAllAction()
Performs the standard response to the add all button being clicked. |
protected void |
doApproveAction()
Performs the standard response to the approve button being clicked. |
protected void |
doCancelAction()
Performs the standard response to the cancel button being clicked. |
protected void |
doGoHomeAction()
Performs the standard response to the go home button being clicked. |
protected void |
doRemoveAction()
Performs the standard response to the remove all button being clicked. |
protected void |
doRemoveAllAction()
Performs the standard response to the remove button being clicked. |
FileQueueAccessory |
getAccessory()
Retrieves the accessory component displayed in the file queue. |
int |
getApproveButtonMnemonic()
Retrieves the the approve button's mnemonic. |
java.lang.String |
getApproveButtonText()
Retrieves the text that appears in the approve button. |
java.lang.String |
getApproveButtonToolTipText()
Retrieves the approve button's tooltip text. |
java.io.File |
getCurrentDirectory()
Retrieves the currently open directory. |
FileQueueEntry[] |
getSelectedEntries()
Retrieves the files selected in the queue table. |
boolean |
isApproved()
Tests if the directory chooser was approved. |
void |
setAccessory(FileQueueAccessory accessory)
Sets the accessory to display in the directory chooser. |
void |
setApproveButtonMnemonic(char mnemonic)
Sets the approve button's mnemonic. |
void |
setApproveButtonText(java.lang.String label)
Sets the text that appears in the approve button. |
void |
setApproveButtonToolTipText(java.lang.String text)
Sets the approve button's tooltip text. |
void |
setCurrentDirectory(java.io.File path)
Sets the currently open directory. |
int |
showDialog()
Shows the file queue to the user. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent)
Shows the standard file queue with the user's home directory initially opened. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.io.File initialPath)
Shows the standard file queue. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.io.File initialPath,
FileQueueAccessory accessory)
Shows the standard file queue with a custom accessory. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.io.File initialPath,
java.lang.String title)
Shows the standard file queue with a custom dialog box title. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.io.File initialPath,
java.lang.String title,
FileQueueAccessory accessory)
Shows the standard file queue with a custom dialog box title and accessory. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.io.File initialPath,
java.lang.String dialogTitle,
FileQueueAccessory accessory,
java.lang.String approveButtonText,
char approveButtonMnemonic,
java.lang.String approveButtonToolTipText)
Shows the standard file queue with a custom dialog box title, accessory and approve button. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.lang.String initialPath)
Shows the standard file queue. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.lang.String initialPath,
FileQueueAccessory accessory)
Shows the standard file queue with a custom accessory. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.lang.String initialPath,
java.lang.String title)
Shows the standard file queue with a custom dialog box title. |
static FileQueueEntry[] |
showFileQueue(java.awt.Frame parent,
java.lang.String initialPath,
java.lang.String title,
FileQueueAccessory accessory)
Shows the standard file queue with a custom dialog box title and accessory. |
Methods inherited from class javax.swing.JDialog |
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, setRootPane, setRootPaneCheckingEnabled, update |
Methods inherited from class java.awt.Dialog |
addNotify, dispose, getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show |
Methods inherited from class java.awt.Window |
addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, toBack, toFront |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFont, validate, validateTree |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, 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, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int APPROVE_OPTION
public static final int CANCEL_OPTION
public static final int ERROR_OPTION
protected FileQueueAccessory accessory
protected javax.swing.JButton addAllButton
protected javax.swing.JButton addButton
protected int approved
protected javax.swing.JButton approveButton
protected javax.swing.JButton cancelButton
protected java.lang.Object[][] chooserFiles
protected com.bigzip.plugin.support.ui.DirectoryChooserPane directoryChooserPane
protected com.bigzip.plugin.support.ui.BiGZiPTable fileChooserTable
protected javax.swing.JButton goHomeButton
protected java.awt.Frame parent
protected java.util.Vector queueFiles
protected com.bigzip.plugin.support.ui.BiGZiPTable queueTable
protected javax.swing.JButton removeAllButton
protected javax.swing.JButton removeButton
protected com.bigzip.plugin.support.ui.FileQueue.TypeRenderer typeRenderer
Constructor Detail |
public FileQueue()
public FileQueue(java.lang.String initialPath)
public FileQueue(java.awt.Frame parent, java.lang.String initialPath)
public FileQueue(java.io.File initialPath)
public FileQueue(java.awt.Frame parent, java.io.File initialPath)
Method Detail |
protected javax.swing.JButton createDefaultAddAllButton()
protected javax.swing.JButton createDefaultAddButton()
protected javax.swing.JButton createDefaultApproveButton()
protected javax.swing.JButton createDefaultCancelButton()
protected javax.swing.JButton createDefaultGoHomeButton()
protected javax.swing.JButton createDefaultRemoveAllButton()
protected javax.swing.JButton createDefaultRemoveButton()
protected javax.swing.table.TableColumn createFilenameColumn()
protected javax.swing.table.TableColumn createOptionsColumn()
protected javax.swing.table.TableColumn createDirectoryColumn()
protected javax.swing.table.TableColumn createTypeColumn()
protected void doAddAction()
protected void doAddAllAction()
protected void doApproveAction()
protected void doCancelAction()
protected void doGoHomeAction()
protected void doRemoveAction()
protected void doRemoveAllAction()
public FileQueueAccessory getAccessory()
public java.lang.String getApproveButtonText()
public int getApproveButtonMnemonic()
public java.lang.String getApproveButtonToolTipText()
public FileQueueEntry[] getSelectedEntries()
public java.io.File getCurrentDirectory()
public boolean isApproved()
public void setAccessory(FileQueueAccessory accessory)
public void setApproveButtonText(java.lang.String label)
public void setApproveButtonMnemonic(char mnemonic)
public void setApproveButtonToolTipText(java.lang.String text)
public void setCurrentDirectory(java.io.File path)
java.lang.IllegalArgumentException
- The path given doesn't not refer to
a directory.public int showDialog()
public static FileQueueEntry[] showFileQueue(java.awt.Frame parent)
parent
- The parent frame of the queue.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.lang.String initialPath)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.lang.String initialPath, java.lang.String title)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.dialogTitle
- The string to appear as the directory chooser's title.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.lang.String initialPath, FileQueueAccessory accessory)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.accessory
- The accessory component to be displayed in the queue.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.lang.String initialPath, java.lang.String title, FileQueueAccessory accessory)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.dialogTitle
- The string to appear as the directory chooser's title.accessory
- The accessory component to be displayed in the queue.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.io.File initialPath)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.io.File initialPath, java.lang.String title)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.dialogTitle
- The string to appear as the directory chooser's title.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.io.File initialPath, FileQueueAccessory accessory)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.accessory
- The accessory component to be displayed in the queue.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.io.File initialPath, java.lang.String title, FileQueueAccessory accessory)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.dialogTitle
- The string to appear as the directory chooser's title.accessory
- The accessory component to be displayed in the queue.public static FileQueueEntry[] showFileQueue(java.awt.Frame parent, java.io.File initialPath, java.lang.String dialogTitle, FileQueueAccessory accessory, java.lang.String approveButtonText, char approveButtonMnemonic, java.lang.String approveButtonToolTipText)
parent
- The parent frame of the queue.initalPath
- The directory initially opened.dialogTitle
- The string to appear as the directory chooser's title.accessory
- The accessory component to be displayed in the queue.approveButtonText
- The text to appear in the approve button.approveButtonMnemonic
- The approve button's mnemonic.approveBuutonToolTipText
- The approve button's tooltip text.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |