org.gephi.ui.components

Class JDropDownToggleButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JToggleButton

org.gephi.ui.components.JDropDownToggleButton

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants

public class JDropDownToggleButton
extends JToggleButton

Author:

Mathieu Bastian

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	JDropDownToggleButton.Model

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

Modifier and Type	Field and Description
private Map<String,Icon>	arrowIcons
private static String	ICON_DISABLED
private static String	ICON_DISABLED_SELECTED
private static String	ICON_NORMAL
private static String	ICON_PRESSED
private static String	ICON_ROLLOVER
private static String	ICON_ROLLOVER_LINE
private static String	ICON_ROLLOVER_SELECTED
private static String	ICON_ROLLOVER_SELECTED_LINE
private static String	ICON_SELECTED
private PopupMenuListener	menuListener
private boolean	mouseInArrowArea
private boolean	mouseInButton
static String	PROP_DROP_DOWN_MENU Use this property name to assign or remove popup menu to/from buttons created by this factory, e.g.
private Map<String,Icon>	regIcons

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
JDropDownToggleButton(Icon icon, JPopupMenu popup)

Method Summary

Modifier and Type	Method and Description
private Icon	_getRolloverIcon()
private Icon	_getRolloverSelectedIcon()
static JToggleButton	createDropDownToggleButton(Icon icon, JPopupMenu dropDownMenu) Creates JToggleButton with a small arrow that shows the provided popup menu when clicked.
private PopupMenuListener	getMenuListener()
(package private) JPopupMenu	getPopupMenu()
(package private) boolean	hasPopupMenu()
private boolean	isInArrowArea(Point p)
private void	resetIcons()
void	setDisabledIcon(Icon icon)
void	setDisabledSelectedIcon(Icon icon)
void	setIcon(Icon icon)
void	setPressedIcon(Icon icon)
void	setRolloverIcon(Icon icon)
void	setRolloverSelectedIcon(Icon icon)
void	setSelectedIcon(Icon icon)
private Icon	updateIcons(Icon orig, String iconType)
private void	updateRollover(Icon rollover, Icon rolloverSelected)

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, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setRolloverEnabled, setSelected, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

mouseInButton

private boolean mouseInButton

mouseInArrowArea

private boolean mouseInArrowArea

regIcons

private Map<String,Icon> regIcons

arrowIcons

private Map<String,Icon> arrowIcons

ICON_NORMAL

private static final String ICON_NORMAL

See Also:

Constant Field Values

ICON_PRESSED

private static final String ICON_PRESSED

See Also:

Constant Field Values

ICON_ROLLOVER

private static final String ICON_ROLLOVER

See Also:

Constant Field Values

ICON_ROLLOVER_SELECTED

private static final String ICON_ROLLOVER_SELECTED

See Also:

Constant Field Values

ICON_SELECTED

private static final String ICON_SELECTED

See Also:

Constant Field Values

ICON_DISABLED

private static final String ICON_DISABLED

See Also:

Constant Field Values

ICON_DISABLED_SELECTED

private static final String ICON_DISABLED_SELECTED

See Also:

Constant Field Values

ICON_ROLLOVER_LINE

private static final String ICON_ROLLOVER_LINE

See Also:

Constant Field Values

ICON_ROLLOVER_SELECTED_LINE

private static final String ICON_ROLLOVER_SELECTED_LINE

See Also:

Constant Field Values

PROP_DROP_DOWN_MENU

public static final String PROP_DROP_DOWN_MENU

Use this property name to assign or remove popup menu to/from buttons created by this factory, e.g. dropDownButton.putClientProperty( PROP_DROP_DOWN_MENU, new JPopupMenu() ) The property value must be JPopupMenu, removing this property removes the arrow from the button.

See Also:

Constant Field Values

menuListener

private PopupMenuListener menuListener

Constructor Detail

JDropDownToggleButton

public JDropDownToggleButton(Icon icon,
                             JPopupMenu popup)

Method Detail

getMenuListener

private PopupMenuListener getMenuListener()

updateRollover

private void updateRollover(Icon rollover,
                            Icon rolloverSelected)

resetIcons

private void resetIcons()

_getRolloverIcon

private Icon _getRolloverIcon()

_getRolloverSelectedIcon

private Icon _getRolloverSelectedIcon()

getPopupMenu

JPopupMenu getPopupMenu()

hasPopupMenu

boolean hasPopupMenu()

isInArrowArea

private boolean isInArrowArea(Point p)

setIcon

public void setIcon(Icon icon)

Overrides:

setIcon in class AbstractButton

updateIcons

private Icon updateIcons(Icon orig,
                         String iconType)

setPressedIcon

public void setPressedIcon(Icon icon)

Overrides:

setPressedIcon in class AbstractButton

setSelectedIcon

public void setSelectedIcon(Icon icon)

Overrides:

setSelectedIcon in class AbstractButton

setRolloverIcon

public void setRolloverIcon(Icon icon)

Overrides:

setRolloverIcon in class AbstractButton

setRolloverSelectedIcon

public void setRolloverSelectedIcon(Icon icon)

Overrides:

setRolloverSelectedIcon in class AbstractButton

setDisabledIcon

public void setDisabledIcon(Icon icon)

Overrides:

setDisabledIcon in class AbstractButton

setDisabledSelectedIcon

public void setDisabledSelectedIcon(Icon icon)

Overrides:

setDisabledSelectedIcon in class AbstractButton

createDropDownToggleButton

public static JToggleButton createDropDownToggleButton(Icon icon,
                                                       JPopupMenu dropDownMenu)

Creates JToggleButton with a small arrow that shows the provided popup menu when clicked.

Parameters:

icon - The default icon, cannot be null

dropDownMenu - Popup menu to display when the arrow is clicked. If this parameter is null then the button doesn't show any arrow and behaves like a regular JToggleButton. It is possible to add the popup menu later using PROP_DROP_DOWN_MENU client property.

Returns:

A toggle-button that is capable of displaying an 'arrow' in its icon to open a popup menu.