com.esri.arcgis.system
Class ArcGISLocale

java.lang.Object
  com.esri.arcgis.system.ArcGISLocale

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IArcGISLocale, Serializable

public class ArcGISLocale
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcGISLocale

Class for accessing ArcGIS locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

ArcGISLocale()
Constructs a ArcGISLocale using ArcGIS Engine.

ArcGISLocale(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcGISLocale theArcGISLocale = (ArcGISLocale) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCountryID() The value of the country ID from the locale.
int	getLangID() The value of the language ID from the locale.
int	getLocale() The value of the locale.
int	getUICountryID() The value of the country ID from the UI locale.
int	getUILangID() The value of the language ID from the UI locale.
int	getUILocale() The value of the UI locale.
int	hashCode() the hashcode for this object
boolean	isRightToLeft() Indicates if the UI locale is right to left.
boolean	isRightToLeftTable() Indicates if the UI locale is right to left table.
boolean	isRightToLeftUI() Indicates if the UI locale is right to left user interface.
void	setLocale() Write the ArcGIS locale for the process.
void	setThreadLocale() Write the ArcGIS locale for the thread.
void	setThreadUILocale() Write the ArcGIS UI locale for the thread.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArcGISLocale

public ArcGISLocale()
             throws IOException,
                    UnknownHostException

Constructs a ArcGISLocale using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcGISLocale

public ArcGISLocale(Object obj)
             throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcGISLocale theArcGISLocale = (ArcGISLocale) obj;

Construct a ArcGISLocale using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcGISLocale.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getLangID

public int getLangID()
              throws IOException,
                     AutomationException

The value of the language ID from the locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLangID in interface IArcGISLocale

Returns:

The langID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCountryID

public int getCountryID()
                 throws IOException,
                        AutomationException

The value of the country ID from the locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getCountryID in interface IArcGISLocale

Returns:

The countryID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocale

public int getLocale()
              throws IOException,
                     AutomationException

The value of the locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLocale in interface IArcGISLocale

Returns:

The locale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUILangID

public int getUILangID()
                throws IOException,
                       AutomationException

The value of the language ID from the UI locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getUILangID in interface IArcGISLocale

Returns:

The langID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUICountryID

public int getUICountryID()
                   throws IOException,
                          AutomationException

The value of the country ID from the UI locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getUICountryID in interface IArcGISLocale

Returns:

The countryID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUILocale

public int getUILocale()
                throws IOException,
                       AutomationException

The value of the UI locale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getUILocale in interface IArcGISLocale

Returns:

The locale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRightToLeft

public boolean isRightToLeft()
                      throws IOException,
                             AutomationException

Indicates if the UI locale is right to left.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isRightToLeft in interface IArcGISLocale

Returns:

The isRightToLeft

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRightToLeftUI

public boolean isRightToLeftUI()
                        throws IOException,
                               AutomationException

Indicates if the UI locale is right to left user interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isRightToLeftUI in interface IArcGISLocale

Returns:

The isRightToLeftUI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRightToLeftTable

public boolean isRightToLeftTable()
                           throws IOException,
                                  AutomationException

Indicates if the UI locale is right to left table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isRightToLeftTable in interface IArcGISLocale

Returns:

The isRightToLeftTable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocale

public void setLocale()
               throws IOException,
                      AutomationException

Write the ArcGIS locale for the process.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLocale in interface IArcGISLocale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThreadLocale

public void setThreadLocale()
                     throws IOException,
                            AutomationException

Write the ArcGIS locale for the thread.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setThreadLocale in interface IArcGISLocale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThreadUILocale

public void setThreadUILocale()
                       throws IOException,
                              AutomationException

Write the ArcGIS UI locale for the thread.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setThreadUILocale in interface IArcGISLocale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.