net.sf.jabref

Class EntryEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.sf.jabref.EntryEditor

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.VetoableChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, EntryContainer

public class EntryEditor
extends javax.swing.JPanel
implements java.beans.VetoableChangeListener, EntryContainer

GUI component that allows editing of the fields of a BibtexEntry (i.e. the one that shows up, when you double click on an entry in the table) It hosts the tabs (required, general, optional) and the buttons to the left. EntryEditor also registers itself as a VetoableChangeListener, receiving events whenever a field of the entry changes, enabling the text fields to update themselves if the change is made from somewhere else.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EntryEditor.StoreFieldAction

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

javax.swing.JPanel.AccessibleJPanel

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

Modifier and Type	Field and Description
net.sf.jabref.EntryEditor.GenerateKeyAction	generateKeyAction
EntryEditor.StoreFieldAction	storeFieldAction
javax.swing.AbstractAction	writeXmp

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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
EntryEditor(JabRefFrame frame_, BasePanel panel_, BibtexEntry entry_)

Method Summary

Modifier and Type	Method and Description
BibtexDatabase	getDatabase()
BibtexEntry	getEntry()
javax.swing.JComponent	getExtra(java.lang.String string, FieldEditor ed) getExtra checks the field name against BibtexFields.getFieldExtras(name).
BibtexEntryType	getType()
int	getVisiblePanel() Returns the index of the active (visible) panel.
java.lang.String	getVisiblePanelName() Returns the name of the currently selected component.
boolean	isEnabled() Reports the enabled status of the editor, as set by setEnabled()
boolean	lastSourceAccepted() Returns false if the contents of the source panel has not been validated, true othervise.
void	rebuildPanels() Rebuild the field tabs.
void	requestFocus()
void	setEnabled(boolean enabled) Sets the enabled status of all text fields of the entry editor.
void	setField(java.lang.String fieldName, java.lang.String newFieldData)
void	setMovingToDifferentEntry()
void	setupJTextComponent(javax.swing.text.JTextComponent ta) NOTE: This method is only used for the source panel, not for the other tabs.
void	setVisiblePanel(int i) Sets the panel with the given index visible.
void	setVisiblePanel(java.lang.String name)
void	storeCurrentEdit() Makes sure the current edit is stored.
boolean	storeSource(boolean showError)
void	switchTo(BibtexEntry be) Updates this editor to show the given entry, regardless of type correspondence.
void	updateAllContentSelectors()
void	updateAllFields() Sets all the text areas according to the shown entry.
void	updateField(java.lang.Object source)
void	updateSource()
void	validateAllFields() Removes the "invalid field" color from all text areas.
void	vetoableChange(java.beans.PropertyChangeEvent e) Update the JTextArea when a field has changed.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, doLayout, 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, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, 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

Field Detail

storeFieldAction

public EntryEditor.StoreFieldAction storeFieldAction

generateKeyAction

public net.sf.jabref.EntryEditor.GenerateKeyAction generateKeyAction

writeXmp

public javax.swing.AbstractAction writeXmp

Constructor Detail

EntryEditor

public EntryEditor(JabRefFrame frame_,
                   BasePanel panel_,
                   BibtexEntry entry_)

Method Detail

getType

public BibtexEntryType getType()

getEntry

public BibtexEntry getEntry()

Specified by:

getEntry in interface EntryContainer

Returns:

reference to the currently edited entry

getDatabase

public BibtexDatabase getDatabase()

rebuildPanels

public void rebuildPanels()

Rebuild the field tabs. This is called e.g. when a new content selector has been added.

getExtra

public javax.swing.JComponent getExtra(java.lang.String string,
                                       FieldEditor ed)

getExtra checks the field name against BibtexFields.getFieldExtras(name). If the name has an entry, the proper component to be shown is created and returned. Otherwise, null is returned. In addition, e.g. listeners can be added to the field editor, even if no component is returned.

Parameters:

string - Field name

Returns:

Component to show, or null if none.

updateSource

public void updateSource()

setupJTextComponent

public void setupJTextComponent(javax.swing.text.JTextComponent ta)

NOTE: This method is only used for the source panel, not for the other tabs. Look at EntryEditorTab for the setup of text components in the other tabs.

requestFocus

public void requestFocus()

Overrides:

requestFocus in class javax.swing.JComponent

isEnabled

public boolean isEnabled()

Reports the enabled status of the editor, as set by setEnabled()

Overrides:

isEnabled in class java.awt.Component

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled status of all text fields of the entry editor.

Overrides:

setEnabled in class javax.swing.JComponent

storeCurrentEdit

public void storeCurrentEdit()

Makes sure the current edit is stored.

getVisiblePanel

public int getVisiblePanel()

Returns the index of the active (visible) panel.

Returns:

an int value

getVisiblePanelName

public java.lang.String getVisiblePanelName()

Returns the name of the currently selected component.

setVisiblePanel

public void setVisiblePanel(int i)

Sets the panel with the given index visible.

Parameters:

i - an int value

setVisiblePanel

public void setVisiblePanel(java.lang.String name)

switchTo

public void switchTo(BibtexEntry be)

Updates this editor to show the given entry, regardless of type correspondence.

Parameters:

be - a BibtexEntry value

lastSourceAccepted

public boolean lastSourceAccepted()

Returns false if the contents of the source panel has not been validated, true othervise.

storeSource

public boolean storeSource(boolean showError)

setField

public void setField(java.lang.String fieldName,
                     java.lang.String newFieldData)

updateAllFields

public void updateAllFields()

Sets all the text areas according to the shown entry.

validateAllFields

public void validateAllFields()

Removes the "invalid field" color from all text areas.

updateAllContentSelectors

public void updateAllContentSelectors()

vetoableChange

public void vetoableChange(java.beans.PropertyChangeEvent e)

Update the JTextArea when a field has changed.

Specified by:

vetoableChange in interface java.beans.VetoableChangeListener

See Also:

VetoableChangeListener.vetoableChange(java.beans.PropertyChangeEvent)

updateField

public void updateField(java.lang.Object source)

setMovingToDifferentEntry

public void setMovingToDifferentEntry()