de.saxsys.mvvmfx

Annotation Type InjectResourceBundle

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface InjectResourceBundle

This annotation can be used to let mvvmFX inject the specified ResourceBundle into your ViewModel and/or FxmlView/JavaView. The annotation has to be set on a field of type ResourceBundle. For fxml based views there are three options to get the ResourceBundle:

• The mvvmFX mechanism using this annotation.
• The standard mechanism provided by the JavaFX runtime using naming conventions.
• Using the Interface Initializable provided by the JavaFX runtime.

The mvvmFX mechanism is independent from the standard JavaFX mechanism and can be used at the same time (even if this isn't really useful). The difference is that the mvvmFX mechanism can be more explicit and more checks are done:

• If there is a field annotated with this annotation but the type of the field isn't fitting ResourceBundle an IllegalStateException will be thrown.
• If there is a View/ViewModel that has a field with this annotation but no ResourceBundle is provided when the view is loaded, an IllegalStateException will be thrown.
• If the View/ViewModel has a field with this annotation and the attribute optional() is set to true (default value is false) and no ResourceBundle is provided when the view is loaded, no exception will be thrown and no ResourceBundle will be injected. You have to check for null in this case.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	optional Default value: false.

Element Detail

optional

public abstract boolean optional

Default value: false. You can use this attribute to express that the resourceBundle injection is optional. If this attribute is set to true and there is a ResourceBundle available it will be injected as normal. If this attribute is set to true but no ResourceBundle is available, nothing will be injection and no IllegalStateException will be thrown to warn you.

Default:

false