Package net.infonode.docking.properties
Class WindowTabButtonProperties
java.lang.Object
net.infonode.properties.propertymap.PropertyMapContainer
net.infonode.docking.properties.WindowTabButtonProperties
Properties and property values for a button in a window tab.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DockingWindowActionProperty
TheDockingWindowAction
that is performed when the button is clicked.static final ButtonFactoryProperty
The button factory.static final IconProperty
The button icon.static final PropertyMapGroup
Property group containing all window tab button properties.static final StringProperty
The button tool tip text.static final BooleanProperty
True if the button is visible. -
Constructor Summary
ConstructorsConstructorDescriptionCreates an empty property object.WindowTabButtonProperties
(WindowTabButtonProperties inheritFrom) Creates a property object that inherit values from another property object.Creates a property object containing the map. -
Method Summary
Modifier and TypeMethodDescriptionaddSuperObject
(WindowTabButtonProperties properties) Adds a super object from which property values are inherited.Gets theDockingWindowAction
that is performed when the button is clicked.Gets the button factory.getIcon()
Returns the button icon.Returns the button tool tip text.boolean
Returns true if this button is visible.Deprecated.removeSuperObject
(WindowTabButtonProperties superObject) Removes a super object.setAction
(DockingWindowAction action) Sets theDockingWindowAction
that will be performed when the button is clicked.setFactory
(ButtonFactory factory) Sets the button factory.Sets the button icon.setTo
(DockingWindowAction action) Sets the action is performed when the button is clicked.setToolTipText
(String text) Sets the button tool tip text.setVisible
(boolean visible) Set to true if this button should be visible.Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
-
Field Details
-
PROPERTIES
Property group containing all window tab button properties. -
VISIBLE
True if the button is visible. -
ICON
The button icon. -
TOOL_TIP_TEXT
The button tool tip text.- Since:
- IDW 1.1.0
-
ACTION
TheDockingWindowAction
that is performed when the button is clicked.- Since:
- IDW 1.3.0
-
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 fromICON
and the tool tip fromTOOL_TIP_TEXT
. An action listener is also added to the button.- Since:
- IDW 1.1.0
-
-
Constructor Details
-
WindowTabButtonProperties
public WindowTabButtonProperties()Creates an empty property object. -
WindowTabButtonProperties
Creates a property object containing the map.- Parameters:
map
- the property map
-
WindowTabButtonProperties
Creates a property object that inherit values from another property object.- Parameters:
inheritFrom
- the object from which to inherit property values
-
-
Method Details
-
addSuperObject
Adds a super object from which property values are inherited.- Parameters:
properties
- the object from which to inherit property values- Returns:
- this
-
removeSuperObject
Deprecated.UseremoveSuperObject(WindowTabButtonProperties)
instead.Removes the last added super object.- Returns:
- this
- Since:
- IDW 1.1.0
-
removeSuperObject
Removes a super object.- Parameters:
superObject
- the super object to remove- Returns:
- this
- Since:
- IDW 1.3.0
-
setVisible
Set to true if this button should be visible.- Parameters:
visible
- true if this button should be visible- Returns:
- this
-
isVisible
public boolean isVisible()Returns true if this button is visible.- Returns:
- true if this button is visible
-
setIcon
Sets the button icon.- Parameters:
icon
- the button icon- Returns:
- this
-
getIcon
Returns the button icon.- Returns:
- the button icon
-
getToolTipText
Returns the button tool tip text.- Returns:
- the button tool tip text
- Since:
- IDW 1.1.0
-
setToolTipText
Sets the button tool tip text.- Parameters:
text
- the button tool tip text- Returns:
- this
- Since:
- IDW 1.1.0
-
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 fromICON
and the tool tip fromTOOL_TIP_TEXT
. An action listener is also added to the button.- Returns:
- the button factory
- Since:
- IDW 1.1.0
-
setFactory
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 fromICON
and the tool tip fromTOOL_TIP_TEXT
. An action listener is also added to the button.- Parameters:
factory
- the button factory- Returns:
- this
- Since:
- IDW 1.1.0
-
getAction
Gets theDockingWindowAction
that is performed when the button is clicked.- Returns:
- the
DockingWindowAction
that is performed when the button is clicked - Since:
- IDW 1.3.0
-
setAction
Sets theDockingWindowAction
that will be performed when the button is clicked.- Parameters:
action
- theDockingWindowAction
that is performed when the button is clicked- Returns:
- this
- Since:
- IDW 1.3.0
-
setTo
Sets the action is performed when the button is clicked. Also sets the icon and tooltip text of the button using the values fromDockingWindowAction
.- Parameters:
action
- the action that is performed when the button is clicked- Returns:
- this
- Since:
- IDW 1.3.0
-
removeSuperObject(WindowTabButtonProperties)
instead.