ilog.views.util

Class IlvLocaleUtil

java.lang.Object

ilog.views.util.IlvLocaleUtil

public class IlvLocaleUtil
extends Object

This class defines a concept of "current locale" for use by all of JViews. While Locale.getDefault() returns a locale that is a good general default, the "current locale" provided by this class depends on the type of GUI and on the request being executed (in a web server situation).

This class also defines a concept of "server locale" for use by those places in JViews where output is known to be presented to the administrator of a web server and definitely not to a user who sees the JViews components or an applet user.

Additionally, this class keeps track of an association between an ICU locale and a java.util locale. When a java.util locale that corresponds to an ICU locale is passed to JViews API, the corresponding ICU locale will be used instead, together with the ICU variants of the globalization API. This holds for specific portions of JViews only.

Since:

JViews 8.7

Field Summary

Fields

Modifier and Type	Field and Description
static String	ULOCALE_PROPERTY Property indicating the ULocale of a JComponent.

Method Summary

Modifier and Type	Method and Description
static com.ibm.icu.util.ULocale	getComponentULocale(Component comp) Returns the ULocale that is in effect for a given AWT or Swing component.
static Locale	getCurrentLocale() Returns the current locale.
static com.ibm.icu.util.ULocale	getCurrentULocale() Returns the current locale as an ICU ULocale.
static Locale	getServerLocale() Returns the server locale.
static com.ibm.icu.util.ULocale	getServerULocale() Returns the server locale.
static Locale	getThreadLocale() Deprecated. Since JViews 8.8, please use getThreadULocale() instead.
static com.ibm.icu.util.ULocale	getThreadULocale() Returns the ICU ULocale that is currently assigned to the current thread, or null for none.
static void	initJComponentULocale(JComponent comp) Initializes the ULocale of a Swing component, in a way that is consistent with the initialization of the Locale of the same component during the JComponent constructor.
static void	setThreadLocale(Locale locale) Deprecated. Since JViews 8.8, please use setThreadULocale(ULocale) instead.
static void	setThreadULocale(com.ibm.icu.util.ULocale locale) Assigns the given ICU ULocale to the current thread.

Methods inherited from class java.lang.Object

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

Field Detail

ULOCALE_PROPERTY

public static final String ULOCALE_PROPERTY

Property indicating the ULocale of a JComponent. It is used in PropertyChangeEvents that are sent to PropertyChangeListeners.

To set an ULocale on a JComponent, while keeping the Locale in sync with the ULocale, your implementation of setULocale to call

 putClientProperty(ULOCALE_PROPERTY, locale);
 setLocale(locale != null ? locale.toLocale() : null);
 

Since:

JViews 8.8

See Also:

Constant Field Values

Method Detail

getCurrentLocale

public static Locale getCurrentLocale()

Returns the current locale. It can be used as default for initializing the locale of JComponents and of ResourceBundles upon creation.

The current locale is determined as follows:

1. If a locale has been set for the current thread using setThreadLocale(Locale) or setThreadULocale(ULocale), it is returned.
2. In a JSF context or servlet context, this returns the locale of the request being executed.
3. In an applet context, this returns the locale of the application context.
4. Otherwise, it returns the global default locale.

If, in a web application, you want to use a Locale that is different from the one computed from the Accept-Language information sent by the browser — for example, a locale specified by corporate policies, the user's explicit selection for the current session, the user's selection from the previous session, or the user's registration profile —, you need to specify it through setThreadULocale(ULocale) for the duration of the current request. If the locale is changing within a session, you may also have to call the setLocale or setULocale method on the relevant JViews components.

Note: The result of this method depends on the current thread (in JSF context, in servlet context, and in applet context).

See Also:

getCurrentULocale(), getThreadLocale()

getCurrentULocale

public static com.ibm.icu.util.ULocale getCurrentULocale()

Returns the current locale as an ICU ULocale. It can be used as default for initializing the locale of ResourceBundles and Formats.

The current locale is determined as follows:

1. If a locale has been set for the current thread using setThreadLocale(Locale) or setThreadULocale(ULocale), it is returned.
2. In a JSF context or servlet context, this returns the locale of the request being executed.
3. In an applet context, this returns the locale of the application context.
4. Otherwise, it returns the global default locale, customized according to some system properties. The global default locale initially depends on the system properties user.language, user.country , and user.variant. Here the following additional optional system properties are taken into account:

   user.script

   A 4-letter ISO 15924 script code.

   user.calendar

   See http://userguide.icu- project.org/locale.

   user.collation

   See http://userguide.icu- project.org/locale.

   user.currency

   See http://userguide.icu- project.org/locale.

   user.numbers

   A 4-letter ISO 15924 script code, or one of the numbering system identifiers listed in Unicode UTS #35.

If, in a web application, you want to use a ULocale that is different from the one computed from the Accept-Language information sent by the browser — for example, a locale specified by corporate policies, the user's explicit selection for the current session, the user's selection from the previous session, or the user's registration profile —, you need to specify it through setThreadULocale(ULocale) for the duration of the current request. If the locale is changing within a session, you may also have to call the setULocale method on the relevant JViews components.

Note: The result of this method depends on the current thread (in JSF context, in servlet context, and in applet context).

Since:

JViews 8.8

See Also:

getCurrentLocale(), getThreadULocale()

getThreadLocale

@Deprecated
public static Locale getThreadLocale()

Deprecated. Since JViews 8.8, please use getThreadULocale() instead.

Returns the Locale that is currently assigned to the current thread, or null for none.

See Also:

setThreadLocale(Locale)

getThreadULocale

public static com.ibm.icu.util.ULocale getThreadULocale()

Returns the ICU ULocale that is currently assigned to the current thread, or null for none.

Since:

JViews 8.8

See Also:

setThreadULocale(ULocale)

setThreadLocale

@Deprecated
public static void setThreadLocale(Locale locale)

Deprecated. Since JViews 8.8, please use setThreadULocale(ULocale) instead.

Assigns the given Locale to the current thread. When the locale argument is null, the association between the current thread and a Locale is removed.

This assigned locale acts as an override for the result obtained by getCurrentLocale().

The intended use of this method is to temporarily override the notion of "current locale":

   Locale locale = ...;
   IlvLocaleUtil.setThreadLocale(locale);
   try {
     ...
   } finally {
     IlvLocaleUtil.setThreadLocale(null);
   }
 

Parameters:

locale - Locale to be assigned to the current thread.

See Also:

getThreadLocale()

setThreadULocale

public static void setThreadULocale(com.ibm.icu.util.ULocale locale)

Assigns the given ICU ULocale to the current thread. When the locale argument is null, the association between the current thread and a ULocale is removed.

This assigned locale acts as an override for the result obtained by getCurrentULocale().

The intended use of this method is to temporarily override the notion of "current locale":

   ULocale locale = ...;
   IlvLocaleUtil.setThreadULocale(locale);
   try {
     ...
   } finally {
     IlvLocaleUtil.setThreadULocale(null);
   }
 

Parameters:

locale - Locale to be assigned to the current thread.

Since:

JViews 8.8

See Also:

getThreadULocale()

getServerLocale

public static Locale getServerLocale()

Returns the server locale. It can be used as default for producing output that is known to be presented to the administrator of a web server and definitely not to a user who sees the JViews components or an applet user.

The server locale is currently determined through ULocale.getDefault() and the following additional optional system properties:

user.script

A 4-letter ISO 15924 script code.

user.calendar

See http://userguide.icu- project.org/locale.

user.collation

See http://userguide.icu- project.org/locale.

user.currency

See http://userguide.icu- project.org/locale.

user.numbers

A 4-letter ISO 15924 script code, or one of the numbering system identifiers listed in Unicode UTS #35.

Returns:

The locale for the server administrator.

See Also:

Locale.getDefault()

getServerULocale

public static com.ibm.icu.util.ULocale getServerULocale()

Returns the server locale. It can be used as default for producing output that is known to be presented to the administrator of a web server and definitely not to a user who sees the JViews components or an applet user.

The server locale is currently determined through ULocale.getDefault() and the following additional optional system properties:

user.script

A 4-letter ISO 15924 script code.

user.calendar

See http://userguide.icu- project.org/locale.

user.collation

See http://userguide.icu- project.org/locale.

user.currency

See http://userguide.icu- project.org/locale.

user.numbers

A 4-letter ISO 15924 script code, or one of the numbering system identifiers listed in Unicode UTS #35.

Returns:

The locale for the server administrator.

Since:

JViews 8.8

See Also:

ULocale.getDefault()

getComponentULocale

public static com.ibm.icu.util.ULocale getComponentULocale(Component comp)

Returns the ULocale that is in effect for a given AWT or Swing component.

This method considers inheritance from the parent component, like Component.getLocale() does.

Parameters:

comp - An AWT or Swing component

Returns:

An ICU ULocale.

Throws:

IllegalStateException - if this component does not have a locale set (note that Swing components all have a Locale set during the constructor) and none of the ancestors has a Locale set either

Since:

JViews 8.8

See Also:

initJComponentULocale(JComponent)

initJComponentULocale

public static void initJComponentULocale(JComponent comp)

Initializes the ULocale of a Swing component, in a way that is consistent with the initialization of the Locale of the same component during the JComponent constructor.

This method should be invoked during the constructor of every Swing component that shall be passed as argument to the getComponentULocale(Component) method and that does not have a setULocale(ULocale) method.

For components that have a setULocale method, you should call setULocale(IlvLocaleUtil.getCurrentULocale()); during the constructor.

Parameters:

comp - A Swing component.

Since:

JViews 8.8