net.infonode.tabbedpanel
public class TabbedPanelProperties extends PropertyMapContainer
Version: $Revision: 1.60 $
See Also: TabbedPanel TabbedPanelProperties TabbedPanelProperties TabbedPanelProperties TabbedPanelProperties
Field Summary | |
---|---|
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 Property[] | TABS_VISUAL_PROPERTIES
Array with all properties that controls the visual apperance except for
shadow |
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[] | VISUAL_PROPERTIES
Array with all properties that controls the visual apperance including
shadow |
Constructor Summary | |
---|---|
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
|
Method Summary | |
---|---|
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. if scrolling is enabled, a tab will be scrolled into the visible part of the tab area when it becomes selected. |
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. The hovered tabbed panel will be the source of the hover event sent to the hover listener. |
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. |
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. number of pixels for the shadow color fading. |
Color | getShadowColor() Gets the shadow color. |
boolean | getShadowEnabled()
Gets shadow enabled
|
int | getShadowSize() Gets the shadow size, i.e. the width/height of the shadow in pixels. |
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. if the tab area should be placed up,
down, left or right of the content area
|
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. negative tab spacing. |
boolean | getTabDeselectable()
Gets if tab is deselectable. |
TabDropDownListVisiblePolicy | getTabDropDownListVisiblePolicy() Gets the tab drop down list visible policy, i.e. when a drop down list with the tabs should be visible. |
TabLayoutPolicy | getTabLayoutPolicy()
Gets the tab layout policy for the tab area, i.e. how the line of tabs
should be laid out
|
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. what triggers a tab selection
|
int | getTabSpacing() Gets the tab spacing, i.e. number of pixels between the tabs in the tab area. |
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. if scrolling is enabled, a tab will be scrolled into the visible part of the tab area when it becomes selected. |
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. The hovered tabbed panel will be the source of the hover event sent to the hover listener. |
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. |
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. number of pixels for the shadow color fading. |
TabbedPanelProperties | setShadowColor(Color color) Sets the shadow color. |
TabbedPanelProperties | setShadowEnabled(boolean value)
Sets shadow enabled
|
TabbedPanelProperties | setShadowSize(int size) Sets the shadow size, i.e. the width/height of the shadow in pixels. |
TabbedPanelProperties | setShadowStrength(float strength) Sets the shadow strength. |
TabbedPanelProperties | setTabAreaOrientation(Direction direction)
Sets the tab area orientation, i.e. if the tab area should be placed up,
down, left or right of the content area.
|
TabbedPanelProperties | setTabDepthOrderPolicy(TabDepthOrderPolicy policy) Sets the tab depth order policy to be used when tabs are overlapping i.e. negative tab spacing. |
TabbedPanelProperties | setTabDeselectable(boolean value)
Sets if tab is deselectable. |
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 {@link net.infonode.gui.icon.IconProvider} and the text will be retrieved by calling toString() on the tab. |
TabbedPanelProperties | setTabLayoutPolicy(TabLayoutPolicy policy)
Sets the tab layout policy for the tab area, i.e. how the line of tabs
should be laid out
|
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. what triggers a tab selection
|
TabbedPanelProperties | setTabSpacing(int value) Sets the tab spacing, i.e. number of pixels between the tabs in the tab area. |
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
Since: ITP 1.3.0
See Also: TabbedPanelProperties
See Also: TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
Since: ITP 1.3.0
See Also: TabbedPanelProperties TabbedPanelProperties
Since: ITP 1.3.0
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties getPaintTabAreaShadow
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
Since: ITP 1.1.0
See Also: TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties
Since: ITP 1.2.0
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
Since: ITP 1.1.0
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
Since: ITP 1.1.0
See Also: TabbedPanelProperties TabbedPanelProperties
See Also: TabbedPanelProperties TabbedPanelProperties
Parameters: map map to store properties in
Parameters: inheritFrom TabbedPanelProperties object to inherit properties from
Parameters: superObject the object from which to inherit property values
Returns: this
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
Returns: true if automactic selection, otherwise false
Returns: the properties for the buttons
Since: ITP 1.3.0
Returns: the properties for the content area
Returns: properties object
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: TabbedPanelProperties
Returns: true 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.
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
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
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
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: TabbedPanelProperties
Gets the shadow color.
Note: This property will only have effect if shadow is enabled.
Returns: the shadow color
See Also: TabbedPanelProperties
Returns: true if shadow is enabled, otherwise false
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: TabbedPanelProperties
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: TabbedPanelProperties TabbedPanelProperties
Returns: the properties for the tab area components
Since: ITP 1.1.0
Returns: the orientation
Returns: the properties for the tab area
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: TabbedPanelProperties
Returns: true if deselectable, otherwise false
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 {@link net.infonode.gui.icon.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
Returns: the tab area layout policy
Returns: true if enabled, otherwise disabled
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: TabbedPanelProperties
Returns: the tab select trigger
Since: ITP 1.1.0
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: TabbedPanelProperties
Returns: this
Parameters: superObject super object to remove
Returns: this
Since: ITP 1.3.0
Parameters: oldSuperObject old super object newSuperObject new super object
Returns: this
Since: ITP 1.4.0
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
Parameters: value true for automactic selection, otherwise false
Returns: this TabbedPanelProperties
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: TabbedPanelProperties
Parameters: highlightEnabled true if the tab pressed with the mouse should be highlighted
Returns: this
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
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
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
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: TabbedPanelProperties
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: TabbedPanelProperties
Parameters: value true for enabled, otherwise false
Returns: this TabbedPanelProperties
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: TabbedPanelProperties
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: TabbedPanelProperties TabbedPanelProperties
Parameters: direction the orientation
Returns: this TabbedPanelProperties
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: TabbedPanelProperties
Parameters: value true for deselectable, otherwise false
Returns: this TabbedPanelProperties
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 {@link net.infonode.gui.icon.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
Parameters: policy the tab area layout policy
Returns: this TabbedPanelProperties
Parameters: enabled true for enabled, otherwise disabled
Returns: this TabbedPanelProperties
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: TabbedPanelProperties
Parameters: trigger the tab select trigger
Returns: this TabbedPanelProperties
Since: ITP 1.1.0
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: TabbedPanelProperties