Class TitledTabProperties
TitledTabProperties holds all properties for a TitledTab
.
A titled tab can have three states, normal, highlighted and disabled. Each state is represented by a TitledTabStateProperties
object containing all properties that can be set for a state.
By default the property values in the highlighted and disabled state are references to corresponding values in the normal state. This means that if you set a property value in the normal state, then highlighted and the disabled state will use that property value if the property has not been set in the highlighted or disabled state.
Example:
Setting the background color in the normal state means that normal, highlighted and disabled state will
use that color as background color. If you set background color for highlighted state, then the highlighted state
will use that color regardless of the background color for the normal state.
By default the tool tip text in all states is the same as the tab text in the normal state. For example, if you
change the tab text in the highlighted state and want the tooltip to display the same text, you must set the "Tool
Tip Text" property TitledTabStateProperties.TOOL_TIP_TEXT
in the highlighted state.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final TitledTabBorderSizePolicyProperty
Border size policy propertystatic final PropertyMapProperty
Disabled state propertiesstatic final BooleanProperty
TitledTab enabled propertystatic final BooleanProperty
Focus Marker Enabled propertystatic final BooleanProperty
Focusabled propertystatic final PropertyMapProperty
Highlighted state propertiesstatic final IntegerProperty
Highlighted raised amount propertystatic final HoverListenerProperty
Hover listener propertystatic final DimensionProviderProperty
Tab minimum size propertystatic final PropertyMapProperty
Normal state propertiesstatic final PropertyMapGroup
A property group for all properties in TitledTabPropertiesstatic final TitledTabSizePolicyProperty
Size policy property -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an empty TitledTabProperties objectTitledTabProperties
(PropertyMap object) Constructs a TitledTabProperties object with the give object as property storageTitledTabProperties
(TitledTabProperties inheritFrom) Constructs a TitledTabProperties object that inherits its properties from the given TitledTabProperties object -
Method Summary
Modifier and TypeMethodDescriptionaddSuperObject
(TitledTabProperties superObject) Adds a super object from which property values are inherited.Gets the border size policy for this TitledTabstatic TitledTabProperties
Creates a properties object with default properties based on the current look and feelGets the properties for the disabled stateboolean
Gets if this TitledTab is enabled or disabledboolean
Gets if this TitledTab is focusableboolean
Gets if this TitledTab should show its built-in focus marker when this tab has focus.Gets the properties for the highlighted stateint
Gets how many pixels higher this TitledTab will be when it is in its highlighted state compared to its normal and disabled stateGets the hover listener that will be triggered when the tab is hovered by the mouse.Gets the dimension provider for the tab's minimum sizeGets the properties for the normal stateGets the size policy for this TitledTabRemoves the last added super object.removeSuperObject
(TitledTabProperties superObject) Removes the given super object.replaceSuperObject
(TitledTabProperties oldSuperObject, TitledTabProperties newSuperObject) Replaces the given super objects.setBorderSizePolicy
(TitledTabBorderSizePolicy sizePolicy) Sets the border size policy for this TitledTabsetEnabled
(boolean value) Sets if this TitledTab should be enabled or not.setFocusable
(boolean value) Sets if this TitledTab should be focusablesetFocusMarkerEnabled
(boolean value) Sets if this TitledTab should show its built-in focus marker when this tab has focus.setHighlightedRaised
(int amount) Sets how many pixels higher this TitledTab will be when it is in its highlighted state compared to its normal and disabled statesetHoverListener
(HoverListener listener) Sets the hover listener that will be triggered when the tab is hovered by the mouse.Sets the tab's minimum size dimension providersetSizePolicy
(TitledTabSizePolicy sizePolicy) Sets the size policy for this TitledTabMethods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
-
Field Details
-
PROPERTIES
A property group for all properties in TitledTabProperties -
FOCUSABLE
Focusabled property- See Also:
-
FOCUS_MARKER_ENABLED
Focus Marker Enabled property- Since:
- ITP 1.4.0
- See Also:
-
NORMAL_PROPERTIES
Normal state properties- See Also:
-
HIGHLIGHTED_PROPERTIES
Highlighted state properties- See Also:
-
DISABLED_PROPERTIES
Disabled state properties- See Also:
-
SIZE_POLICY
Size policy property -
BORDER_SIZE_POLICY
Border size policy property -
MINIMUM_SIZE_PROVIDER
Tab minimum size property -
HIGHLIGHTED_RAISED_AMOUNT
Highlighted raised amount property -
HOVER_LISTENER
Hover listener property- Since:
- ITP 1.3.0
- See Also:
-
ENABLED
TitledTab enabled property- Since:
- ITP 1.5.0
- See Also:
-
-
Constructor Details
-
TitledTabProperties
public TitledTabProperties()Constructs an empty TitledTabProperties object -
TitledTabProperties
Constructs a TitledTabProperties object with the give object as property storage- Parameters:
object
- object to store properties in
-
TitledTabProperties
Constructs a TitledTabProperties object that inherits its properties from the given TitledTabProperties object- Parameters:
inheritFrom
- TitledTabProperties object to inherit properties from
-
-
Method Details
-
addSuperObject
Adds a super object from which property values are inherited.- Parameters:
superObject
- the object from which to inherit property values- Returns:
- this
-
removeSuperObject
Removes the last added super object.- Returns:
- this
-
removeSuperObject
Removes the given super object.- Parameters:
superObject
- super object to remove- Returns:
- this
- Since:
- ITP 1.3.0
-
replaceSuperObject
public TitledTabProperties replaceSuperObject(TitledTabProperties oldSuperObject, TitledTabProperties newSuperObject) Replaces the given super objects.- Parameters:
oldSuperObject
- super object to replacenewSuperObject
- new super object- Returns:
- this
- Since:
- ITP 1.4.0
-
getDefaultProperties
Creates a properties object with default properties based on the current look and feel- Returns:
- properties object
-
getNormalProperties
Gets the properties for the normal state- Returns:
- the normal state properties
-
getHighlightedProperties
Gets the properties for the highlighted state- Returns:
- the highlighted state properties
-
getDisabledProperties
Gets the properties for the disabled state- Returns:
- the disabled state properties
-
setFocusable
Sets if this TitledTab should be focusable- Parameters:
value
- true for focusable, otherwise false- Returns:
- this TitledTabProperties
-
getFocusable
public boolean getFocusable()Gets if this TitledTab is focusable- Returns:
- true for focusable, otherwise false
-
setFocusMarkerEnabled
Sets if this TitledTab should show its built-in focus marker when this tab has focus.
Note: Disabling the focus marker is useful when for example creating a theme that draws its own focus marker.
- Parameters:
value
- true for enabled, otherwise false- Returns:
- this TitledTabProperties
- Since:
- ITP 1.4.0
-
getFocusMarkerEnabled
public boolean getFocusMarkerEnabled()Gets if this TitledTab should show its built-in focus marker when this tab has focus.
Note: Disabling the focus marker is useful when for example creating a theme that draws its own focus marker.
- Returns:
- true for enabled, otherwise false
- Since:
- ITP 1.4.0
-
setSizePolicy
Sets the size policy for this TitledTab- Parameters:
sizePolicy
- the size policy- Returns:
- this TitledTabProperties
-
getSizePolicy
Gets the size policy for this TitledTab- Returns:
- the size policy
-
setBorderSizePolicy
Sets the border size policy for this TitledTab- Parameters:
sizePolicy
- the border size policy- Returns:
- this TitledTabProperties
-
getBorderSizePolicy
Gets the border size policy for this TitledTab- Returns:
- the border size policy
-
setMinimumSizeProvider
Sets the tab's minimum size dimension provider- Parameters:
size
- the minimum size dimension provider or null if tab's default minimum size should be used instead- Returns:
- this TitledTabProperties
-
getMinimumSizeProvider
Gets the dimension provider for the tab's minimum size- Returns:
- the minimum size provider or null if default tab minimum size is to be used instead
-
setHighlightedRaised
Sets how many pixels higher this TitledTab will be when it is in its highlighted state compared to its normal and disabled state- Parameters:
amount
- number of pixels- Returns:
- this TitledTabProperties
-
getHighlightedRaised
public int getHighlightedRaised()Gets how many pixels higher this TitledTab will be when it is in its highlighted state compared to its normal and disabled state- Returns:
- number of pixels
-
setEnabled
Sets if this TitledTab should be enabled or not.
Note: Calling
TitledTab.setEnabled(boolean)
will modify this property for the tab.- Parameters:
value
- true for enabled, otherwise false- Returns:
- this TitledTabProperties
- Since:
- ITP 1.5.0
-
getEnabled
public boolean getEnabled()Gets if this TitledTab is enabled or disabled- Returns:
- true for enabled, otherwise false
- Since:
- ITP 1.5.0
-
setHoverListener
Sets the hover listener that will be triggered when the tab is hovered by the mouse.
The hovered titled tab will be the source of the hover event sent to the hover listener.
- Parameters:
listener
- the hover listener- Returns:
- this TitledTabProperties
- Since:
- ITP 1.3.0
-
getHoverListener
Gets the hover listener that will be triggered when the tab is hovered by the mouse.
The hovered titled tab will be the source of the hover event sent to the hover listener.
- Returns:
- the hover listener
- Since:
- ITP 1.3.0
-