Module org.tentackle.fx
Package org.tentackle.fx

Interface FxController

All Known Implementing Classes:
AbstractFxController, AbstractValidateableFxController, I18NEditor
public interface FxController
The controller interface all Tentackle FX-controllers must implement.
Author:
harald

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure()
    Configures the controller as the final step in initialization.
    FxComponentBinder
    getBinder()
    Gets the binder of this controller.
    FxContainer
    getContainer()
    Gets the top-level container.
    This is usually the view.
    List<Field>
    getFXMLFields()
    Gets all fields in this controller annotated with @FXML.
    The fields are made accessible, if private.
    List<Method>
    getFXMLMethods()
    Gets all methods in this controller annotated with @FXML.
    The methods are made accessible, if private.
    javafx.stage.Stage
    getStage()
    Gets the stage of which the controller's view is the root of the scene.
    javafx.scene.Parent
    getView()
    Gets the view managed by this controller.
    void
    setView(javafx.scene.Parent view)
    Sets the view managed by this controller.
    void
    validateInjections()
    Validate @FXML-annotated fields.
    The fxml-loader does not throw an exception if a fx:id does not correspond to a field annotated with @FXML.

  • Method Details

    • setView

      void setView(javafx.scene.Parent view)
      Sets the view managed by this controller.
      Parameters:
      view - the view

    • getView

      javafx.scene.Parent getView()
      Gets the view managed by this controller.
      Returns:
      the view

    • getStage

      javafx.stage.Stage getStage()
      Gets the stage of which the controller's view is the root of the scene.
      Returns:
      the stage, null if not a root scene

    • getContainer

      FxContainer getContainer()
      Gets the top-level container.
      This is usually the view.
      Returns:
      the container, null if none

    • validateInjections

      void validateInjections()
      Validate @FXML-annotated fields.
      The fxml-loader does not throw an exception if a fx:id does not correspond to a field annotated with @FXML. This method verifies that all such fields provide a non-null value.

    • getBinder

      FxComponentBinder getBinder()
      Gets the binder of this controller.
      Returns:
      the binder, never null.

    • configure

      void configure()
      Configures the controller as the final step in initialization.

    • getFXMLFields

      List<Field> getFXMLFields()
      Gets all fields in this controller annotated with @FXML.
      The fields are made accessible, if private.
      Returns:
      the fields

    • getFXMLMethods

      List<Method> getFXMLMethods()
      Gets all methods in this controller annotated with @FXML.
      The methods are made accessible, if private.
      Returns:
      the methods