- All Implemented Interfaces:
Styleable
,EventTarget
Tabs are placed within a TabPane
, where each tab represents a single
'page'.
Tabs can contain any Node
such as UI controls or groups
of nodes added to a layout container.
When the user clicks on a Tab in the TabPane the Tab content becomes visible to the user.
- Since:
- JavaFX 2.0
-
Property Summary
TypePropertyDescriptionfinal BooleanProperty
The closable state for this tab.final ObjectProperty<Node>
The content associated with the tab.final ObjectProperty<ContextMenu>
The context menu associated with the tab.final ReadOnlyBooleanProperty
Indicates whether or not thisTab
is disabled.final BooleanProperty
Sets the disabled state of this tab.final ObjectProperty<Node>
The graphic in the tab.final StringProperty
The id of this tab.final ObjectProperty<EventHandler<Event>>
The event handler that is associated with the tab when the tab is closed.final ObjectProperty<EventHandler<Event>>
Called when there is an external request to close thisTab
.final ObjectProperty<EventHandler<Event>>
The event handler that is associated with a selection on the tab.final ReadOnlyBooleanProperty
The currently selected tab.final StringProperty
The CSS style string associated to this tab.final ReadOnlyObjectProperty<TabPane>
The TabPane that contains this tab.final StringProperty
The text shown in the tab.final ObjectProperty<Tooltip>
The tooltip associated with this tab. -
Field Summary
Modifier and TypeFieldDescriptionCalled when a user closes this tab.Called when the tab becomes selected or unselected.Called when there is an external request to close thisTab
. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal <E extends Event>
voidaddEventFilter
(EventType<E> eventType, EventHandler<? super E> eventFilter) Registers an event filter for this target.final <E extends Event>
voidaddEventHandler
(EventType<E> eventType, EventHandler<? super E> eventHandler) Registers an event handler for this target.Construct an event dispatch chain for this target.final BooleanProperty
The closable state for this tab.final ObjectProperty<Node>
The content associated with the tab.final ObjectProperty<ContextMenu>
The context menu associated with the tab.final ReadOnlyBooleanProperty
Indicates whether or not thisTab
is disabled.final BooleanProperty
Sets the disabled state of this tab.static List<CssMetaData<? extends Styleable,
?>> Gets theCssMetaData
associated with this class, which may include theCssMetaData
of its superclasses.final Node
The content associated with the tab.final ContextMenu
The context menu associated with the tab.List<CssMetaData<? extends Styleable,
?>> The CssMetaData of this Styleable.final Node
The graphic shown in the tab.final String
getId()
The id of this tab.final EventHandler<Event>
The event handler that is associated with the tab when the tab is closed.Gets the value of theonCloseRequest
property.final EventHandler<Event>
The event handler that is associated with a selection on the tab.final ObservableMap<Object,
Object> Returns an observable map of properties on this Tab for use primarily by application developers.final ObservableSet<PseudoClass>
Return the pseudo-class state of this Styleable.final String
getStyle()
The CSS style string associated to this tab.Return the parent of this Styleable, or null if there is no parent.A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.final TabPane
A reference to the TabPane that contains this tab instance.final String
getText()
The text shown in the tab.final Tooltip
The tooltip associated with this tab.The type of thisStyleable
that is to be used in selector matching.Returns a previously set Object property, or null if no such property has been set using thesetUserData(java.lang.Object)
method.final ObjectProperty<Node>
The graphic in the tab.boolean
Tests if this Tab has properties.final StringProperty
The id of this tab.final boolean
Returnstrue
if this tab is closable.final boolean
Returnstrue
if this tab is disable.final boolean
final boolean
Represents whether this tab is the currently selected tab, To change the selected Tab usetabPane.getSelectionModel().select()
final ObjectProperty<EventHandler<Event>>
The event handler that is associated with the tab when the tab is closed.final ObjectProperty<EventHandler<Event>>
Called when there is an external request to close thisTab
.final ObjectProperty<EventHandler<Event>>
The event handler that is associated with a selection on the tab.final <E extends Event>
voidremoveEventFilter
(EventType<E> eventType, EventHandler<? super E> eventFilter) Unregisters a previously registered event filter from this target.final <E extends Event>
voidremoveEventHandler
(EventType<E> eventType, EventHandler<? super E> eventHandler) Unregisters a previously registered event handler from this target.final ReadOnlyBooleanProperty
The currently selected tab.final void
setClosable
(boolean value) Setstrue
if the tab is closable.final void
setContent
(Node value) The content to show within the main TabPane area.final void
setContextMenu
(ContextMenu value) Specifies the context menu to show when the user right-clicks on the tab.final void
setDisable
(boolean value) Sets the disabled state of this tab.final void
setGraphic
(Node value) Sets the graphic to show in the tab to allow the user to differentiate between the function of each tab.final void
Sets the id of this tab.final void
setOnClosed
(EventHandler<Event> value) Defines a function to be called when the tab is closed.void
setOnCloseRequest
(EventHandler<Event> value) Sets the value of theonCloseRequest
property.final void
setOnSelectionChanged
(EventHandler<Event> value) Defines a function to be called when a selection changed has occurred on the tab.final void
A string representation of the CSS style associated with this tab.final void
Sets the text to show in the tab to allow the user to differentiate between the function of each tab.final void
setTooltip
(Tooltip value) Specifies the tooltip to show when the user hovers over the tab.void
setUserData
(Object value) Convenience method for setting a single Object property that can be retrieved at a later date.final StringProperty
The CSS style string associated to this tab.final ReadOnlyObjectProperty<TabPane>
The TabPane that contains this tab.final StringProperty
The text shown in the tab.final ObjectProperty<Tooltip>
The tooltip associated with this tab.Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods declared in interface javafx.css.Styleable
getStyleableNode
-
Property Details
-
id
The id of this tab.- See Also:
-
style
The CSS style string associated to this tab.- See Also:
-
selected
The currently selected tab.- See Also:
-
tabPane
The TabPane that contains this tab.- See Also:
-
text
The text shown in the tab.- See Also:
-
graphic
The graphic in the tab.- See Also:
-
content
The content associated with the tab.
- See Also:
-
contextMenu
The context menu associated with the tab. -
closable
The closable state for this tab. -
onSelectionChanged
The event handler that is associated with a selection on the tab. -
onClosed
The event handler that is associated with the tab when the tab is closed. -
tooltip
The tooltip associated with this tab.- See Also:
-
disable
Sets the disabled state of this tab. A disable tab is no longer interactive or traversable, but the contents remain interactive. A disable tab can be selected usingTabPane.getSelectionModel()
.- Default value:
- false
- Since:
- JavaFX 2.2
- See Also:
-
disabled
Indicates whether or not thisTab
is disabled. ATab
will become disabled ifdisable
is set totrue
on either itself or if theTabPane
is disabled.- Default value:
- false
- Since:
- JavaFX 2.2
- See Also:
-
onCloseRequest
Called when there is an external request to close thisTab
. The installed event handler can prevent tab closing by consuming the received event.- Since:
- JavaFX 8.0
- See Also:
-
-
Field Details
-
SELECTION_CHANGED_EVENT
Called when the tab becomes selected or unselected.
-
CLOSED_EVENT
Called when a user closes this tab. This is useful for freeing up memory.
-
TAB_CLOSE_REQUEST_EVENT
Called when there is an external request to close thisTab
. The installed event handler can prevent tab closing by consuming the received event.- Since:
- JavaFX 8.0
-
-
Constructor Details
-
Tab
public Tab()Creates a tab with no title. -
Tab
Creates a tab with a text title.- Parameters:
text
- The title of the tab.
-
Tab
Creates a tab with a text title and the specified content node.- Parameters:
text
- The title of the tab.content
- The content of the tab.- Since:
- JavaFX 8u40
-
-
Method Details
-
setId
Sets the id of this tab. This simple string identifier is useful for finding a specific Tab within theTabPane
. The default value isnull
.- Parameters:
value
- the id of this tab
-
getId
The id of this tab. -
idProperty
The id of this tab.- Returns:
- the id property of this tab
- See Also:
-
setStyle
A string representation of the CSS style associated with this tab. This is analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule.Parsing this style might not be supported on some limited platforms. It is recommended to use a standalone CSS file instead.
- Parameters:
value
- the style string
-
getStyle
The CSS style string associated to this tab. -
styleProperty
The CSS style string associated to this tab.- Returns:
- the CSS style string property associated to this tab
- See Also:
-
isSelected
public final boolean isSelected()Represents whether this tab is the currently selected tab, To change the selected Tab use
tabPane.getSelectionModel().select()
- Returns:
- true if selected
-
selectedProperty
The currently selected tab.- Returns:
- the selected tab
- See Also:
-
getTabPane
A reference to the TabPane that contains this tab instance.
- Returns:
- the TabPane
-
tabPaneProperty
The TabPane that contains this tab.- Returns:
- the TabPane property
- See Also:
-
setText
Sets the text to show in the tab to allow the user to differentiate between the function of each tab. The text is always visible
- Parameters:
value
- the text string
-
getText
The text shown in the tab.- Returns:
- The text shown in the tab.
-
textProperty
The text shown in the tab.- Returns:
- the text property
- See Also:
-
setGraphic
Sets the graphic to show in the tab to allow the user to differentiate between the function of each tab. By default the graphic does not rotate based on the TabPane.tabPosition value, but it can be set to rotate by setting TabPane.rotateGraphic to true.
- Parameters:
value
- the graphic node
-
getGraphic
The graphic shown in the tab.- Returns:
- The graphic shown in the tab.
-
graphicProperty
The graphic in the tab.- Returns:
- The graphic in the tab.
- See Also:
-
setContent
The content to show within the main TabPane area. The content can be any Node such as UI controls or groups of nodes added to a layout container.
- Parameters:
value
- the content node
-
getContent
The content associated with the tab.
- Returns:
- The content associated with the tab.
-
contentProperty
The content associated with the tab.
- Returns:
- the content property
- See Also:
-
setContextMenu
Specifies the context menu to show when the user right-clicks on the tab.
- Parameters:
value
- the context menu
-
getContextMenu
The context menu associated with the tab.- Returns:
- The context menu associated with the tab.
-
contextMenuProperty
The context menu associated with the tab.- Returns:
- the context menu property
- See Also:
-
setClosable
public final void setClosable(boolean value) Sets
true
if the tab is closable. If this is set tofalse
, then regardless of the TabClosingPolicy, it will not be possible for the user to close this tab. Therefore, when this property isfalse
, no 'close' button will be shown on the tab. The default istrue
.- Parameters:
value
- the closable value
-
isClosable
public final boolean isClosable()Returnstrue
if this tab is closable.- Returns:
true
if the tab is closable.
-
closableProperty
The closable state for this tab.- Returns:
- the closable property
- See Also:
-
setOnSelectionChanged
Defines a function to be called when a selection changed has occurred on the tab.- Parameters:
value
- the on selection changed event handler
-
getOnSelectionChanged
The event handler that is associated with a selection on the tab.- Returns:
- The event handler that is associated with a tab selection.
-
onSelectionChangedProperty
The event handler that is associated with a selection on the tab.- Returns:
- the on selection changed event handler property
- See Also:
-
setOnClosed
Defines a function to be called when the tab is closed.- Parameters:
value
- the on closed event handler
-
getOnClosed
The event handler that is associated with the tab when the tab is closed.- Returns:
- The event handler that is associated with the tab when the tab is closed.
-
onClosedProperty
The event handler that is associated with the tab when the tab is closed.- Returns:
- the on closed event handler property
- See Also:
-
setTooltip
Specifies the tooltip to show when the user hovers over the tab.
- Parameters:
value
- the tool tip value
-
getTooltip
The tooltip associated with this tab.- Returns:
- The tooltip associated with this tab.
-
tooltipProperty
The tooltip associated with this tab.- Returns:
- the tool tip property
- See Also:
-
setDisable
public final void setDisable(boolean value) Sets the disabled state of this tab.- Default value:
- false
- Parameters:
value
- the state to set this tab- Since:
- JavaFX 2.2
-
isDisable
public final boolean isDisable()Returnstrue
if this tab is disable.- Returns:
- true if this tab is disable
- Since:
- JavaFX 2.2
-
disableProperty
Sets the disabled state of this tab. A disable tab is no longer interactive or traversable, but the contents remain interactive. A disable tab can be selected usingTabPane.getSelectionModel()
.- Default value:
- false
- Returns:
- the disable property
- Since:
- JavaFX 2.2
- See Also:
-
isDisabled
public final boolean isDisabled()- Returns:
- true if the TabPane is disabled
- Since:
- JavaFX 2.2
-
disabledProperty
Indicates whether or not thisTab
is disabled. ATab
will become disabled ifdisable
is set totrue
on either itself or if theTabPane
is disabled.- Default value:
- false
- Returns:
- the disabled property
- Since:
- JavaFX 2.2
- See Also:
-
onCloseRequestProperty
Called when there is an external request to close thisTab
. The installed event handler can prevent tab closing by consuming the received event.- Returns:
- the
onCloseRequest
property - Since:
- JavaFX 8.0
- See Also:
-
getOnCloseRequest
Gets the value of theonCloseRequest
property.- Property description:
- Called when there is an external request to close this
Tab
. The installed event handler can prevent tab closing by consuming the received event. - Returns:
- the value of the
onCloseRequest
property - Since:
- JavaFX 8.0
- See Also:
-
setOnCloseRequest
Sets the value of theonCloseRequest
property.- Property description:
- Called when there is an external request to close this
Tab
. The installed event handler can prevent tab closing by consuming the received event. - Parameters:
value
- the value for theonCloseRequest
property- Since:
- JavaFX 8.0
- See Also:
-
getProperties
Returns an observable map of properties on this Tab for use primarily by application developers.- Returns:
- an observable map of properties on this Tab for use primarily by application developers
- Since:
- JavaFX 2.2
-
hasProperties
public boolean hasProperties()Tests if this Tab has properties.- Returns:
- true if this tab has properties.
- Since:
- JavaFX 2.2
-
setUserData
Convenience method for setting a single Object property that can be retrieved at a later date. This is functionally equivalent to calling the getProperties().put(Object key, Object value) method. This can later be retrieved by callinggetUserData()
.- Parameters:
value
- The value to be stored - this can later be retrieved by callinggetUserData()
.- Since:
- JavaFX 2.2
-
getUserData
Returns a previously set Object property, or null if no such property has been set using thesetUserData(java.lang.Object)
method.- Returns:
- The Object that was previously set, or null if no property has been set or if null was set.
- Since:
- JavaFX 2.2
-
getStyleClass
A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine. This variable is analogous to the "class" attribute on an HTML element and, as such, each element of the list is a style class to which this Node belongs.- Specified by:
getStyleClass
in interfaceStyleable
- Returns:
- a list of String identifiers which can be used to logically group Nodes, specifically for an external style engine
- See Also:
-
buildEventDispatchChain
Description copied from interface:EventTarget
Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at thisEventTarget
. This event target is not automatically added to the chain, so if it wants to process events, it needs to add anEventDispatcher
for itself to the chain.In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target.
The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain.
The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain.
- Specified by:
buildEventDispatchChain
in interfaceEventTarget
- Parameters:
tail
- the initial chain to build from- Returns:
- the resulting event dispatch chain for this target
-
addEventHandler
public final <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler) Description copied from interface:EventTarget
Registers an event handler for this target.The handler is called when the target receives an
Event
of the specified type during the bubbling phase of event delivery.- Specified by:
addEventHandler
in interfaceEventTarget
- Type Parameters:
E
- the event class of the handler- Parameters:
eventType
- the type of the events received by the handlereventHandler
- the event handler
-
removeEventHandler
public final <E extends Event> void removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler) Description copied from interface:EventTarget
Unregisters a previously registered event handler from this target.Since it is possible to register a single
EventHandler
instance for different event types, the caller needs to specify the event type from which the handler should be unregistered.- Specified by:
removeEventHandler
in interfaceEventTarget
- Type Parameters:
E
- the event class of the handler- Parameters:
eventType
- the event type from which to unregistereventHandler
- the event handler
-
addEventFilter
public final <E extends Event> void addEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter) Description copied from interface:EventTarget
Registers an event filter for this target.The filter is called when the target receives an
Event
of the specified type during the capturing phase of event delivery.- Specified by:
addEventFilter
in interfaceEventTarget
- Type Parameters:
E
- the event class of the filter- Parameters:
eventType
- the type of the events received by the filtereventFilter
- the event filter
-
removeEventFilter
public final <E extends Event> void removeEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter) Description copied from interface:EventTarget
Unregisters a previously registered event filter from this target.Since it is possible to register a single
EventHandler
instance for different event types, the caller needs to specify the event type from which the filter should be unregistered.- Specified by:
removeEventFilter
in interfaceEventTarget
- Type Parameters:
E
- the event class of the filter- Parameters:
eventType
- the event type from which to unregistereventFilter
- the event filter
-
getTypeSelector
The type of thisStyleable
that is to be used in selector matching. This is analogous to an "element" in HTML. (CSS Type Selector).- Specified by:
getTypeSelector
in interfaceStyleable
- Returns:
- "Tab"
- Since:
- JavaFX 8.0
-
getStyleableParent
Return the parent of this Styleable, or null if there is no parent.- Specified by:
getStyleableParent
in interfaceStyleable
- Returns:
getTabPane()
- Since:
- JavaFX 8.0
-
getPseudoClassStates
Return the pseudo-class state of this Styleable. CSS assumes this set is read-only.- Specified by:
getPseudoClassStates
in interfaceStyleable
- Returns:
- the pseudo-class state
- Since:
- JavaFX 8.0
-
getCssMetaData
The CssMetaData of this Styleable. This may be returned as an unmodifiable list.- Specified by:
getCssMetaData
in interfaceStyleable
- Returns:
- the CssMetaData
- Since:
- JavaFX 8.0
-
getClassCssMetaData
Gets theCssMetaData
associated with this class, which may include theCssMetaData
of its superclasses.- Returns:
- the
CssMetaData
- Since:
- JavaFX 8.0
-