org.netbeans.swing.tabcontrol.plaf
Class TabControlButton

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.AbstractButton
                  javax.swing.JButton
                      org.netbeans.swing.tabcontrol.plaf.TabControlButton

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants

public abstract class TabControlButton
extends JButton

A base class for control buttons placed within the tabs (view tabs) or next to the tab row (editor tabs). By default the button posts a TabActionEvent to the TabDisplayerUI when pressed.

The button is painted using a set of icons only unless 'showBorder' is true. The icons should include 'fake' button border then.

Since:

1.9

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JButton

JButton.AccessibleJButton

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

protected TabDisplayer	displayer
static int	ID_CLOSE_BUTTON
static int	ID_DROP_DOWN_BUTTON
static int	ID_MAXIMIZE_BUTTON
static int	ID_PIN_BUTTON
static int	ID_RESTORE_BUTTON
static int	ID_RESTORE_GROUP_BUTTON
static int	ID_SCROLL_LEFT_BUTTON
static int	ID_SCROLL_RIGHT_BUTTON
static int	ID_SLIDE_DOWN_BUTTON
static int	ID_SLIDE_GROUP_BUTTON
static int	ID_SLIDE_LEFT_BUTTON
static int	ID_SLIDE_RIGHT_BUTTON
static int	STATE_DEFAULT
static int	STATE_DISABLED
static int	STATE_PRESSED
static int	STATE_ROLLOVER

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

Method Summary

protected void	configureButton() Make sure that only button icon gets painted (turn off borders etc)
protected TabActionEvent	createTabActionEvent(ActionEvent e)
protected void	fireActionPerformed(ActionEvent event)
protected int	getButtonId()
Icon	getDisabledIcon()
Icon	getDisabledSelectedIcon()
Icon	getIcon()
Icon	getPressedIcon()
Icon	getRolloverIcon()
Icon	getRolloverSelectedIcon()
protected abstract String	getTabActionCommand(ActionEvent e)
protected TabDisplayer	getTabDisplayer()
void	updateUI()

Methods inherited from class javax.swing.JButton

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

Methods inherited from class javax.swing.AbstractButton

actionPropertyChanged, addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, 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, 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

ID_CLOSE_BUTTON

public static final int ID_CLOSE_BUTTON

See Also:

Constant Field Values

ID_PIN_BUTTON

public static final int ID_PIN_BUTTON

See Also:

Constant Field Values

ID_MAXIMIZE_BUTTON

public static final int ID_MAXIMIZE_BUTTON

See Also:

Constant Field Values

ID_RESTORE_BUTTON

public static final int ID_RESTORE_BUTTON

See Also:

Constant Field Values

ID_SLIDE_LEFT_BUTTON

public static final int ID_SLIDE_LEFT_BUTTON

See Also:

Constant Field Values

ID_SLIDE_RIGHT_BUTTON

public static final int ID_SLIDE_RIGHT_BUTTON

See Also:

Constant Field Values

ID_SLIDE_DOWN_BUTTON

public static final int ID_SLIDE_DOWN_BUTTON

See Also:

Constant Field Values

ID_DROP_DOWN_BUTTON

public static final int ID_DROP_DOWN_BUTTON

See Also:

Constant Field Values

ID_SCROLL_LEFT_BUTTON

public static final int ID_SCROLL_LEFT_BUTTON

See Also:

Constant Field Values

ID_SCROLL_RIGHT_BUTTON

public static final int ID_SCROLL_RIGHT_BUTTON

See Also:

Constant Field Values

ID_RESTORE_GROUP_BUTTON

public static final int ID_RESTORE_GROUP_BUTTON

Since:

1.27

See Also:

Constant Field Values

ID_SLIDE_GROUP_BUTTON

public static final int ID_SLIDE_GROUP_BUTTON

Since:

1.27

See Also:

Constant Field Values

STATE_DEFAULT

public static final int STATE_DEFAULT

See Also:

Constant Field Values

STATE_PRESSED

public static final int STATE_PRESSED

See Also:

Constant Field Values

STATE_DISABLED

public static final int STATE_DISABLED

See Also:

Constant Field Values

STATE_ROLLOVER

public static final int STATE_ROLLOVER

See Also:

Constant Field Values

displayer

protected final TabDisplayer displayer

Method Detail

getTabActionCommand

protected abstract String getTabActionCommand(ActionEvent e)

Parameters:

e -

Returns:

Tab Action id that is posted to the TabDisplayerUI for processing when the button is pressed.

getButtonId

protected int getButtonId()

Returns:

Button type identification that is used by the TabDisplayerUI to select the correct icons for this button.

getIcon

public Icon getIcon()

Overrides:

getIcon in class AbstractButton

getPressedIcon

public Icon getPressedIcon()

Overrides:

getPressedIcon in class AbstractButton

getRolloverIcon

public Icon getRolloverIcon()

Overrides:

getRolloverIcon in class AbstractButton

getRolloverSelectedIcon

public Icon getRolloverSelectedIcon()

Overrides:

getRolloverSelectedIcon in class AbstractButton

getDisabledIcon

public Icon getDisabledIcon()

Overrides:

getDisabledIcon in class AbstractButton

getDisabledSelectedIcon

public Icon getDisabledSelectedIcon()

Overrides:

getDisabledSelectedIcon in class AbstractButton

updateUI

public void updateUI()

Overrides:

updateUI in class JButton

configureButton

protected void configureButton()

Make sure that only button icon gets painted (turn off borders etc)

fireActionPerformed

protected void fireActionPerformed(ActionEvent event)

Overrides:

fireActionPerformed in class AbstractButton

createTabActionEvent

protected TabActionEvent createTabActionEvent(ActionEvent e)

Returns:

Tab action event that is posted to the TabDisplayerUI when this button is pressed.

getTabDisplayer

protected TabDisplayer getTabDisplayer()