Is @FXML needed for every declaration?

by

The @FXML annotation enables an FXMLLoader to inject values defined in an FXML file into references in the controller class. In other words, if you annotate your timerLabel with @FXML, then it will be initialized by the FXMLLoader when the load() method is called by an element in the FXML file with fx:id="timerLabel". As others have pointed out in the comments, this means you should never write code like

@FXML
private Label timerLabel = new Label();

Here timerLabel will first be initialized to the new Label(); you create in the code, and will then almost immediately be re-initialized to the value defined in the FXML file. This is at best redundant, and at worst misleading. If you don’t correctly match the variable names to the fx:id, your variable will be referring to the wrong Label and the error will be very difficult to track down.

To get to your actual question:

When the FXMLLoader loads the FXML file, it will attempt to inject any elements that have an fx:id attribute into the controller. It will look for

  1. Any public field with a variable name matching the fx:id attribute, or
  2. Any field (public or not) with a variable name matching the fx:id attribute that is annotated with @FXML.

So in your example, since all your fields are public, you can omit all the @FXML annotations (even the first) and it will still work.

However, if you follow good practice and make your fields private, then each declaration must be annotated @FXML for the injection to work.

So 

@FXML
private Label timerLabel;
@FXML
private TextField mainTextField;

etc will work, but

@FXML
private Label timerLabel;
private TextField mainTextField;

will not.

More Related Contents:

  1. Passing Parameters JavaFX FXML
  2. Javafx – Can application class be the controller class
  3. Loading new fxml in the same scene
  4. JavaFx, Problems with @FXML
  5. One controller to 2 fxmls (JavaFX)
  6. Customize ListView in JavaFX with FXML
  7. FXMLLoader getController returns NULL?
  8. JavaFX periodic background task
  9. Javafx tableview not showing data in all columns
  10. How to write a KeyListener for JavaFX
  11. JavaFX 2.1 TableView refresh items
  12. JavaFX How to set scene background image
  13. How to understand and use “ , in JavaFX?
  14. Why should I avoid using PropertyValueFactory in JavaFX?
  15. How do I remove the default border glow of a JavaFX button (when selected)?
  16. how to set up two timelines to one app?
  17. JavaFX 8 – Zooming Relative to Mouse Pointer
  18. Where does javafx.scene.image.Image(“flower.png”) look for flower.png?
  19. JavaFX 2 TableView : different cell factory depending on the data inside the cell
  20. JavaFX Nested Controllers (FXML )
  21. JavaFX table- how to add components?
  22. How do I access a UI element from another controller class in JavaFX?
  23. Copiable Label/TextField/LabeledText in JavaFX
  24. Colouring table row in JavaFX
  25. JavaFX8 fxml naming of nested controllers
  26. Can not work with MediaPlayer class, javafx.media is not found
  27. running JavaFX application after jpackage
  28. Cant create new FXML File in Eclipse
  29. How do you use a JavaFX TableView with java records?
  30. Error invoking method, failed to launch jvm

Leave a Comment