Tab (JavaFX 8)

java.lang.Object
- javafx.scene.control.Tab

All Implemented Interfaces:

Styleable, EventTarget
```
@DefaultProperty(value="content")
 @IDProperty(value="id")
public class Tab
extends Object
implements EventTarget, Styleable
```
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

All Methods Instance Methods Concrete Methods
Type	Property and Description
`BooleanProperty`	`closable` The closable state for this tab.
`ObjectProperty<Node>`	`content` The content associated with the tab.
`ObjectProperty<ContextMenu>`	`contextMenu` The context menu associated with the tab.
`ReadOnlyBooleanProperty`	`disabled` Indicates whether or not this `Tab` is disabled.
`BooleanProperty`	`disable` Sets the disabled state of this tab.
`ObjectProperty<Node>`	`graphic` The graphic in the tab.
`StringProperty`	`id` The id of this tab.
`ObjectProperty<EventHandler<Event>>`	`onClosed` The event handler that is associated with the tab when the tab is closed.
`ObjectProperty<EventHandler<Event>>`	`onCloseRequest` Called when there is an external request to close this `Tab`.
`ObjectProperty<EventHandler<Event>>`	`onSelectionChanged` The event handler that is associated with a selection on the tab.
`ReadOnlyBooleanProperty`	`selected` The currently selected tab.
`StringProperty`	`style` The CSS style string associated to this tab.
`ReadOnlyObjectProperty<TabPane>`	`tabPane` The TabPane that contains this tab.
`StringProperty`	`text` The text shown in the tab.
`ObjectProperty<Tooltip>`	`tooltip` The tooltip associated with this tab.

Field Summary

Fields
Modifier and Type	Field and Description
`static EventType<Event>`	`CLOSED_EVENT` Called when a user closes this tab.
`static EventType<Event>`	`SELECTION_CHANGED_EVENT` Called when the tab becomes selected or unselected.
`static EventType<Event>`	`TAB_CLOSE_REQUEST_EVENT` Called when there is an external request to close this `Tab`.

Constructor Summary

Constructors
Constructor and Description
`Tab()` Creates a tab with no title.
`Tab(String text)` Creates a tab with a text title.
`Tab(String text, Node content)` Creates a tab with a text title and the specified content node.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BooleanProperty`	`closableProperty()` The closable state for this tab.
`ObjectProperty<Node>`	`contentProperty()` The content associated with the tab.
`ObjectProperty<ContextMenu>`	`contextMenuProperty()` The context menu associated with the tab.
`ReadOnlyBooleanProperty`	`disabledProperty()` Indicates whether or not this `Tab` is disabled.
`BooleanProperty`	`disableProperty()` Sets the disabled state of this tab.
`static List<CssMetaData<? extends Styleable,?>>`	`getClassCssMetaData()`
`Node`	`getContent()` The content associated with the tab.
`ContextMenu`	`getContextMenu()` The context menu associated with the tab.
`List<CssMetaData<? extends Styleable,?>>`	`getCssMetaData()` The CssMetaData of this Styleable.
`Node`	`getGraphic()` The graphic shown in the tab.
`String`	`getId()` The id of this tab.
`EventHandler<Event>`	`getOnClosed()` The event handler that is associated with the tab when the tab is closed.
`EventHandler<Event>`	`getOnCloseRequest()` Gets the value of the property onCloseRequest.
`EventHandler<Event>`	`getOnSelectionChanged()` The event handler that is associated with a selection on the tab.
`ObservableMap<Object,Object>`	`getProperties()` Returns an observable map of properties on this Tab for use primarily by application developers.
`ObservableSet<PseudoClass>`	`getPseudoClassStates()` Return the pseudo-class state of this Styleable.
`String`	`getStyle()` The CSS style string associated to this tab.
`Styleable`	`getStyleableParent()` Return the parent of this Styleable, or null if there is no parent.
`ObservableList<String>`	`getStyleClass()` A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
`TabPane`	`getTabPane()` A reference to the TabPane that contains this tab instance.
`String`	`getText()` The text shown in the tab.
`Tooltip`	`getTooltip()` The tooltip associated with this tab.
`String`	`getTypeSelector()` The type of this `Styleable` that is to be used in selector matching.
`Object`	`getUserData()` Returns a previously set Object property, or null if no such property has been set using the `setUserData(java.lang.Object)` method.
`ObjectProperty<Node>`	`graphicProperty()` The graphic in the tab.
`boolean`	`hasProperties()` Tests if this Tab has properties.
`StringProperty`	`idProperty()` The id of this tab.
`boolean`	`isClosable()` Returns `true` if this tab is closable.
`boolean`	`isDisable()` Returns `true` if this tab is disable.
`boolean`	`isDisabled()` Returns true when the `Tab` `disable` is set to `true` or if the `TabPane` is disabled.
`boolean`	`isSelected()` Represents whether this tab is the currently selected tab, To change the selected Tab use `tabPane.getSelectionModel().select()`
`ObjectProperty<EventHandler<Event>>`	`onClosedProperty()` The event handler that is associated with the tab when the tab is closed.
`ObjectProperty<EventHandler<Event>>`	`onCloseRequestProperty()` Called when there is an external request to close this `Tab`.
`ObjectProperty<EventHandler<Event>>`	`onSelectionChangedProperty()` The event handler that is associated with a selection on the tab.
`ReadOnlyBooleanProperty`	`selectedProperty()` The currently selected tab.
`void`	`setClosable(boolean value)` Sets `true` if the tab is closable.
`void`	`setContent(Node value)` The content to show within the main TabPane area.
`void`	`setContextMenu(ContextMenu value)` Specifies the context menu to show when the user right-clicks on the tab.
`void`	`setDisable(boolean value)` Sets the disabled state of this tab.
`void`	`setGraphic(Node value)` Sets the graphic to show in the tab to allow the user to differentiate between the function of each tab.
`void`	`setId(String value)` Sets the id of this tab.
`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 the property onCloseRequest.
`void`	`setOnSelectionChanged(EventHandler<Event> value)` Defines a function to be called when a selection changed has occurred on the tab.
`void`	`setStyle(String value)` A string representation of the CSS style associated with this tab.
`void`	`setText(String value)` Sets the text to show in the tab to allow the user to differentiate between the function of each tab.
`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.
`StringProperty`	`styleProperty()` The CSS style string associated to this tab.
`ReadOnlyObjectProperty<TabPane>`	`tabPaneProperty()` The TabPane that contains this tab.
`StringProperty`	`textProperty()` The text shown in the tab.
`ObjectProperty<Tooltip>`	`tooltipProperty()` The tooltip associated with this tab.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - id
```
public final StringProperty idProperty
```
    The id of this tab.
  - style
```
public final StringProperty styleProperty
```
    The CSS style string associated to this tab.
    
    See Also:
    
    getStyle(), setStyle(String)
  - selected
```
public final ReadOnlyBooleanProperty selectedProperty
```
    The currently selected tab.
    
    See Also:
    
    isSelected()
  - tabPane
```
public final ReadOnlyObjectProperty<TabPane> tabPaneProperty
```
    The TabPane that contains this tab.
    
    See Also:
    
    getTabPane()
  - text
```
public final StringProperty textProperty
```
    The text shown in the tab.
    
    See Also:
    
    getText(), setText(String)
  - graphic
```
public final ObjectProperty<Node> graphicProperty
```
    The graphic in the tab.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - content
```
public final ObjectProperty<Node> contentProperty
```
    The content associated with the tab.
    
    See Also:
    
    getContent(), setContent(Node)
  - contextMenu
```
public final ObjectProperty<ContextMenu> contextMenuProperty
```
    The context menu associated with the tab.
    
    See Also:
    
    getContextMenu(), setContextMenu(ContextMenu)
  - closable
```
public final BooleanProperty closableProperty
```
    The closable state for this tab.
    
    See Also:
    
    isClosable(), setClosable(boolean)
  - onSelectionChanged
```
public final ObjectProperty<EventHandler<Event>> onSelectionChangedProperty
```
    The event handler that is associated with a selection on the tab.
    
    See Also:
    
    getOnSelectionChanged(), setOnSelectionChanged(EventHandler)
  - onClosed
```
public final ObjectProperty<EventHandler<Event>> onClosedProperty
```
    The event handler that is associated with the tab when the tab is closed.
    
    See Also:
    
    getOnClosed(), setOnClosed(EventHandler)
  - tooltip
```
public final ObjectProperty<Tooltip> tooltipProperty
```
    The tooltip associated with this tab.
    
    See Also:
    
    getTooltip(), setTooltip(Tooltip)
  - disable
```
public final BooleanProperty 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 using TabPane.getSelectionModel().
    
    Default value:
    
    false
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    isDisable(), setDisable(boolean)
  - disabled
```
public final ReadOnlyBooleanProperty disabledProperty
```
    Indicates whether or not this Tab is disabled. A Tab will become disabled if disable is set to true on either itself or if the TabPane is disabled.
    
    Default value:
    
    false
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    isDisabled()
  - onCloseRequest
```
public final ObjectProperty<EventHandler<Event>> onCloseRequestProperty
```
    Called when there is an external request to close this Tab. The installed event handler can prevent tab closing by consuming the received event.
    
    Since:
    
    JavaFX 8.0
    
    See Also:
    
    getOnCloseRequest(), setOnCloseRequest(EventHandler)
- Field Detail
  - SELECTION_CHANGED_EVENT
```
public static final EventType<Event> SELECTION_CHANGED_EVENT
```
    Called when the tab becomes selected or unselected.
  - CLOSED_EVENT
```
public static final EventType<Event> CLOSED_EVENT
```
    Called when a user closes this tab. This is useful for freeing up memory.
  - TAB_CLOSE_REQUEST_EVENT
```
public static final EventType<Event> TAB_CLOSE_REQUEST_EVENT
```
    Called when there is an external request to close this Tab. The installed event handler can prevent tab closing by consuming the received event.
    
    Since:
    
    JavaFX 8.0
- Constructor Detail
  - Tab
```
public Tab()
```
    Creates a tab with no title.
  - Tab
```
public Tab(String text)
```
    Creates a tab with a text title.
    
    Parameters:
    
    text - The title of the tab.
  - Tab
```
public Tab(String text,
           Node content)
```
    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 Detail
  - setId
```
public final void setId(String value)
```
    Sets the id of this tab. This simple string identifier is useful for finding a specific Tab within the TabPane. The default value is null.
  - getId
```
public final String getId()
```
    The id of this tab.
    
    Specified by:
    
    getId in interface Styleable
    
    Returns:
    
    The id of the tab.
  - idProperty
```
public final StringProperty idProperty()
```
    The id of this tab.
  - setStyle
```
public final void setStyle(String value)
```
    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.
  - getStyle
```
public final String getStyle()
```
    The CSS style string associated to this tab.
    
    Specified by:
    
    getStyle in interface Styleable
    
    Returns:
    
    The CSS style string associated to this tab.
  - styleProperty
```
public final StringProperty styleProperty()
```
    The CSS style string associated to this tab.
    
    See Also:
    
    getStyle(), setStyle(String)
  - isSelected
```
public final boolean isSelected()
```
    Represents whether this tab is the currently selected tab, To change the selected Tab use tabPane.getSelectionModel().select()
  - selectedProperty
```
public final ReadOnlyBooleanProperty selectedProperty()
```
    The currently selected tab.
    
    See Also:
    
    isSelected()
  - getTabPane
```
public final TabPane getTabPane()
```
    A reference to the TabPane that contains this tab instance.
  - tabPaneProperty
```
public final ReadOnlyObjectProperty<TabPane> tabPaneProperty()
```
    The TabPane that contains this tab.
    
    See Also:
    
    getTabPane()
  - setText
```
public final void setText(String value)
```
    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
  - getText
```
public final String getText()
```
    The text shown in the tab.
    
    Returns:
    
    The text shown in the tab.
  - textProperty
```
public final StringProperty textProperty()
```
    The text shown in the tab.
    
    See Also:
    
    getText(), setText(String)
  - setGraphic
```
public 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. 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.
  - getGraphic
```
public final Node getGraphic()
```
    The graphic shown in the tab.
    
    Returns:
    
    The graphic shown in the tab.
  - graphicProperty
```
public final ObjectProperty<Node> graphicProperty()
```
    The graphic in the tab.
    
    See Also:
    
    getGraphic(), setGraphic(Node)
  - setContent
```
public final void setContent(Node value)
```
    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.
  - getContent
```
public final Node getContent()
```
    The content associated with the tab.
    
    Returns:
    
    The content associated with the tab.
  - contentProperty
```
public final ObjectProperty<Node> contentProperty()
```
    The content associated with the tab.
    
    See Also:
    
    getContent(), setContent(Node)
  - setContextMenu
```
public final void setContextMenu(ContextMenu value)
```
    Specifies the context menu to show when the user right-clicks on the tab.
  - getContextMenu
```
public final ContextMenu getContextMenu()
```
    The context menu associated with the tab.
    
    Returns:
    
    The context menu associated with the tab.
  - contextMenuProperty
```
public final ObjectProperty<ContextMenu> contextMenuProperty()
```
    The context menu associated with the tab.
    
    See Also:
    
    getContextMenu(), setContextMenu(ContextMenu)
  - setClosable
```
public final void setClosable(boolean value)
```
    Sets true if the tab is closable. If this is set to false, then regardless of the TabClosingPolicy, it will not be possible for the user to close this tab. Therefore, when this property is false, no 'close' button will be shown on the tab. The default is true.
  - isClosable
```
public final boolean isClosable()
```
    Returns true if this tab is closable.
    
    Returns:
    
    true if the tab is closable.
  - closableProperty
```
public final BooleanProperty closableProperty()
```
    The closable state for this tab.
    
    See Also:
    
    isClosable(), setClosable(boolean)
  - setOnSelectionChanged
```
public final void setOnSelectionChanged(EventHandler<Event> value)
```
    Defines a function to be called when a selection changed has occurred on the tab.
  - getOnSelectionChanged
```
public final EventHandler<Event> 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
```
public final ObjectProperty<EventHandler<Event>> onSelectionChangedProperty()
```
    The event handler that is associated with a selection on the tab.
    
    See Also:
    
    getOnSelectionChanged(), setOnSelectionChanged(EventHandler)
  - setOnClosed
```
public final void setOnClosed(EventHandler<Event> value)
```
    Defines a function to be called when the tab is closed.
  - getOnClosed
```
public final EventHandler<Event> 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
```
public final ObjectProperty<EventHandler<Event>> onClosedProperty()
```
    The event handler that is associated with the tab when the tab is closed.
    
    See Also:
    
    getOnClosed(), setOnClosed(EventHandler)
  - setTooltip
```
public final void setTooltip(Tooltip value)
```
    Specifies the tooltip to show when the user hovers over the tab.
  - getTooltip
```
public final Tooltip getTooltip()
```
    The tooltip associated with this tab.
    
    Returns:
    
    The tooltip associated with this tab.
  - tooltipProperty
```
public final ObjectProperty<Tooltip> tooltipProperty()
```
    The tooltip associated with this tab.
    
    See Also:
    
    getTooltip(), setTooltip(Tooltip)
  - 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()
```
    Returns true if this tab is disable.
    
    Since:
    
    JavaFX 2.2
  - disableProperty
```
public final BooleanProperty 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 using TabPane.getSelectionModel().
    
    Default value:
    
    false
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    isDisable(), setDisable(boolean)
  - isDisabled
```
public final boolean isDisabled()
```
    Returns true when the Tab disable is set to true or if the TabPane is disabled.
    
    Since:
    
    JavaFX 2.2
  - disabledProperty
```
public final ReadOnlyBooleanProperty disabledProperty()
```
    Indicates whether or not this Tab is disabled. A Tab will become disabled if disable is set to true on either itself or if the TabPane is disabled.
    
    Default value:
    
    false
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    isDisabled()
  - onCloseRequestProperty
```
public final ObjectProperty<EventHandler<Event>> onCloseRequestProperty()
```
    Called when there is an external request to close this Tab. The installed event handler can prevent tab closing by consuming the received event.
    
    Since:
    
    JavaFX 8.0
    
    See Also:
    
    getOnCloseRequest(), setOnCloseRequest(EventHandler)
  - getOnCloseRequest
```
public EventHandler<Event> getOnCloseRequest()
```
    Gets the value of the property onCloseRequest.
    
    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.
    
    Since:
    
    JavaFX 8.0
  - setOnCloseRequest
```
public void setOnCloseRequest(EventHandler<Event> value)
```
    Sets the value of the property onCloseRequest.
    
    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.
    
    Since:
    
    JavaFX 8.0
  - getProperties
```
public final ObservableMap<Object,Object> 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
```
public void setUserData(Object value)
```
    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 calling getUserData().
    
    Parameters:
    
    value - The value to be stored - this can later be retrieved by calling getUserData().
    
    Since:
    
    JavaFX 2.2
  - getUserData
```
public Object getUserData()
```
    Returns a previously set Object property, or null if no such property has been set using the setUserData(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
```
public ObservableList<String> 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 interface Styleable
    
    See Also:
    
    CSS3 class selectors
  - getTypeSelector
```
public String getTypeSelector()
```
    The type of this Styleable that is to be used in selector matching. This is analogous to an "element" in HTML. (CSS Type Selector).
    
    Specified by:
    
    getTypeSelector in interface Styleable
    
    Returns:
    
    "Tab"
    
    Since:
    
    JavaFX 8.0
  - getStyleableParent
```
public Styleable getStyleableParent()
```
    Return the parent of this Styleable, or null if there is no parent.
    
    Specified by:
    
    getStyleableParent in interface Styleable
    
    Returns:
    
    getTabPane()
    
    Since:
    
    JavaFX 8.0
  - getPseudoClassStates
```
public final ObservableSet<PseudoClass> getPseudoClassStates()
```
    Return the pseudo-class state of this Styleable. CSS assumes this set is read-only.
    
    Specified by:
    
    getPseudoClassStates in interface Styleable
    
    Since:
    
    JavaFX 8.0
  - getCssMetaData
```
public List<CssMetaData<? extends Styleable,?>> getCssMetaData()
```
    The CssMetaData of this Styleable. This may be returned as an unmodifiable list.
    
    Specified by:
    
    getCssMetaData in interface Styleable
    
    Since:
    
    JavaFX 8.0
  - getClassCssMetaData
```
public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
```
    Returns:
    
    The CssMetaData associated with this class, which may include the CssMetaData of its super classes.
    
    Since:
    
    JavaFX 8.0

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Class Tab

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

id

style

selected

tabPane

text

graphic

content

contextMenu

closable

onSelectionChanged

onClosed

tooltip

disable

disabled

onCloseRequest

Field Detail

SELECTION_CHANGED_EVENT

CLOSED_EVENT

TAB_CLOSE_REQUEST_EVENT

Constructor Detail

Tab

Tab

Tab

Method Detail

setId

getId

idProperty

setStyle

getStyle

styleProperty

isSelected

selectedProperty

getTabPane

tabPaneProperty

setText

getText

textProperty

setGraphic

getGraphic

graphicProperty

setContent

getContent

contentProperty

setContextMenu

getContextMenu

contextMenuProperty

setClosable

isClosable

closableProperty

setOnSelectionChanged

getOnSelectionChanged

onSelectionChangedProperty

setOnClosed

getOnClosed

onClosedProperty

setTooltip

getTooltip

tooltipProperty

setDisable

isDisable

disableProperty

isDisabled

disabledProperty

onCloseRequestProperty

getOnCloseRequest

setOnCloseRequest

getProperties

hasProperties

setUserData

getUserData

getStyleClass

getTypeSelector

getStyleableParent