craft

Class SenseQueryDialog

Object

Component

Container

Window

Dialog

JDialog

craft.SenseQueryDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class SenseQueryDialog
extends JDialog

A general dialog box to handle querying of word senses from an interactive user. Its overall operation is to present a list of Wordnet senses, and if the user rejects them, get some free-form generic information from the user. There are two main uses of the dialog: for the user to choose from a list of Wordnet senses, or for the user to enter a generic free-form definition, with a part of speech. It is the caller's responsibility to decide which of the uses is appropriate, with the following exception: if a Wordnet sense is being queried, the user can provide their own definition if they want. In that case, even though a Wordnet type descriptor was passed in, a generic type descriptor is readied for return.
If the Wordnet dictionary can't be found or opened, then the dialog silently ignores Wordnet and just displays the generic pos and definition panel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	SenseQueryDialog.ComboBoxRenderer
(package private) class	SenseQueryDialog.MyDocumentListener

Nested classes/interfaces inherited from class JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

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

Field Summary

Fields

Modifier and Type	Field and Description
private Color	bg
private JPanel	buttonPanel
private boolean	cancelled
private JTextField	def
private net.didion.jwnl.data.Synset	defaultSynset
(package private) SenseQueryDialog.MyDocumentListener	docListener
private String	genericDef
private JPanel	genericPanel
private String	genericPOS
(package private) String[]	glossList
private AbstractTypeDescriptor	initial
private JPanel	labelPanel
private Frame	owner
private String	phrase
private JComboBox	poschoices
(package private) String[]	posList
private AbstractTypeDescriptor	result
private JComboBox	sensechoices
(package private) net.didion.jwnl.data.Synset[]	synsetList
(package private) chargerlib.Transcript	transcript
private boolean	userEditable
private WordnetManager	wnmgr
private String	word
private JPanel	wordnetPanel

Fields inherited from class JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
SenseQueryDialog(Frame frame, String w, String p, AbstractTypeDescriptor defaultDescriptor, boolean tryGeneric) Sets up and runs the querying for a sense.

Method Summary

Modifier and Type	Method and Description
private void	arrangeAppearanceToDescriptorType(Class descriptorClass)
AbstractTypeDescriptor	getTypeDescriptor() Get the result of the dialog's querying.
boolean	isCancelled()
private String	makePrompt()
private void	performCancel()
private void	performOK()
private void	performSkip()
private void	setGenericValues(String pos, String definition)
private void	setup()
private void	setupWordnetChoices()
private String	wrap(String string, int width)

Methods inherited from class JDialog

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

Methods inherited from class Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class Window

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

Methods inherited from class 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 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, remove, 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 Object

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

Field Detail

owner

private Frame owner

word

private String word

phrase

private String phrase

transcript

chargerlib.Transcript transcript

genericPOS

private String genericPOS

genericDef

private String genericDef

defaultSynset

private net.didion.jwnl.data.Synset defaultSynset

poschoices

private final JComboBox poschoices

sensechoices

private final JComboBox sensechoices

def

private final JTextField def

initial

private AbstractTypeDescriptor initial

result

private AbstractTypeDescriptor result

userEditable

private boolean userEditable

cancelled

private boolean cancelled

bg

private Color bg

wnmgr

private WordnetManager wnmgr

synsetList

net.didion.jwnl.data.Synset[] synsetList

glossList

String[] glossList

posList

String[] posList

labelPanel

private JPanel labelPanel

wordnetPanel

private JPanel wordnetPanel

genericPanel

private JPanel genericPanel

buttonPanel

private JPanel buttonPanel

docListener

SenseQueryDialog.MyDocumentListener docListener

Constructor Detail

SenseQueryDialog

public SenseQueryDialog(Frame frame,
                        String w,
                        String p,
                        AbstractTypeDescriptor defaultDescriptor,
                        boolean tryGeneric)

Sets up and runs the querying for a sense.

Parameters:

frame - the controlling frame for this dialog

trans - the transcript on which to write the results of the dialog.

w - The word being queried

p - The phrase in which the word appears

defaultDescriptor - an initial or default value for the type descriptor. If it's a Wordnet type descriptor, then the dialog will gather its own collection of Wordnet senses, then query the user for either one of them, or a free-form definition entered by a user. If it's a generic type descriptor, then there's no choice, just a definition and part of speech that the user can provide.

tryGeneric - Whether to query for a generic definition in case the wordnet query fails.

See Also:

charger.obj.TypeDescriptor#legalPartsOfSpeech

Method Detail

setup

private void setup()

setupWordnetChoices

private void setupWordnetChoices()

setGenericValues

private void setGenericValues(String pos,
                              String definition)

getTypeDescriptor

public AbstractTypeDescriptor getTypeDescriptor()

Get the result of the dialog's querying.

Returns:

null if the user cancelled, or something went wrong, otherwise whatever type descriptor is appropriate. It is up to the caller to determine the return type and handle it appropriately.

isCancelled

public boolean isCancelled()

arrangeAppearanceToDescriptorType

private void arrangeAppearanceToDescriptorType(Class descriptorClass)

performOK

private void performOK()

performSkip

private void performSkip()

performCancel

private void performCancel()

makePrompt

private String makePrompt()

wrap

private String wrap(String string,
                    int width)