net.infonode.docking.properties

Class WindowTabButtonProperties

public class WindowTabButtonProperties extends PropertyMapContainer

Properties and property values for a button in a window tab.

Version: $Revision: 1.16 $

Author: $Author: jesper $

Field Summary
static DockingWindowActionProperty	ACTION The DockingWindowAction that is performed when the button is clicked.
static ButtonFactoryProperty	FACTORY The button factory.
static IconProperty	ICON The button icon.
static PropertyMapGroup	PROPERTIES Property group containing all window tab button properties.
static StringProperty	TOOL_TIP_TEXT The button tool tip text.
static BooleanProperty	VISIBLE True if the button is visible.

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

Method Summary
WindowTabButtonProperties	addSuperObject(WindowTabButtonProperties properties) Adds a super object from which property values are inherited.
DockingWindowAction	getAction() Gets the DockingWindowAction that is performed when the button is clicked.
ButtonFactory	getFactory() Gets the button factory.
Icon	getIcon() Returns the button icon.
String	getToolTipText() Returns the button tool tip text.
boolean	isVisible() Returns true if this button is visible.
WindowTabButtonProperties	removeSuperObject() Removes the last added super object.
WindowTabButtonProperties	removeSuperObject(WindowTabButtonProperties superObject) Removes a super object.
WindowTabButtonProperties	setAction(DockingWindowAction action) Sets the DockingWindowAction that will be performed when the button is clicked.
WindowTabButtonProperties	setFactory(ButtonFactory factory) Sets the button factory.
WindowTabButtonProperties	setIcon(Icon icon) Sets the button icon.
WindowTabButtonProperties	setTo(DockingWindowAction action) Sets the action is performed when the button is clicked.
WindowTabButtonProperties	setToolTipText(String text) Sets the button tool tip text.
WindowTabButtonProperties	setVisible(boolean visible) Set to true if this button should be visible.

Field Detail

ACTION

public static final DockingWindowActionProperty ACTION

The DockingWindowAction that is performed when the button is clicked.

Since: IDW 1.3.0

FACTORY

public static final ButtonFactoryProperty FACTORY

The button factory. This factory is used to create the button when it's first needed. Modifying this property will NOT cause already created buttons to be replaced. The created button will be set to non-focusable and will be assigned the icon from ICON and the tool tip from TOOL_TIP_TEXT. An action listener is also added to the button.

Since: IDW 1.1.0

ICON

public static final IconProperty ICON

The button icon.

PROPERTIES

public static final PropertyMapGroup PROPERTIES

Property group containing all window tab button properties.

TOOL_TIP_TEXT

public static final StringProperty TOOL_TIP_TEXT

The button tool tip text.

Since: IDW 1.1.0

VISIBLE

public static final BooleanProperty VISIBLE

True if the button is visible.

Constructor Detail

WindowTabButtonProperties

public WindowTabButtonProperties()

Creates an empty property object.

WindowTabButtonProperties

public WindowTabButtonProperties(PropertyMap map)

Creates a property object containing the map.

Parameters: map the property map

WindowTabButtonProperties

public WindowTabButtonProperties(WindowTabButtonProperties 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 WindowTabButtonProperties addSuperObject(WindowTabButtonProperties properties)

Adds a super object from which property values are inherited.

Parameters: properties the object from which to inherit property values

Returns: this

getAction

public DockingWindowAction getAction()

Gets the DockingWindowAction that is performed when the button is clicked.

Returns: the DockingWindowAction that is performed when the button is clicked

Since: IDW 1.3.0

getFactory

public ButtonFactory getFactory()

Gets the button factory. This factory is used to create the button when it's first needed. Modifying this property will NOT cause already created buttons to be replaced. The created button will be set to non-focusable and will be assigned the icon from ICON and the tool tip from TOOL_TIP_TEXT. An action listener is also added to the button.

Returns: the button factory

Since: IDW 1.1.0

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

Since: IDW 1.1.0

isVisible

public boolean isVisible()

Returns true if this button is visible.

Returns: true if this button is visible

removeSuperObject

public WindowTabButtonProperties removeSuperObject()

Deprecated: Use removeSuperObject instead.

Removes the last added super object.

Returns: this

Since: IDW 1.1.0

removeSuperObject

public WindowTabButtonProperties removeSuperObject(WindowTabButtonProperties superObject)

Removes a super object.

Parameters: superObject the super object to remove

Returns: this

Since: IDW 1.3.0

setAction

public WindowTabButtonProperties setAction(DockingWindowAction action)

Sets the DockingWindowAction that will be performed when the button is clicked.

Parameters: action the DockingWindowAction that is performed when the button is clicked

Returns: this

Since: IDW 1.3.0

setFactory

public WindowTabButtonProperties setFactory(ButtonFactory factory)

Sets the button factory. This factory is used to create the button when it's first needed. Modifying this property will NOT cause already created buttons to be replaced. The created button will be set to non-focusable and will be assigned the icon from 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

Since: IDW 1.1.0