com.alee.extended.button

Class WebSwitch

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.alee.laf.panel.WebPanel

com.alee.extended.button.WebSwitch

All Implemented Interfaces:

com.alee.managers.language.LanguageContainerMethods, MarginSupport, PaddingSupport, ShapeProvider, Skinnable, Styleable, ToolTipMethods, Paintable, EventMethods, SizeMethods<WebPanel>, com.alee.utils.swing.SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class WebSwitch
extends WebPanel

This component that allows switching between two states.

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

Fields

Modifier and Type	Field and Description
protected java.util.List<java.awt.event.ActionListener>	actionListeners Switch action listeners.
protected boolean	animate Style settings.
protected boolean	animating
protected com.alee.utils.swing.WebTimer	animator
protected javax.swing.JComponent	deselectedComponent
protected WebPanel	gripper UI elements.
protected float	gripperLocation
protected boolean	selected Runtime variables.
protected javax.swing.JComponent	selectedComponent

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 com.alee.managers.style.MarginSupport

EMPTY

Fields inherited from interface com.alee.managers.style.PaddingSupport

EMPTY

Fields inherited from interface com.alee.utils.swing.SizeMethods

UNDEFINED

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
WebSwitch() Constructs a deselected switch.
WebSwitch(boolean selected) Constructs either selected or deselected switch.
WebSwitch(StyleId id) Constructs a deselected switch.
WebSwitch(StyleId id, boolean selected) Constructs either selected or deselected switch.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener actionListener) Adds new switch action listener.
protected void	createAnimator() Initializes switch animator.
void	fireActionPerformed() Fires that switch action is performed.
javax.swing.JComponent	getDeselectedComponent() Returns deselected switch component.
WebPanel	getGripper() Returns switch gripper.
float	getGripperLocation() Returns current gripper location.
javax.swing.JComponent	getSelectedComponent() Returns selected switch component.
boolean	isAnimate() Returns whether switch should animate all transition by default or not.
boolean	isSelected() Returns whether switch is selected or not.
void	removeActionListener(java.awt.event.ActionListener actionListener) Removes switch action listener.
void	setAnimate(boolean animate) Sets whether switch should animate all transition by default or not.
void	setDeselectedComponent(javax.swing.JComponent component) Sets new deselected switch component.
protected void	setDeselectedComponentImpl(javax.swing.JComponent component) Sets new deselected switch component.
void	setEnabled(boolean enabled) Sets whether switch is enabled or not.
void	setSelected(boolean selected) Sets whether switch is selected or not.
void	setSelected(boolean selected, boolean animate) Sets whether switch is selected or not and animates the transition if requested.
void	setSelectedComponent(javax.swing.JComponent component) Sets new selected switch component.
protected void	setSelectedComponentImpl(javax.swing.JComponent component) Sets new selected switch component.
void	setSwitchComponents(javax.swing.Icon selected, javax.swing.Icon deselected) Sets new switch components based on two icons.
void	setSwitchComponents(javax.swing.JComponent selected, javax.swing.JComponent deselected) Sets new switch components.
void	setSwitchComponents(java.lang.String selected, java.lang.String deselected) Sets new switch components based on two text labels.
protected void	startAnimation() Starts animation.

Methods inherited from class com.alee.laf.panel.WebPanel

add, add, add, add, add, add, addStyleListener, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, contains, equalizeComponentsHeight, equalizeComponentsSize, equalizeComponentsWidth, getCustomPainter, getCustomPainter, getCustomPainters, getFirstComponent, getLanguageContainerKey, getLastComponent, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getPadding, getPreferredHeight, getPreferredSize, getPreferredWidth, getSkin, getStyleId, onDoubleClick, onFocusGain, onFocusLoss, onKeyPress, onKeyPress, onKeyRelease, onKeyRelease, onKeyType, onKeyType, onMenuTrigger, onMouseClick, onMouseClick, onMouseDrag, onMouseDrag, onMouseEnter, onMouseExit, onMousePress, onMousePress, provideShape, remove, remove, removeAll, removeLanguageContainerKey, removeStyleListener, removeToolTip, removeToolTips, removeToolTips, removeToolTips, restoreDefaultPainters, restoreSkin, setCustomPainter, setCustomPainter, setLanguageContainerKey, setMargin, setMargin, setMargin, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumWidth, setPadding, setPadding, setPadding, setPreferredHeight, setPreferredSize, setPreferredWidth, setSkin, setSkin, setStyleId, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, updateUI

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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

Methods inherited from class java.lang.Object

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

Field Detail

actionListeners

protected final java.util.List<java.awt.event.ActionListener> actionListeners

Switch action listeners.

animate

protected boolean animate

Style settings.

gripper

protected final WebPanel gripper

UI elements.

selectedComponent

protected javax.swing.JComponent selectedComponent

deselectedComponent

protected javax.swing.JComponent deselectedComponent

selected

protected boolean selected

Runtime variables.

animating

protected boolean animating

animator

protected com.alee.utils.swing.WebTimer animator

gripperLocation

protected float gripperLocation

Constructor Detail

WebSwitch

public WebSwitch()

Constructs a deselected switch.

WebSwitch

public WebSwitch(boolean selected)

Constructs either selected or deselected switch.

Parameters:

selected - whether switch is selected or not

WebSwitch

public WebSwitch(StyleId id)

Constructs a deselected switch.

Parameters:

id - style ID

WebSwitch

public WebSwitch(StyleId id,
                 boolean selected)

Constructs either selected or deselected switch.

Parameters:

id - style ID

selected - whether switch is selected or not

Method Detail

createAnimator

protected void createAnimator()

Initializes switch animator.

startAnimation

protected void startAnimation()

Starts animation.

getGripper

public WebPanel getGripper()

Returns switch gripper.

Returns:

switch gripper

getGripperLocation

public float getGripperLocation()

Returns current gripper location.

Returns:

current gripper location

getSelectedComponent

public javax.swing.JComponent getSelectedComponent()

Returns selected switch component.

Returns:

selected switch component

setSelectedComponent

public void setSelectedComponent(javax.swing.JComponent component)

Sets new selected switch component.

Parameters:

component - new selected switch component

setSelectedComponentImpl

protected void setSelectedComponentImpl(javax.swing.JComponent component)

Sets new selected switch component.

Parameters:

component - new selected switch component

getDeselectedComponent

public javax.swing.JComponent getDeselectedComponent()

Returns deselected switch component.

Returns:

deselected switch component

setDeselectedComponent

public void setDeselectedComponent(javax.swing.JComponent component)

Sets new deselected switch component.

Parameters:

component - new deselected switch component

setDeselectedComponentImpl

protected void setDeselectedComponentImpl(javax.swing.JComponent component)

Sets new deselected switch component.

Parameters:

component - new deselected switch component

setSwitchComponents

public void setSwitchComponents(javax.swing.JComponent selected,
                                javax.swing.JComponent deselected)

Sets new switch components.

Parameters:

selected - new selected switch component

deselected - new deselected switch component

setSwitchComponents

public void setSwitchComponents(javax.swing.Icon selected,
                                javax.swing.Icon deselected)

Sets new switch components based on two icons.

Parameters:

selected - new selected switch component

deselected - new deselected switch component

setSwitchComponents

public void setSwitchComponents(java.lang.String selected,
                                java.lang.String deselected)

Sets new switch components based on two text labels.

Parameters:

selected - new selected switch component

deselected - new deselected switch component

setEnabled

public void setEnabled(boolean enabled)

Sets whether switch is enabled or not.

Overrides:

setEnabled in class javax.swing.JComponent

Parameters:

enabled - whether switch is enabled or not

isSelected

public boolean isSelected()

Returns whether switch is selected or not.

Returns:

true if switch is selected, false otherwise

setSelected

public void setSelected(boolean selected)

Sets whether switch is selected or not.

Parameters:

selected - whether switch is selected or not

setSelected

public void setSelected(boolean selected,
                        boolean animate)

Sets whether switch is selected or not and animates the transition if requested.

Parameters:

selected - whether switch is selected or not

animate - whether switch should animate the transition or not

isAnimate

public boolean isAnimate()

Returns whether switch should animate all transition by default or not.

Returns:

true if switch should animate all transition by default, false otherwise

setAnimate

public void setAnimate(boolean animate)

Sets whether switch should animate all transition by default or not.

Parameters:

animate - whether switch should animate all transition by default or not

addActionListener

public void addActionListener(java.awt.event.ActionListener actionListener)

Adds new switch action listener.

Parameters:

actionListener - switch action listener

removeActionListener

public void removeActionListener(java.awt.event.ActionListener actionListener)

Removes switch action listener.

Parameters:

actionListener - switch action listener

fireActionPerformed

public void fireActionPerformed()

Fires that switch action is performed.