com.lf.commons.gui

Class ClosableTab

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.gui.ClosableTab

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class ClosableTab
extends javax.swing.JPanel
implements java.awt.event.ActionListener

Implements a standard tab used by JTabbedPane which can be closed.

To be consistent with other applications like Firefox the tab component can only be closed if it is currently selected by the user. The closing feature can be temporarily disabled. External action listeners can be installed to react on tab closing e.g. by showing a dialog where the user can save files etc.

Since:

1.5

Version:

$Revision: 1.19 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

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 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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ClosableTab() Constructor method for i18n purposes only.
ClosableTab(java.lang.String title, javax.swing.Icon icon, java.lang.String tooltip, boolean closable) Constructor of this form.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Reacts on component interaction.
void	addActionListener(java.awt.event.ActionListener listener) Adds an instance reacting on tab close events.
void	addClosableTabListener(ClosableTabListener listener) Adds an instance reacting on closed tabs.
void	addMouseListener(java.awt.event.MouseListener listener) Adds an instance reacting on mouse events.
protected void	finalize() Clean-up method to help the gc.
static java.lang.String	getActionCommand() Provide the action command for the close button.
static ClosableTab	getClosableTab(javax.swing.JButton button) Determines the parental ClosableTab for the given button.
static javax.swing.event.ChangeListener	installChangeListener(javax.swing.JTabbedPane tabbedpane) Convenience method to install a change listener which refreshes the given closable tab.
void	refresh() Updates the tab renderer according to its current state.
void	removeActionListener(java.awt.event.ActionListener listener) Removes an instance reacting on tab close events.
void	removeClosableTabListener(ClosableTabListener listener) Removes an instance reacting on closed tabs.
void	removeMouseListener(java.awt.event.MouseListener listener) Removes an instance reacting on mouse events.
void	setIcon(javax.swing.Icon icon) Changes the tab icon (not the close icon!).
void	setText(java.lang.String text) Changes the tab text.
void	setToolTip(java.lang.String text) Changes the tooltip.
void	tabClosed() Informs the installed ClosableTabListener's.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, 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, setEnabled, 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, 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, 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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClosableTab

public ClosableTab()
            throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

ClosableTab

public ClosableTab(java.lang.String title,
           javax.swing.Icon icon,
           java.lang.String tooltip,
           boolean closable)

Constructor of this form.

Parameters:

title - The title to be displayed in this tab

icon - The icon to be displayed in this tab

tooltip - The tooltip to be displayed for this tab

closable - May the tab be closed by the user?

Since:

1.5

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

addActionListener

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

Adds an instance reacting on tab close events.

Parameters:

listener - Action listener to be added

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.5

removeActionListener

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

Removes an instance reacting on tab close events.

Parameters:

listener - Action listener to be removed

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.5

addMouseListener

public void addMouseListener(java.awt.event.MouseListener listener)

Adds an instance reacting on mouse events.

Overrides:

addMouseListener in class java.awt.Component

Parameters:

listener - Mouse listener to be added

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.5

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener listener)

Removes an instance reacting on mouse events.

Overrides:

removeMouseListener in class java.awt.Component

Parameters:

listener - Mouse listener to be removed

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.5

getActionCommand

public static java.lang.String getActionCommand()

Provide the action command for the close button.

Returns:

The action command

Since:

1.5

refresh

public void refresh()

Updates the tab renderer according to its current state.

Normally the close icon is only enabled if the surrounding tab is currently selected. This is the nice behaviour of widely spreaded applications like Mozilla Firefox. The tabbed pane is determined automatically. If you like the close icon to be displayed always then no refreshing is needed here.

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.5

setIcon

public void setIcon(javax.swing.Icon icon)

Changes the tab icon (not the close icon!).

Parameters:

icon - The tab icon

Since:

1.6

setText

public void setText(java.lang.String text)

Changes the tab text.

Parameters:

text - The tab text

Since:

1.6

setToolTip

public void setToolTip(java.lang.String text)

Changes the tooltip.

Parameters:

text - The tab tooltip

Since:

1.6

getClosableTab

public static ClosableTab getClosableTab(javax.swing.JButton button)

Determines the parental ClosableTab for the given button.

Parameters:

button - The button

Returns:

The closable tab, may be null

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.6

addClosableTabListener

public void addClosableTabListener(ClosableTabListener listener)

Adds an instance reacting on closed tabs.

Parameters:

listener - Listener to be added

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.6

removeClosableTabListener

public void removeClosableTabListener(ClosableTabListener listener)

Removes an instance reacting on closed tabs.

Parameters:

listener - Listener to be removed

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.6

tabClosed

public void tabClosed()

Informs the installed ClosableTabListener's.

Since:

1.6

installChangeListener

public static javax.swing.event.ChangeListener installChangeListener(javax.swing.JTabbedPane tabbedpane)

Convenience method to install a change listener which refreshes the given closable tab.

Parameters:

tabbedpane - The parental component

Returns:

The added listener for removal

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Reacts on component interaction.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - Event to be processed

Since:

1.5