universum.studios.android.util

Class Localer

java.lang.Object

universum.studios.android.util.Localer

public class Localer
extends Object

The Localer class provides API allowing to set up custom Locale for an Android application. Which locale should be used can be specified via setLocale(Locale, Resources). The specified locale will be set up as default locale via Locale.setDefault(Locale) and also will be used to update the configuration of the Android application resources so also strings from resources will be properly obtained based on the specified locale.

The best place where to place Localer is within custom Application implementation as shown in the following sample:

 public final class LocalizedApplication extends Application {

      // Localer instance used to update locale of this Android application.
      private final Localer localer = new Localer(Locale.FRENCH);

      @Override
      public void onCreate() {
          super.onCreate();
          this.localer.dispatchApplicationCreated(getResources());
      }

      @Override
      public void onConfigurationChanged(Configuration newConfig) {
          super.onConfigurationChanged(newConfig);
          this.localer.dispatchConfigurationChanged(newConfig, getResources());
      }

      // Changes the current application locale to the specified one.
      public void changeLocale(@NonNull Locale locale) {
          this.localer.setLocale(locale, getResources());
          // Note, that the call above will change default locale and also locale of this Android
          // application resources, unfortunately, if you want to this change be presented also in
          // the currently running UI (activity), such an UI needs to be recreated so a new values
          // from resources based on the new locale can be loaded properly.
      }
 }
 

Since:

1.0

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
Localer() Creates a new instance of Localer to manage custom locale within this Android application with default Locale set to Locale.ENGLISH.
Localer(Locale locale) Creates a new instance of Localer to manage custom locale within this Android application with the given default Locale.

Method Summary

Modifier and Type	Method and Description
void	dispatchApplicationCreated(android.content.res.Resources resources) Called from application's Application.onCreate() to dispatch, that application was just created.
void	dispatchConfigurationChanged(android.content.res.Configuration newConfig, android.content.res.Resources resources) Called from application's Application.onConfigurationChanged(Configuration) to dispatch changed configuration.
Locale	getLocale() Returns the current locale assigned to this Localer.
void	setLocale(Locale locale, android.content.res.Resources resources) Sets the given locale to be used as locale for this Android application, so all stuffs related to locale, like resources will depends on the passed Locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Localer

public Localer()

Creates a new instance of Localer to manage custom locale within this Android application with default Locale set to Locale.ENGLISH.

Localer

public Localer(@NonNull
               Locale locale)

Creates a new instance of Localer to manage custom locale within this Android application with the given default Locale.

Parameters:

locale - The desired locale.

See Also:

setLocale(Locale, Resources)

Method Detail

dispatchApplicationCreated

public void dispatchApplicationCreated(@NonNull
                                       android.content.res.Resources resources)

Called from application's Application.onCreate() to dispatch, that application was just created.

Parameters:

resources - An application resources.

See Also:

dispatchConfigurationChanged(Configuration, Resources)

dispatchConfigurationChanged

public void dispatchConfigurationChanged(@NonNull
                                         android.content.res.Configuration newConfig,
                                         @NonNull
                                         android.content.res.Resources resources)

Called from application's Application.onConfigurationChanged(Configuration) to dispatch changed configuration.

Parameters:

newConfig - An instance of changed configuration.

resources - An application resources.

See Also:

dispatchApplicationCreated(Resources)

setLocale

public void setLocale(@NonNull
                      Locale locale,
                      @NonNull
                      android.content.res.Resources resources)

Sets the given locale to be used as locale for this Android application, so all stuffs related to locale, like resources will depends on the passed Locale.

Note, that this does not reload the currently running UI (activity/-ies) so the locale change will be not visible in the UI until it is re-created so a new values from resources based on the changed locale can be properly loaded again.

Parameters:

locale - An instance of locale to be used as locale for this Android application.

resources - An application resources.

getLocale

@NonNull
public Locale getLocale()

Returns the current locale assigned to this Localer.

Returns:

An instance of Locale or null if there is no locale assigned.