xdev.ui

Class XdevToggleButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

xdev.ui.XdevToggleButton

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants, Persistable, XdevFocusCycleComponent

@BeanSettings(useXdevCustomizer=true)
public class XdevToggleButton
extends JToggleButton
implements XdevFocusCycleComponent, Persistable

The standard toggle button in XDEV. Based on JToggleButton.

Since:

2.0

Author:

XDEV Software

See Also:

JToggleButton, XdevFocusCycleComponent, Serialized Form

Nested Class Summary

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.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 xdev.ui.XdevFocusCycleComponent

TAB_INDEX_PROPERTY

Fields inherited from interface xdev.ui.persistence.Persistable

VALUE_SEPARATOR

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
XdevToggleButton() Creates an initially unselected XdevToggleButton without setting the text or image.
XdevToggleButton(Action a) Creates a XdevToggleButton where properties are taken from the Action supplied.
XdevToggleButton(Icon icon) Creates an initially unselected XdevToggleButton with the specified image but no text.
XdevToggleButton(String text) Creates an unselected XdevToggleButton with the specified text.
XdevToggleButton(String text, Icon icon) Creates a XdevToggleButton that has the specified text and image, and that is initially unselected.

Method Summary

Modifier and Type	Method and Description
ButtonGroup	getButtonGroup() Returns the group that the button belongs to.
String	getPersistentId() Uses the name of the component as a persistent id.
int	getTabIndex() Returns the tabindex assigned to this component.
boolean	isPersistenceEnabled() Flag, indicates, if the gui state for this component should be persisted.
void	loadPersistentState(String persistentState) Restores this Components persistent state.
String	savePersistentState() Generates a String representation of this Components persistent state and returns it for being stored.
void	setPersistenceEnabled(boolean persistenceEnabled) Sets the persistenceEnabled flag.
void	setTabIndex(int tabIndex) Sets the tabindex of this component.
String	toString()

Methods inherited from class javax.swing.JToggleButton

getAccessibleContext, getUIClassID, paramString, updateUI

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, setSelected, 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, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

XdevToggleButton

public XdevToggleButton()

Creates an initially unselected XdevToggleButton without setting the text or image.

XdevToggleButton

public XdevToggleButton(Action a)

Creates a XdevToggleButton where properties are taken from the Action supplied.

Parameters:

a - the Action used to specify the new XdevToggleButton

See Also:

AbstractButton.setAction(Action)

XdevToggleButton

public XdevToggleButton(Icon icon)

Creates an initially unselected XdevToggleButton with the specified image but no text.

Parameters:

icon - the image that the XdevToggleButton should display

XdevToggleButton

public XdevToggleButton(String text,
                        Icon icon)

Creates a XdevToggleButton that has the specified text and image, and that is initially unselected.

Parameters:

text - the string displayed on the XdevToggleButton

icon - the image that the XdevToggleButton should display

XdevToggleButton

public XdevToggleButton(String text)

Creates an unselected XdevToggleButton with the specified text.

Parameters:

text - the string displayed on the XdevToggleButton

Method Detail

getButtonGroup

public ButtonGroup getButtonGroup()

Returns the group that the button belongs to.

Returns:

the group that the button belongs to

toString

public String toString()

Overrides:

toString in class Component

getTabIndex

public int getTabIndex()

Returns the tabindex assigned to this component. The tabindex defines the position of the component in the focus cycle.

Specified by:

getTabIndex in interface XdevFocusCycleComponent

Returns:

tabindex of this component

setTabIndex

public void setTabIndex(int tabIndex)

Sets the tabindex of this component. The tabindex defines the position of the component in the focus cycle.

To exclude this component from the focus cycle set tabindex to -1.

Specified by:

setTabIndex in interface XdevFocusCycleComponent

Parameters:

tabIndex - to be set

loadPersistentState

public void loadPersistentState(String persistentState)

Restores this Components persistent state.

By calling this method, the passed state information get interpreted and applied on the affected attributes.

Specified by:

loadPersistentState in interface Persistable

Parameters:

persistentState - String representation for the persistent state of the Component.

See Also:

savePersistentState()

savePersistentState

public String savePersistentState()

Generates a String representation of this Components persistent state and returns it for being stored.

Persisted properties:

• selection state

Specified by:

savePersistentState in interface Persistable

Returns:

a String containing persistent state

getPersistentId

public String getPersistentId()

Uses the name of the component as a persistent id.

If no name is specified the name of the class will be used. This will work only for one persistent instance of the class!

Return a persistent id for this Component.

The following requirements have to be met for the persistent id:

• it has to be unique within the current application
• it has to be indentical across multiple invocations of the application

Specified by:

getPersistentId in interface Persistable

Returns:

a persistent id

isPersistenceEnabled

public boolean isPersistenceEnabled()

Flag, indicates, if the gui state for this component should be persisted.

Specified by:

isPersistenceEnabled in interface Persistable

Returns:

true if a instance of type Persistable is to be persisted.

setPersistenceEnabled

public void setPersistenceEnabled(boolean persistenceEnabled)

Sets the persistenceEnabled flag.

Parameters:

persistenceEnabled - the state for this instance