Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8097570

FXML best practices documentation needed

    Details

    • Type: Task
    • Status: Closed
    • Priority: P4
    • Resolution: Duplicate
    • Affects Version/s: 7-pool
    • Fix Version/s: None
    • Component/s: docs
    • Labels:

      Description

      In order to support good, clean adoption of FXML in a healthy way we need to have the FXML best practices clearly outlined in some documentation. This documentation should be released at the same time as the official release of the platform to avoid confusion, increase platform uptake and prevent bad practices from taking hold early. Ideally the docco would be released well before the launch in order to get feedback from FXML beta testers (who are currently discussing most of this on the forums anyway).

      This documentation could build upon the good intro already provided (http://fxexperience.com/2011/07/introducing-fxml/) but should include at least the following:
      * guidelines on loading FXML files: including when to use static and non-static loads, and the URL+resource-loading intricacies
      * guidelines on BuilderFactories, when and how to use them
      * guidelines on controller best practices, how they should access resources and interact with other controllers, etc
      * guidelines on 'model' best practices (if needed - it is unclear how a model fits into the FXML landscape)

      Based on these best practices, a simple, step-through tutorial would also be extremely useful. This would ideally cover a small but realistic scenario (such as a search screen that returns a list of results, where clicking on one of these results shows a detail page on the item). This could either be written by the JFX team or I am sure community would chip (I would) - we however need to know the real best practices intended by the JFX team before we can really do this - otherwise we may be pushing the wrong the cart.

      Cheers,
      zonski

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                dzwolenskjfx Daniel Zwolenski (Inactive)
              • Votes:
                7 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Imported: