org.jrebirth.af.core.resource.fxml

Class FXML

java.lang.Object

org.jrebirth.af.core.resource.AbstractBaseParams

org.jrebirth.af.core.resource.fxml.FXML

All Implemented Interfaces:

FXMLParams, ResourceParams

public class FXML
extends AbstractBaseParams
implements FXMLParams

The interface FXML.

Author:

Sébastien Bordes

Property Summary

Properties

Type	Property and Description
StringProperty	absoluteBundlePath Absolute bundle path property.
StringProperty	absolutePath Absolute path property.
StringProperty	bundleName Bundle name property.
StringProperty	fxmlName Fxml name property.

Field Summary

Fields

Modifier and Type	Field and Description
private StringProperty	absoluteBundlePath The absolute path used to retrieved resource bundle file if different of fxml one.
private StringProperty	absolutePath The absolute path used to retrieved fxml file and resource bundle.
private StringProperty	bundleName The FXML resource bundle name (without .properties extension).
static String	DOT_SEPARATOR The dot separator used by fxml declaration.
static String	FXML_EXT The fxml file extension.
private StringProperty	fxmlName The FXML file name (without .fxml extension).
static String	PATH_SEPARATOR The path separator used by fxml declaration.

Fields inherited from interface org.jrebirth.af.core.resource.ResourceParams

PARAMETER_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
FXML(String name) Default Constructor.
FXML(String globalPath, String globalName) Default Constructor.
FXML(String fxmlPath, String fxmlName, String bundlePath, String bundleName) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	absoluteBundlePath() Gets the absolute path for resource bundle.
StringProperty	absoluteBundlePathProperty() Absolute bundle path property.
String	absolutePath() Gets the absolute path for fxml (and for resource bundle if bundle path is null).
StringProperty	absolutePathProperty() Absolute path property.
String	bundleName() Gets the resource bundle file name (without suffix).
StringProperty	bundleNameProperty() Bundle name property.
String	fxmlName() Gets the FXML file name (and resource bundle file name if bundle name is null).
StringProperty	fxmlNameProperty() Fxml name property.
String	getBundlePath() Return the full path of the resource bundle file without .properties extension.
protected List<? extends Object>	getFieldValues() Return all values of ParameterEntry object.
String	getFxmlPath() Return the full path of the fxml file without .fxml extension.
void	parse(String[] parameters) Parse a string to initialize fields.

Methods inherited from class org.jrebirth.af.core.resource.AbstractBaseParams

activateAutoRefresh, getKey, hasChanged, hasChanged, readBoolean, readDouble, readInteger, setKey, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jrebirth.af.core.resource.ResourceParams

activateAutoRefresh, getKey, hasChanged, hasChanged, setKey

Property Detail

absolutePath

Absolute path property.

Returns:

the string property

fxmlName

Fxml name property.

Returns:

the string property

absoluteBundlePath

Absolute bundle path property.

Returns:

the string property

bundleName

Bundle name property.

Returns:

the string property

Field Detail

PATH_SEPARATOR

public static final String PATH_SEPARATOR

The path separator used by fxml declaration.

See Also:

Constant Field Values

DOT_SEPARATOR

public static final String DOT_SEPARATOR

The dot separator used by fxml declaration.

See Also:

Constant Field Values

FXML_EXT

public static final String FXML_EXT

The fxml file extension.

See Also:

Constant Field Values

absolutePath

private final StringProperty absolutePath

The absolute path used to retrieved fxml file and resource bundle.

absoluteBundlePath

private final StringProperty absoluteBundlePath

The absolute path used to retrieved resource bundle file if different of fxml one.

fxmlName

private final StringProperty fxmlName

The FXML file name (without .fxml extension).

bundleName

private final StringProperty bundleName

The FXML resource bundle name (without .properties extension).

Constructor Detail

FXML

public FXML(String fxmlPath,
    String fxmlName,
    String bundlePath,
    String bundleName)

Default Constructor.

Parameters:

fxmlPath - the fxml file absolute path

fxmlName - the fxml file name

bundlePath - the resource bundle absolute path

bundleName - the resource bundle file name

FXML

public FXML(String globalPath,
    String globalName)

Default Constructor.

Parameters:

globalPath - the path iused to laod fxml and resource bundle files

globalName - the fxml and resource bundle name (without suffix)

FXML

public FXML(String name)

Default Constructor.

Parameters:

name - the fxml and resource bundle file name

Method Detail

absolutePath

public String absolutePath()

Gets the absolute path for fxml (and for resource bundle if bundle path is null).

Specified by:

absolutePath in interface FXMLParams

Returns:

the absolute path

absolutePathProperty

public StringProperty absolutePathProperty()

Absolute path property.

Returns:

the string property

fxmlName

public String fxmlName()

Gets the FXML file name (and resource bundle file name if bundle name is null).

Specified by:

fxmlName in interface FXMLParams

Returns:

the fxml file name

fxmlNameProperty

public StringProperty fxmlNameProperty()

Fxml name property.

Returns:

the string property

absoluteBundlePath

public String absoluteBundlePath()

Gets the absolute path for resource bundle.

Specified by:

absoluteBundlePath in interface FXMLParams

Returns:

the absolute path for resource bundle

absoluteBundlePathProperty

public StringProperty absoluteBundlePathProperty()

Absolute bundle path property.

Returns:

the string property

bundleName

public String bundleName()

Gets the resource bundle file name (without suffix).

Specified by:

bundleName in interface FXMLParams

Returns:

the resource bundle file name

bundleNameProperty

public StringProperty bundleNameProperty()

Bundle name property.

Returns:

the string property

getFxmlPath

public String getFxmlPath()

Return the full path of the fxml file without .fxml extension.

Specified by:

getFxmlPath in interface FXMLParams

Returns:

the full fxml path

getBundlePath

public String getBundlePath()

Return the full path of the resource bundle file without .properties extension.

Specified by:

getBundlePath in interface FXMLParams

Returns:

the full resource bundle path

parse

public void parse(String[] parameters)

Parse a string to initialize fields.

Specified by:

parse in interface ResourceParams

Parameters:

parameters - split from resource properties file

getFieldValues

protected List<? extends Object> getFieldValues()

Return all values of ParameterEntry object.

Specified by:

getFieldValues in class AbstractBaseParams

Returns:

the list of parameters describing the resource to build