net.sf.jabref.gui

Class FileListEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTable

net.sf.jabref.gui.FileListEditor

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.CellEditorListener, javax.swing.event.ListSelectionListener, javax.swing.event.RowSorterListener, javax.swing.event.TableColumnModelListener, javax.swing.event.TableModelListener, javax.swing.Scrollable, DownloadExternalFile.DownloadCallback, FieldEditor

public class FileListEditor
extends javax.swing.JTable
implements FieldEditor, DownloadExternalFile.DownloadCallback

Created by Morten O. Alver 2007.02.22

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JTable.AccessibleJTable, javax.swing.JTable.DropLocation, javax.swing.JTable.PrintMode

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

javax.swing.JComponent.AccessibleJComponent

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 inherited from class javax.swing.JTable

AUTO_RESIZE_ALL_COLUMNS, AUTO_RESIZE_LAST_COLUMN, AUTO_RESIZE_NEXT_COLUMN, AUTO_RESIZE_OFF, AUTO_RESIZE_SUBSEQUENT_COLUMNS, autoCreateColumnsFromModel, autoResizeMode, cellEditor, cellSelectionEnabled, columnModel, dataModel, defaultEditorsByColumnClass, defaultRenderersByColumnClass, editingColumn, editingRow, editorComp, gridColor, preferredViewportSize, rowHeight, rowMargin, rowSelectionAllowed, selectionBackground, selectionForeground, selectionModel, showHorizontalLines, showVerticalLines, tableHeader

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
FileListEditor(JabRefFrame frame, MetaData metaData, java.lang.String fieldName, java.lang.String content, EntryEditor entryEditor)

Method Summary

Methods

Modifier and Type	Method and Description
void	addUndoableEditListener(javax.swing.event.UndoableEditListener listener)
void	append(java.lang.String text)
static java.lang.Thread	autoSetLinks(BibtexEntry entry, FileListTableModel tableModel, MetaData metaData, java.awt.event.ActionListener callback, javax.swing.JDialog diag) Automatically add links for this entry to the table model given as an argument, based on the globally stored list of external file types.
static java.lang.Thread	autoSetLinks(java.util.Collection<BibtexEntry> entries, NamedCompound ce, java.util.Set<BibtexEntry> changedEntries, java.util.ArrayList<java.io.File> dirs) Automatically add links for this set of entries, based on the globally stored list of external file types.
void	clearAutoCompleteSuggestion()
void	downloadComplete(FileListEntry file) This is the callback method that the DownloadExternalFile class uses to report the result of a download operation.
java.lang.String	getFieldName()
javax.swing.JLabel	getLabel()
javax.swing.JComponent	getPane()
java.lang.String	getSelectedText() normally implemented in JTextArea and JTextField
FileListTableModel	getTableModel()
java.lang.String	getText()
javax.swing.JComponent	getTextComponent()
boolean	hasRedoInformation()
boolean	hasUndoInformation()
void	paste(java.lang.String textToInsert) paste text into component, it should also take some selected text into account
void	redo()
static java.io.File	relativizePath(java.io.File f, java.util.ArrayList<java.io.File> dirs) If the file is below one of the directories in a list, return a File specifying a path relative to that directory.
void	setActiveBackgroundColor()
void	setAutoCompleteListener(AutoCompleteListener listener)
void	setInvalidBackgroundColor()
void	setLabelColor(java.awt.Color c)
void	setText(java.lang.String newText) Sets the given text on the current field editor and marks this text editor as modified.
void	setValidBackgroundColor()
void	undo()
void	updateFont()
void	updateFontColor()

Methods inherited from class javax.swing.JTable

addColumn, addColumnSelectionInterval, addNotify, addRowSelectionInterval, changeSelection, clearSelection, columnAdded, columnAtPoint, columnMarginChanged, columnMoved, columnRemoved, columnSelectionChanged, configureEnclosingScrollPane, convertColumnIndexToModel, convertColumnIndexToView, convertRowIndexToModel, convertRowIndexToView, createDefaultColumnModel, createDefaultColumnsFromModel, createDefaultDataModel, createDefaultEditors, createDefaultRenderers, createDefaultSelectionModel, createDefaultTableHeader, createScrollPaneForTable, doLayout, editCellAt, editCellAt, editingCanceled, editingStopped, getAccessibleContext, getAutoCreateColumnsFromModel, getAutoCreateRowSorter, getAutoResizeMode, getCellEditor, getCellEditor, getCellRect, getCellRenderer, getCellSelectionEnabled, getColumn, getColumnClass, getColumnCount, getColumnModel, getColumnName, getColumnSelectionAllowed, getDefaultEditor, getDefaultRenderer, getDragEnabled, getDropLocation, getDropMode, getEditingColumn, getEditingRow, getEditorComponent, getFillsViewportHeight, getGridColor, getIntercellSpacing, getModel, getPreferredScrollableViewportSize, getPrintable, getRowCount, getRowHeight, getRowHeight, getRowMargin, getRowSelectionAllowed, getRowSorter, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedColumn, getSelectedColumnCount, getSelectedColumns, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionForeground, getSelectionModel, getShowHorizontalLines, getShowVerticalLines, getSurrendersFocusOnKeystroke, getTableHeader, getToolTipText, getUI, getUIClassID, getUpdateSelectionOnSort, getValueAt, initializeLocalVars, isCellEditable, isCellSelected, isColumnSelected, isEditing, isRowSelected, moveColumn, paramString, prepareEditor, prepareRenderer, print, print, print, print, print, processKeyBinding, removeColumn, removeColumnSelectionInterval, removeEditor, removeNotify, removeRowSelectionInterval, resizeAndRepaint, rowAtPoint, selectAll, setAutoCreateColumnsFromModel, setAutoCreateRowSorter, setAutoResizeMode, setCellEditor, setCellSelectionEnabled, setColumnModel, setColumnSelectionAllowed, setColumnSelectionInterval, setDefaultEditor, setDefaultRenderer, setDragEnabled, setDropMode, setEditingColumn, setEditingRow, setFillsViewportHeight, setGridColor, setIntercellSpacing, setModel, setPreferredScrollableViewportSize, setRowHeight, setRowHeight, setRowMargin, setRowSelectionAllowed, setRowSelectionInterval, setRowSorter, setSelectionBackground, setSelectionForeground, setSelectionMode, setSelectionModel, setShowGrid, setShowHorizontalLines, setShowVerticalLines, setSurrendersFocusOnKeystroke, setTableHeader, setUI, setUpdateSelectionOnSort, setValueAt, sizeColumnsToFit, sizeColumnsToFit, sorterChanged, tableChanged, unconfigureEnclosingScrollPane, updateUI, valueChanged

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, 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 net.sf.jabref.FieldEditor

getParent, requestFocus, setBackground, setEnabled

Constructor Detail

FileListEditor

public FileListEditor(JabRefFrame frame,
              MetaData metaData,
              java.lang.String fieldName,
              java.lang.String content,
              EntryEditor entryEditor)

Method Detail

getTableModel

public FileListTableModel getTableModel()

getFieldName

public java.lang.String getFieldName()

Specified by:

getFieldName in interface FieldEditor

getPane

public javax.swing.JComponent getPane()

Specified by:

getPane in interface FieldEditor

getTextComponent

public javax.swing.JComponent getTextComponent()

Specified by:

getTextComponent in interface FieldEditor

getLabel

public javax.swing.JLabel getLabel()

Specified by:

getLabel in interface FieldEditor

setLabelColor

public void setLabelColor(java.awt.Color c)

Specified by:

setLabelColor in interface FieldEditor

getText

public java.lang.String getText()

Specified by:

getText in interface FieldEditor

setText

public void setText(java.lang.String newText)

Description copied from interface: FieldEditor

Sets the given text on the current field editor and marks this text editor as modified.

Specified by:

setText in interface FieldEditor

append

public void append(java.lang.String text)

Specified by:

append in interface FieldEditor

updateFont

public void updateFont()

Specified by:

updateFont in interface FieldEditor

paste

public void paste(java.lang.String textToInsert)

Description copied from interface: FieldEditor

paste text into component, it should also take some selected text into account

Specified by:

paste in interface FieldEditor

getSelectedText

public java.lang.String getSelectedText()

Description copied from interface: FieldEditor

normally implemented in JTextArea and JTextField

Specified by:

getSelectedText in interface FieldEditor

Returns:

autoSetLinks

public static java.lang.Thread autoSetLinks(java.util.Collection<BibtexEntry> entries,
                            NamedCompound ce,
                            java.util.Set<BibtexEntry> changedEntries,
                            java.util.ArrayList<java.io.File> dirs)

Automatically add links for this set of entries, based on the globally stored list of external file types. The entries are modified, and corresponding UndoEdit elements added to the NamedCompound given as argument. Furthermore, all entries which are modified are added to the Set of entries given as an argument. The entries' bibtex keys must have been set - entries lacking key are ignored. The operation is done in a new thread, which is returned for the caller to wait for if needed.

Parameters:

entries - A collection of BibtexEntry objects to find links for.

ce - A NamedCompound to add UndoEdit elements to.

changedEntries - A Set of BibtexEntry objects to which all modified entries is added.

Returns:

the thread performing the autosetting

autoSetLinks

public static java.lang.Thread autoSetLinks(BibtexEntry entry,
                            FileListTableModel tableModel,
                            MetaData metaData,
                            java.awt.event.ActionListener callback,
                            javax.swing.JDialog diag)

Automatically add links for this entry to the table model given as an argument, based on the globally stored list of external file types. The entry itself is not modified. The entry's bibtex key must have been set. The operation is done in a new thread, which is returned for the caller to wait for if needed.

Parameters:

entry - The BibtexEntry to find links for.

tableModel - The table model to insert links into. Already existing links are not duplicated or removed.

metaData - The MetaData providing the relevant file directory, if any.

callback - An ActionListener that is notified (on the event dispatch thread) when the search is finished. The ActionEvent has id=0 if no new links were added, and id=1 if one or more links were added. This parameter can be null, which means that no callback will be notified.

diag - An instantiated modal JDialog which will be used to display the progress of the autosetting. This parameter can be null, which means that no progress update will be shown.

Returns:

the thread performing the autosetting

relativizePath

public static java.io.File relativizePath(java.io.File f,
                          java.util.ArrayList<java.io.File> dirs)

If the file is below one of the directories in a list, return a File specifying a path relative to that directory.

downloadComplete

public void downloadComplete(FileListEntry file)

This is the callback method that the DownloadExternalFile class uses to report the result of a download operation. This call may never come, if the user cancelled the operation.

Specified by:

downloadComplete in interface DownloadExternalFile.DownloadCallback

Parameters:

file - The FileListEntry linking to the resulting local file.

hasUndoInformation

public boolean hasUndoInformation()

Specified by:

hasUndoInformation in interface FieldEditor

undo

public void undo()

Specified by:

undo in interface FieldEditor

hasRedoInformation

public boolean hasRedoInformation()

Specified by:

hasRedoInformation in interface FieldEditor

redo

public void redo()

Specified by:

redo in interface FieldEditor

addUndoableEditListener

public void addUndoableEditListener(javax.swing.event.UndoableEditListener listener)

Specified by:

addUndoableEditListener in interface FieldEditor

setAutoCompleteListener

public void setAutoCompleteListener(AutoCompleteListener listener)

Specified by:

setAutoCompleteListener in interface FieldEditor

clearAutoCompleteSuggestion

public void clearAutoCompleteSuggestion()

Specified by:

clearAutoCompleteSuggestion in interface FieldEditor

setActiveBackgroundColor

public void setActiveBackgroundColor()

Specified by:

setActiveBackgroundColor in interface FieldEditor

setValidBackgroundColor

public void setValidBackgroundColor()

Specified by:

setValidBackgroundColor in interface FieldEditor

setInvalidBackgroundColor

public void setInvalidBackgroundColor()

Specified by:

setInvalidBackgroundColor in interface FieldEditor

updateFontColor

public void updateFontColor()

Specified by:

updateFontColor in interface FieldEditor