gate.gui.annedit

Class SearchAndAnnotatePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

gate.gui.annedit.SearchAndAnnotatePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class SearchAndAnnotatePanel
extends JPanel

Build a GUI for searching and annotating annotations in a text. It needs to be called from a OwnedAnnotationEditor.

Here is an example how to add it to a JPanel panel.

 SearchAndAnnotatePanel searchPanel =
     new SearchAndAnnotatePanel(panel.getBackground(), this, window);
 panel.add(searchPanel);
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SearchAndAnnotatePanel.AnnotateAllMatchesAction
protected class	SearchAndAnnotatePanel.AnnotateMatchAction
protected class	SearchAndAnnotatePanel.FindFirstAction
protected class	SearchAndAnnotatePanel.FindNextAction
protected class	SearchAndAnnotatePanel.FindPreviousAction
protected class	SearchAndAnnotatePanel.SmallButton A smaller JButton with less margins.
protected class	SearchAndAnnotatePanel.UndoAnnotateAllMatchesAction Remove the annotations added by the last action that annotate all matches.

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedList<Annotation>	annotateAllAnnotationsID List of annotations ID that have been created by the AnnotateAllMatchesAction.
protected SearchAndAnnotatePanel.AnnotateAllMatchesAction	annotateAllMatchesAction
protected SearchAndAnnotatePanel.SmallButton	annotateAllMatchesSmallButton
protected SearchAndAnnotatePanel.AnnotateMatchAction	annotateMatchAction
protected AnnotationSetListener	annotationSetListener Listener for updating the list of searched annotations.
protected String	content
protected SearchAndAnnotatePanel.FindFirstAction	findFirstAction
protected SearchAndAnnotatePanel.FindNextAction	findNextAction
protected SearchAndAnnotatePanel.FindPreviousAction	findPreviousAction
protected SearchAndAnnotatePanel.SmallButton	firstSmallButton
protected JButton	helpRegExpButton Help button that gives predefined regular expressions.
protected LinkedList<Vector<Integer>>	matchedIndexes Start and end index of the all the matches.
protected Matcher	matcher Shared instance of the matcher.
protected int	nextMatchStartsFrom
protected Box	searchBox The box used to host the search pane.
protected JCheckBox	searchCaseSensChk Checkbox for enabling case sensitive searching.
protected JCheckBox	searchEnabledCheck Checkbox for showing the search UI.
protected JCheckBox	searchHighlightsChk Checkbox for enabling whole word searching.
protected JPanel	searchPane The pane containing the UI for search and annotate functionality.
protected JCheckBox	searchRegExpChk Checkbox for enabling RegEx searching.
protected JTextField	searchTextField Text field for searching
protected JCheckBox	searchWholeWordsChk Checkbox for enabling whole word searching.
protected SearchAndAnnotatePanel.UndoAnnotateAllMatchesAction	undoAnnotateAllMatchesAction

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
SearchAndAnnotatePanel(Color color, OwnedAnnotationEditor annotationEditor, Window window)

Method Summary

Modifier and Type	Method and Description
AnnotationEditorOwner	getOwner()
protected void	initGui(Color color) Build the GUI with JPanels and Boxes.
protected void	initListeners()

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

annotationSetListener

protected AnnotationSetListener annotationSetListener

Listener for updating the list of searched annotations.

searchBox

protected Box searchBox

The box used to host the search pane.

searchPane

protected JPanel searchPane

The pane containing the UI for search and annotate functionality.

searchTextField

protected JTextField searchTextField

Text field for searching

searchRegExpChk

protected JCheckBox searchRegExpChk

Checkbox for enabling RegEx searching.

helpRegExpButton

protected JButton helpRegExpButton

Help button that gives predefined regular expressions.

searchCaseSensChk

protected JCheckBox searchCaseSensChk

Checkbox for enabling case sensitive searching.

searchWholeWordsChk

protected JCheckBox searchWholeWordsChk

Checkbox for enabling whole word searching.

searchHighlightsChk

protected JCheckBox searchHighlightsChk

Checkbox for enabling whole word searching.

searchEnabledCheck

protected JCheckBox searchEnabledCheck

Checkbox for showing the search UI.

matcher

protected Matcher matcher

Shared instance of the matcher.

findFirstAction

protected SearchAndAnnotatePanel.FindFirstAction findFirstAction

findPreviousAction

protected SearchAndAnnotatePanel.FindPreviousAction findPreviousAction

findNextAction

protected SearchAndAnnotatePanel.FindNextAction findNextAction

annotateMatchAction

protected SearchAndAnnotatePanel.AnnotateMatchAction annotateMatchAction

annotateAllMatchesAction

protected SearchAndAnnotatePanel.AnnotateAllMatchesAction annotateAllMatchesAction

undoAnnotateAllMatchesAction

protected SearchAndAnnotatePanel.UndoAnnotateAllMatchesAction undoAnnotateAllMatchesAction

nextMatchStartsFrom

protected int nextMatchStartsFrom

content

protected String content

matchedIndexes

protected LinkedList<Vector<Integer>> matchedIndexes

Start and end index of the all the matches.

annotateAllAnnotationsID

protected LinkedList<Annotation> annotateAllAnnotationsID

List of annotations ID that have been created by the AnnotateAllMatchesAction.

firstSmallButton

protected SearchAndAnnotatePanel.SmallButton firstSmallButton

annotateAllMatchesSmallButton

protected SearchAndAnnotatePanel.SmallButton annotateAllMatchesSmallButton

Constructor Detail

SearchAndAnnotatePanel

public SearchAndAnnotatePanel(Color color,
                              OwnedAnnotationEditor annotationEditor,
                              Window window)

Method Detail

initGui

protected void initGui(Color color)

Build the GUI with JPanels and Boxes.

Parameters:

color - Color of the background. _ _ _ _ _ V Search & Annotate |_| Case |_| Regexp |_| Whole |_| Highlights _______________________________________________ |V_Searched_Expression__________________________| |?| |First| |Prev.| |Next| |Annotate| |Ann. all next|

initListeners

protected void initListeners()

getOwner

public AnnotationEditorOwner getOwner()

Returns:

the owner