org.ceryle.ui.graph
Class FindTopicDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.ceryle.ui.graph.FindTopicDialog

All Implemented Interfaces:

FocusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, MessageWriter

public class FindTopicDialog
extends JDialog
implements MessageWriter, FocusListener

A class that creates a dialog box used for searching for a topic in the graph. This uses the gnu.regexp regular expression (RE) package, which allows for sixteen different (!) RE syntax variations, which should pretty much satisfy anyone's preferences. With JDK 1.4's availability of an RE package, this could be replaced at some point.

Since:

JDK1.3

Version:

$Id: FindTopicDialog.java,v 3.9 2007-06-20 01:28:21 altheim Exp $

Author:

Murray Altheim

See Also:

Serialized Form

Nested Class Summary

class

FindTopicDialog.FindKeyListener Internal class implements KeyAdapter to capture key events.

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

FindTopicDialog(TMLayoutPanel tmlpanel, String defaultString, BitSet settings)
Constructor for a FindTopicDialog, including a reference to the parent Desktop, a TopicMap topicmap, an optional default search String defaultString (which can be null), and a bitwise int settings to provide various search settings.

Method Summary

protected void	exit() Closes the Find Topic dialog (disposing of it).
void	find(boolean next) Performs the Find function, Find Next if next is true.
void	focusGained(FocusEvent fe) Indicates that the panel has gained the focus.
void	focusLost(FocusEvent fe) Indicates that the panel has lost the focus.
FindTopicPanel	getFindTopicPanel() Returns the internal FindTopicPanel (that does all the work).
boolean	isSearchVisibleOnly() Returns true if the current setting is to search visible nodes only.
void	reload() Requests a reload of the topics based on the current graph.
String	writeMessage(int status, String message) Writes the String message to the current message window.
void	writeMessage(String message) Writes the String message to the current message window.
void	writeStatus(String message) Sets the content of the status line to the String message.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, isOpaque, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FindTopicDialog

public FindTopicDialog(TMLayoutPanel tmlpanel,
                       String defaultString,
                       BitSet settings)

Constructor for a FindTopicDialog, including a reference to the parent Desktop, a TopicMap topicmap, an optional default search String defaultString (which can be null), and a bitwise int settings to provide various search settings.

Parameters:

tmlpanel - the TMLayoutPanel containing the TopicMap object

defaultString - the default search string

settings - bitwise settings

Method Detail

getFindTopicPanel

public FindTopicPanel getFindTopicPanel()

Returns the internal FindTopicPanel (that does all the work).

reload

public void reload()

Requests a reload of the topics based on the current graph.

isSearchVisibleOnly

public boolean isSearchVisibleOnly()

Returns true if the current setting is to search visible nodes only.

find

public void find(boolean next)

Performs the Find function, Find Next if next is true. If a search has not yet occurred, a Find is performed.

writeMessage

public void writeMessage(String message)

Writes the String message to the current message window.

Specified by:

writeMessage in interface MessageWriter

writeMessage

public String writeMessage(int status,
                           String message)

Writes the String message to the current message window.

Specified by:

writeMessage in interface MessageWriter

Returns:

the String value of the message, including any changes made.

See Also:

MessageHandler

writeStatus

public void writeStatus(String message)

Sets the content of the status line to the String message.

Specified by:

writeStatus in interface MessageWriter

focusGained

public void focusGained(FocusEvent fe)

Indicates that the panel has gained the focus.

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent fe)

Indicates that the panel has lost the focus.

Specified by:

focusLost in interface FocusListener

exit

protected void exit()

Closes the Find Topic dialog (disposing of it).