public class WindowTabButtonProperties extends PropertyMapContainer
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
javax.swing.Icon |
getIcon()
Returns the button icon.
|
java.lang.String |
getToolTipText()
Returns the button tool tip text.
|
boolean |
isVisible()
Returns true if this button is visible.
|
WindowTabButtonProperties |
removeSuperObject()
Deprecated.
Use
removeSuperObject(WindowTabButtonProperties) instead. |
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(javax.swing.Icon icon)
Sets the button icon.
|
WindowTabButtonProperties |
setTo(DockingWindowAction action)
Sets the action is performed when the button is clicked.
|
WindowTabButtonProperties |
setToolTipText(java.lang.String text)
Sets the button tool tip text.
|
WindowTabButtonProperties |
setVisible(boolean visible)
Set to true if this button should be visible.
|
getMap
public static final PropertyMapGroup PROPERTIES
public static final BooleanProperty VISIBLE
public static final IconProperty ICON
public static final StringProperty TOOL_TIP_TEXT
public static final DockingWindowActionProperty ACTION
DockingWindowAction
that is performed when the button is clicked.public static final ButtonFactoryProperty FACTORY
ICON
and the tool tip from TOOL_TIP_TEXT
. An action listener is also added to the button.public WindowTabButtonProperties()
public WindowTabButtonProperties(PropertyMap map)
map
- the property mappublic WindowTabButtonProperties(WindowTabButtonProperties inheritFrom)
inheritFrom
- the object from which to inherit property valuespublic WindowTabButtonProperties addSuperObject(WindowTabButtonProperties properties)
properties
- the object from which to inherit property valuespublic WindowTabButtonProperties removeSuperObject()
removeSuperObject(WindowTabButtonProperties)
instead.public WindowTabButtonProperties removeSuperObject(WindowTabButtonProperties superObject)
superObject
- the super object to removepublic WindowTabButtonProperties setVisible(boolean visible)
visible
- true if this button should be visiblepublic boolean isVisible()
public WindowTabButtonProperties setIcon(javax.swing.Icon icon)
icon
- the button iconpublic javax.swing.Icon getIcon()
public java.lang.String getToolTipText()
public WindowTabButtonProperties setToolTipText(java.lang.String text)
text
- the button tool tip textpublic ButtonFactory getFactory()
ICON
and the tool tip from TOOL_TIP_TEXT
. An action listener is also added to the button.public WindowTabButtonProperties setFactory(ButtonFactory factory)
ICON
and the tool tip from TOOL_TIP_TEXT
. An action listener is also added to the button.factory
- the button factorypublic DockingWindowAction getAction()
DockingWindowAction
that is performed when the button is clicked.DockingWindowAction
that is performed when the button is clickedpublic WindowTabButtonProperties setAction(DockingWindowAction action)
DockingWindowAction
that will be performed when the button is clicked.action
- the DockingWindowAction
that is performed when the button is clickedpublic WindowTabButtonProperties setTo(DockingWindowAction action)
DockingWindowAction
.action
- the action that is performed when the button is clicked