com.lf.commons.table

Class ButtonDef

java.lang.Object

com.lf.commons.table.ButtonDef

public class ButtonDef
extends java.lang.Object

Data encapsulation class for TableButtonPanel.

Set the comboItems property if you like a ComboButton being displayed instead of a simple JButton. The ComboButton provides an array down icon button to display a popup with click options for the button. This functionality has been implemented by the Thunderbird e-mail client for example.

Since:

1.6

Version:

$Revision: 1.20 $, $Date: 2016/01/01 15:43:01 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	autoenable The strategy for automatic enabling, null means no automatic enabling (default).
EnableChecker	checker The instance responsible for enabling, null if not used (default).
ComboButtonItem[]	comboitems The button options if the button allows for more than one action (arrow down, optional).
java.lang.String	defaultaction The default action command for combo buttons (comboitems) needs to be set.
javax.swing.ImageIcon	icon The button icon.
java.lang.String	key Unique button key.
java.lang.String	popuptext The text for the popup menu.
java.lang.String	tooltip The button tooltip.

Constructor Summary

Constructors

Constructor and Description
ButtonDef() Constructor method for i18n purposes only.
ButtonDef(java.lang.String key) Another constructor with real initializing functionality.
ButtonDef(java.lang.String key, ComboButtonItem[] items, java.lang.String defaultaction) Another constructor with real initializing functionality.
ButtonDef(java.lang.String key, java.lang.String tooltip) Another constructor with real initializing functionality.
ButtonDef(java.lang.String key, java.lang.String tooltip, javax.swing.ImageIcon icon) Another constructor with real initializing functionality.
ButtonDef(java.lang.String key, java.lang.String tooltip, javax.swing.ImageIcon icon, EnableChecker checker, java.lang.String popuptext) Another constructor with real initializing functionality.
ButtonDef(java.lang.String key, java.lang.String tooltip, javax.swing.ImageIcon icon, EnableChecker checker, java.lang.String popuptext, ComboButtonItem[] items, java.lang.String defaultaction) Another constructor with real initializing functionality.
ButtonDef(java.lang.String key, java.lang.String tooltip, javax.swing.ImageIcon icon, java.lang.String popuptext, ComboButtonItem[] items, java.lang.String defaultaction, java.lang.String autoenable) Another constructor with real initializing functionality.
ButtonDef(java.lang.String key, java.lang.String tooltip, javax.swing.ImageIcon icon, java.lang.String autoenable, java.lang.String popuptext) Another constructor with real initializing functionality.
ButtonDef(java.lang.String key, java.lang.String tooltip, java.lang.String popuptext) Another constructor with real initializing functionality.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	acceptAutoEnablePattern(java.lang.String pattern, int count) Checks, if the selection count matches the given pattern (button should be enabled).
static boolean	checkAutoEnablePattern(java.lang.String pattern) Checks the given auto-enable pattern for correctness.
boolean	equals(ButtonDef tocheck) Checks if a given ButtonDef instance is equal to this instance.
ButtonDef	setAutoEnabled(java.lang.String autoenable) Updates the auto-enable feature (1, +, ?
ButtonDef	setEnableChecker(EnableChecker checker) Sets a new checker instance for auto-enabling.
java.lang.String	toString() Debug method for testing the internal managed strings.

Methods inherited from class java.lang.Object

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

Field Detail

key

public java.lang.String key

Unique button key.

tooltip

public java.lang.String tooltip

The button tooltip.

popuptext

public java.lang.String popuptext

The text for the popup menu.

icon

public javax.swing.ImageIcon icon

The button icon.

autoenable

public java.lang.String autoenable

The strategy for automatic enabling, null means no automatic enabling (default).

checker

public EnableChecker checker

The instance responsible for enabling, null if not used (default).

comboitems

public ComboButtonItem[] comboitems

The button options if the button allows for more than one action (arrow down, optional).

defaultaction

public java.lang.String defaultaction

The default action command for combo buttons (comboitems) needs to be set.

Constructor Detail

ButtonDef

public ButtonDef()
          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

ButtonDef

public ButtonDef(java.lang.String key)

Another constructor with real initializing functionality.

This variant can be used for the default buttons.

Parameters:

key - Unique button key (required)

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

ButtonDef

public ButtonDef(java.lang.String key,
         java.lang.String tooltip)

Another constructor with real initializing functionality.

This variant can be used for the default buttons.

Parameters:

key - Unique button key (required)

tooltip - The button tooltip (optional)

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

ButtonDef

public ButtonDef(java.lang.String key,
         java.lang.String tooltip,
         javax.swing.ImageIcon icon)

Another constructor with real initializing functionality.

Parameters:

key - Unique button key (required)

tooltip - The button tooltip (optional)

icon - The button icon (optional)

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

ButtonDef

public ButtonDef(java.lang.String key,
         java.lang.String tooltip,
         java.lang.String popuptext)

Another constructor with real initializing functionality.

Parameters:

key - Unique button key (required)

tooltip - The button tooltip (optional)

popuptext - The text for the popup menu (optional)

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

ButtonDef

public ButtonDef(java.lang.String key,
         java.lang.String tooltip,
         javax.swing.ImageIcon icon,
         java.lang.String autoenable,
         java.lang.String popuptext)

Another constructor with real initializing functionality.

Possible auto-enable patterns are (see regular expressions, section "Greedy quantifiers"):

? one selected item or none at all * zero or more selected items (button is always enabled) + one or more selected items n exactly n selected items n, at least n selected items n,m at least n but not more than m selected items never button is always disabled always same as "*" (button is always enabled)

Parameters:

key - Unique button key (required)

tooltip - The button tooltip (optional)

icon - The button icon (optional)

autoenable - The strategy for enabling/disabling, not used if null

popuptext - The text for the popup menu (optional)

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

ButtonDef

public ButtonDef(java.lang.String key,
         java.lang.String tooltip,
         javax.swing.ImageIcon icon,
         EnableChecker checker,
         java.lang.String popuptext)

Another constructor with real initializing functionality.

Use the checker instance to implement your own enabling strategy for buttons.

Parameters:

key - Unique button key (required)

tooltip - The button tooltip (optional)

icon - The button icon (optional)

checker - The checker for enabling/disabling, not used if null

popuptext - The text for the popup menu (optional)

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

ButtonDef

public ButtonDef(java.lang.String key,
         java.lang.String tooltip,
         javax.swing.ImageIcon icon,
         EnableChecker checker,
         java.lang.String popuptext,
         ComboButtonItem[] items,
         java.lang.String defaultaction)

Another constructor with real initializing functionality.

Use the checker instance to implement your own enabling strategy for buttons.

Parameters:

key - Unique button key (required)

tooltip - The button tooltip (optional)

icon - The button icon (optional)

checker - The checker for enabling/disabling, not used if null

popuptext - The text for the popup menu (optional)

items - The button options if the button allows for more than one action (arrow down, optional)

defaultaction - The default action command for combo buttons (comboitems) needs to be set

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

ButtonDef

public ButtonDef(java.lang.String key,
         java.lang.String tooltip,
         javax.swing.ImageIcon icon,
         java.lang.String popuptext,
         ComboButtonItem[] items,
         java.lang.String defaultaction,
         java.lang.String autoenable)

Another constructor with real initializing functionality.

Parameters:

key - Unique button key (required)

tooltip - The button tooltip (optional)

icon - The button icon (optional)

popuptext - The text for the popup menu (optional)

items - The button options if the button allows for more than one action (arrow down, optional)

defaultaction - The default action command for combo buttons (comboitems) needs to be set

autoenable - The strategy for enabling/disabling, not used if null

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

ButtonDef

public ButtonDef(java.lang.String key,
         ComboButtonItem[] items,
         java.lang.String defaultaction)

Another constructor with real initializing functionality.

Use the checker instance to implement your own enabling strategy for buttons.

Parameters:

key - Unique button key (required)

items - The button options if the button allows for more than one action (arrow down, optional)

defaultaction - The default action command for combo buttons (comboitems) needs to be set

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

Method Detail

toString

public java.lang.String toString()

Debug method for testing the internal managed strings.

Overrides:

toString in class java.lang.Object

Since:

1.6

equals

public boolean equals(ButtonDef tocheck)

Checks if a given ButtonDef instance is equal to this instance.

Parameters:

tocheck - Instance to be checked

Returns:

The ButtonDef instance to check for equality

Since:

1.5

checkAutoEnablePattern

public static boolean checkAutoEnablePattern(java.lang.String pattern)

Checks the given auto-enable pattern for correctness.

Parameters:

pattern - The pattern to be checked

Returns:

Pattern is OK?

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

acceptAutoEnablePattern

public static boolean acceptAutoEnablePattern(java.lang.String pattern,
                              int count)

Checks, if the selection count matches the given pattern (button should be enabled).

Parameters:

pattern - The pattern to be checked

count - The selected item count

Returns:

Pattern is OK?

Throws:

java.lang.NullPointerException - If parameters are null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

setAutoEnabled

public ButtonDef setAutoEnabled(java.lang.String autoenable)

Updates the auto-enable feature (1, +, ? etc.).

Parameters:

autoenable - The strategy for enabling/disabling, not used if null

Returns:

The def to support chaining

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

setEnableChecker

public ButtonDef setEnableChecker(EnableChecker checker)

Sets a new checker instance for auto-enabling.

Parameters:

checker - The checker, may be null

Returns:

The def to support chaining

Since:

1.6