Interface LocaleChangeListener


public interface LocaleChangeListener
The LocaleChangeListener interface defines a contract for classes that need to respond to locale changes. Implementing classes can register themselves with a LocaleManager to be notified when the application's locale changes.

Usage:

  1. Implement this interface in the class where locale updates are required.
  2. Register the class as a listener using localeManager.addLocaleChangeListener(this);.
  3. Override the onLocaleChange() method to handle locale updates.
  4. Ensure proper cleanup by removing the listener in the dispose() method using localeManager.removeLocaleChangeListener(this);.
  5. Call localeManager.reloadLocaleInProgram("newLocale"); to trigger the locale change.

Example:

public class MyComponent implements LocaleChangeListener {
    private LocaleManager localeManager;

    public MyComponent(LocaleManager localeManager) {
        this.localeManager = localeManager;
        this.localeManager.addLocaleChangeListener(this);
    }

    @Override
    public void onLocaleChange() {
        // Update UI or perform actions based on the new locale
        System.out.println("Locale has changed!");
    }

    @Override
    public void dispose() {
        if (localeManager != null) {
            localeManager.removeLocaleChangeListener(this);
        }
        super.dispose();
    }
}
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Called when the listener is no longer needed.
    void
    Called when the locale changes.
  • Method Details

    • onLocaleChange

      void onLocaleChange()
      Called when the locale changes. Implementing classes should override this method to perform actions based on the new locale.

      See: LocaleChangeListener for usage example.

    • dispose

      void dispose()
      Called when the listener is no longer needed. Implementing classes should override this method to perform cleanup actions.

      See: LocaleChangeListener for usage example.