TableButtonPanel (Commons)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - com.lf.commons.table.TableButtonPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListSelectionListener
```
public class TableButtonPanel
extends javax.swing.JPanel
implements javax.swing.event.ListSelectionListener
```
Container for managing table buttons like "Edit", "View", "Delete" etc.
The developer can choose from a set of pre-defined buttons as mentioned above and has the chance to add self-defined buttons as well. The component is highly configurable and optimized for the use with a TablePanel but not restricted to it. The components are not installed all at once but only if added to the underlying toolbar. Listeners can be installed with one step, the button can be identified by their unique key which is also used a action command. The button names contain the popup text as additional payload.

Since:

1.6

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
Modifier and Type	Field and Description
`static java.lang.String`	`BUTTON_ADD` Unique button identifier.
`static java.lang.String`	`BUTTON_CONNECT` Unique button identifier.
`static java.lang.String`	`BUTTON_COPY` Unique button identifier.
`static java.lang.String`	`BUTTON_CUT` Unique button identifier.
`static java.lang.String`	`BUTTON_DELETE` Unique button identifier.
`static java.lang.String`	`BUTTON_DISCONNECT` Unique button identifier.
`static java.lang.String`	`BUTTON_EDIT` Unique button identifier.
`static java.lang.String`	`BUTTON_FIND` Unique button identifier.
`static java.lang.String`	`BUTTON_HELP` Unique button identifier.
`static java.lang.String`	`BUTTON_LOAD_FILE` Unique button identifier.
`static java.lang.String`	`BUTTON_OPEN` Unique button identifier.
`static java.lang.String`	`BUTTON_PASTE` Unique button identifier.
`static java.lang.String`	`BUTTON_PRINT` Unique button identifier.
`static java.lang.String`	`BUTTON_REFRESH` Unique button identifier.
`static java.lang.String`	`BUTTON_RENAME` Unique button identifier.
`static java.lang.String`	`BUTTON_SAVE_FILE` Unique button identifier.
`static java.lang.String`	`BUTTON_SETTINGS` Unique button identifier.
`static java.lang.String`	`BUTTON_TRASH` Unique button identifier.
`static java.lang.String`	`BUTTON_VIEW` Unique button identifier.
`static java.net.URL`	`ICON_ADD` A button icon.
`static java.net.URL`	`ICON_CONNECT` A button icon.
`static java.net.URL`	`ICON_COPY` A button icon.
`static java.net.URL`	`ICON_CUT` A button icon.
`static java.net.URL`	`ICON_DELETE` A button icon.
`static java.net.URL`	`ICON_DISCONNECT` A button icon.
`static java.net.URL`	`ICON_EDIT` A button icon.
`static java.net.URL`	`ICON_FIND` A button icon.
`static java.net.URL`	`ICON_HELP` A button icon.
`static java.net.URL`	`ICON_LOAD_FILE` A button icon.
`static java.net.URL`	`ICON_OPEN` A button icon.
`static java.net.URL`	`ICON_PASTE` A button icon.
`static java.net.URL`	`ICON_PRINT` A button icon.
`static java.net.URL`	`ICON_REFRESH` A button icon.
`static java.net.URL`	`ICON_RENAME` A button icon.
`static java.net.URL`	`ICON_SAVE_FILE` A button icon.
`static java.net.URL`	`ICON_SETTINGS` A button icon.
`static java.net.URL`	`ICON_TRASH` A button icon.
`static java.net.URL`	`ICON_VIEW` A button icon.
`static java.lang.String`	`SEPARATOR` Unique button identifier (placeholder for separator).
`protected javax.swing.JToolBar`	`toolBar`

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

TableButtonPanel()
Constructor of this form.

Constructors
Constructor and Description
`TableButtonPanel()` Constructor of this form.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActionListener(java.awt.event.ActionListener listener)` Adds a listener to be informed about clicks to all buttons currently installed.
`java.awt.Component`	`addButton(ButtonDef def)` Adds another toolbar button.
`protected void`	`finalize()` Clean-up method to help the gc.
`java.awt.Component[]`	`getAllButtons()` Provides the list of the currently shown buttons from left to right.
`java.awt.Component`	`getButton(java.lang.String key)` Determines the button for a button key.
`javax.swing.JToolBar`	`getToolBar()` Provides the tool bar component.
`void`	`removeActionListener(java.awt.event.ActionListener listener)` Removes a listener to be informed about clicks from all buttons currently installed.
`void`	`setButtons(ButtonDef[] defs)` Creates the toolbar buttons in the order the buttons are passed here.
`void`	`setTableComponent(java.awt.Component tablecomp)` Sets the component to be monitored for automatic button enabling/disabling.
`protected void`	`updateButtons()` Implements the auto-enable strategies for the installed buttons.
`void`	`valueChanged(javax.swing.event.ListSelectionEvent event)` Reacts on table selection changes.

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

- Field Detail
  - SEPARATOR
```
public static final java.lang.String SEPARATOR
```
    Unique button identifier (placeholder for separator).
    
    See Also:
    Constant Field Values
  - BUTTON_ADD
```
public static final java.lang.String BUTTON_ADD
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_DELETE
```
public static final java.lang.String BUTTON_DELETE
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_EDIT
```
public static final java.lang.String BUTTON_EDIT
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_VIEW
```
public static final java.lang.String BUTTON_VIEW
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_RENAME
```
public static final java.lang.String BUTTON_RENAME
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_HELP
```
public static final java.lang.String BUTTON_HELP
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_REFRESH
```
public static final java.lang.String BUTTON_REFRESH
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_PRINT
```
public static final java.lang.String BUTTON_PRINT
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_OPEN
```
public static final java.lang.String BUTTON_OPEN
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_CUT
```
public static final java.lang.String BUTTON_CUT
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_COPY
```
public static final java.lang.String BUTTON_COPY
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_PASTE
```
public static final java.lang.String BUTTON_PASTE
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_FIND
```
public static final java.lang.String BUTTON_FIND
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_SETTINGS
```
public static final java.lang.String BUTTON_SETTINGS
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_CONNECT
```
public static final java.lang.String BUTTON_CONNECT
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_DISCONNECT
```
public static final java.lang.String BUTTON_DISCONNECT
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_TRASH
```
public static final java.lang.String BUTTON_TRASH
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_LOAD_FILE
```
public static final java.lang.String BUTTON_LOAD_FILE
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - BUTTON_SAVE_FILE
```
public static final java.lang.String BUTTON_SAVE_FILE
```
    Unique button identifier.
    
    See Also:
    Constant Field Values
  - ICON_ADD
```
public static final java.net.URL ICON_ADD
```
    A button icon.
  - ICON_DELETE
```
public static final java.net.URL ICON_DELETE
```
    A button icon.
  - ICON_EDIT
```
public static final java.net.URL ICON_EDIT
```
    A button icon.
  - ICON_VIEW
```
public static final java.net.URL ICON_VIEW
```
    A button icon.
  - ICON_RENAME
```
public static final java.net.URL ICON_RENAME
```
    A button icon.
  - ICON_HELP
```
public static final java.net.URL ICON_HELP
```
    A button icon.
  - ICON_REFRESH
```
public static final java.net.URL ICON_REFRESH
```
    A button icon.
  - ICON_PRINT
```
public static final java.net.URL ICON_PRINT
```
    A button icon.
  - ICON_OPEN
```
public static final java.net.URL ICON_OPEN
```
    A button icon.
  - ICON_CUT
```
public static final java.net.URL ICON_CUT
```
    A button icon.
  - ICON_COPY
```
public static final java.net.URL ICON_COPY
```
    A button icon.
  - ICON_PASTE
```
public static final java.net.URL ICON_PASTE
```
    A button icon.
  - ICON_FIND
```
public static final java.net.URL ICON_FIND
```
    A button icon.
  - ICON_SETTINGS
```
public static final java.net.URL ICON_SETTINGS
```
    A button icon.
  - ICON_CONNECT
```
public static final java.net.URL ICON_CONNECT
```
    A button icon.
  - ICON_DISCONNECT
```
public static final java.net.URL ICON_DISCONNECT
```
    A button icon.
  - ICON_TRASH
```
public static final java.net.URL ICON_TRASH
```
    A button icon.
  - ICON_LOAD_FILE
```
public static final java.net.URL ICON_LOAD_FILE
```
    A button icon.
  - ICON_SAVE_FILE
```
public static final java.net.URL ICON_SAVE_FILE
```
    A button icon.
  - toolBar
```
protected javax.swing.JToolBar toolBar
```
- Constructor Detail
  - TableButtonPanel
```
public TableButtonPanel()
```
    Constructor of this form.
    
    Since:
    
    1.6
- 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
  - setButtons
```
public void setButtons(ButtonDef[] defs)
```
    Creates the toolbar buttons in the order the buttons are passed here.
    
    Parameters:
    defs - The button definitions
    
    Throws:
    
    java.lang.NullPointerException - If the parameters are null
    Since:
    
    1.6
  - addButton
```
public java.awt.Component addButton(ButtonDef def)
```
    Adds another toolbar button.
    
    Parameters:
    def - The button definition
    
    Returns:
    The created button of type JButton or ComboButton, may be null
    
    Throws:
    
    java.lang.IllegalArgumentException - If the parameters are invalid
    
    java.lang.NullPointerException - If the parameters are null
    Since:
    
    1.6
  - getButton
```
public java.awt.Component getButton(java.lang.String key)
```
    Determines the button for a button key.
    The button is only returned if it is already installed and never created here.
    
    Parameters:
    key - The internally used button key
    
    Returns:
    The requested button of type JButton or ComboButton, may be null
    
    Throws:
    
    java.lang.NullPointerException - If the parameters are null
    Since:
    
    1.6
  - getAllButtons
```
public java.awt.Component[] getAllButtons()
```
    Provides the list of the currently shown buttons from left to right.
    
    Returns:
    The button array of type JButton or ComboButton, may be null
    Since:
    
    1.6
  - addActionListener
```
public void addActionListener(java.awt.event.ActionListener listener)
```
    Adds a listener to be informed about clicks to all buttons currently installed.
    
    Parameters:
    listener - The listener instance
    
    Throws:
    
    java.lang.NullPointerException - If parameter is null
    
    java.lang.IllegalArgumentException - If threshold is not between 10% and 100%
    Since:
    
    1.6
  - removeActionListener
```
public void removeActionListener(java.awt.event.ActionListener listener)
```
    Removes a listener to be informed about clicks from all buttons currently installed.
    
    Parameters:
    listener - The listener instance
    
    Throws:
    
    java.lang.NullPointerException - If parameter is null
    Since:
    
    1.6
  - setTableComponent
```
public void setTableComponent(java.awt.Component tablecomp)
```
    Sets the component to be monitored for automatic button enabling/disabling.
    Currently this class provides support for TablePanel instances.
    
    Parameters:
    tablecomp - The component to be monitored, may be null
    
    Throws:
    
    java.lang.NullPointerException - If a parameter is null
    
    java.lang.IllegalArgumentException - If a parameter is invalid
    Since:
    
    1.6
  - getToolBar
```
public javax.swing.JToolBar getToolBar()
```
    Provides the tool bar component.
    
    Returns:
    The tool bar
    Since:
    
    1.6
  - updateButtons
```
protected void updateButtons()
```
    Implements the auto-enable strategies for the installed buttons.
    
    Since:
    
    1.6
  - valueChanged
```
public void valueChanged(javax.swing.event.ListSelectionEvent event)
```
    Reacts on table selection changes.
    
    Specified by:
    
    valueChanged in interface javax.swing.event.ListSelectionListener
    
    Parameters:
    event - The event
    Since:
    
    1.6

Class TableButtonPanel

Nested Class Summary

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

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

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

SEPARATOR

BUTTON_ADD

BUTTON_DELETE

BUTTON_EDIT

BUTTON_VIEW

BUTTON_RENAME

BUTTON_HELP

BUTTON_REFRESH

BUTTON_PRINT

BUTTON_OPEN

BUTTON_CUT

BUTTON_COPY

BUTTON_PASTE

BUTTON_FIND

BUTTON_SETTINGS

BUTTON_CONNECT

BUTTON_DISCONNECT

BUTTON_TRASH

BUTTON_LOAD_FILE

BUTTON_SAVE_FILE

ICON_ADD

ICON_DELETE

ICON_EDIT

ICON_VIEW

ICON_RENAME

ICON_HELP

ICON_REFRESH

ICON_PRINT

ICON_OPEN

ICON_CUT

ICON_COPY

ICON_PASTE

ICON_FIND

ICON_SETTINGS

ICON_CONNECT

ICON_DISCONNECT

ICON_TRASH

ICON_LOAD_FILE

ICON_SAVE_FILE

toolBar

Constructor Detail

TableButtonPanel

Method Detail

finalize

setButtons

addButton

getButton

getAllButtons

addActionListener

removeActionListener

setTableComponent

getToolBar

updateButtons

valueChanged