Class TabbedPanelProperties
TabbedPanel
. A
TabbedPanelProperties object contains separate property objects for the
content area, the tab area, the tab area components and the buttons of
the TabbedPanel.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IntegerProperty
Abort drag key code propertystatic final BooleanProperty
Auto select tab propertystatic final PropertyMapProperty
Button propertiesstatic final PropertyMapProperty
Content area propertiesstatic final BooleanProperty
Ensure selected visible propertystatic final Property[]
Array with all properties that controls the functional behaviorstatic final BooleanProperty
If true the tab pressed with the mouse will be highlighted, otherwise it remains unchanged.static final HoverListenerProperty
Hover listener propertystatic final TabbedPanelHoverPolicyProperty
Tabbed panel hover policy.static final BooleanProperty
Paint a shadow for the tab area.static final PropertyMapGroup
A property group for all properties in TabbedPanelPropertiesstatic final IntegerProperty
Shadow blend area size propertystatic final ColorProperty
Shadow color propertystatic final BooleanProperty
Shadow enabled propertystatic final Property[]
Array with all properties that controls the shadowstatic final IntegerProperty
Shadow size propertystatic final FloatProperty
Shadow strength propertystatic final PropertyMapProperty
Tab area components propertiesstatic final DirectionProperty
Tab area orientation propertystatic final PropertyMapProperty
Tab area propertiesstatic final TabDepthOrderPolicyProperty
Tab depth order.static final BooleanProperty
Tab deselectable propertystatic final TabDropDownListVisiblePolicyProperty
Tab drop down list visible propertystatic final TabLayoutPolicyProperty
Tab layout propertystatic final BooleanProperty
Tab reorder propertystatic final IntegerProperty
Tab scrolling offset propertystatic final TabSelectTriggerProperty
Tab select triggerstatic final IntegerProperty
Tab spacing propertystatic final Property[]
Array with all properties that controls the visual apperance except for shadowstatic final Property[]
Array with all properties that controls the visual apperance including shadow -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an empty TabbedPanelProperties objectConstructs a TabbedPanelProperties map with the given map as property storageTabbedPanelProperties
(TabbedPanelProperties inheritFrom) Constructs a TabbedPanelProperties object that inherits its properties from the given TabbedPanelProperties object -
Method Summary
Modifier and TypeMethodDescriptionaddSuperObject
(TabbedPanelProperties superObject) Adds a super object from which property values are inherited.int
Gets the key code for aborting a tab drag or reorder operation.boolean
Gets if automatic selection of a tab is enabled.Gets the properties getMap() with properties for all the buttons in a tabbed panel.Gets the properties getMap() with properties for the tabbed panel's content areastatic TabbedPanelProperties
Creates a properties object with default properties based on the current look and feelboolean
Gets if a tab should be made visible if it is selected, i.e.boolean
Gets if the tab pressed with the mouse will be highlighted.Gets the hover listener that will be triggered when the tabbed panel is hovered by the mouse.Gets the hover policy.boolean
Returns true if a shadow is painted for the tab area, false if a shadow is painted for the highlighted tab and the tab area components panel.int
Gets the shadow blend area size, i.e.Gets the shadow color.boolean
Gets shadow enabledint
Gets the shadow size, i.e.float
Gets the shadow strength.Gets the properties getMap() with properties for the area in a tabbed panel's tab area where the tab area components are shown.Gets the tab area orientation, i.e.Gets the properties getMap() with properties for the tabbed panel's tab areaGets the tab depth order policy to be used when tabs are overlapping i.e.boolean
Gets if tab is deselectable.Gets the tab drop down list visible policy, i.e.Gets the tab layout policy for the tab area, i.e.boolean
Gets if the tabs can be reorder using the mouse.int
Gets number of pixels to be shown for the last scrolled tab.Gets the tab select trigger, i.e.int
Gets the tab spacing, i.e.Removes the last added super object.removeSuperObject
(TabbedPanelProperties superObject) Removes the given super object.replaceSuperObject
(TabbedPanelProperties oldSuperObject, TabbedPanelProperties newSuperObject) Replaces the given super objects.setAbortDragKey
(int keyCode) Sets the key code for aborting a tab drag or reorder operation.setAutoSelectTab
(boolean value) Sets if automatic selection of a tab is enabled.setEnsureSelectedTabVisible
(boolean value) Sets if a tab should be made visible if it is selected, i.e.setHighlightPressedTab
(boolean highlightEnabled) Set to true if the tab pressed with the mouse should be highlighted, otherwise it's not changed.setHoverListener
(HoverListener listener) Sets the hover listener that will be triggered when the tabbed panel is hoverd by the mouse.setHoverPolicy
(TabbedPanelHoverPolicy hoverPolicy) Sets the hover policy.setPaintTabAreaShadow
(boolean paintShadow) Set to true if a shadow should be painted for the tab area, false if a shadow should be painted for the highlighted tab and the tab area components panel.setShadowBlendAreaSize
(int size) Sets the shadow blend area size, i.e.setShadowColor
(Color color) Sets the shadow color.setShadowEnabled
(boolean value) Sets shadow enabledsetShadowSize
(int size) Sets the shadow size, i.e.setShadowStrength
(float strength) Sets the shadow strength.setTabAreaOrientation
(Direction direction) Sets the tab area orientation, i.e.Sets the tab depth order policy to be used when tabs are overlapping i.e.setTabDeselectable
(boolean value) Sets if tab is deselectable.Sets the tab drop down list visible policy, i.e.setTabLayoutPolicy
(TabLayoutPolicy policy) Sets the tab layout policy for the tab area, i.e.setTabReorderEnabled
(boolean enabled) Sets if the tabs can be reordered using the mousesetTabScrollingOffset
(int offset) Sets number of pixels to be shown for the scrolled out tab next to the first visible tab.setTabSelectTrigger
(TabSelectTrigger trigger) Sets the tab select trigger, i.e.setTabSpacing
(int value) Sets the tab spacing, i.e.Methods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
-
Field Details
-
PROPERTIES
A property group for all properties in TabbedPanelProperties -
TAB_REORDER_ENABLED
Tab reorder property- See Also:
-
ABORT_DRAG_KEY
Abort drag key code property- See Also:
-
TAB_LAYOUT_POLICY
Tab layout property- See Also:
-
TAB_DROP_DOWN_LIST_VISIBLE_POLICY
Tab drop down list visible property- Since:
- ITP 1.1.0
- See Also:
-
TAB_SELECT_TRIGGER
Tab select trigger- Since:
- ITP 1.1.0
- See Also:
-
TAB_SCROLLING_OFFSET
Tab scrolling offset property- See Also:
-
ENSURE_SELECTED_VISIBLE
Ensure selected visible property- See Also:
-
TAB_AREA_ORIENTATION
Tab area orientation property- See Also:
-
TAB_SPACING
Tab spacing property- See Also:
-
TAB_DEPTH_ORDER
Tab depth order.- Since:
- ITP 1.2.0
- See Also:
-
AUTO_SELECT_TAB
Auto select tab property- See Also:
-
HIGHLIGHT_PRESSED_TAB
If true the tab pressed with the mouse will be highlighted, otherwise it remains unchanged.- See Also:
-
TAB_DESELECTABLE
Tab deselectable property- See Also:
-
CONTENT_PANEL_PROPERTIES
Content area properties- See Also:
-
TAB_AREA_PROPERTIES
Tab area properties- See Also:
-
TAB_AREA_COMPONENTS_PROPERTIES
Tab area components properties- Since:
- ITP 1.1.0
- See Also:
-
BUTTON_PROPERTIES
Button properties- Since:
- ITP 1.3.0
- See Also:
-
SHADOW_ENABLED
Shadow enabled property- See Also:
-
HOVER_LISTENER
Hover listener property- Since:
- ITP 1.3.0
- See Also:
-
HOVER_POLICY
Tabbed panel hover policy.- Since:
- ITP 1.3.0
- See Also:
-
PAINT_TAB_AREA_SHADOW
Paint a shadow for the tab area. If this property is set to false a shadow is painted for the highlighted tab and the tab area components panel.- See Also:
-
SHADOW_SIZE
Shadow size property- See Also:
-
SHADOW_BLEND_AREA_SIZE
Shadow blend area size property- See Also:
-
SHADOW_COLOR
Shadow color property- See Also:
-
SHADOW_STRENGTH
Shadow strength property- See Also:
-
FUNCTIONAL_PROPERTIES
Array with all properties that controls the functional behavior -
SHADOW_PROPERTIES
Array with all properties that controls the shadow -
TABS_VISUAL_PROPERTIES
Array with all properties that controls the visual apperance except for shadow -
VISUAL_PROPERTIES
Array with all properties that controls the visual apperance including shadow
-
-
Constructor Details
-
TabbedPanelProperties
public TabbedPanelProperties()Constructs an empty TabbedPanelProperties object -
TabbedPanelProperties
Constructs a TabbedPanelProperties map with the given map as property storage- Parameters:
map
- map to store properties in
-
TabbedPanelProperties
Constructs a TabbedPanelProperties object that inherits its properties from the given TabbedPanelProperties object- Parameters:
inheritFrom
- TabbedPanelProperties object to inherit properties from
-
-
Method Details
-
getDefaultProperties
Creates a properties object with default properties based on the current look and feel- Returns:
- properties object
-
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 TabbedPanelProperties replaceSuperObject(TabbedPanelProperties oldSuperObject, TabbedPanelProperties newSuperObject) Replaces the given super objects.- Parameters:
oldSuperObject
- old super objectnewSuperObject
- new super object- Returns:
- this
- Since:
- ITP 1.4.0
-
setShadowStrength
Sets the shadow strength. 0 means the shadow color is the same as the backgound color and 1 means the shadow color is the same as shadow color.
Note: This property will only have effect if shadow is enabled.
- Parameters:
strength
- the strength between 0 and 1- Returns:
- this TabbedPanelProperties
- See Also:
-
setShadowBlendAreaSize
Sets the shadow blend area size, i.e. number of pixels for the shadow color fading.
Note: This property will only have effect if shadow is enabled.
- Parameters:
size
- the shadow blend area size in pixels- Returns:
- this TabbedPanelProperties
- See Also:
-
setShadowSize
Sets the shadow size, i.e. the width/height of the shadow in pixels.
Note: This property will only have effect if shadow is enabled.
- Parameters:
size
- shadow size in pixels- Returns:
- this TabbedPanelProperties
- See Also:
-
setShadowColor
Sets the shadow color.
Note: This property will only have effect if shadow is enabled.
- Parameters:
color
- the shadow color- Returns:
- this TabbedPanelProperties
- See Also:
-
setShadowEnabled
Sets shadow enabled- Parameters:
value
- true for enabled, otherwise false- Returns:
- this TabbedPanelProperties
-
setAutoSelectTab
Sets if automatic selection of a tab is enabled. Automatic selection means that if no tab is selected and a tab is added to the TabbedPanel, then the added tab will automatically be selected. If a selected tab is removed from the TabbedPanel then the tab next to the selected tab will automatically be selected.- Parameters:
value
- true for automactic selection, otherwise false- Returns:
- this TabbedPanelProperties
-
setTabDeselectable
Sets if tab is deselectable. This means that if the selected tab is clicked then the selected tab will be deselected. Clicking it again will select the tab again.- Parameters:
value
- true for deselectable, otherwise false- Returns:
- this TabbedPanelProperties
-
setEnsureSelectedTabVisible
Sets if a tab should be made visible if it is selected, i.e. if scrolling is enabled, a tab will be scrolled into the visible part of the tab area when it becomes selected.
Note: This will only have effect if scolling is enabled.
- Parameters:
value
- true for selected visible, otherwise false- Returns:
- this TabbedPanelProperties
- See Also:
-
setTabScrollingOffset
Sets number of pixels to be shown for the scrolled out tab next to the first visible tab.
Note: This will only have effect if scolling is enabled.
- Parameters:
offset
- number of pixels- Returns:
- this TabbedPanelProperties
- See Also:
-
setTabReorderEnabled
Sets if the tabs can be reordered using the mouse- Parameters:
enabled
- true for enabled, otherwise disabled- Returns:
- this TabbedPanelProperties
-
setHighlightPressedTab
Set to true if the tab pressed with the mouse should be highlighted, otherwise it's not changed.- Parameters:
highlightEnabled
- true if the tab pressed with the mouse should be highlighted- Returns:
- this
-
setAbortDragKey
Sets the key code for aborting a tab drag or reorder operation.
Note: The right mouse button can also be used to abort the operation.
- Parameters:
keyCode
- key code- Returns:
- this TabbedPanelProperties
-
setTabLayoutPolicy
Sets the tab layout policy for the tab area, i.e. how the line of tabs should be laid out- Parameters:
policy
- the tab area layout policy- Returns:
- this TabbedPanelProperties
-
setTabDropDownListVisiblePolicy
Sets the tab drop down list visible policy, i.e. when a drop down list with the tabs should be visible
The drop down list will show an icon for the tab if the tab implements the
IconProvider
and the text will be retrieved by calling toString() on the tab.- Parameters:
policy
- the tab drop down list visible policy- Returns:
- this TabbedPanelProperties
- Since:
- ITP 1.1.0
-
setTabSelectTrigger
Sets the tab select trigger, i.e. what triggers a tab selection- Parameters:
trigger
- the tab select trigger- Returns:
- this TabbedPanelProperties
- Since:
- ITP 1.1.0
-
setTabAreaOrientation
Sets the tab area orientation, i.e. if the tab area should be placed up, down, left or right of the content area.- Parameters:
direction
- the orientation- Returns:
- this TabbedPanelProperties
-
setTabSpacing
Sets the tab spacing, i.e. number of pixels between the tabs in the tab area.
This can be a negative value i.e. tabs will be overlapping each other. The depth order can be controlled with the property TAB_DEPTH_ORDER.
- Parameters:
value
- number of pixels. A negative value reuslts in tabs overlapping each other with the number of pixels.- Returns:
- this TabbedPanelProperties
- See Also:
-
setTabDepthOrderPolicy
Sets the tab depth order policy to be used when tabs are overlapping i.e. negative tab spacing.
If the depth order is descending, the first tab will be the top most and the last tab the bottom most. If the depth order is ascending, then the first tab will be the bottom most and the last tab the top most. Note that if a tab is highlighted, it will always be shown as the top most tab.
- Parameters:
policy
- the tab depth order policy- Returns:
- this TabbedPanelProperties
- Since:
- ITP 1.2.0
- See Also:
-
getShadowStrength
public float getShadowStrength()Gets the shadow strength. 0 means the shadow color is the same as the backgound color and 1 means the shadow color is the same as shadow color.
Note: This property will only have effect if shadow is enabled.
- Returns:
- the shadow strength between 0 and 1
- See Also:
-
getShadowBlendAreaSize
public int getShadowBlendAreaSize()Gets the shadow blend area size, i.e. number of pixels for the shadow color fading.
Note: This property will only have effect if shadow is enabled.
- Returns:
- the shadow blend area size in pixels
- See Also:
-
getShadowSize
public int getShadowSize()Gets the shadow size, i.e. the width/height of the shadow in pixels.
Note: This property will only have effect if shadow is enabled.
- Returns:
- shadow size in pixels
- See Also:
-
getShadowColor
Gets the shadow color.
Note: This property will only have effect if shadow is enabled.
- Returns:
- the shadow color
- See Also:
-
getShadowEnabled
public boolean getShadowEnabled()Gets shadow enabled- Returns:
- true if shadow is enabled, otherwise false
-
getAutoSelectTab
public boolean getAutoSelectTab()Gets if automatic selection of a tab is enabled. Automatic selection means that if no tab is selected and a tab is added to the TabbedPanel, then the added tab will automatically be selected. If a selected tab is removed from the TabbedPanel then the tab next to the selected tab will automatically be selected.- Returns:
- true if automactic selection, otherwise false
-
getHighlightPressedTab
public boolean getHighlightPressedTab()Gets if the tab pressed with the mouse will be highlighted.- Returns:
- true if the tab pressed with the mouse will be highlighted
-
getTabDeselectable
public boolean getTabDeselectable()Gets if tab is deselectable. This means that if the selected tab is clicked then the selected tab will be deselected. Clicking it again will select the tab again.- Returns:
- true if deselectable, otherwise false
-
getEnsureSelectedTabVisible
public boolean getEnsureSelectedTabVisible()Gets if a tab should be made visible if it is selected, i.e. if scrolling is enabled, a tab will be scrolled into the visible part of the tab area when it becomes selected.
Note: This will only have effect if scolling is enabled.
- Returns:
- true if selected visible should be made visible, otherwise false
- See Also:
-
getPaintTabAreaShadow
public boolean getPaintTabAreaShadow()Returns true if a shadow is painted for the tab area, false if a shadow is painted for the highlighted tab and the tab area components panel.- Returns:
- true if a shadow is painted for the tab area, false if a shadow is painted for the highlighted tab and the tab area components panel
- Since:
- ITP 1.1.0
-
setPaintTabAreaShadow
Set to true if a shadow should be painted for the tab area, false if a shadow should be painted for the highlighted tab and the tab area components panel.- Parameters:
paintShadow
- true if a shadow should be painted for the tab area, false if a shadow should be painted for the highlighted tab and the tab area components panel- Returns:
- this
- Since:
- ITP 1.1.0
-
getTabScrollingOffset
public int getTabScrollingOffset()Gets number of pixels to be shown for the last scrolled tab.
Note: This will only have effect if scolling is enabled.
- Returns:
- number of pixels
- See Also:
-
getTabReorderEnabled
public boolean getTabReorderEnabled()Gets if the tabs can be reorder using the mouse.- Returns:
- true if enabled, otherwise disabled
-
getAbortDragKey
public int getAbortDragKey()Gets the key code for aborting a tab drag or reorder operation.
Note that the right mouse button can also be used to abort the operation.
- Returns:
- the key code
-
getTabLayoutPolicy
Gets the tab layout policy for the tab area, i.e. how the line of tabs should be laid out- Returns:
- the tab area layout policy
-
getTabDropDownListVisiblePolicy
Gets the tab drop down list visible policy, i.e. when a drop down list with the tabs should be visible.
The drop down list will show an icon for the tab if the tab implements the
IconProvider
and the text will be retrieved by calling toString() on the tab.- Returns:
- the tab drop down list visible policy
- Since:
- ITP 1.1.0
-
getTabSelectTrigger
Gets the tab select trigger, i.e. what triggers a tab selection- Returns:
- the tab select trigger
- Since:
- ITP 1.1.0
-
getTabAreaOrientation
Gets the tab area orientation, i.e. if the tab area should be placed up, down, left or right of the content area- Returns:
- the orientation
-
getTabSpacing
public int getTabSpacing()Gets the tab spacing, i.e. number of pixels between the tabs in the tab area.
This can be a negative value i.e. tabs will be overlapping each other. The depth order can be controlled with the property TAB_DEPTH_ORDER.
- Returns:
- number of pixels, can be negative i.e. tabs will be overlapping
- See Also:
-
getTabDepthOrderPolicy
Gets the tab depth order policy to be used when tabs are overlapping i.e. negative tab spacing.
If the depth order is descending, the first tab will be the top most and the last tab the bottom most. If the depth order is ascending, then the first tab will be the bottom most and the last tab the top most. Note that if a tab is highlighted, it will always be shown as the top most tab.
- Returns:
- the tab depth order policy
- Since:
- ITP 1.2.0
- See Also:
-
setHoverListener
Sets the hover listener that will be triggered when the tabbed panel is hoverd by the mouse.
The hovered tabbed panel will be the source of the hover event sent to the hover listener.
- Parameters:
listener
- the hover listener- Returns:
- this TabbedPanelProperties
- Since:
- ITP 1.3.0
-
getHoverListener
Gets the hover listener that will be triggered when the tabbed panel is hovered by the mouse.
The hovered tabbed panel will be the source of the hover event sent to the hover listener.
- Returns:
- the hover listener
- Since:
- ITP 1.3.0
-
setHoverPolicy
Sets the hover policy.
The hover policy determines when the tabbed panel is considered hovered by the mouse and the hover listener is called. The default hover policy is NO_HOVERED_CHILD.
- Parameters:
hoverPolicy
- the hover policy- Returns:
- this TabbedPanelProperties
- Since:
- ITP 1.3.0
-
getHoverPolicy
Gets the hover policy.
The hover policy determines when the tabbed panel is considered hovered by the mouse and the hover listener is called. The default hover policy is NO_HOVERED_CHILD.
- Returns:
- the hover policy
- Since:
- ITP 1.3.0
-
getContentPanelProperties
Gets the properties getMap() with properties for the tabbed panel's content area- Returns:
- the properties for the content area
-
getTabAreaProperties
Gets the properties getMap() with properties for the tabbed panel's tab area- Returns:
- the properties for the tab area
-
getTabAreaComponentsProperties
Gets the properties getMap() with properties for the area in a tabbed panel's tab area where the tab area components are shown.- Returns:
- the properties for the tab area components
- Since:
- ITP 1.1.0
-
getButtonProperties
Gets the properties getMap() with properties for all the buttons in a tabbed panel.- Returns:
- the properties for the buttons
- Since:
- ITP 1.3.0
-