Module atlantafx.base

Package atlantafx.base.controls

Class Tab

java.lang.Object

atlantafx.base.controls.Tab

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class Tab
extends Object
implements javafx.event.EventTarget, javafx.css.Styleable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Tab.AdaptiveResizePolicy	Resizes the tabs to a fixed width when there is available space; otherwise, it proportionally shrinks the tab width.
static class	Tab.AllTabsClosingPolicy
static interface	Tab.ClosingPolicy	Describes the closing policies for tabs.
static class	Tab.ComputedWidthResizePolicy	Resizes the tabs to a computed width, requiring the user to scroll horizontally if the total width exceeds the visible width of the tab line.
static enum	Tab.DragPolicy	Describes the drag policies for tabs.
static class	Tab.FixedWidthResizePolicy	Resizes the tabs to a fixed width, requiring the user to scroll horizontally if the total width exceeds the visible width of the tab line.
static class	Tab.NoTabsClosingPolicy
static interface	Tab.ResizePolicy	The Tab.ResizePolicy interface defines the strategy for calculating the width of tabs in the TabLine control.
static class	Tab.SelectedTabClosingPolicy
static class	Tab.StretchingResizePolicy	Resizes the tabs to fill all available space proportionally.

Property Summary

Properties

Type	Property	Description
final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.ContextMenu>	contextMenu	The context menu associated with the tab.
final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node>	graphic	The graphic to show in the tab to allow the user to differentiate between the function of each tab.
final javafx.beans.property.StringProperty	id	The simple string identifier for finding a specific tab.
final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onClosed	The event handler that is associated with the tab when the tab is closed.
final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onCloseRequest	The event handler that is called when there is an external request to close this tab.
final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onSelectionChanged	The event handler that is associated with a selection on the tab.
final javafx.beans.property.BooleanProperty	pinned	The pinned state for this tab.
final javafx.beans.property.ReadOnlyBooleanProperty	selected	The currently selected tab.
final javafx.beans.property.StringProperty	style	The CSS style string associated to this tab.
final javafx.beans.property.ReadOnlyObjectProperty<@Nullable TabLine>	tabLine	The TabLine that contains this tab.
final javafx.beans.property.StringProperty	text	The text to show in the tab to allow the user to differentiate between the function of each tab.
final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.Tooltip>	tooltip	The tooltip associated with this tab.

Field Summary

Fields

Modifier and Type	Field	Description
static final javafx.event.EventType<javafx.event.Event>	CLOSED_EVENT	Called when a user closes this tab.
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.ContextMenu>	contextMenu
protected static final String	DEFAULT_STYLE_CLASS
protected final EventHandlerManager	eventHandlerManager
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node>	graphic
protected @Nullable javafx.beans.property.StringProperty	id
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onClosed
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onCloseRequest
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onSelectionChanged
protected @Nullable javafx.beans.property.BooleanProperty	pinned
protected @Nullable javafx.collections.ObservableMap<Object,Object>	properties
protected @Nullable javafx.beans.property.ReadOnlyBooleanWrapper	selected
static final javafx.event.EventType<javafx.event.Event>	SELECTION_CHANGED_EVENT	Called when the tab becomes selected or unselected.
protected @Nullable javafx.beans.property.StringProperty	style
protected final javafx.collections.ObservableList<String>	styleClass
static final javafx.event.EventType<javafx.event.Event>	TAB_CLOSE_REQUEST_EVENT	Called when there is an external request to close this Tab.
protected @Nullable javafx.beans.property.StringProperty	text
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.Tooltip>	tooltip
protected static final Object	USER_DATA_KEY

Constructor Summary

Constructors

Constructor	Description
Tab()	Creates an empty tab.
Tab(@Nullable String text)	See Tab(String, String, Node).
Tab(@Nullable String id, @Nullable String text)	See Tab(String, String, Node).
Tab(@Nullable String id, @Nullable String text, @Nullable javafx.scene.Node graphic)	Creates a tab.

Method Summary

Modifier and Type	Method	Description
final <E extends javafx.event.Event> void	addEventFilter(javafx.event.EventType<E> eventType, javafx.event.EventHandler<? super E> eventFilter)
final <E extends javafx.event.Event> void	addEventHandler(javafx.event.EventType<E> eventType, javafx.event.EventHandler<? super E> eventHandler)
javafx.event.EventDispatchChain	buildEventDispatchChain(javafx.event.EventDispatchChain chain)
final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.ContextMenu>	contextMenuProperty()	The context menu associated with the tab.
static List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getClassCssMetaData()	Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
@Nullable javafx.scene.control.ContextMenu	getContextMenu()	Gets the value of the contextMenu property.
List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getCssMetaData()
@Nullable javafx.scene.Node	getGraphic()	Gets the value of the graphic property.
@Nullable String	getId()	Gets the value of the id property.
@Nullable javafx.event.EventHandler<javafx.event.Event>	getOnClosed()	Gets the value of the onClosed property.
@Nullable javafx.event.EventHandler<javafx.event.Event>	getOnCloseRequest()	Gets the value of the onCloseRequest property.
@Nullable javafx.event.EventHandler<javafx.event.Event>	getOnSelectionChanged()	Gets the value of the onSelectionChanged property.
final javafx.collections.ObservableMap<Object,Object>	getProperties()	Returns an observable map of properties on this Tab for use primarily by application developers.
final javafx.collections.ObservableSet<javafx.css.PseudoClass>	getPseudoClassStates()
@Nullable String	getStyle()	Gets the value of the style property.
@Nullable javafx.css.Styleable	getStyleableParent()
javafx.collections.ObservableList<String>	getStyleClass()
@Nullable TabLine	getTabLine()	Gets the value of the tabLine property.
@Nullable String	getText()	Gets the value of the text property.
@Nullable javafx.scene.control.Tooltip	getTooltip()	Gets the value of the tooltip property.
String	getTypeSelector()
Object	getUserData()	Returns a previously set Object property, or null if no such property has been set using the setUserData(Object) method.
final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node>	graphicProperty()	The graphic to show in the tab to allow the user to differentiate between the function of each tab.
boolean	hasProperties()	Tests if this Tab has properties.
final javafx.beans.property.StringProperty	idProperty()	The simple string identifier for finding a specific tab.
boolean	isPinned()	Gets the value of the pinned property.
boolean	isSelected()	Gets the value of the selected property.
final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onClosedProperty()	The event handler that is associated with the tab when the tab is closed.
final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onCloseRequestProperty()	The event handler that is called when there is an external request to close this tab.
final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>>	onSelectionChangedProperty()	The event handler that is associated with a selection on the tab.
final javafx.beans.property.BooleanProperty	pinnedProperty()	The pinned state for this tab.
final <E extends javafx.event.Event> void	removeEventFilter(javafx.event.EventType<E> eventType, javafx.event.EventHandler<? super E> eventFilter)
final <E extends javafx.event.Event> void	removeEventHandler(javafx.event.EventType<E> eventType, javafx.event.EventHandler<? super E> eventHandler)
final javafx.beans.property.ReadOnlyBooleanProperty	selectedProperty()	The currently selected tab.
protected javafx.beans.property.ReadOnlyBooleanWrapper	selectedPropertyImpl()
void	setContextMenu(@Nullable javafx.scene.control.ContextMenu value)	Sets the value of the contextMenu property.
protected <E extends javafx.event.Event> void	setEventHandler(javafx.event.EventType<E> eventType, @Nullable javafx.event.EventHandler<E> eventHandler)
void	setGraphic(@Nullable javafx.scene.Node value)	Sets the value of the graphic property.
void	setId(@Nullable String value)	Sets the value of the id property.
void	setOnClosed(@Nullable javafx.event.EventHandler<javafx.event.Event> value)	Sets the value of the onClosed property.
void	setOnCloseRequest(@Nullable javafx.event.EventHandler<javafx.event.Event> value)	Sets the value of the onCloseRequest property.
void	setOnSelectionChanged(@Nullable javafx.event.EventHandler<javafx.event.Event> value)	Sets the value of the onSelectionChanged property.
void	setPinned(boolean value)	Sets the value of the pinned property.
void	setStyle(@Nullable String value)	Sets the value of the style property.
void	setText(@Nullable String value)	Sets the value of the text property.
void	setTooltip(@Nullable javafx.scene.control.Tooltip value)	Sets the value of the tooltip property.
void	setUserData(Object value)	Convenience method for setting a single Object property that can be retrieved at a later date.
final javafx.beans.property.StringProperty	styleProperty()	The CSS style string associated to this tab.
final javafx.beans.property.ReadOnlyObjectProperty<@Nullable TabLine>	tabLineProperty()	The TabLine that contains this tab.
final javafx.beans.property.StringProperty	textProperty()	The text to show in the tab to allow the user to differentiate between the function of each tab.
final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.Tooltip>	tooltipProperty()	The tooltip associated with this tab.
protected void	updateSelected(boolean value)
protected void	updateTabLine(@Nullable TabLine value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Property Details

id

public final javafx.beans.property.StringProperty idProperty

The simple string identifier for finding a specific tab. The default value is null.

See Also:

• getId()
• setId(String)
• idProperty()

style

public final javafx.beans.property.StringProperty styleProperty

The CSS style string associated to this tab.

See Also:

• getStyle()
• setStyle(String)
• styleProperty()

selected

public final javafx.beans.property.ReadOnlyBooleanProperty selectedProperty

The currently selected tab.

See Also:

• isSelected()
• selectedProperty()

text

public final javafx.beans.property.StringProperty textProperty

The text to show in the tab to allow the user to differentiate between the function of each tab. The text is always visible.

See Also:

• getText()
• setText(String)
• textProperty()

graphic

public final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node> graphicProperty

The graphic to show in the tab to allow the user to differentiate between the function of each tab.

See Also:

• getGraphic()
• setGraphic(Node)
• graphicProperty()

contextMenu

public final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.ContextMenu> contextMenuProperty

The context menu associated with the tab.

See Also:

• getContextMenu()
• setContextMenu(ContextMenu)
• contextMenuProperty()

pinned

public final javafx.beans.property.BooleanProperty pinnedProperty

The pinned state for this tab. The default is false.

See Also:

• isPinned()
• setPinned(boolean)
• pinnedProperty()

onSelectionChanged

public final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onSelectionChangedProperty

The event handler that is associated with a selection on the tab.

See Also:

• getOnSelectionChanged()
• setOnSelectionChanged(EventHandler)
• onSelectionChangedProperty()

onClosed

public final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onClosedProperty

The event handler that is associated with the tab when the tab is closed.

See Also:

• getOnClosed()
• setOnClosed(EventHandler)
• onClosedProperty()

tooltip

public final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.Tooltip> tooltipProperty

The tooltip associated with this tab.

See Also:

• getTooltip()
• setTooltip(Tooltip)
• tooltipProperty()

onCloseRequest

public final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onCloseRequestProperty

The event handler that is called when there is an external request to close this tab. The installed event handler can prevent tab closing by consuming the received event.

See Also:

• getOnCloseRequest()
• setOnCloseRequest(EventHandler)
• onCloseRequestProperty()

tabLine

public final javafx.beans.property.ReadOnlyObjectProperty<@Nullable TabLine> tabLineProperty

The TabLine that contains this tab.

See Also:

• getTabLine()
• tabLineProperty()

Field Details

DEFAULT_STYLE_CLASS

protected static final String DEFAULT_STYLE_CLASS

See Also:

• Constant Field Values

SELECTION_CHANGED_EVENT

public static final javafx.event.EventType<javafx.event.Event> SELECTION_CHANGED_EVENT

Called when the tab becomes selected or unselected.

CLOSED_EVENT

public static final javafx.event.EventType<javafx.event.Event> CLOSED_EVENT

Called when a user closes this tab.

TAB_CLOSE_REQUEST_EVENT

public static final javafx.event.EventType<javafx.event.Event> TAB_CLOSE_REQUEST_EVENT

Called when there is an external request to close this Tab. The installed event handler thus can prevent tab closing by consuming the received event.

id

@Nullable
protected @Nullable javafx.beans.property.StringProperty id

style

@Nullable
protected @Nullable javafx.beans.property.StringProperty style

selected

@Nullable
protected @Nullable javafx.beans.property.ReadOnlyBooleanWrapper selected

text

@Nullable
protected @Nullable javafx.beans.property.StringProperty text

graphic

@Nullable
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node> graphic

contextMenu

@Nullable
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.ContextMenu> contextMenu

pinned

@Nullable
protected @Nullable javafx.beans.property.BooleanProperty pinned

onSelectionChanged

@Nullable
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onSelectionChanged

onClosed

@Nullable
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onClosed

tooltip

@Nullable
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.Tooltip> tooltip

onCloseRequest

@Nullable
protected @Nullable javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onCloseRequest

USER_DATA_KEY

protected static final Object USER_DATA_KEY

properties

@Nullable
protected @Nullable javafx.collections.ObservableMap<Object,Object> properties

eventHandlerManager

protected final EventHandlerManager eventHandlerManager

styleClass

protected final javafx.collections.ObservableList<String> styleClass

Constructor Details

Tab

public Tab()

Creates an empty tab.

Tab

public Tab(@Nullable
 @Nullable String text)

See Tab(String, String, Node).

Tab

public Tab(@Nullable
 @Nullable String id,
 @Nullable
 @Nullable String text)

See Tab(String, String, Node).

Tab

public Tab(@Nullable
 @Nullable String id,
 @Nullable
 @Nullable String text,
 @Nullable
 @Nullable javafx.scene.Node graphic)

Creates a tab.

Parameters:

id - the id of the tab

text - the title of the tab

graphic - the graphic for the tab

Method Details

idProperty

public final javafx.beans.property.StringProperty idProperty()

The simple string identifier for finding a specific tab. The default value is null.

Returns:

the id property

See Also:

• getId()
• setId(String)

getId

@Nullable
public @Nullable String getId()

Gets the value of the id property.

Specified by:

getId in interface javafx.css.Styleable

Property description:

The simple string identifier for finding a specific tab. The default value is null.

Returns:

the value of the id property

See Also:

• setId(String)
• idProperty()

setId

public void setId(@Nullable
 @Nullable String value)

Sets the value of the id property.

Property description:

The simple string identifier for finding a specific tab. The default value is null.

Parameters:

value - the value for the id property

See Also:

• getId()
• idProperty()

styleProperty

public final javafx.beans.property.StringProperty styleProperty()

The CSS style string associated to this tab.

Returns:

the style property

See Also:

• getStyle()
• setStyle(String)

getStyle

@Nullable
public @Nullable String getStyle()

Gets the value of the style property.

Specified by:

getStyle in interface javafx.css.Styleable

Property description:

The CSS style string associated to this tab.

Returns:

the value of the style property

See Also:

• setStyle(String)
• styleProperty()

setStyle

public void setStyle(@Nullable
 @Nullable String value)

Sets the value of the style property.

Property description:

The CSS style string associated to this tab.

Parameters:

value - the value for the style property

See Also:

• getStyle()
• styleProperty()

selectedProperty

public final javafx.beans.property.ReadOnlyBooleanProperty selectedProperty()

The currently selected tab.

Returns:

the selected property

See Also:

• isSelected()

selectedPropertyImpl

protected javafx.beans.property.ReadOnlyBooleanWrapper selectedPropertyImpl()

isSelected

public boolean isSelected()

Gets the value of the selected property.

Property description:

The currently selected tab.

Returns:

the value of the selected property

See Also:

• selectedProperty()

updateSelected

protected void updateSelected(boolean value)

textProperty

public final javafx.beans.property.StringProperty textProperty()

The text to show in the tab to allow the user to differentiate between the function of each tab. The text is always visible.

Returns:

the text property

See Also:

• getText()
• setText(String)

getText

@Nullable
public @Nullable String getText()

Gets the value of the text property.

Property description:

The text to show in the tab to allow the user to differentiate between the function of each tab. The text is always visible.

Returns:

the value of the text property

See Also:

• setText(String)
• textProperty()

setText

public void setText(@Nullable
 @Nullable String value)

Sets the value of the text property.

Property description:

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 value for the text property

See Also:

• getText()
• textProperty()

graphicProperty

public final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node> graphicProperty()

The graphic to show in the tab to allow the user to differentiate between the function of each tab.

Returns:

the graphic property

See Also:

• getGraphic()
• setGraphic(Node)

getGraphic

@Nullable
public @Nullable javafx.scene.Node getGraphic()

Gets the value of the graphic property.

Property description:

The graphic to show in the tab to allow the user to differentiate between the function of each tab.

Returns:

the value of the graphic property

See Also:

• setGraphic(Node)
• graphicProperty()

setGraphic

public void setGraphic(@Nullable
 @Nullable javafx.scene.Node value)

Sets the value of the graphic property.

Property description:

The graphic to show in the tab to allow the user to differentiate between the function of each tab.

Parameters:

value - the value for the graphic property

See Also:

• getGraphic()
• graphicProperty()

contextMenuProperty

public final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.ContextMenu> contextMenuProperty()

The context menu associated with the tab.

Returns:

the contextMenu property

See Also:

• getContextMenu()
• setContextMenu(ContextMenu)

getContextMenu

@Nullable
public @Nullable javafx.scene.control.ContextMenu getContextMenu()

Gets the value of the contextMenu property.

Property description:

The context menu associated with the tab.

Returns:

the value of the contextMenu property

See Also:

• setContextMenu(ContextMenu)
• contextMenuProperty()

setContextMenu

public void setContextMenu(@Nullable
 @Nullable javafx.scene.control.ContextMenu value)

Sets the value of the contextMenu property.

Property description:

The context menu associated with the tab.

Parameters:

value - the value for the contextMenu property

See Also:

• getContextMenu()
• contextMenuProperty()

pinnedProperty

public final javafx.beans.property.BooleanProperty pinnedProperty()

The pinned state for this tab. The default is false.

Returns:

the pinned property

See Also:

• isPinned()
• setPinned(boolean)

isPinned

public boolean isPinned()

Gets the value of the pinned property.

Property description:

The pinned state for this tab. The default is false.

Returns:

the value of the pinned property

See Also:

• setPinned(boolean)
• pinnedProperty()

setPinned

public void setPinned(boolean value)

Sets the value of the pinned property.

Property description:

The pinned state for this tab. The default is false.

Parameters:

value - the value for the pinned property

See Also:

• isPinned()
• pinnedProperty()

onSelectionChangedProperty

public final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onSelectionChangedProperty()

The event handler that is associated with a selection on the tab.

Returns:

the onSelectionChanged property

See Also:

• getOnSelectionChanged()
• setOnSelectionChanged(EventHandler)

getOnSelectionChanged

@Nullable
public @Nullable javafx.event.EventHandler<javafx.event.Event> getOnSelectionChanged()

Gets the value of the onSelectionChanged property.

Property description:

The event handler that is associated with a selection on the tab.

Returns:

the value of the onSelectionChanged property

See Also:

• setOnSelectionChanged(EventHandler)
• onSelectionChangedProperty()

setOnSelectionChanged

public void setOnSelectionChanged(@Nullable
 @Nullable javafx.event.EventHandler<javafx.event.Event> value)

Sets the value of the onSelectionChanged property.

Property description:

The event handler that is associated with a selection on the tab.

Parameters:

value - the value for the onSelectionChanged property

See Also:

• getOnSelectionChanged()
• onSelectionChangedProperty()

onClosedProperty

public final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onClosedProperty()

The event handler that is associated with the tab when the tab is closed.

Returns:

the onClosed property

See Also:

• getOnClosed()
• setOnClosed(EventHandler)

getOnClosed

@Nullable
public @Nullable javafx.event.EventHandler<javafx.event.Event> getOnClosed()

Gets the value of the onClosed property.

Property description:

The event handler that is associated with the tab when the tab is closed.

Returns:

the value of the onClosed property

See Also:

• setOnClosed(EventHandler)
• onClosedProperty()

setOnClosed

public void setOnClosed(@Nullable
 @Nullable javafx.event.EventHandler<javafx.event.Event> value)

Sets the value of the onClosed property.

Property description:

The event handler that is associated with the tab when the tab is closed.

Parameters:

value - the value for the onClosed property

See Also:

• getOnClosed()
• onClosedProperty()

tooltipProperty

public final javafx.beans.property.ObjectProperty<@Nullable javafx.scene.control.Tooltip> tooltipProperty()

The tooltip associated with this tab.

Returns:

the tooltip property

See Also:

• getTooltip()
• setTooltip(Tooltip)

getTooltip

@Nullable
public @Nullable javafx.scene.control.Tooltip getTooltip()

Gets the value of the tooltip property.

Property description:

The tooltip associated with this tab.

Returns:

the value of the tooltip property

See Also:

• setTooltip(Tooltip)
• tooltipProperty()

setTooltip

public void setTooltip(@Nullable
 @Nullable javafx.scene.control.Tooltip value)

Sets the value of the tooltip property.

Property description:

The tooltip associated with this tab.

Parameters:

value - the value for the tooltip property

See Also:

• getTooltip()
• tooltipProperty()

onCloseRequestProperty

public final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<javafx.event.Event>> onCloseRequestProperty()

The event handler that is 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 onCloseRequest property

See Also:

• getOnCloseRequest()
• setOnCloseRequest(EventHandler)

getOnCloseRequest

@Nullable
public @Nullable javafx.event.EventHandler<javafx.event.Event> getOnCloseRequest()

Gets the value of the onCloseRequest property.

Property description:

The event handler that is 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

See Also:

• setOnCloseRequest(EventHandler)
• onCloseRequestProperty()

setOnCloseRequest

public void setOnCloseRequest(@Nullable
 @Nullable javafx.event.EventHandler<javafx.event.Event> value)

Sets the value of the onCloseRequest property.

Property description:

The event handler that is 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 the onCloseRequest property

See Also:

• getOnCloseRequest()
• onCloseRequestProperty()

tabLineProperty

public final javafx.beans.property.ReadOnlyObjectProperty<@Nullable TabLine> tabLineProperty()

The TabLine that contains this tab.

Returns:

the tabLine property

See Also:

• getTabLine()

getTabLine

@Nullable
public @Nullable TabLine getTabLine()

Gets the value of the tabLine property.

Property description:

The TabLine that contains this tab.

Returns:

the value of the tabLine property

See Also:

• tabLineProperty()

updateTabLine

protected void updateTabLine(@Nullable
 @Nullable TabLine value)

getProperties

public final javafx.collections.ObservableMap<Object,Object> getProperties()

Returns an observable map of properties on this Tab for use primarily by application developers.

hasProperties

public boolean hasProperties()

Tests if this Tab has properties.

getUserData

public Object getUserData()

Returns a previously set Object property, or null if no such property has been set using the setUserData(Object) method.

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().

buildEventDispatchChain

public javafx.event.EventDispatchChain buildEventDispatchChain(javafx.event.EventDispatchChain chain)

Specified by:

buildEventDispatchChain in interface javafx.event.EventTarget

addEventHandler

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

Specified by:

addEventHandler in interface javafx.event.EventTarget

removeEventHandler

public final <E extends javafx.event.Event> void removeEventHandler(javafx.event.EventType<E> eventType,
 javafx.event.EventHandler<? super E> eventHandler)

Specified by:

removeEventHandler in interface javafx.event.EventTarget

addEventFilter

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

Specified by:

addEventFilter in interface javafx.event.EventTarget

removeEventFilter

public final <E extends javafx.event.Event> void removeEventFilter(javafx.event.EventType<E> eventType,
 javafx.event.EventHandler<? super E> eventFilter)

Specified by:

removeEventFilter in interface javafx.event.EventTarget

setEventHandler

protected <E extends javafx.event.Event> void setEventHandler(javafx.event.EventType<E> eventType,
 @Nullable
 @Nullable javafx.event.EventHandler<E> eventHandler)

getTypeSelector

public String getTypeSelector()

Specified by:

getTypeSelector in interface javafx.css.Styleable

getStyleClass

public javafx.collections.ObservableList<String> getStyleClass()

Specified by:

getStyleClass in interface javafx.css.Styleable

getPseudoClassStates

public final javafx.collections.ObservableSet<javafx.css.PseudoClass> getPseudoClassStates()

Specified by:

getPseudoClassStates in interface javafx.css.Styleable

getCssMetaData

public List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getCssMetaData()

Specified by:

getCssMetaData in interface javafx.css.Styleable

getStyleableParent

@Nullable
public @Nullable javafx.css.Styleable getStyleableParent()

Specified by:

getStyleableParent in interface javafx.css.Styleable

getClassCssMetaData

public static List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getClassCssMetaData()

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.