net.infonode.properties.gui.util

Class ButtonProperties

public class ButtonProperties extends PropertyMapContainer

Properties and property values for a button.

Version: $Revision: 1.3 $

Author: $Author: jesper $

Field Summary
static IconProperty	DISABLED_ICON The disabled button icon.
static ButtonFactoryProperty	FACTORY The button factory. The created button will be assigned the icon from ICON or DISABLED_ICON and the tool tip from TOOL_TIP_TEXT.
static IconProperty	ICON The button icon.
static PropertyMapGroup	PROPERTIES Property group for all button properties.
static StringProperty	TOOL_TIP_TEXT The enabled button tool tip text.

Constructor Summary
	ButtonProperties() Creates an empty property object.
	ButtonProperties(PropertyMap map) Creates a property map containing the map.
	ButtonProperties(ButtonProperties inheritFrom) Creates a property object that inherit values from another property object.

Method Summary
ButtonProperties	addSuperObject(ButtonProperties properties) Adds a super object from which property values are inherited.
AbstractButton	applyTo(AbstractButton button) Applies the icon, disabled icon and tool tip to the given button
Icon	getDisabledIcon() Returns the disabled button icon.
ButtonFactory	getFactory() Gets the button factory. The created button will be assigned the icon from ICON or DISABLED_ICON and the tool tip from TOOL_TIP_TEXT.
Icon	getIcon() Returns the button icon.
String	getToolTipText() Returns the button tool tip text.
ButtonProperties	removeSuperObject() Removes the last added super object.
ButtonProperties	removeSuperObject(ButtonProperties superObject) Removes the given super object.
ButtonProperties	setDisabledIcon(Icon icon) Sets the disabled button icon.
ButtonProperties	setFactory(ButtonFactory factory) Sets the button factory. The created button will be assigned the icon from ICON or DISABLED_ICON and the tool tip from TOOL_TIP_TEXT.
ButtonProperties	setIcon(Icon icon) Sets the button icon.
ButtonProperties	setToolTipText(String text) Sets the button tool tip text.

Field Detail

DISABLED_ICON

public static final IconProperty DISABLED_ICON

The disabled button icon.

FACTORY

public static final ButtonFactoryProperty FACTORY

The button factory.

The created button will be assigned the icon from ICON or DISABLED_ICON and the tool tip from TOOL_TIP_TEXT. An action listener is also added to the button.

ICON

public static final IconProperty ICON

The button icon.

PROPERTIES

public static final PropertyMapGroup PROPERTIES

Property group for all button properties.

TOOL_TIP_TEXT

public static final StringProperty TOOL_TIP_TEXT

The enabled button tool tip text.

Constructor Detail

ButtonProperties

public ButtonProperties()

Creates an empty property object.

ButtonProperties

public ButtonProperties(PropertyMap map)

Creates a property map containing the map.

Parameters: map the property map

ButtonProperties

public ButtonProperties(ButtonProperties inheritFrom)

Creates a property object that inherit values from another property object.

Parameters: inheritFrom the object from which to inherit property values

Method Detail

addSuperObject

public ButtonProperties addSuperObject(ButtonProperties properties)

Adds a super object from which property values are inherited.

Parameters: properties the object from which to inherit property values

Returns: this

applyTo

public AbstractButton applyTo(AbstractButton button)

Applies the icon, disabled icon and tool tip to the given button

Parameters: button botton

Returns: the button

getDisabledIcon

public Icon getDisabledIcon()

Returns the disabled button icon.

Returns: the disabled button icon

getFactory

public ButtonFactory getFactory()

Gets the button factory.

The created button will be assigned the icon from ICON or DISABLED_ICON and the tool tip from TOOL_TIP_TEXT. An action listener is also added to the button.

Returns: the button factory

getIcon

public Icon getIcon()

Returns the button icon.

Returns: the button icon

getToolTipText

public String getToolTipText()

Returns the button tool tip text.

Returns: the button tool tip text

removeSuperObject

public ButtonProperties removeSuperObject()

Removes the last added super object.

Returns: this

removeSuperObject

public ButtonProperties removeSuperObject(ButtonProperties superObject)

Removes the given super object.

Parameters: superObject super object to remove

Returns: this

setDisabledIcon

public ButtonProperties setDisabledIcon(Icon icon)

Sets the disabled button icon.

Parameters: icon the disabled button icon

Returns: this

setFactory

public ButtonProperties setFactory(ButtonFactory factory)

Sets the button factory.

The created button will be assigned the icon from ICON or DISABLED_ICON and the tool tip from TOOL_TIP_TEXT. An action listener is also added to the button.

Parameters: factory the button factory

Returns: this

setIcon

public ButtonProperties setIcon(Icon icon)

Sets the button icon.

Parameters: icon the button icon

Returns: this

setToolTipText

public ButtonProperties setToolTipText(String text)

Sets the button tool tip text.

Parameters: text the button tool tip text

Returns: this