oracle.ide.controls
Class ToolButton

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JButton
                      oracle.ide.controls.ToolButton

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class ToolButton

extends javax.swing.JButton

An implementation of a toolbar button specialized for use in the IDE Toolbar.

The icon handling of the class has been tuned for improved performance upon construction, delaying the fetching of any icon associated with the ToggleAction until it is required.

See Also:

Toolbar, Serialized Form

Nested Class Summary

protected static class

ToolButton.DefaultActionPropertyChangeListener The default PropertyChangeListener used to update a Toolbar button as properties change on its associated Action.

Nested classes inherited from class javax.swing.JButton

javax.swing.JButton.AccessibleJButton

Nested classes inherited from class javax.swing.AbstractButton

javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.JPopupMenu	popup
protected static java.lang.String	uiClassID Deprecated. No replacement.

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

ToolButton(javax.swing.Action action)

Method Summary

javax.swing.JMenuItem	addPopupItem(java.lang.String label) Deprecated. Replace a menu-ing ToolButton with MenuToolButton.
static java.lang.String	buildToolTip(javax.swing.Action action)
protected void	configurePropertiesFromAction(javax.swing.Action a) Override inherited implementation to delay setting the icon property until it is explicitly requested.
protected java.beans.PropertyChangeListener	createActionPropertyChangeListener(javax.swing.Action a)
protected javax.swing.JPopupMenu	createPopupMenu() Deprecated. Replace a menu-ing ToolButton with MenuToolButton.
javax.swing.JMenuItem	findPopupItem(java.lang.String label) Deprecated. Replace a menu-ing ToolButton with MenuToolButton.
javax.swing.Icon	getDisabledIcon() Override inherited implementation to fetch the disabled icon from the Action if an attempt to do so has not yet been made.
javax.swing.Icon	getIcon() Override inherited implementation to fetch the icon from the Action if an attempt to do so has not yet been made.
boolean	getIconVisible() Deprecated. Replace with getIcon() != null.
boolean	getLabelVisible() Deprecated. Replace with getClientProperty("hideActionText").
protected void	init() Deprecated. No replacement -- this method is no longer called during construction.
protected static boolean	isLabelVisible(javax.swing.AbstractButton button)
boolean	isMenuStyle()
protected void	layoutToolbar()
protected void	paintComponent(java.awt.Graphics g)
protected void	releasePopupMenu() Deprecated. Replace a menu-ing ToolButton with MenuToolButton.
void	removePopupItem(java.lang.String label) Deprecated. Replace a menu-ing ToolButton with MenuToolButton.
void	repaint()
void	setDisabledIcon(javax.swing.Icon icon) Override inherited implementation to additionaly set the flag indicating that the disabled icon should be considered as having been fetched.
void	setIcon(javax.swing.Icon icon) Override inherited implementation to additionaly set the flag indicating that the icon should be considered as having been fetched.
void	setIconVisible(boolean visible) Deprecated. Replace with setIcon(Icon).
void	setLabelVisible(boolean visible) Deprecated. Replace with putClientProperty("hideActionText", Boolean) and repaint().
void	setMenuStyle(boolean menuStyle) Deprecated. Replace a menu-ing ToolButton with MenuToolButton.
void	setPressedIcon(javax.swing.Icon icon) Override inherited implementation to ensure that default icon is initialized before deferring to super implementation.
void	updateUI()

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, 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, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIconTextGap, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

uiClassID

protected static final java.lang.String uiClassID

Deprecated. No replacement.

See Also:

Constant Field Values

popup

protected javax.swing.JPopupMenu popup

Constructor Detail

ToolButton

public ToolButton(javax.swing.Action action)

Method Detail

buildToolTip

public static java.lang.String buildToolTip(javax.swing.Action action)

addPopupItem

public javax.swing.JMenuItem addPopupItem(java.lang.String label)

Deprecated. Replace a menu-ing ToolButton with MenuToolButton.

removePopupItem

public void removePopupItem(java.lang.String label)

Deprecated. Replace a menu-ing ToolButton with MenuToolButton.

findPopupItem

public javax.swing.JMenuItem findPopupItem(java.lang.String label)

Deprecated. Replace a menu-ing ToolButton with MenuToolButton.

setLabelVisible

public final void setLabelVisible(boolean visible)

Deprecated. Replace with putClientProperty("hideActionText", Boolean) and repaint().

getLabelVisible

public final boolean getLabelVisible()

Deprecated. Replace with getClientProperty("hideActionText").

setIconVisible

public final void setIconVisible(boolean visible)

Deprecated. Replace with setIcon(Icon).

getIconVisible

public final boolean getIconVisible()

Deprecated. Replace with getIcon() != null.

setMenuStyle

public void setMenuStyle(boolean menuStyle)

Deprecated. Replace a menu-ing ToolButton with MenuToolButton.

isMenuStyle

public boolean isMenuStyle()

init

protected void init()

Deprecated. No replacement -- this method is no longer called during construction.

createPopupMenu

protected javax.swing.JPopupMenu createPopupMenu()

Deprecated. Replace a menu-ing ToolButton with MenuToolButton.

releasePopupMenu

protected void releasePopupMenu()

Deprecated. Replace a menu-ing ToolButton with MenuToolButton.

isLabelVisible

protected static boolean isLabelVisible(javax.swing.AbstractButton button)

layoutToolbar

protected final void layoutToolbar()

updateUI

public void updateUI()

configurePropertiesFromAction

protected void configurePropertiesFromAction(javax.swing.Action a)

Override inherited implementation to delay setting the icon property until it is explicitly requested. This optimization allows for a quicker creation time by postponing any resource fetch of the Action until it is needed.

See Also:

getIcon()

createActionPropertyChangeListener

protected java.beans.PropertyChangeListener createActionPropertyChangeListener(javax.swing.Action a)

getIcon

public javax.swing.Icon getIcon()

Override inherited implementation to fetch the icon from the Action if an attempt to do so has not yet been made. Ordinarilly the icon would have been set in configurePropertiesFromAction but has been delayed for performance reasons.

See Also:

configurePropertiesFromAction(javax.swing.Action)

setIcon

public void setIcon(javax.swing.Icon icon)

Override inherited implementation to additionaly set the flag indicating that the icon should be considered as having been fetched.

See Also:

getIcon()

setPressedIcon

public void setPressedIcon(javax.swing.Icon icon)

Override inherited implementation to ensure that default icon is initialized before deferring to super implementation.

getDisabledIcon

public javax.swing.Icon getDisabledIcon()

Override inherited implementation to fetch the disabled icon from the Action if an attempt to do so has not yet been made.

setDisabledIcon

public void setDisabledIcon(javax.swing.Icon icon)

Override inherited implementation to additionaly set the flag indicating that the disabled icon should be considered as having been fetched.

See Also:

getDisabledIcon()

repaint

public void repaint()

paintComponent

protected void paintComponent(java.awt.Graphics g)