org.mdiutil.swing

Class JTriStateCheckBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

javax.swing.JCheckBox

org.mdiutil.swing.JTriStateCheckBox

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants

public class JTriStateCheckBox
extends JCheckBox

A tri-state checkbox.

Since:

1.3.30

See Also:

Serialized Form

Nested Class Summary

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

JCheckBox.AccessibleJCheckBox

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

JToggleButton.AccessibleJToggleButton, JToggleButton.ToggleButtonModel

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

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

Field Summary

Fields inherited from class javax.swing.JCheckBox

BORDER_PAINTED_FLAT_CHANGED_PROPERTY

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JTriStateCheckBox() Creates an initially unselected tri-state check box with no text.
JTriStateCheckBox(String text) Creates an initially unselected tri-state check box with a text.
JTriStateCheckBox(String text, boolean selected) Creates a tri-state check box with a text and specifies whether or not it is initially selected.
JTriStateCheckBox(String text, short state) Creates a tri-state check box with a text and specifies whether or not it is initially selected.

Method Summary

Modifier and Type	Method and Description
void	addStateChangeListener(TriStateChangeListener listener) Add a state change listener.
protected void	fireStateChangeEvent() Fire a state change event.
ImageIcon	getDefaultPartialStateIcon() Return the default partial state icon.
short	getState() Return the tri-state check box state.
TriStateChangeListener[]	getStateChangeListeners() Return the state change listeners.
boolean	isAcceptingPartialState() Return true if the partial state is enabled when the user clicks on the check box.
boolean	isPartialSelected() Return true if the state is TriStateChangeEvent.STATE_PARTIAL_SELECTED.
void	paintChildren(Graphics g)
void	removeStateChangeListener(TriStateChangeListener listener) Remove a state change listener.
void	setAcceptPartialState(boolean acceptPartialState) Set if the partial state is enabled when the user clicks on the check box.
void	setPartialStateIcon(ImageIcon icon) Set the partial state icon.
void	setSelected(boolean b) Sets the state of the check box.
boolean	setState(short state) Set the tri-state check box state.
void	updateUI()

Methods inherited from class javax.swing.JCheckBox

getAccessibleContext, getUIClassID, isBorderPaintedFlat, paramString, setBorderPaintedFlat

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

JTriStateCheckBox

public JTriStateCheckBox()

Creates an initially unselected tri-state check box with no text.

JTriStateCheckBox

public JTriStateCheckBox(String text)

Creates an initially unselected tri-state check box with a text.

Parameters:

text - the text of the check box

JTriStateCheckBox

public JTriStateCheckBox(String text,
                         boolean selected)

Creates a tri-state check box with a text and specifies whether or not it is initially selected.

Parameters:

text - the text of the check box

selected - a boolean value indicating the initial selection state. If true the check box is selected

JTriStateCheckBox

public JTriStateCheckBox(String text,
                         short state)

Creates a tri-state check box with a text and specifies whether or not it is initially selected.

Parameters:

text - the text of the check box

state - the state

Method Detail

setAcceptPartialState

public void setAcceptPartialState(boolean acceptPartialState)

Set if the partial state is enabled when the user clicks on the check box.

Parameters:

acceptPartialState - true if the partial state is enabled when the user clicks on the check box

isAcceptingPartialState

public boolean isAcceptingPartialState()

Return true if the partial state is enabled when the user clicks on the check box.

Returns:

true if the partial state is enabled when the user clicks on the check box

addStateChangeListener

public void addStateChangeListener(TriStateChangeListener listener)

Add a state change listener.

Parameters:

listener - the listener

removeStateChangeListener

public void removeStateChangeListener(TriStateChangeListener listener)

Remove a state change listener.

Parameters:

listener - the listener

getStateChangeListeners

public TriStateChangeListener[] getStateChangeListeners()

Return the state change listeners.

Returns:

the listeners

fireStateChangeEvent

protected void fireStateChangeEvent()

Fire a state change event.

getDefaultPartialStateIcon

public ImageIcon getDefaultPartialStateIcon()

Return the default partial state icon.

Returns:

the icon

setPartialStateIcon

public void setPartialStateIcon(ImageIcon icon)

Set the partial state icon.

Parameters:

icon - the icon

updateUI

public void updateUI()

Overrides:

updateUI in class JCheckBox

getState

public short getState()

Return the tri-state check box state.

Returns:

the state

setState

public final boolean setState(short state)

Set the tri-state check box state. The supported states are:

• TriStateChangeEvent.STATE_UNSELECTED: the unselected state. The AbstractButton.isSelected() method will return false
• TriStateChangeEvent.STATE_SELECTED: the selected state. The AbstractButton.isSelected() method will return true
• TriStateChangeEvent.STATE_PARTIAL_SELECTED: the partial selected state. The AbstractButton.isSelected() method will return true

Parameters:

state - the state

Returns:

true if the check box is selected

isPartialSelected

public boolean isPartialSelected()

Return true if the state is TriStateChangeEvent.STATE_PARTIAL_SELECTED.

Returns:

true if the state is partial selected

setSelected

public void setSelected(boolean b)

Sets the state of the check box. Note that this method does not trigger an actionEvent.

Overrides:

setSelected in class AbstractButton

Parameters:

b - true if the check box is selected, otherwise false

paintChildren

public void paintChildren(Graphics g)

Overrides:

paintChildren in class JComponent