Module org.tquadrat.foundation.fx

Package org.tquadrat.foundation.fx.internal

Class FXUserDataBean<A extends Application>

java.lang.Object

org.tquadrat.foundation.fx.internal.FXUserDataBean<A>

Type Parameters:

A - The class of the JavaFX application.

Direct Known Subclasses:

SceneUserData

@ClassVersion(sourceVersion="$Id: FXUserDataBean.java 1110 2024-03-04 15:26:06Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public abstract sealed class FXUserDataBean<A extends Application>
extends Object
permits SceneUserData<A>

The abstract base class for user data beans that can be used with several JavaFX entities.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: FXUserDataBean.java 1110 2024-03-04 15:26:06Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.fx.internal.FXUserDataBean"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final A	m_Application	A reference to the application's main class.
private Optional<URL>	m_ApplicationCSS	The URL for the application's main CSS file.
private final Stage	m_PrimaryStage	A reference to the application's primary stage.
private final Map<String,Object>	m_Properties	The additional properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FXUserDataBean(A application, Stage primaryStage)	Creates a new FXUserDataBean instance.

Method Summary

Modifier and Type	Method	Description
final A	getApplication()	Returns the reference to the application's main class.
final Optional<URL>	getApplicationCSS()	Returns the URL for tha application's main CSS file.
final Stage	getPrimaryStage()	Returns the reference to the application's primary stage.
final Optional<Object>	getProperty(String name)	Returns the property with the given name.
final boolean	hasProperty(String name)	Checks whether a property with the given name exists.
final void	removeProperty(String name)	Removes the property with the given name; nothing happens if there is no property with the given name.
final void	setApplicationCSS(URL cssURL)	Sets the URL for the application's CSS file.
final void	setProperty(String name, Object value)	Sets the property with the given name to the given value.

Methods inherited from class java.lang.Object

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

Field Details

m_Application

private final A extends Application m_Application

A reference to the application's main class.

m_ApplicationCSS

private Optional<URL> m_ApplicationCSS

The URL for the application's main CSS file.

m_PrimaryStage

private final Stage m_PrimaryStage

A reference to the application's primary stage.

m_Properties

private final Map<String,Object> m_Properties

The additional properties.

Constructor Details

FXUserDataBean

protected FXUserDataBean(A application,
 Stage primaryStage)

Creates a new FXUserDataBean instance.

Parameters:

application - The reference for the application's main class.

primaryStage - The reference for the application's primary stage.

Method Details

getApplication

public final A getApplication()

Returns the reference to the application's main class.

Returns:

The application class.

getApplicationCSS

public final Optional<URL> getApplicationCSS()

Returns the URL for tha application's main CSS file.

Returns:

An instance of Optional that holds the CSS URL.

getPrimaryStage

public final Stage getPrimaryStage()

Returns the reference to the application's primary stage.

Returns:

The primary stage

getProperty

public final Optional<Object> getProperty(String name)

Returns the property with the given name.

Parameters:

name - The name of the property.

Returns:

An instance of Optional that holds the property.

hasProperty

public final boolean hasProperty(String name)

Checks whether a property with the given name exists.

Parameters:

name - The name of the property.

Returns:

true if there is a property with the given name (that can still be null), false otherwise.

removeProperty

public final void removeProperty(String name)

Removes the property with the given name; nothing happens if there is no property with the given name.

Parameters:

name - The name of the property.

setApplicationCSS

public final void setApplicationCSS(URL cssURL)

Sets the URL for the application's CSS file.

Parameters:

cssURL - The URL for the CSS file.

setProperty

public final void setProperty(String name,
 Object value)

Sets the property with the given name to the given value.

Parameters:

name - The name of the property.

value - The new value of the property; this can be null.