net.sf.jabref.groups

Class GroupSelector

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.jgoodies.uif_lite.panel.SimpleInternalFrame

net.sf.jabref.SidePaneComponent

net.sf.jabref.groups.GroupSelector

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.TreeSelectionListener, ErrorMessageDisplay

public class GroupSelector
extends SidePaneComponent
implements javax.swing.event.TreeSelectionListener, java.awt.event.ActionListener, ErrorMessageDisplay

The whole UI component holding the groups tree and the buttons

See Also:

Serialized Form

Nested Class Summary

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
javax.swing.AbstractAction	clearHighlightAction

Fields inherited from class net.sf.jabref.SidePaneComponent

close, panel, visible

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
GroupSelector(JabRefFrame frame, SidePaneManager manager) The first element for each group defines which field to use for the quicksearch.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
void	addGroups(GroupTreeNode newGroups, javax.swing.undo.CompoundEdit ce) Adds the specified node as a child of the current root.
void	componentClosing() Override this method if the component needs to make any changes before it can close.
void	componentOpening() Override this method if the component needs to do any actions when opening.
void	concludeAssignment(javax.swing.undo.AbstractUndoableEdit undo, GroupTreeNode node, int assignedEntries)
void	concludeMoveGroup(javax.swing.undo.AbstractUndoableEdit undo, GroupTreeNode node) Concludes the moving of a group tree node by storing the specified undo information, marking the change, and setting the status line.
java.util.Enumeration<javax.swing.tree.TreePath>	getExpandedPaths()
GroupsTree	getGroupsTree()
GroupTreeNode	getGroupTreeRoot()
javax.swing.tree.TreePath	getSelectionPath()
boolean	moveNodeDown(GroupTreeNode node, boolean checkSingleSelection)
boolean	moveNodeLeft(GroupTreeNode node, boolean checkSingleSelection)
boolean	moveNodeRight(GroupTreeNode node, boolean checkSingleSelection)
boolean	moveNodeUp(GroupTreeNode node, boolean checkSingleSelection)
void	reportError(java.lang.String errorMessage) This method is required by the ErrorMessageDisplay interface, and lets this class serve as a callback for regular expression exceptions happening in DatabaseSearch.
void	reportError(java.lang.String errorMessage, java.lang.Exception exception) This method is required by the ErrorMessageDisplay interface, and lets this class serve as a callback for regular expression exceptions happening in DatabaseSearch.
void	revalidateGroups() Revalidate the groups tree (e.g.
void	revalidateGroups(GroupTreeNode node) Revalidate the groups tree (e.g.
void	revalidateGroups(javax.swing.tree.TreePath[] selectionPaths, java.util.Enumeration<javax.swing.tree.TreePath> expandedNodes) Revalidate the groups tree (e.g.
void	revalidateGroups(javax.swing.tree.TreePath[] selectionPaths, java.util.Enumeration<javax.swing.tree.TreePath> expandedNodes, GroupTreeNode node) Revalidate the groups tree (e.g.
void	setActiveBasePanel(BasePanel panel) panel may be null to indicate that no file is currently open.
void	setGroups(GroupTreeNode groupsRoot)
void	showMatchingGroups(BibtexEntry[] entries, boolean requireAll) Highlight all groups that contain any/all of the specified entries.
protected void	showOverlappingGroups(java.util.List<BibtexEntry> matches) Show groups that, if selected, would show at least one of the entries found in the specified search.
void	updateGroupContentIfEnabled(boolean deletion)
void	valueChanged(javax.swing.event.TreeSelectionEvent e)

Methods inherited from class net.sf.jabref.SidePaneComponent

getActiveBasePanel, getMinimumSize, hideAway

Methods inherited from class com.jgoodies.uif_lite.panel.SimpleInternalFrame

getContent, getFrameIcon, getHeaderBackground, getTextForeground, getTitle, getToolBar, isSelected, setContent, setFrameIcon, setSelected, setTitle, setToolBar, updateUI

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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, 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, 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, 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, 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

Field Detail

clearHighlightAction

public final javax.swing.AbstractAction clearHighlightAction

Constructor Detail

GroupSelector

public GroupSelector(JabRefFrame frame,
                     SidePaneManager manager)

The first element for each group defines which field to use for the quicksearch. The next two define the name and regexp for the group.

Method Detail

updateGroupContentIfEnabled

public void updateGroupContentIfEnabled(boolean deletion)

Parameters:

deletion - != addition

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent e)

Specified by:

valueChanged in interface javax.swing.event.TreeSelectionListener

revalidateGroups

public void revalidateGroups(javax.swing.tree.TreePath[] selectionPaths,
                             java.util.Enumeration<javax.swing.tree.TreePath> expandedNodes)

Revalidate the groups tree (e.g. after the data stored in the model has been changed) and set the specified selection and expansion state.

Parameters:

node - If this is non-null, the view is scrolled to make it visible.

revalidateGroups

public void revalidateGroups(javax.swing.tree.TreePath[] selectionPaths,
                             java.util.Enumeration<javax.swing.tree.TreePath> expandedNodes,
                             GroupTreeNode node)

Revalidate the groups tree (e.g. after the data stored in the model has been changed) and set the specified selection and expansion state.

Parameters:

node - If this is non-null, the view is scrolled to make it visible.

revalidateGroups

public void revalidateGroups()

Revalidate the groups tree (e.g. after the data stored in the model has been changed) and maintain the current selection and expansion state.

revalidateGroups

public void revalidateGroups(GroupTreeNode node)

Revalidate the groups tree (e.g. after the data stored in the model has been changed) and maintain the current selection and expansion state.

Parameters:

node - If this is non-null, the view is scrolled to make it visible.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

componentOpening

public void componentOpening()

Description copied from class: SidePaneComponent

Override this method if the component needs to do any actions when opening.

Overrides:

componentOpening in class SidePaneComponent

componentClosing

public void componentClosing()

Description copied from class: SidePaneComponent

Override this method if the component needs to make any changes before it can close.

Overrides:

componentClosing in class SidePaneComponent

setGroups

public void setGroups(GroupTreeNode groupsRoot)

addGroups

public void addGroups(GroupTreeNode newGroups,
                      javax.swing.undo.CompoundEdit ce)

Adds the specified node as a child of the current root. The group contained in newGroups must not be of type AllEntriesGroup, since every tree has exactly one AllEntriesGroup (its root). The newGroups are inserted directly, i.e. they are not deepCopy()'d.

getSelectionPath

public javax.swing.tree.TreePath getSelectionPath()

moveNodeUp

public boolean moveNodeUp(GroupTreeNode node,
                          boolean checkSingleSelection)

Parameters:

node - The node to move

Returns:

true if move was successful, false if not.

moveNodeDown

public boolean moveNodeDown(GroupTreeNode node,
                            boolean checkSingleSelection)

Parameters:

node - The node to move

Returns:

true if move was successful, false if not.

moveNodeLeft

public boolean moveNodeLeft(GroupTreeNode node,
                            boolean checkSingleSelection)

Parameters:

node - The node to move

Returns:

true if move was successful, false if not.

moveNodeRight

public boolean moveNodeRight(GroupTreeNode node,
                             boolean checkSingleSelection)

Parameters:

node - The node to move

Returns:

true if move was successful, false if not.

concludeMoveGroup

public void concludeMoveGroup(javax.swing.undo.AbstractUndoableEdit undo,
                              GroupTreeNode node)

Concludes the moving of a group tree node by storing the specified undo information, marking the change, and setting the status line.

Parameters:

undo - Undo information for the move operation.

node - The node that has been moved.

concludeAssignment

public void concludeAssignment(javax.swing.undo.AbstractUndoableEdit undo,
                               GroupTreeNode node,
                               int assignedEntries)

getGroupTreeRoot

public GroupTreeNode getGroupTreeRoot()

getExpandedPaths

public java.util.Enumeration<javax.swing.tree.TreePath> getExpandedPaths()

setActiveBasePanel

public void setActiveBasePanel(BasePanel panel)

panel may be null to indicate that no file is currently open.

Overrides:

setActiveBasePanel in class SidePaneComponent

reportError

public void reportError(java.lang.String errorMessage)

This method is required by the ErrorMessageDisplay interface, and lets this class serve as a callback for regular expression exceptions happening in DatabaseSearch.

Specified by:

reportError in interface ErrorMessageDisplay

Parameters:

errorMessage -

reportError

public void reportError(java.lang.String errorMessage,
                        java.lang.Exception exception)

This method is required by the ErrorMessageDisplay interface, and lets this class serve as a callback for regular expression exceptions happening in DatabaseSearch.

Specified by:

reportError in interface ErrorMessageDisplay

Parameters:

errorMessage -

exception - Exception representing the error condition.

showMatchingGroups

public void showMatchingGroups(BibtexEntry[] entries,
                               boolean requireAll)

Highlight all groups that contain any/all of the specified entries. If entries is null or has zero length, highlight is cleared.

showOverlappingGroups

protected void showOverlappingGroups(java.util.List<BibtexEntry> matches)

Show groups that, if selected, would show at least one of the entries found in the specified search.

getGroupsTree

public GroupsTree getGroupsTree()