JComponentPack 1.5.0

com.zfqjava.swing
Class XCheckBox

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.AbstractButton
                  extended by javax.swing.JToggleButton
                      extended by javax.swing.JCheckBox
                          extended by com.zfqjava.swing.XCheckBox
All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants

public class XCheckBox
extends JCheckBox

XCheckBox is a three state CheckBox.

Since:
JDirChooser 1.2
See Also:
Serialized Form

Nested Class Summary
protected  class XCheckBox.AccessibleXCheckBox
          This class implements accessibility support for the XCheckBox class.
 
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
static int DESELECTED
          Type used for deselected state.
static int PENDING
          Type used for pending state.
static int SELECTED
          Type used for selected state.
 
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
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 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
XCheckBox()
          Constructs a three state check box.
XCheckBox(Action a)
          Creates a check box where properties are taken from the Action supplied.
XCheckBox(Icon icon)
          Creates an initially unselected check box with an icon.
XCheckBox(Icon icon, boolean selected)
          Creates a check box with an icon and specifies whether or not it is initially selected.
XCheckBox(String text)
          Creates an initially unselected check box with text.
XCheckBox(String text, boolean selected)
          Creates a check box with text and specifies whether or not it is initially selected.
XCheckBox(String text, Icon icon)
          Creates an initially unselected check box with the specified text and icon.
XCheckBox(String text, Icon icon, boolean selected)
          Creates a check box with text and icon, and specifies whether or not it is initially selected.
XCheckBox(String text, Icon icon, int state)
          Creates a check box with text and icon, and specifies select state.
 
Method Summary
 AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this XCheckBox.
 Icon getDisabledPendingIcon()
          Returns the disabled pending icon.
 Icon getPendingIcon()
          Returns the pending icon.
 Icon getRolloverPendingIcon()
          Returns the the rollover pending icon.
 int getSelectState()
          Returns the select state.
 String getUIClassID()
          Returns a string that specifies the name of the L&F class that renders this component.
 boolean isPendingState()
          Determines the pending state.
 boolean isSelected()
          Overide the method to return the selected value.
protected  String paramString()
          Returns a string representation of this XCheckBox.
 void setDisabledPendingIcon(Icon disabledPendingIcon)
          Sets the disabled pending icon.
 void setPendingIcon(Icon pendingIcon)
          Sets the pending icon.
 void setRolloverPendingIcon(Icon rolloverPendingIcon)
          Sets the rollover pending icon.
 void setSelected(boolean b)
          Overide the method to set the selected state.
 void setSelectState(int state)
          Sets the select state.
 void updateUI()
          Resets the UI property with a value from the current look and feel.
 
Methods inherited from class javax.swing.JCheckBox
isBorderPaintedFlat, 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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, 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, 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, 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

SELECTED

public static final int SELECTED
Type used for selected state.

See Also:
Constant Field Values

DESELECTED

public static final int DESELECTED
Type used for deselected state.

See Also:
Constant Field Values

PENDING

public static final int PENDING
Type used for pending state.

See Also:
Constant Field Values
Constructor Detail

XCheckBox

public XCheckBox()
Constructs a three state check box.


XCheckBox

public XCheckBox(Icon icon)
Creates an initially unselected check box with an icon.

Parameters:
icon - the Icon image to display

XCheckBox

public XCheckBox(Icon icon,
                 boolean selected)
Creates a check box with an icon and specifies whether or not it is initially selected.

Parameters:
icon - the Icon image to display
selected - a boolean value indicating the initial selection state. If true the check box is selected

XCheckBox

public XCheckBox(String text)
Creates an initially unselected check box with text.

Parameters:
text - the text of the check box.

XCheckBox

public XCheckBox(Action a)
Creates a check box where properties are taken from the Action supplied.

Parameters:
a - the action

XCheckBox

public XCheckBox(String text,
                 boolean selected)
Creates a check box with 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

XCheckBox

public XCheckBox(String text,
                 Icon icon)
Creates an initially unselected check box with the specified text and icon.

Parameters:
text - the text of the check box.
icon - the Icon image to display

XCheckBox

public XCheckBox(String text,
                 Icon icon,
                 boolean selected)
Creates a check box with text and icon, and specifies whether or not it is initially selected.

Parameters:
text - the text of the check box.
icon - the Icon image to display
selected - a boolean value indicating the initial selection state. If true the check box is selected

XCheckBox

public XCheckBox(String text,
                 Icon icon,
                 int state)
Creates a check box with text and icon, and specifies select state.

Parameters:
text - the text of the check box
icon - the Icon image to display
state - the select state, one of 3 legal values:
  • XCheckBox.SELECTED
  • XCheckBox.DESELECTED
  • XCheckBox.PENDING
Method Detail

updateUI

public void updateUI()
Resets the UI property with a value from the current look and feel.

Overrides:
updateUI in class JCheckBox
See Also:
JComponent.updateUI()

getUIClassID

public String getUIClassID()
Returns a string that specifies the name of the L&F class that renders this component.

Overrides:
getUIClassID in class JCheckBox
Returns:
"CheckBoxUI"
See Also:
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setPendingIcon

public void setPendingIcon(Icon pendingIcon)
Sets the pending icon.

Parameters:
pendingIcon - the pending state icon
See Also:
getPendingIcon

getPendingIcon

public Icon getPendingIcon()
Returns the pending icon.

Returns:
the pending icon
See Also:
setPendingIcon

setRolloverPendingIcon

public void setRolloverPendingIcon(Icon rolloverPendingIcon)
Sets the rollover pending icon.

Parameters:
rolloverPendingIcon - the rollover pending icon
See Also:
getRolloverPendingIcon()

getRolloverPendingIcon

public Icon getRolloverPendingIcon()
Returns the the rollover pending icon.

Returns:
the rollover pending icon
See Also:
setRolloverPendingIcon(javax.swing.Icon)

setDisabledPendingIcon

public void setDisabledPendingIcon(Icon disabledPendingIcon)
Sets the disabled pending icon.

Parameters:
disabledPendingIcon - the disabled pending icon
See Also:
getDisabledPendingIcon()

getDisabledPendingIcon

public Icon getDisabledPendingIcon()
Returns the disabled pending icon.

Returns:
the disabled pending icon
See Also:
setDisabledPendingIcon(javax.swing.Icon)

setSelected

public void setSelected(boolean b)
Overide the method to set the selected state.

Overrides:
setSelected in class AbstractButton

isSelected

public boolean isSelected()
Overide the method to return the selected value.

Overrides:
isSelected in class AbstractButton

getSelectState

public int getSelectState()
Returns the select state.

Returns:
the select state, one of 3 legal values:
  • XCheckBox.SELECTED
  • XCheckBox.DESELECTED
  • XCheckBox.PENDING
See Also:
setSelectState(int)

setSelectState

public void setSelectState(int state)
Sets the select state.

Parameters:
state - the select state, one of 3 legal values:
  • XCheckBox.SELECTED
  • XCheckBox.DESELECTED
  • XCheckBox.PENDING
See Also:
setSelectState(int)

isPendingState

public boolean isPendingState()
Determines the pending state.

Returns:
true if the XCheckBox is pending state, otherwise return false.

paramString

protected String paramString()
Returns a string representation of this XCheckBox. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:
paramString in class JCheckBox
Returns:
a string representation of this XCheckBox.

getAccessibleContext

public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this XCheckBox. For XCheckBoxs, the AccessibleContext takes the form of an AccessibleXCheckBox. A new AccessibleXCheckBox instance is created if necessary.

Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in class JCheckBox
Returns:
an AccessibleXCheckBox that serves as the AccessibleContext of this XCheckBox

JComponentPack 1.5.0

Send your Feedback
JComponentPack 1.5.0
Copyright © 2001-2007 Extreme Component, Inc. All rights reserved.