LocaleTools.LocaleHelper (ATG Java API)

java.lang.Object
- atg.core.i18n.LocaleTools.LocaleHelper

All Implemented Interfaces:

java.lang.Comparable<LocaleTools.LocaleHelper>

Enclosing class:

LocaleTools
```
public class LocaleTools.LocaleHelper
extends java.lang.Object
implements java.lang.Comparable<LocaleTools.LocaleHelper>
```
UI helper class implementing utility methods on the locale object.

Constructor Summary

Constructors
Constructor and Description

LocaleTools.LocaleHelper(java.util.Locale pLocale)

Constructors
Constructor and Description
`LocaleTools.LocaleHelper(java.util.Locale pLocale)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(LocaleTools.LocaleHelper pOther)` Compares this LocaleHelper object against another LocaleHelper object.
`java.lang.String`	`formatDouble(java.lang.Double pDouble)` Formats a double in a locale-sensitive manner.
`java.lang.String`	`formatFloat(java.lang.Float pFloat)` Formats a float in a locale-sensitive manner.
`java.text.Collator`	`getCollator()`
`java.text.DateFormatSymbols`	`getDateFormatSymbols()` Returns the dateFormatSymbols object for current locale.
`java.lang.String`	`getDatePattern()` Returns the date pattern for this locale and the current date pattern style setting.
`java.util.HashMap<java.lang.String,java.lang.String>`	`getDatePatterns()` Returns a mapping of date pattern styles to the date pattern for the current locale.
`java.lang.String`	`getDateTimePattern()` Returns the dateTime pattern for this locale and the current dateTime pattern style setting.
`java.util.HashMap<java.lang.String,java.lang.String>`	`getDateTimePatterns()` Returns a mapping of dateTime pattern styles to the dateTime pattern for the current locale.
`java.util.List`	`getDateTokens()` Returns a list containing tokens representing a minimal date pattern for this locale and the current date pattern style setting.
`java.lang.String`	`getDefaultDatePattern()`
`java.lang.String`	`getDefaultDateTimePattern()`
`java.lang.String`	`getDefaultTimePattern()`
`java.lang.String`	`getDisplayCountry()` Returns a country for the locale localized according to the servlet request locale that is appropriate for display to the user.
`java.lang.String`	`getDisplayLanguage()` Returns a language for the locale localized according to the servlet request locale that is appropriate for display to the user.
`java.lang.String`	`getDisplayName()` Returns a name for the locale localized according to the request locale that is appropriate for display to the user.
`java.lang.String`	`getDisplayVariant()` Returns a variant for the locale localized according to the servlet request locale that is appropriate for display to the user.
`java.lang.String`	`getFullDatePattern()`
`java.lang.String`	`getFullDateTimePattern()`
`java.lang.String`	`getFullTimePattern()`
`java.util.Locale`	`getLocale()` Returns the wrapped locale object.
`java.lang.String`	`getLongDatePattern()`
`java.lang.String`	`getLongDateTimePattern()`
`java.lang.String`	`getLongTimePattern()`
`java.lang.String`	`getMediumDatePattern()`
`java.lang.String`	`getMediumDateTimePattern()`
`java.lang.String`	`getMediumTimePattern()`
`java.lang.String`	`getShortDatePattern()`
`java.lang.String`	`getShortDateTimePattern()`
`java.lang.String`	`getShortTimePattern()`
`java.lang.String`	`getShortWith4DigitYearDatePattern()`
`java.lang.String`	`getShortWith4DigitYearTimePattern()`
`java.lang.String`	`getShortWith4DigitYeatDateTimePattern()`
`java.lang.String`	`getTimePattern()` Returns the time pattern for this locale and the current time pattern style setting.
`java.util.HashMap<java.lang.String,java.lang.String>`	`getTimePatterns()` Returns a mapping of time pattern styles to the time pattern for the current locale.
`java.lang.Number`	`parseEntireNumber(java.lang.String pNumberString)` Parses a string to produce a number.
`java.lang.Number`	`parseNumber(java.lang.String pNumberString)` Parses a string to produce a number.
`void`	`setLocale(java.util.Locale pLocale)` Sets the wrapped locale object.
`void`	`sort(java.util.List<java.lang.String> pList)` Makes linguistic sorting for list of Strings.
`java.lang.String`	`toString()` Returns the locale string representation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LocaleTools.LocaleHelper
```
public LocaleTools.LocaleHelper(java.util.Locale pLocale)
```
- Method Detail
  - setLocale
```
public void setLocale(java.util.Locale pLocale)
```
    Sets the wrapped locale object.
    
    Parameters:
    pLocale - The wrapped locale object.
  - getLocale
```
public java.util.Locale getLocale()
```
    Returns the wrapped locale object.
    
    Returns:
    The wrapped locale object.
  - getCollator
```
public java.text.Collator getCollator()
```
    Returns:
    locale specific collator.
  - sort
```
public void sort(java.util.List<java.lang.String> pList)
```
    Makes linguistic sorting for list of Strings.
    
    Parameters:
    pList - list of String to sort.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Returns a name for the locale localized according to the request locale that is appropriate for display to the user.
    
    Returns:
    Locale name for display.
    See Also:
    Locale.getDisplayName()
  - getDisplayCountry
```
public java.lang.String getDisplayCountry()
```
    Returns a country for the locale localized according to the servlet request locale that is appropriate for display to the user.
    
    Returns:
    Locale country name for display.
    See Also:
    Locale.getDisplayCountry()
  - getDisplayLanguage
```
public java.lang.String getDisplayLanguage()
```
    Returns a language for the locale localized according to the servlet request locale that is appropriate for display to the user.
    
    Returns:
    Locale language name for display.
    See Also:
    Locale.getDisplayLanguage()
  - getDisplayVariant
```
public java.lang.String getDisplayVariant()
```
    Returns a variant for the locale localized according to the servlet request locale that is appropriate for display to the user.
    
    Returns:
    Locale variant name for display.
    See Also:
    Locale.getDisplayVariant()
  - formatDouble
```
public java.lang.String formatDouble(java.lang.Double pDouble)
```
    Formats a double in a locale-sensitive manner.
    
    Parameters:
    pDouble - java.lang.Double
    
    Returns:
    String
  - formatFloat
```
public java.lang.String formatFloat(java.lang.Float pFloat)
```
    Formats a float in a locale-sensitive manner.
    
    Parameters:
    pFloat - java.lang.Float
    
    Returns:
    String
  - parseNumber
```
public java.lang.Number parseNumber(java.lang.String pNumberString)
                             throws java.text.ParseException
```
    Parses a string to produce a number. The method may not use the entire text of the given string.
    
    Parameters:
    pNumberString - String
    
    Returns:
    Number
    
    Throws:
    
    java.text.ParseException
  - parseEntireNumber
```
public java.lang.Number parseEntireNumber(java.lang.String pNumberString)
                                   throws java.text.ParseException
```
    Parses a string to produce a number. If the method dosn't use the entire text of the given string, ParseException will be thrown.
    
    Parameters:
    pNumberString - String
    
    Returns:
    Number
    
    Throws:
    
    java.text.ParseException
  - getDatePattern
```
public java.lang.String getDatePattern()
```
    Returns the date pattern for this locale and the current date pattern style setting. This can be used from within a jsp for example as follows:
```
 
 <dsp:importbean bean="/atg/core/i18n/LocaleTools"/>
 <dsp:setvalue bean="LocaleTools.dateStyle" value="short"/>
 <fmt:formatDate value="${date}" pattern="${LocaleTools.userPreferredLocale.datePattern}"/>
 
 
```
    Returns:
    The date format for this locale and the current date pattern style setting.
    See Also:
    LocaleTools#setDateStyle()
  - getDatePatterns
```
public java.util.HashMap<java.lang.String,java.lang.String> getDatePatterns()
```
    Returns a mapping of date pattern styles to the date pattern for the current locale. This can be used from within a jsp for example as follows:
```
 
 <dsp:importbean bean="/atg/core/i18n/LocaleTools"/>
 <dsp:getvalueof var="userPreferredLocale" bean="LocaleTools.userPreferredLocale"/>
 <fmt:formatDate value="${date}" pattern="${userPreferredLocale.datePatterns.full}"/>
 
 
```
    Returns:
    A mapping of date pattern styles to the date pattern for the current locale.
  - getTimePattern
```
public java.lang.String getTimePattern()
```
    Returns the time pattern for this locale and the current time pattern style setting. This can be used from within a jsp for example as follows:
```
 
 <dsp:importbean bean="/atg/core/i18n/LocaleTools"/>
 <dsp:setvalue bean="LocaleTools.timeStyle" value="short"/>
 <fmt:formatDate value="${time}" pattern="${LocaleTools.userPreferredLocale.timePattern}"/>
 
 
```
    Returns:
    The time pattern for this locale and the current time pattern style setting.
    See Also:
    LocaleTools#setTimeStyle()
  - getTimePatterns
```
public java.util.HashMap<java.lang.String,java.lang.String> getTimePatterns()
```
    Returns a mapping of time pattern styles to the time pattern for the current locale. This can be used from within a jsp for example as follows:
```
 
 <dsp:importbean bean="/atg/core/i18n/LocaleTools"/>
 <fmt:formatDate value="${time}" pattern="${LocaleTools.userPreferredLocale.timePatterns.full}"/>
 
 
```
    Returns:
    A mapping of time pattern styles to the time pattern for the current locale.
  - getDateTimePattern
```
public java.lang.String getDateTimePattern()
```
    Returns the dateTime pattern for this locale and the current dateTime pattern style setting. This can be used from within a jsp for example as follows:
```
 
 <dsp:importbean bean="/atg/core/i18n/LocaleTools"/>
 <dsp:setvalue bean="LocaleTools.dateTimeStyle" value="short"/>
 <fmt:formatDate value="${dateTime}" pattern="${LocaleTools.userPreferredLocale.dateTimePattern}"/>
 
 
```
    Returns:
    The dateTime pattern for this locale and the current dateTime pattern style setting.
    See Also:
    LocaleTools#setDateTimeStyle()
  - getDateTimePatterns
```
public java.util.HashMap<java.lang.String,java.lang.String> getDateTimePatterns()
```
    Returns a mapping of dateTime pattern styles to the dateTime pattern for the current locale. This can be used from within a jsp for example as follows:
    
    Returns:
    A mapping of dateTime pattern styles to the dateTime pattern for the current locale.
  - getDateFormatSymbols
```
public java.text.DateFormatSymbols getDateFormatSymbols()
```
    Returns the dateFormatSymbols object for current locale. This can be used from within a jsp for example as follows:
```
 
 <dsp:importbean bean="/atg/core/i18n/LocaleTools"/>
 <c:set var="amValue" value="${LocaleTools.userFormattingLocaleHelper.dateFormatSymbols.amPmStrings[0]}"/>
 
 
```
    Returns:
    The dateFormatSymbols object for current locale.
    See Also:
    DateFormatSymbols
  - compareTo
```
public int compareTo(LocaleTools.LocaleHelper pOther)
```
    Compares this LocaleHelper object against another LocaleHelper object. The comparison is based on the display name of both LocaleHelper objects.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<LocaleTools.LocaleHelper>
    
    Parameters:
    pOther - The LocaleTools to be compared.
    
    Returns:
    the value 0 if the LocaleHelper argument display name is equal to this display name; a value less than 0 if this LocaleHelper display name is less than the LocaleHelper argument display name; and a value greater than 0 if this LocaleHelper display name is greater than the LocaleHelper argument display name.
  - toString
```
public java.lang.String toString()
```
    Returns the locale string representation.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    Returns the locale string representation.
    See Also:
    Locale.toString()
  - getShortDatePattern
```
public java.lang.String getShortDatePattern()
```
    Returns:
    the short date pattern
  - getShortWith4DigitYearDatePattern
```
public java.lang.String getShortWith4DigitYearDatePattern()
```
    Returns:
    the short date pattern
  - getLongDatePattern
```
public java.lang.String getLongDatePattern()
```
    Returns:
    the long date pattern
  - getFullDatePattern
```
public java.lang.String getFullDatePattern()
```
    Returns:
    the full date pattern
  - getMediumDatePattern
```
public java.lang.String getMediumDatePattern()
```
    Returns:
    the medium date pattern
  - getDefaultDatePattern
```
public java.lang.String getDefaultDatePattern()
```
    Returns:
    the default date pattern
  - getShortTimePattern
```
public java.lang.String getShortTimePattern()
```
    Returns:
    the short time pattern
  - getShortWith4DigitYearTimePattern
```
public java.lang.String getShortWith4DigitYearTimePattern()
```
    Returns:
    the short time pattern
  - getLongTimePattern
```
public java.lang.String getLongTimePattern()
```
    Returns:
    the long time pattern
  - getFullTimePattern
```
public java.lang.String getFullTimePattern()
```
    Returns:
    the full time pattern
  - getMediumTimePattern
```
public java.lang.String getMediumTimePattern()
```
    Returns:
    the medium time pattern
  - getDefaultTimePattern
```
public java.lang.String getDefaultTimePattern()
```
    Returns:
    the default time pattern
  - getShortDateTimePattern
```
public java.lang.String getShortDateTimePattern()
```
    Returns:
    the short date and time pattern
  - getShortWith4DigitYeatDateTimePattern
```
public java.lang.String getShortWith4DigitYeatDateTimePattern()
```
    Returns:
    the short date and time pattern
  - getLongDateTimePattern
```
public java.lang.String getLongDateTimePattern()
```
    Returns:
    the long date and time pattern
  - getFullDateTimePattern
```
public java.lang.String getFullDateTimePattern()
```
    Returns:
    the full date and time pattern
  - getMediumDateTimePattern
```
public java.lang.String getMediumDateTimePattern()
```
    Returns:
    the medium date and time pattern
  - getDefaultDateTimePattern
```
public java.lang.String getDefaultDateTimePattern()
```
    Returns:
    the default date and time pattern
  - getDateTokens
```
public java.util.List getDateTokens()
```
    Returns a list containing tokens representing a minimal date pattern for this locale and the current date pattern style setting. A date pattern of 'MM/DD/YY' will return a list containing M, D, Y. This can be used from within a jsp when displaying locale specific dates in the UI for example as follows:
```
<dsp:droplet name="/atg/dynamo/droplet/ForEach">
  <dsp:oparam name="output">
    <dsp:getvalueof id="dateTokens" bean="/LocaleTools.userFormattingLocaleHelper.dateTokens" 
                    idtype="java.util.List">
    </dsp:getvalueof>
  </dsp:oparam>
```
    Returns:
    List containing tokens representing a minimal date pattern.

Class LocaleTools.LocaleHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocaleTools.LocaleHelper

Method Detail

setLocale

getLocale

getCollator

sort

getDisplayName

getDisplayCountry

getDisplayLanguage

getDisplayVariant

formatDouble

formatFloat

parseNumber

parseEntireNumber

getDatePattern

getDatePatterns

getTimePattern

getTimePatterns

getDateTimePattern

getDateTimePatterns

getDateFormatSymbols

compareTo

toString

getShortDatePattern

getShortWith4DigitYearDatePattern

getLongDatePattern

getFullDatePattern

getMediumDatePattern

getDefaultDatePattern

getShortTimePattern

getShortWith4DigitYearTimePattern

getLongTimePattern

getFullTimePattern

getMediumTimePattern

getDefaultTimePattern

getShortDateTimePattern

getShortWith4DigitYeatDateTimePattern

getLongDateTimePattern

getFullDateTimePattern

getMediumDateTimePattern

getDefaultDateTimePattern

getDateTokens