com.cathive.fx.guice

Annotation Type FXMLComponent

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface FXMLComponent

This class can be used to annotate FXML-based components.

Since:

2.0.0

Author:

Benjamin P. Jung

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	charset Character set that has to be used, when parsing the FXML input given.
String	location A string definition of the URL to be used for loading the FXML file.
String	resources Location of the ResourceBundle to be used when loading the FXML document that represents this component.

Element Detail

location

public abstract String location

A string definition of the URL to be used for loading the FXML file.

The location can either be a location absolute or relative within the classpath (e.g. "/com/example/MyComponent.fxml" or "MyComponent.fxml") or a complete URL (e.g. "http://www.example.com/MyComponent.fxml")

Returns:

A String that represents the location of the FXML file that shall be loaded.

See Also:

FXMLLoader.setLocation(java.net.URL)

Default:

""

resources

public abstract String resources

Location of the ResourceBundle to be used when loading the FXML document that represents this component.

Default: none

Returns:

Location of the resource bundle

See Also:

FXMLLoader.setResources(java.util.ResourceBundle)

Default:

""

charset

public abstract String charset

Character set that has to be used, when parsing the FXML input given.

Default: UTF-8

Returns:

The charset of the FXML file

See Also:

FXMLLoader.setCharset(java.nio.charset.Charset)

Default:

"UTF-8"