com.isti.util.gui
Class EntryFieldPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.isti.util.gui.EntryFieldPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class EntryFieldPanel
extends javax.swing.JPanel

Class EntryFieldPanel defines a single-line entry panel.

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

static int	DEF_HORIZ_GAP Default horizontal gap value.
static int	DEF_VERT_GAP Default vertical gap value.
protected javax.swing.JTextField	textEditFieldObj Text-edit field for panel.

Fields inherited from class javax.swing.JComponent

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

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

EntryFieldPanel()
Creates a single-line entry panel.

EntryFieldPanel(java.lang.Object msgObj)
Creates a single-line entry panel.

EntryFieldPanel(java.lang.Object msgObj, java.lang.Object promptObj)
Creates a single-line entry panel.

EntryFieldPanel(java.lang.Object msgObj, java.lang.Object promptObj, java.lang.Object bottomObj)
Creates a single-line entry panel.

EntryFieldPanel(java.lang.Object msgObj, java.lang.Object promptObj, java.lang.Object bottomObj, int horizGap, int vertGap)
Creates a single-line entry panel.

Method Summary

java.lang.String	getEditFieldText() Returns the contents of the text-edit-field object used by this panel.
javax.swing.JTextField	getTextEditFieldObj() Returns the text-edit-field object used by this panel.
void	setEditFieldText(java.lang.String str) Sets the contents of the text-edit-field object used by this panel.
java.lang.String	showPanelInDialog(java.awt.Component parentComp, java.lang.String titleStr) Displays this entry-line panel in a popup dialog, with "OK" and "Cancel" buttons and a "PLAIN_MESSAGE" style, modal window.
java.lang.String	showPanelInDialog(java.awt.Component parentComp, java.lang.String titleStr, boolean modalFlag) Displays this entry-line panel in a popup dialog, with "OK" and "Cancel" buttons and a "PLAIN_MESSAGE" style of window.
java.lang.String	showPanelInDialog(java.awt.Component parentComp, java.lang.String titleStr, int msgType, boolean modalFlag) Displays this entry-line panel in a popup dialog, with "OK" and "Cancel" buttons.
java.lang.String	showPanelInDialog(java.awt.Component parentComp, java.lang.String titleStr, int optionType, int msgType, boolean modalFlag) Displays this entry-line panel in a popup dialog.

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DEF_HORIZ_GAP

public static final int DEF_HORIZ_GAP

Default horizontal gap value.

See Also:

Constant Field Values

DEF_VERT_GAP

public static final int DEF_VERT_GAP

Default vertical gap value.

See Also:

Constant Field Values

textEditFieldObj

protected final javax.swing.JTextField textEditFieldObj

Text-edit field for panel.

Constructor Detail

EntryFieldPanel

public EntryFieldPanel(java.lang.Object msgObj,
                       java.lang.Object promptObj,
                       java.lang.Object bottomObj,
                       int horizGap,
                       int vertGap)

Creates a single-line entry panel.

Parameters:

msgObj - the message object to show above the text-edit field; may be a 'String', a 'Component', or null for none.

promptObj - the prompt object to show to the left of the text-edit field; may be a 'String', a 'Component', or null for none.

bottomObj - the object to show below the text-edit field; may be a 'String', a 'Component', or null for none.

horizGap - the horizontal gap to use in the layout.

vertGap - the vertical gap to use in the layout.

EntryFieldPanel

public EntryFieldPanel(java.lang.Object msgObj,
                       java.lang.Object promptObj,
                       java.lang.Object bottomObj)

Creates a single-line entry panel.

Parameters:

msgObj - the message object to show above the text-edit field; may be a 'String', a 'Component', or null for none.

promptObj - the prompt object to show to the left of the text-edit field; may be a 'String', a 'Component', or null for none.

bottomObj - the object to show below the text-edit field; may be a 'String', a 'Component', or null for none.

EntryFieldPanel

public EntryFieldPanel(java.lang.Object msgObj,
                       java.lang.Object promptObj)

Creates a single-line entry panel.

Parameters:

msgObj - the message object to show above the text-edit field; may be a 'String', a 'Component', or null for none.

promptObj - the prompt object to show to the left of the text-edit field; may be a 'String', a 'Component', or null for none.

EntryFieldPanel

public EntryFieldPanel(java.lang.Object msgObj)

Creates a single-line entry panel.

Parameters:

msgObj - the message object to show above the text-edit field; may be a 'String', a 'Component', or null for none.

EntryFieldPanel

public EntryFieldPanel()

Creates a single-line entry panel.

Method Detail

showPanelInDialog

public java.lang.String showPanelInDialog(java.awt.Component parentComp,
                                          java.lang.String titleStr,
                                          int optionType,
                                          int msgType,
                                          boolean modalFlag)

Displays this entry-line panel in a popup dialog. This method blocks until the dialog is closed, and then it returns the contents of the text-edit field.

Parameters:

parentComp - the parent component for the popup.

titleStr - the title string for popup window.

optionType - specifies what default option buttons to automatically create if 'optionsArr' is null or empty; one of: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, OK_CANCEL_OPTION or NO_AUTOBUTTONS_OPTION.

msgType - the type of message to be displayed (primarily used to determine the icon from the pluggable Look and Feel): ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE.

modalFlag - true for modal, false for modeless (allows other windows to run).

Returns:

The contents of the text-edit field if the user hit the "OK" button; null if not.

showPanelInDialog

public java.lang.String showPanelInDialog(java.awt.Component parentComp,
                                          java.lang.String titleStr,
                                          int msgType,
                                          boolean modalFlag)

Displays this entry-line panel in a popup dialog, with "OK" and "Cancel" buttons. This method blocks until the dialog is closed, and then it returns the contents of the text-edit field.

Parameters:

parentComp - the parent component for the popup.

titleStr - the title string for popup window.

msgType - the type of message to be displayed (primarily used to determine the icon from the pluggable Look and Feel): ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE.

modalFlag - true for modal, false for modeless (allows other windows to run).

Returns:

The contents of the text-edit field if the user hit the "OK" button; null if not.

showPanelInDialog

public java.lang.String showPanelInDialog(java.awt.Component parentComp,
                                          java.lang.String titleStr,
                                          boolean modalFlag)

Displays this entry-line panel in a popup dialog, with "OK" and "Cancel" buttons and a "PLAIN_MESSAGE" style of window. This method blocks until the dialog is closed, and then it returns the contents of the text-edit field.

Parameters:

parentComp - the parent component for the popup.

titleStr - the title string for popup window.

modalFlag - true for modal, false for modeless (allows other windows to run).

Returns:

The contents of the text-edit field if the user hit the "OK" button; null if not.

showPanelInDialog

public java.lang.String showPanelInDialog(java.awt.Component parentComp,
                                          java.lang.String titleStr)

Displays this entry-line panel in a popup dialog, with "OK" and "Cancel" buttons and a "PLAIN_MESSAGE" style, modal window. This method blocks until the dialog is closed, and then it returns the contents of the text-edit field.

Parameters:

parentComp - the parent component for the popup.

titleStr - the title string for popup window.

Returns:

The contents of the text-edit field if the user hit the "OK" button; null if not.

getEditFieldText

public java.lang.String getEditFieldText()

Returns the contents of the text-edit-field object used by this panel.

Returns:

The contents of the text-edit-field object used by this panel.

setEditFieldText

public void setEditFieldText(java.lang.String str)

Sets the contents of the text-edit-field object used by this panel.

Parameters:

str - the contents string to use.

getTextEditFieldObj

public javax.swing.JTextField getTextEditFieldObj()

Returns the text-edit-field object used by this panel.

Returns:

The 'JTextField' object used by this panel.