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

Annotation Type FxControllerService

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

    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.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 java.lang.String RESOURCES_NONE
      Disables loading of the resource bundle.
      Set resources=FxControllerService.RESOURCES_NONE.

    • Optional Element Summary

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

    • Field Detail

      • RESOURCES_NONE

        static final java.lang.String RESOURCES_NONE
        Disables loading of the resource bundle.
        Set resources=FxControllerService.RESOURCES_NONE.

      • FXML_NONE

        static final java.lang.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.

    • Element Detail

      • url

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

      • resources

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

      • css

        java.lang.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

      • caching

        FxControllerService.CACHING caching
        Returns whether controller should be cached.
        Returns:
        the caching mode, CACHING.NO is default.
        Default:
        org.tentackle.fx.FxControllerService.CACHING.NO

      • binding

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