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

Annotation Interface FxControllerService

@Documented @Retention(RUNTIME) @Target(TYPE) @Service(FxController.class) @Analyze("org.tentackle.buildsupport.FxControllerBundleAnalyzeHandler") public @interface FxControllerService
Annotation for Tentackle FX-controllers.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    FxControllerService.BINDING
    Type of binding.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    FxControllerService.BINDING
    binding
    Returns whether controller should be bound to the model.
    String
    css
    The stylesheet.
    By default, a file <controller-classname>.css is searched for.
    String
    resources
    Gets the resource bundle for annotated controller.
    boolean
    test
    Returns whether controller should be unit tested.
    String
    url
    Gets the fxml-URL for annotated controller.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FXML_NONE
    Disables the fxml-loader if the view is provided by the controller.
    Set url=FxControllerService.FXML_NONE.
    The controller needs one of the following constructors: If resources=FxControllerService.RESOURCES_NONE:
    static final String
    RESOURCES_NONE
    Disables loading of the resource bundle.
    Set resources=FxControllerService.RESOURCES_NONE.

  • Field Details

    • RESOURCES_NONE

      static final String RESOURCES_NONE
      Disables loading of the resource bundle.
      Set resources=FxControllerService.RESOURCES_NONE.
      See Also:

    • FXML_NONE

      static final String FXML_NONE
      Disables the fxml-loader if the view is provided by the controller.
      Set url=FxControllerService.FXML_NONE.
      The controller needs one of the following constructors:
      1. If resources=FxControllerService.RESOURCES_NONE: 
                public <Controllername> () {

        }
      2. otherwise: 
                public <Controllername> (ResourceBundle resources) {

        }
        Notice that resources is never null.
      See Also:

  • Element Details

    • url

      String url
      Gets the fxml-URL for annotated controller.
      Returns:
      the fxml-URL or empty string if <controller-classname>.fxml
      Default:
      ""

    • resources

      String resources
      Gets the resource bundle for annotated controller.
      Returns:
      the bundle url, empty string if <controller-classname>.properties, no resources if RESOURCES_NONE
      Default:
      ""

    • css

      String css
      The stylesheet.
      By default, a file <controller-classname>.css is searched for. Missing is ok.
      Returns:
      the CSS string
      Default:
      ""

    • test

      boolean test
      Returns whether controller should be unit tested.
      Returns:
      true if create and bind for test (default), false if no test
      Default:
      true

    • binding

      FxControllerService.BINDING binding
      Returns whether controller should be bound to the model.
      Returns:
      the binding mode, BINDING.YES is the default
      Default:
      YES