com.isti.util.gui
Class CheckBoxItemPanel

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

All Implemented Interfaces:

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

public class CheckBoxItemPanel

extends javax.swing.JPanel

Class CheckBoxItemPanel defines a panel containing a check-box item and message text.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.JCheckBox	checkBoxItemObj Check-box item for panel.
static int	DEF_HORIZ_GAP Default horizontal gap value for items on panel layout.
static int	DEF_VERT_GAP Default vertical gap value for items on panel layout.

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.Container

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

CheckBoxItemPanel()
Creates a check-box item panel.

CheckBoxItemPanel(java.lang.Object msgObj)
Creates a check-box item panel.

CheckBoxItemPanel(java.lang.Object msgObj, java.lang.String promptStr)
Creates a check-box item panel.

CheckBoxItemPanel(java.lang.Object msgObj, java.lang.String promptStr, boolean initialStateFlg)
Creates a check-box item panel.

CheckBoxItemPanel(java.lang.Object msgObj, java.lang.String promptStr, java.lang.Object bottomObj, boolean initialStateFlg)
Creates a check-box item panel.

CheckBoxItemPanel(java.lang.Object msgObj, java.lang.String promptStr, java.lang.Object bottomObj, boolean initialStateFlg, int horizGap, int vertGap)
Creates a check-box item panel.

Method Summary

javax.swing.JCheckBox	getCheckBoxItemObj() Returns the check-box object used by this panel.
boolean	getCheckBoxState() Returns the state of the check-box item.
void	setCheckBoxState(boolean flgVal) Sets the state of the check-box item.
void	setCheckBoxText(java.lang.String textStr) Sets the text shown on the check-box item.
int	showPanelInDialog(java.awt.Component parentComp, java.lang.String titleStr) Displays this check-box panel in a popup dialog, with "OK" and "Cancel" buttons and a "PLAIN_MESSAGE" style, modal window.
int	showPanelInDialog(java.awt.Component parentComp, java.lang.String titleStr, boolean modalFlag) Displays this check-box panel in a popup dialog, with "OK" and "Cancel" buttons and a "PLAIN_MESSAGE" style of window.
int	showPanelInDialog(java.awt.Component parentComp, java.lang.String titleStr, int msgType, boolean modalFlag) Displays this check-box panel in a popup dialog, with "OK" and "Cancel" buttons.
int	showPanelInDialog(java.awt.Component parentComp, java.lang.String titleStr, int optionType, int msgType, boolean modalFlag) Displays this check-box 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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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 for items on panel layout.

See Also:

Constant Field Values

DEF_VERT_GAP

public static final int DEF_VERT_GAP

Default vertical gap value for items on panel layout.

See Also:

Constant Field Values

checkBoxItemObj

protected final javax.swing.JCheckBox checkBoxItemObj

Check-box item for panel.

Constructor Detail

CheckBoxItemPanel

public CheckBoxItemPanel(java.lang.Object msgObj,
                         java.lang.String promptStr,
                         java.lang.Object bottomObj,
                         boolean initialStateFlg,
                         int horizGap,
                         int vertGap)

Creates a check-box item panel.

Parameters:

msgObj - the message object to show above the check-box item; may be a 'String', a 'Component', or null for none.

promptStr - the prompt string to show to the right of the check box.

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

initialStateFlg - sets the initial state of the check-box item; true for selected, false for not selected.

horizGap - the horizontal gap to use in the layout.

vertGap - the vertical gap to use in the layout.

CheckBoxItemPanel

public CheckBoxItemPanel(java.lang.Object msgObj,
                         java.lang.String promptStr,
                         java.lang.Object bottomObj,
                         boolean initialStateFlg)

Creates a check-box item panel.

Parameters:

msgObj - the message object to show above the check-box item; may be a 'String', a 'Component', or null for none.

promptStr - the prompt string to show to the right of the check box.

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

initialStateFlg - sets the initial state of the check-box item; true for selected, false for not selected.

CheckBoxItemPanel

public CheckBoxItemPanel(java.lang.Object msgObj,
                         java.lang.String promptStr,
                         boolean initialStateFlg)

Creates a check-box item panel.

Parameters:

msgObj - the message object to show above the check-box item; may be a 'String', a 'Component', or null for none.

promptStr - the prompt string to show to the right of the check box.

initialStateFlg - sets the initial state of the check-box item; true for selected, false for not selected.

CheckBoxItemPanel

public CheckBoxItemPanel(java.lang.Object msgObj,
                         java.lang.String promptStr)

Creates a check-box item panel.

Parameters:

msgObj - the message object to show above the check-box item; may be a 'String', a 'Component', or null for none.

promptStr - the prompt string to show to the right of the check box.

CheckBoxItemPanel

public CheckBoxItemPanel(java.lang.Object msgObj)

Creates a check-box item panel.

Parameters:

msgObj - the message object to show above the check-box item; may be a 'String', a 'Component', or null for none.

CheckBoxItemPanel

public CheckBoxItemPanel()

Creates a check-box item panel.

Method Detail

showPanelInDialog

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

Displays this check-box panel in a popup dialog. This method blocks until the dialog is dismissed by the user (even if the window is non-modal). The returned value will be one of the "..._OPTION" values.

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:

An integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the dialog without selecting an option.

showPanelInDialog

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

Displays this check-box panel in a popup dialog, with "OK" and "Cancel" buttons. This method blocks until the dialog is dismissed by the user (even if the window is non-modal). The returned value will be one of the "..._OPTION" values.

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:

An integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the dialog without selecting an option.

showPanelInDialog

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

Displays this check-box panel in a popup dialog, with "OK" and "Cancel" buttons and a "PLAIN_MESSAGE" style of window. This method blocks until the dialog is dismissed by the user (even if the window is non-modal). The returned value will be one of the "..._OPTION" values.

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:

An integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the dialog without selecting an option.

showPanelInDialog

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

Displays this check-box panel in a popup dialog, with "OK" and "Cancel" buttons and a "PLAIN_MESSAGE" style, modal window. This method blocks until the dialog is dismissed by the user (even if the window is non-modal). The returned value will be one of the "..._OPTION" values.

Parameters:

parentComp - the parent component for the popup.

titleStr - the title string for popup window.

Returns:

An integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the dialog without selecting an option.

getCheckBoxState

public boolean getCheckBoxState()

Returns the state of the check-box item.

Returns:

true if selected; false if not.

setCheckBoxState

public void setCheckBoxState(boolean flgVal)

Sets the state of the check-box item.

Parameters:

flgVal - true for selected; false for not.

setCheckBoxText

public void setCheckBoxText(java.lang.String textStr)

Sets the text shown on the check-box item.

Parameters:

textStr - text to be shown.

getCheckBoxItemObj

public javax.swing.JCheckBox getCheckBoxItemObj()

Returns the check-box object used by this panel.

Returns:

The 'JCheckBox' object used by this panel.