Feature request : internationalization

[ange-diambote]

It is possible to add internationalization in fxml file?

[pfurbacher]

I think the intended way of configuring i18n when using this framework is to provide a custom alternative to net.rgielen.fxweaver.spring.InjectionPointLazyFxControllerAndViewResolver (see the Javadocs for the hint to provide your own resolver).

Take a look at the sample project, springboot-sample -- specifically the class JavafxWeaverSpringbootSampleApplication. Replace InjectionPointLazyFxControllerAndViewResolver with something like the following, where you supply both the FXWeaver and ResourceBundle in the constructor (note that I basically copied from InjectionPointLazyFxControllerAndViewResolver and added the ResourceBundle at appropriate points):

public class LazyFxControllerAndViewResolver {

    private final FxWeaver fxWeaver;
    private final ResourceBundle bundle;
   
    public LazyFxControllerAndViewResolver(FxWeaver fxWeaver, ResourceBundle bundle) {
        this.fxWeaver = fxWeaver;
        this.bundle = bundle;
    }
    
    public <C, V extends Node> FxControllerAndView<C, V> resolve(InjectionPoint injectionPoint) {
        ResolvableType resolvableType = findResolvableType(injectionPoint);
        if (resolvableType == null) {
            throw new IllegalArgumentException("No ResolvableType found");
        }
        try {
            @SuppressWarnings("unchecked")
            Class<C> controllerClass = (Class<C>) resolvableType.getGenerics()[0].resolve();
            Locale.setDefault(Locale.FRENCH);
            return new LazyFxControllerAndView<>(() -> fxWeaver.load(controllerClass, bundle));
        } catch (Exception e) {
            throw new IllegalArgumentException(
                    "Generic controller type not resolvable for injection point " + injectionPoint, e);
        }
    }

    private ResolvableType findResolvableType(InjectionPoint injectionPoint) {
        return Optional.ofNullable(injectionPoint.getMethodParameter())
                .map(ResolvableType::forMethodParameter)
                // TODO: Refactor the following to use .or() when dropping Java 8 support
                .orElse(
                        Optional.ofNullable(injectionPoint.getField())
                                .map(ResolvableType::forField)
                                .orElse(null)
                );
    }
}

In JavafxWeaverSpringbootSampleApplication, add a bean:

    @Bean
    public ResourceBundle bundle() {
        // My default is "ENGLISH". Instead of changing my computer's timezone for testing, 
        // I'm programmatically setting it here. In live code, I imaging one would set
        // Locale locale = Locale.getDefault()
        
        Locale locale = Locale.FRENCH;
        System.out.println("locale: " + locale);
        return ResourceBundle.getBundle("bundle", locale);
    }

and change the ```controllerAndView(...)` method to read

    @Bean
    @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
    public <C, V extends Node> FxControllerAndView<C, V> controllerAndView(FxWeaver fxWeaver,
                                                                           InjectionPoint injectionPoint) {
        
        return new LazyFxControllerAndViewResolver(fxWeaver, bundle()).resolve(injectionPoint);
    }

In PrimaryStageInitializer, add an autowired member variable:

@Autowired ResourceBundle bundle;

and add the bundle as a parameter in

Scene scene = new Scene( fxWeaver.loadView(MainController.class, bundle), 400, 300);

Create the suite of i18n bundle.properties files, and make changes to the text values in the sample project's fxml files to point to the keys in the bundle -- e.g., in MainController.fxml, <Button fx:id="helloButton" text="%say.hello"/>.

That should result in a working example in internationalizing an app using this framework.

[kerner1000]

@pfurbacher Excellent, that worked like a charm, thanks a lot!
It would be nice if InjectionPointLazyFxControllerAndViewResolver's members fxWeaver and findResolvableType would be protected, so we could extend this class. Or maybe even better, add ResourceBundle as another default member.

[kerner1000]

I created a PR for easy implementation of the suggested changes. Maybe we can even make this the default behaviour.
#21