ptolemy.vergil.basic

Class SearchResultsDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

ptolemy.actor.gui.PtolemyDialog

ptolemy.vergil.basic.SearchResultsDialog

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.ListSelectionListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants, QueryListener

Direct Known Subclasses:

DependencyResultsDialog

public class SearchResultsDialog
extends PtolemyDialog
implements javax.swing.event.ListSelectionListener, QueryListener

This class is a non-modal dialog for displaying search results.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Edward A. Lee

See Also:

Serialized Form

Pt.AcceptedRating:

Red (eal)

Pt.ProposedRating:

Yellow (eal)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SearchResultsDialog.NamedObjComparator Comparator for sorting named objects alphabetically by name.
(package private) class	SearchResultsDialog.NamedObjRenderer Default renderer for results table.
(package private) class	SearchResultsDialog.ResultsTableModel The table model for the search results table.

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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
protected java.awt.Frame	_owner The The frame that, per the user, is generating the dialog.
protected Query	_query The query portion of the dialog.
protected javax.swing.JTable	_resultsTable Table for search results.
protected SearchResultsDialog.ResultsTableModel	_resultsTableModel Model for the table.
protected Entity	_target The entity on which search is performed.

Fields inherited from class ptolemy.actor.gui.PtolemyDialog

_cancelButton, _configuration, _helpButton

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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

Constructors

Constructor and Description
SearchResultsDialog(DialogTableau tableau, java.awt.Frame owner, Entity target, Configuration configuration) Construct a dialog for search results.
SearchResultsDialog(java.lang.String title, DialogTableau tableau, java.awt.Frame owner, Entity target, Configuration configuration) Construct a dialog for search results.

Method Summary

Modifier and Type	Method and Description
protected void	_clearHighlights() Clear all highlights.
protected void	_createExtendedButtons(javax.swing.JPanel panel) Create buttons.
protected java.util.Set<NamedObj>	_find(NamedObj container, java.lang.String text, boolean includeValues, boolean includeNames, boolean recursive, boolean caseSensitive, java.util.regex.Pattern pattern) Return a list of objects in the model that match the specified search.
protected java.net.URL	_getHelpURL() Return a URL that points to the help page.
protected void	_highlightResult(NamedObj target) Highlight the specified object and all its containers to indicate that it matches the search criteria.
protected void	_initializeQuery() Initialize the query dialog.
protected void	_processButtonPress(java.lang.String button) Process a button press.
protected void	_search() Perform a search and update the results table.
void	changed(java.lang.String name) Execute the search.
void	dispose() Override to clear highlights.
void	valueChanged(javax.swing.event.ListSelectionEvent event) React to notice that the selection has changed.

Methods inherited from class ptolemy.actor.gui.PtolemyDialog

_cancel, _isDirty, _setDirty, _showHelp, actionPerformed, getTarget, saveIfRequired, setContents, setScrollableContents, setTarget

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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 java.awt.MenuContainer

getFont, postEvent

Field Detail

_owner

protected java.awt.Frame _owner

The The frame that, per the user, is generating the dialog. Typically a BasicGraphFrame.

_resultsTableModel

protected SearchResultsDialog.ResultsTableModel _resultsTableModel

Model for the table.

_query

protected Query _query

The query portion of the dialog.

_resultsTable

protected javax.swing.JTable _resultsTable

Table for search results.

_target

protected Entity _target

The entity on which search is performed.

Constructor Detail

SearchResultsDialog

public SearchResultsDialog(DialogTableau tableau,
                           java.awt.Frame owner,
                           Entity target,
                           Configuration configuration)

Construct a dialog for search results.

Parameters:

tableau - The DialogTableau.

owner - The frame that, per the user, is generating the dialog.

target - The object on which the search is to be done.

configuration - The configuration to use to open the help screen (or null if help is not supported).

SearchResultsDialog

public SearchResultsDialog(java.lang.String title,
                           DialogTableau tableau,
                           java.awt.Frame owner,
                           Entity target,
                           Configuration configuration)

Construct a dialog for search results.

Parameters:

title - The title of the dialog

tableau - The DialogTableau.

owner - The frame that, per the user, is generating the dialog.

target - The object on which the search is to be done.

configuration - The configuration to use to open the help screen (or null if help is not supported).

Method Detail

changed

public void changed(java.lang.String name)

Execute the search. This is called to notify this dialog that one of the search options has changed.

Specified by:

changed in interface QueryListener

Parameters:

name - The name of the query field that changed.

dispose

public void dispose()

Override to clear highlights.

Overrides:

dispose in class java.awt.Window

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent event)

React to notice that the selection has changed.

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

Parameters:

event - The selection event.

_clearHighlights

protected void _clearHighlights()

Clear all highlights.

_highlightResult

protected void _highlightResult(NamedObj target)

Highlight the specified object and all its containers to indicate that it matches the search criteria.

Parameters:

target - The target.

_initializeQuery

protected void _initializeQuery()

Initialize the query dialog. Derived classes may change the layout of the query dialog.

_search

protected void _search()

Perform a search and update the results table.

_createExtendedButtons

protected void _createExtendedButtons(javax.swing.JPanel panel)

Create buttons.

Specified by:

_createExtendedButtons in class PtolemyDialog

Parameters:

panel - The panel into which to put the buttons.

_find

protected java.util.Set<NamedObj> _find(NamedObj container,
                                        java.lang.String text,
                                        boolean includeValues,
                                        boolean includeNames,
                                        boolean recursive,
                                        boolean caseSensitive,
                                        java.util.regex.Pattern pattern)

Return a list of objects in the model that match the specified search.

Parameters:

container - The container within which to search.

text - The text to find.

includeValues - True to search values of Settable objects.

includeNames - True to include names of objects.

recursive - True to search within objects immediately contained.

caseSensitive - True to match the case.

pattern - The text compiled as a pattern, or null if the text could not be compiled as a pattern.

Returns:

The list of objects in the model that match the specified search.

_getHelpURL

protected java.net.URL _getHelpURL()

Return a URL that points to the help page.

Specified by:

_getHelpURL in class PtolemyDialog

Returns:

A URL that points to the help page

_processButtonPress

protected void _processButtonPress(java.lang.String button)

Process a button press.

Overrides:

_processButtonPress in class PtolemyDialog

Parameters:

button - The button.