JavaFX 24 · javafx.scene.control.Tab · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private BooleanProperty	closable
public static final EventType<Event>	CLOSED_EVENT Called when a user closes this tab.
private ObjectProperty<Node>	content
private ObjectProperty<ContextMenu>	contextMenu
private static final String	DEFAULT_STYLE_CLASS
private BooleanProperty	disable
private ReadOnlyBooleanWrapper	disabled
private final EventHandlerManager	eventHandlerManager
private ObjectProperty<Node>	graphic
private StringProperty	id
private ObjectProperty<EventHandler<Event>>	onClosed
private ObjectProperty<EventHandler<Event>>	onCloseRequest Called when there is an external request to close this `Tab`.
private ObjectProperty<EventHandler<Event>>	onSelectionChanged
private final InvalidationListener	parentDisabledChangedListener
private ObservableMap<Object, Object>	properties
private ReadOnlyBooleanWrapper	selected
public static final EventType<Event>	SELECTION_CHANGED_EVENT Called when the tab becomes selected or unselected.
private StringProperty	style
private final ObservableList<String>	styleClass
public static final EventType<Event>	TAB_CLOSE_REQUEST_EVENT Called when there is an external request to close this `Tab`.
private ReadOnlyObjectWrapper<TabPane>	tabPane
private StringProperty	text
private ObjectProperty<Tooltip>	tooltip
private static final Object	USER_DATA_KEY

Access	Constructor and Description
public	Tab() Creates a tab with no title.
public	Tab(String The title of the tab. text) Creates a tab with a text title.
public	Tab(String The title of the tab. text, Node The content of the tab. content) Creates a tab with a text title and the specified content node.

Method Summary

Modifier and Type	Method and Description
public final <E extends Event> void	addEventFilter(EventType<E> the type of the events received by the filter eventType, EventHandler<? super E> the event filter eventFilter) Overrides default javafx.event.EventTarget.addEventFilter. Registers an event filter for this target.
public final <E extends Event> void	addEventHandler(EventType<E> the type of the events received by the handler eventType, EventHandler<? super E> the event handler eventHandler) Overrides default javafx.event.EventTarget.addEventHandler. Registers an event handler for this target.
public EventDispatchChain	buildEventDispatchChain(EventDispatchChain the initial chain to build from tail) Implements javafx.event.EventTarget.buildEventDispatchChain. Construct an event dispatch chain for this target.
public final BooleanProperty	Returns: the closable property closableProperty() The closable state for this tab.
public final ObjectProperty<Node>	Returns: the content property contentProperty() The content associated with the tab.
public final ObjectProperty<ContextMenu>	Returns: the context menu property contextMenuProperty() The context menu associated with the tab.
public final ReadOnlyBooleanProperty	Returns: the disabled property disabledProperty() Indicates whether or not this `Tab` is disabled.
private ReadOnlyBooleanWrapper	disabledPropertyImpl()
public final BooleanProperty	Returns: the disable property disableProperty() Sets the disabled state of this tab.
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public final Node	Returns: The content associated with the tab. getContent() The content associated with the tab.
public final ContextMenu	Returns: The context menu associated with the tab. getContextMenu() The context menu associated with the tab.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Implements javafx.css.Styleable.getCssMetaData. The CssMetaData of this Styleable.
public final Node	Returns: The graphic shown in the tab. getGraphic() The graphic shown in the tab.
public final String	Returns: The id of the tab. getId() Implements javafx.css.Styleable.getId. The id of this tab.
public final EventHandler<Event>	Returns: The event handler that is associated with the tab when the tab is closed. getOnClosed() The event handler that is associated with the tab when the tab is closed.
public EventHandler<Event>	getOnCloseRequest()
public final EventHandler<Event>	Returns: The event handler that is associated with a tab selection. getOnSelectionChanged() The event handler that is associated with a selection on the tab.
public final ObservableMap<Object, Object>	Returns: an observable map of properties on this Tab for use primarily by application developers getProperties() Returns an observable map of properties on this Tab for use primarily by application developers.
public final ObservableSet<PseudoClass>	getPseudoClassStates() Implements javafx.css.Styleable.getPseudoClassStates. Return the pseudo-class state of this Styleable.
public final String	Returns: The CSS style string associated to this tab. getStyle() Implements javafx.css.Styleable.getStyle. The CSS style string associated to this tab.
public Styleable	Returns: `getTabPane()` getStyleableParent() Implements javafx.css.Styleable.getStyleableParent. Return the parent of this Styleable, or null if there is no parent.
public ObservableList<String>	getStyleClass() Implements javafx.css.Styleable.getStyleClass. A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
public final TabPane	Returns: the TabPane getTabPane() A reference to the TabPane that contains this tab instance.
public final String	Returns: The text shown in the tab. getText() The text shown in the tab.
public final Tooltip	Returns: The tooltip associated with this tab. getTooltip() The tooltip associated with this tab.
public String	Returns: "Tab" getTypeSelector() Implements javafx.css.Styleable.getTypeSelector. The type of this `Styleable` that is to be used in selector matching.
public Object	Returns: The Object that was previously set, or null if no property has been set or if null was set. getUserData() Returns a previously set Object property, or null if no such property has been set using the `Tab#setUserData(java.lang.Object)` method.
public final ObjectProperty<Node>	Returns: The graphic in the tab. graphicProperty() The graphic in the tab.
public boolean	Returns: true if this tab has properties. hasProperties() Tests if this Tab has properties.
public final StringProperty	Returns: the id property of this tab idProperty() The id of this tab.
public final boolean	Returns: `true` if the tab is closable. isClosable() Returns `true` if this tab is closable.
public final boolean	Returns: true if this tab is disable isDisable() Returns `true` if this tab is disable.
public final boolean	Returns: true if the TabPane is disabled isDisabled() Returns true when the `Tab` `disable` is set to `true` or if the `TabPane` is disabled.
public final boolean	Returns: true if selected isSelected() Represents whether this tab is the currently selected tab, To change the selected Tab use `tabPane.getSelectionModel().select()`
pack-priv Node	lookup(String selector)
pack-priv List<Node>	lookupAll(String selector)
public final ObjectProperty<EventHandler<Event>>	Returns: the on closed event handler property onClosedProperty() The event handler that is associated with the tab when the tab is closed.
public final ObjectProperty<EventHandler<Event>>	onCloseRequestProperty()
public final ObjectProperty<EventHandler<Event>>	Returns: the on selection changed event handler property onSelectionChangedProperty() The event handler that is associated with a selection on the tab.
public final <E extends Event> void	removeEventFilter(EventType<E> the event type from which to unregister eventType, EventHandler<? super E> the event filter eventFilter) Overrides default javafx.event.EventTarget.removeEventFilter. Unregisters a previously registered event filter from this target.
public final <E extends Event> void	removeEventHandler(EventType<E> the event type from which to unregister eventType, EventHandler<? super E> the event handler eventHandler) Overrides default javafx.event.EventTarget.removeEventHandler. Unregisters a previously registered event handler from this target.
public final ReadOnlyBooleanProperty	Returns: the selected tab selectedProperty() The currently selected tab.
private ReadOnlyBooleanWrapper	selectedPropertyImpl()
public final void	setClosable(boolean the closable value value) Sets `true` if the tab is closable.
public final void	setContent(Node the content node value) The content to show within the main TabPane area.
public final void	setContextMenu(ContextMenu the context menu value) Specifies the context menu to show when the user right-clicks on the tab.
public final void	setDisable(boolean the state to set this tab value) Sets the disabled state of this tab.
private final void	setDisabled(boolean value)
pack-priv <E extends Event> void	setEventHandler(EventType<E> eventType, EventHandler<E> eventHandler)
public final void	setGraphic(Node the graphic node value) Sets the graphic to show in the tab to allow the user to differentiate between the function of each tab.
public final void	setId(String the id of this tab value) Sets the id of this tab.
public final void	setOnClosed(EventHandler<Event> the on closed event handler value) Defines a function to be called when the tab is closed.
public void	setOnCloseRequest(EventHandler<Event> value)
public final void	setOnSelectionChanged(EventHandler<Event> the on selection changed event handler value) Defines a function to be called when a selection changed has occurred on the tab.
pack-priv final void	setSelected(boolean value)
public final void	setStyle(String the style string value) A string representation of the CSS style associated with this tab.
pack-priv final void	setTabPane(TabPane value)
public final void	setText(String the text string value) Sets the text to show in the tab to allow the user to differentiate between the function of each tab.
public final void	setTooltip(Tooltip the tool tip value value) Specifies the tooltip to show when the user hovers over the tab.
public void	setUserData(Object The value to be stored - this can later be retrieved by calling `Tab#getUserData()`. value) Convenience method for setting a single Object property that can be retrieved at a later date.
public final StringProperty	Returns: the CSS style string property associated to this tab styleProperty() The CSS style string associated to this tab.
public final ReadOnlyObjectProperty<TabPane>	Returns: the TabPane property tabPaneProperty() The TabPane that contains this tab.
private ReadOnlyObjectWrapper<TabPane>	tabPanePropertyImpl()
public final StringProperty	Returns: the text property textProperty() The text shown in the tab.
public final ObjectProperty<Tooltip>	Returns: the tool tip property tooltipProperty() The tooltip associated with this tab.
private void	updateDisabled()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

closable	back to summary
private BooleanProperty closable

CLOSED_EVENT	back to summary
public static final EventType<Event> CLOSED_EVENT Called when a user closes this tab. This is useful for freeing up memory.

content	back to summary
private ObjectProperty<Node> content

contextMenu	back to summary
private ObjectProperty<ContextMenu> contextMenu

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS

disable	back to summary
private BooleanProperty disable

disabled	back to summary
private ReadOnlyBooleanWrapper disabled

eventHandlerManager	back to summary
private final EventHandlerManager eventHandlerManager

graphic	back to summary
private ObjectProperty<Node> graphic

id	back to summary
private StringProperty id

onClosed	back to summary
private ObjectProperty<EventHandler<Event>> onClosed

onCloseRequest	back to summary
private ObjectProperty<EventHandler<Event>> onCloseRequest 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

onSelectionChanged	back to summary
private ObjectProperty<EventHandler<Event>> onSelectionChanged

parentDisabledChangedListener	back to summary
private final InvalidationListener parentDisabledChangedListener

properties	back to summary
private ObservableMap<Object, Object> properties

selected	back to summary
private ReadOnlyBooleanWrapper selected

SELECTION_CHANGED_EVENT	back to summary
public static final EventType<Event> SELECTION_CHANGED_EVENT Called when the tab becomes selected or unselected.

style	back to summary
private StringProperty style

styleClass	back to summary
private final ObservableList<String> styleClass

TAB_CLOSE_REQUEST_EVENT	back to summary
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

tabPane	back to summary
private ReadOnlyObjectWrapper<TabPane> tabPane

text	back to summary
private StringProperty text

tooltip	back to summary
private ObjectProperty<Tooltip> tooltip

USER_DATA_KEY	back to summary
private static final Object USER_DATA_KEY

Tab	back to summary
public Tab() Creates a tab with no title.

Tab	back to summary
public Tab(String text) Creates a tab with a text title. Parameters text:String The title of the tab.

Tab	back to summary
public Tab(String text, Node content) Creates a tab with a text title and the specified content node. Parameters text:String The title of the tab. content:Node The content of the tab. Since JavaFX 8u40

Method Detail

addEventFilter back to summary

addEventFilter	back to summary
public final <E extends Event> void addEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter) Overrides default javafx.event.EventTarget.addEventFilter. Doc from javafx.event.EventTarget.addEventFilter. 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. Parameters <E> the event class of the filter eventType:EventType<E> the type of the events received by the filter eventFilter:EventHandler<? super E> the event filter Annotations @Override

public final <E extends Event> void addEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter)

Overrides default javafx.event.EventTarget.addEventFilter.

Doc from javafx.event.EventTarget.addEventFilter.

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.

Parameters

<E>: the event class of the filter
eventType:EventType<E>: the type of the events received by the filter
eventFilter:EventHandler<? super E>: the event filter

Annotations

@Override

addEventHandler back to summary

addEventHandler	back to summary
public final <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler) Overrides default javafx.event.EventTarget.addEventHandler. Doc from javafx.event.EventTarget.addEventHandler. 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. Parameters <E> the event class of the handler eventType:EventType<E> the type of the events received by the handler eventHandler:EventHandler<? super E> the event handler Annotations @Override

public final <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)

Overrides default javafx.event.EventTarget.addEventHandler.

Doc from javafx.event.EventTarget.addEventHandler.

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.

Parameters

<E>: the event class of the handler
eventType:EventType<E>: the type of the events received by the handler
eventHandler:EventHandler<? super E>: the event handler

Annotations

@Override

buildEventDispatchChain back to summary

buildEventDispatchChain	back to summary
public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail) Implements javafx.event.EventTarget.buildEventDispatchChain. Doc from javafx.event.EventTarget.buildEventDispatchChain. 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 this `EventTarget`. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an `EventDispatcher` 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. Parameters tail:EventDispatchChain the initial chain to build from Returns:EventDispatchChain the resulting event dispatch chain for this target Annotations @Override

public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)

Implements javafx.event.EventTarget.buildEventDispatchChain.

Doc from javafx.event.EventTarget.buildEventDispatchChain.

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 this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher 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.

Parameters

tail:EventDispatchChain: the initial chain to build from

Returns:EventDispatchChain

the resulting event dispatch chain for this target

Annotations

@Override

closableProperty	back to summary
public final BooleanProperty closableProperty() The closable state for this tab. Returns:BooleanProperty the closable property

closableProperty

public Class Tab

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail