public class TabbedPanelProperties extends PropertyMapContainer
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.Modifier and Type | Field and Description |
---|---|
static IntegerProperty |
ABORT_DRAG_KEY
Abort drag key code property
|
static BooleanProperty |
AUTO_SELECT_TAB
Auto select tab property
|
static PropertyMapProperty |
BUTTON_PROPERTIES
Button properties
|
static PropertyMapProperty |
CONTENT_PANEL_PROPERTIES
Content area properties
|
static BooleanProperty |
ENSURE_SELECTED_VISIBLE
Ensure selected visible property
|
static Property[] |
FUNCTIONAL_PROPERTIES
Array with all properties that controls the functional behavior
|
static BooleanProperty |
HIGHLIGHT_PRESSED_TAB
If true the tab pressed with the mouse will be highlighted, otherwise it
remains unchanged.
|
static HoverListenerProperty |
HOVER_LISTENER
Hover listener property
|
static TabbedPanelHoverPolicyProperty |
HOVER_POLICY
Tabbed panel hover policy.
|
static BooleanProperty |
PAINT_TAB_AREA_SHADOW
Paint a shadow for the tab area.
|
static PropertyMapGroup |
PROPERTIES
A property group for all properties in TabbedPanelProperties
|
static IntegerProperty |
SHADOW_BLEND_AREA_SIZE
Shadow blend area size property
|
static ColorProperty |
SHADOW_COLOR
Shadow color property
|
static BooleanProperty |
SHADOW_ENABLED
Shadow enabled property
|
static Property[] |
SHADOW_PROPERTIES
Array with all properties that controls the shadow
|
static IntegerProperty |
SHADOW_SIZE
Shadow size property
|
static FloatProperty |
SHADOW_STRENGTH
Shadow strength property
|
static PropertyMapProperty |
TAB_AREA_COMPONENTS_PROPERTIES
Tab area components properties
|
static DirectionProperty |
TAB_AREA_ORIENTATION
Tab area orientation property
|
static PropertyMapProperty |
TAB_AREA_PROPERTIES
Tab area properties
|
static TabDepthOrderPolicyProperty |
TAB_DEPTH_ORDER
Tab depth order.
|
static BooleanProperty |
TAB_DESELECTABLE
Tab deselectable property
|
static TabDropDownListVisiblePolicyProperty |
TAB_DROP_DOWN_LIST_VISIBLE_POLICY
Tab drop down list visible property
|
static TabLayoutPolicyProperty |
TAB_LAYOUT_POLICY
Tab layout property
|
static BooleanProperty |
TAB_REORDER_ENABLED
Tab reorder property
|
static IntegerProperty |
TAB_SCROLLING_OFFSET
Tab scrolling offset property
|
static TabSelectTriggerProperty |
TAB_SELECT_TRIGGER
Tab select trigger
|
static IntegerProperty |
TAB_SPACING
Tab spacing property
|
static Property[] |
TABS_VISUAL_PROPERTIES
Array with all properties that controls the visual apperance except for
shadow
|
static Property[] |
VISUAL_PROPERTIES
Array with all properties that controls the visual apperance including
shadow
|
Constructor and Description |
---|
TabbedPanelProperties()
Constructs an empty TabbedPanelProperties object
|
TabbedPanelProperties(PropertyMap map)
Constructs a TabbedPanelProperties map with the given map as property
storage
|
TabbedPanelProperties(TabbedPanelProperties inheritFrom)
Constructs a TabbedPanelProperties object that inherits its properties
from the given TabbedPanelProperties object
|
Modifier and Type | Method and Description |
---|---|
TabbedPanelProperties |
addSuperObject(TabbedPanelProperties superObject)
Adds a super object from which property values are inherited.
|
int |
getAbortDragKey()
Gets the key code for aborting a tab drag or reorder operation.
|
boolean |
getAutoSelectTab()
Gets if automatic selection of a tab is enabled.
|
TabbedPanelButtonProperties |
getButtonProperties()
Gets the properties getMap() with properties for all the buttons in a
tabbed panel.
|
TabbedPanelContentPanelProperties |
getContentPanelProperties()
Gets the properties getMap() with properties for the tabbed panel's
content area
|
static TabbedPanelProperties |
getDefaultProperties()
Creates a properties object with default properties based on the current
look and feel
|
boolean |
getEnsureSelectedTabVisible()
Gets if a tab should be made visible if it is selected, i.e.
|
boolean |
getHighlightPressedTab()
Gets if the tab pressed with the mouse will be highlighted.
|
HoverListener |
getHoverListener()
Gets the hover listener that will be triggered when the tabbed panel is hovered by the mouse.
|
TabbedPanelHoverPolicy |
getHoverPolicy()
Gets the hover policy.
|
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.
|
int |
getShadowBlendAreaSize()
Gets the shadow blend area size, i.e.
|
java.awt.Color |
getShadowColor()
Gets the shadow color.
|
boolean |
getShadowEnabled()
Gets shadow enabled
|
int |
getShadowSize()
Gets the shadow size, i.e.
|
float |
getShadowStrength()
Gets the shadow strength.
|
TabAreaComponentsProperties |
getTabAreaComponentsProperties()
Gets the properties getMap() with properties for the area in a tabbed
panel's tab area where the tab area components are shown.
|
Direction |
getTabAreaOrientation()
Gets the tab area orientation, i.e.
|
TabAreaProperties |
getTabAreaProperties()
Gets the properties getMap() with properties for the tabbed panel's tab
area
|
TabDepthOrderPolicy |
getTabDepthOrderPolicy()
Gets the tab depth order policy to be used when tabs are overlapping i.e.
|
boolean |
getTabDeselectable()
Gets if tab is deselectable.
|
TabDropDownListVisiblePolicy |
getTabDropDownListVisiblePolicy()
Gets the tab drop down list visible policy, i.e.
|
TabLayoutPolicy |
getTabLayoutPolicy()
Gets the tab layout policy for the tab area, i.e.
|
boolean |
getTabReorderEnabled()
Gets if the tabs can be reorder using the mouse.
|
int |
getTabScrollingOffset()
Gets number of pixels to be shown for the last scrolled tab.
|
TabSelectTrigger |
getTabSelectTrigger()
Gets the tab select trigger, i.e.
|
int |
getTabSpacing()
Gets the tab spacing, i.e.
|
TabbedPanelProperties |
removeSuperObject()
Removes the last added super object.
|
TabbedPanelProperties |
removeSuperObject(TabbedPanelProperties superObject)
Removes the given super object.
|
TabbedPanelProperties |
replaceSuperObject(TabbedPanelProperties oldSuperObject,
TabbedPanelProperties newSuperObject)
Replaces the given super objects.
|
TabbedPanelProperties |
setAbortDragKey(int keyCode)
Sets the key code for aborting a tab drag or reorder operation.
|
TabbedPanelProperties |
setAutoSelectTab(boolean value)
Sets if automatic selection of a tab is enabled.
|
TabbedPanelProperties |
setEnsureSelectedTabVisible(boolean value)
Sets if a tab should be made visible if it is selected, i.e.
|
TabbedPanelProperties |
setHighlightPressedTab(boolean highlightEnabled)
Set to true if the tab pressed with the mouse should be highlighted,
otherwise it's not changed.
|
TabbedPanelProperties |
setHoverListener(HoverListener listener)
Sets the hover listener that will be triggered when the tabbed panel is hoverd by the mouse.
|
TabbedPanelProperties |
setHoverPolicy(TabbedPanelHoverPolicy hoverPolicy)
Sets the hover policy.
|
TabbedPanelProperties |
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.
|
TabbedPanelProperties |
setShadowBlendAreaSize(int size)
Sets the shadow blend area size, i.e.
|
TabbedPanelProperties |
setShadowColor(java.awt.Color color)
Sets the shadow color.
|
TabbedPanelProperties |
setShadowEnabled(boolean value)
Sets shadow enabled
|
TabbedPanelProperties |
setShadowSize(int size)
Sets the shadow size, i.e.
|
TabbedPanelProperties |
setShadowStrength(float strength)
Sets the shadow strength.
|
TabbedPanelProperties |
setTabAreaOrientation(Direction direction)
Sets the tab area orientation, i.e.
|
TabbedPanelProperties |
setTabDepthOrderPolicy(TabDepthOrderPolicy policy)
Sets the tab depth order policy to be used when tabs are overlapping i.e.
|
TabbedPanelProperties |
setTabDeselectable(boolean value)
Sets if tab is deselectable.
|
TabbedPanelProperties |
setTabDropDownListVisiblePolicy(TabDropDownListVisiblePolicy policy)
Sets the tab drop down list visible policy, i.e.
|
TabbedPanelProperties |
setTabLayoutPolicy(TabLayoutPolicy policy)
Sets the tab layout policy for the tab area, i.e.
|
TabbedPanelProperties |
setTabReorderEnabled(boolean enabled)
Sets if the tabs can be reordered using the mouse
|
TabbedPanelProperties |
setTabScrollingOffset(int offset)
Sets number of pixels to be shown for the scrolled out tab next to the
first visible tab.
|
TabbedPanelProperties |
setTabSelectTrigger(TabSelectTrigger trigger)
Sets the tab select trigger, i.e.
|
TabbedPanelProperties |
setTabSpacing(int value)
Sets the tab spacing, i.e.
|
getMap
public static final PropertyMapGroup PROPERTIES
public static final BooleanProperty TAB_REORDER_ENABLED
public static final IntegerProperty ABORT_DRAG_KEY
setAbortDragKey(int)
,
getAbortDragKey()
public static final TabLayoutPolicyProperty TAB_LAYOUT_POLICY
public static final TabDropDownListVisiblePolicyProperty TAB_DROP_DOWN_LIST_VISIBLE_POLICY
public static final TabSelectTriggerProperty TAB_SELECT_TRIGGER
setTabSelectTrigger(net.infonode.tabbedpanel.TabSelectTrigger)
,
getTabSelectTrigger()
public static final IntegerProperty TAB_SCROLLING_OFFSET
public static final BooleanProperty ENSURE_SELECTED_VISIBLE
public static final DirectionProperty TAB_AREA_ORIENTATION
public static final IntegerProperty TAB_SPACING
setTabSpacing(int)
,
getTabSpacing()
public static final TabDepthOrderPolicyProperty TAB_DEPTH_ORDER
setAutoSelectTab(boolean)
,
getAutoSelectTab()
public static final BooleanProperty AUTO_SELECT_TAB
setAutoSelectTab(boolean)
,
getAutoSelectTab()
public static final BooleanProperty HIGHLIGHT_PRESSED_TAB
public static final BooleanProperty TAB_DESELECTABLE
public static final PropertyMapProperty CONTENT_PANEL_PROPERTIES
getContentPanelProperties()
public static final PropertyMapProperty TAB_AREA_PROPERTIES
getTabAreaProperties()
public static final PropertyMapProperty TAB_AREA_COMPONENTS_PROPERTIES
getTabAreaComponentsProperties()
public static final PropertyMapProperty BUTTON_PROPERTIES
getButtonProperties()
public static final BooleanProperty SHADOW_ENABLED
setShadowEnabled(boolean)
,
getShadowEnabled()
public static final HoverListenerProperty HOVER_LISTENER
setHoverListener(net.infonode.gui.hover.HoverListener)
,
getHoverListener()
public static final TabbedPanelHoverPolicyProperty HOVER_POLICY
setHoverPolicy(net.infonode.tabbedpanel.TabbedPanelHoverPolicy)
,
getHoverPolicy()
public static final BooleanProperty PAINT_TAB_AREA_SHADOW
public static final IntegerProperty SHADOW_SIZE
setShadowSize(int)
,
getShadowSize()
public static final IntegerProperty SHADOW_BLEND_AREA_SIZE
public static final ColorProperty SHADOW_COLOR
public static final FloatProperty SHADOW_STRENGTH
setShadowStrength(float)
,
getShadowStrength()
public static final Property[] FUNCTIONAL_PROPERTIES
public static final Property[] SHADOW_PROPERTIES
public static final Property[] TABS_VISUAL_PROPERTIES
public static final Property[] VISUAL_PROPERTIES
public TabbedPanelProperties()
public TabbedPanelProperties(PropertyMap map)
map
- map to store properties inpublic TabbedPanelProperties(TabbedPanelProperties inheritFrom)
inheritFrom
- TabbedPanelProperties object to inherit properties frompublic static TabbedPanelProperties getDefaultProperties()
public TabbedPanelProperties addSuperObject(TabbedPanelProperties superObject)
superObject
- the object from which to inherit property valuespublic TabbedPanelProperties removeSuperObject()
public TabbedPanelProperties removeSuperObject(TabbedPanelProperties superObject)
superObject
- super object to removepublic TabbedPanelProperties replaceSuperObject(TabbedPanelProperties oldSuperObject, TabbedPanelProperties newSuperObject)
oldSuperObject
- old super objectnewSuperObject
- new super objectpublic TabbedPanelProperties setShadowStrength(float strength)
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.
strength
- the strength between 0 and 1setShadowColor(java.awt.Color)
,
setShadowEnabled(boolean)
public TabbedPanelProperties setShadowBlendAreaSize(int size)
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.
size
- the shadow blend area size in pixelssetShadowEnabled(boolean)
public TabbedPanelProperties setShadowSize(int size)
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.
size
- shadow size in pixelssetShadowEnabled(boolean)
public TabbedPanelProperties setShadowColor(java.awt.Color color)
Sets the shadow color.
Note: This property will only have effect if shadow is enabled.
color
- the shadow colorsetShadowEnabled(boolean)
public TabbedPanelProperties setShadowEnabled(boolean value)
value
- true for enabled, otherwise falsepublic TabbedPanelProperties setAutoSelectTab(boolean value)
value
- true for automactic selection, otherwise falsepublic TabbedPanelProperties setTabDeselectable(boolean value)
value
- true for deselectable, otherwise falsepublic TabbedPanelProperties setEnsureSelectedTabVisible(boolean value)
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.
value
- true for selected visible, otherwise falsesetTabLayoutPolicy(net.infonode.tabbedpanel.TabLayoutPolicy)
public TabbedPanelProperties setTabScrollingOffset(int offset)
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.
offset
- number of pixelssetTabLayoutPolicy(net.infonode.tabbedpanel.TabLayoutPolicy)
public TabbedPanelProperties setTabReorderEnabled(boolean enabled)
enabled
- true for enabled, otherwise disabledpublic TabbedPanelProperties setHighlightPressedTab(boolean highlightEnabled)
highlightEnabled
- true if the tab pressed with the mouse should be highlightedpublic TabbedPanelProperties setAbortDragKey(int keyCode)
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.
keyCode
- key codepublic TabbedPanelProperties setTabLayoutPolicy(TabLayoutPolicy policy)
policy
- the tab area layout policypublic TabbedPanelProperties setTabDropDownListVisiblePolicy(TabDropDownListVisiblePolicy policy)
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.
policy
- the tab drop down list visible policypublic TabbedPanelProperties setTabSelectTrigger(TabSelectTrigger trigger)
trigger
- the tab select triggerpublic TabbedPanelProperties setTabAreaOrientation(Direction direction)
direction
- the orientationpublic TabbedPanelProperties setTabSpacing(int value)
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.
value
- number of pixels. A negative value reuslts in tabs
overlapping each other with the number of pixels.setTabDepthOrderPolicy(net.infonode.tabbedpanel.TabDepthOrderPolicy)
public TabbedPanelProperties setTabDepthOrderPolicy(TabDepthOrderPolicy policy)
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.
policy
- the tab depth order policysetTabSpacing(int)
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.
getShadowColor()
,
getShadowEnabled()
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.
getShadowEnabled()
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.
getShadowEnabled()
public java.awt.Color getShadowColor()
Gets the shadow color.
Note: This property will only have effect if shadow is enabled.
getShadowEnabled()
public boolean getShadowEnabled()
public boolean getAutoSelectTab()
public boolean getHighlightPressedTab()
public boolean getTabDeselectable()
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.
getTabLayoutPolicy()
public boolean getPaintTabAreaShadow()
public TabbedPanelProperties setPaintTabAreaShadow(boolean paintShadow)
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 panelpublic int getTabScrollingOffset()
Gets number of pixels to be shown for the last scrolled tab.
Note: This will only have effect if scolling is enabled.
getTabLayoutPolicy()
public boolean getTabReorderEnabled()
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.
public TabLayoutPolicy getTabLayoutPolicy()
public TabDropDownListVisiblePolicy 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.
public TabSelectTrigger getTabSelectTrigger()
public Direction getTabAreaOrientation()
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.
getTabDepthOrderPolicy()
public TabDepthOrderPolicy 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.
getTabSpacing()
public TabbedPanelProperties setHoverListener(HoverListener listener)
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.
listener
- the hover listenerpublic HoverListener 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.
public TabbedPanelProperties setHoverPolicy(TabbedPanelHoverPolicy hoverPolicy)
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.
hoverPolicy
- the hover policypublic TabbedPanelHoverPolicy 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.
public TabbedPanelContentPanelProperties getContentPanelProperties()
public TabAreaProperties getTabAreaProperties()
public TabAreaComponentsProperties getTabAreaComponentsProperties()
public TabbedPanelButtonProperties getButtonProperties()