com.esri.arcgis.controls
Interface IARUnitConverter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ARUnitConverter, IARUnitConverterProxy

public interface IARUnitConverter
extends java.io.Serializable

COM Interface 'IARUnitConverter'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members that control the ARUnitConverter.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID_1_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_3_NAME
static java.lang.String	DISPID_4_NAME
static java.lang.String	DISPID_5_NAME
static java.lang.String	DISPID_6_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID11a10d49_2e44_4204_b253_f63b9c18ba89
static int	xxDummy Deprecated. Internal use only

Method Summary

double	convertUnits(double dValue, int inUnits, int outUnits) Converts the specified value between two units of measure.
java.lang.String	doubleAsString(double dValue, int nDigits, boolean bSeparators) Converts the specified value to a string rounded to a specified number of decimal places.
java.lang.String	esriUnitsAsAbbreviatedString(int units, int caseAppearance) Converts the specified units to a string abbreviation in upper or lower case.
java.lang.String	esriUnitsAsString(int units, int caseAppearance, boolean bPlural) Converts the specified units to strings in upper or lower case.
void	getLocationAsString(IARMap pMap, double xCoord, double yCoord, int displayUnits, java.lang.String[] sXLocation, java.lang.String[] sYLocation, java.lang.String[] sUnits) Converts the specified coordinates and units to strings.
void	getLongLatAsString(double longitude, double latitude, int displayUnits, java.lang.String[] sLongitude, java.lang.String[] sLatitude, java.lang.String[] sUnits) Converts the specified degree coordinates and units to strings.

Field Detail

IID11a10d49_2e44_4204_b253_f63b9c18ba89

static final int IID11a10d49_2e44_4204_b253_f63b9c18ba89

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_1_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_NAME

static final java.lang.String DISPID_3_NAME

See Also:

Constant Field Values

DISPID_4_NAME

static final java.lang.String DISPID_4_NAME

See Also:

Constant Field Values

DISPID_5_NAME

static final java.lang.String DISPID_5_NAME

See Also:

Constant Field Values

DISPID_6_NAME

static final java.lang.String DISPID_6_NAME

See Also:

Constant Field Values

Method Detail

getLocationAsString

void getLocationAsString(IARMap pMap,
                         double xCoord,
                         double yCoord,
                         int displayUnits,
                         java.lang.String[] sXLocation,
                         java.lang.String[] sYLocation,
                         java.lang.String[] sUnits)
                         throws java.io.IOException,
                                AutomationException

Converts the specified coordinates and units to strings.

Parameters:

pMap - A reference to a com.esri.arcgis.controls.IARMap (in)

xCoord - The xCoord (in)

yCoord - The yCoord (in)

displayUnits - A com.esri.arcgis.controls.esriARUnits constant (in)

sXLocation - The sXLocation (in/out: use single element array)

sYLocation - The sYLocation (in/out: use single element array)

sUnits - The sUnits (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esriUnitsAsString

java.lang.String esriUnitsAsString(int units,
                                   int caseAppearance,
                                   boolean bPlural)
                                   throws java.io.IOException,
                                          AutomationException

Converts the specified units to strings in upper or lower case.

Parameters:

units - A com.esri.arcgis.controls.esriARUnits constant (in)

caseAppearance - A com.esri.arcgis.controls.esriARCaseAppearance constant (in)

bPlural - The bPlural (in)

Returns:

The sUnitString

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertUnits

double convertUnits(double dValue,
                    int inUnits,
                    int outUnits)
                    throws java.io.IOException,
                           AutomationException

Converts the specified value between two units of measure.

Parameters:

dValue - The dValue (in)

inUnits - A com.esri.arcgis.controls.esriARUnits constant (in)

outUnits - A com.esri.arcgis.controls.esriARUnits constant (in)

Returns:

The outValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doubleAsString

java.lang.String doubleAsString(double dValue,
                                int nDigits,
                                boolean bSeparators)
                                throws java.io.IOException,
                                       AutomationException

Converts the specified value to a string rounded to a specified number of decimal places.

Parameters:

dValue - The dValue (in)

nDigits - The nDigits (in)

bSeparators - The bSeparators (in)

Returns:

The sValueString

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLongLatAsString

void getLongLatAsString(double longitude,
                        double latitude,
                        int displayUnits,
                        java.lang.String[] sLongitude,
                        java.lang.String[] sLatitude,
                        java.lang.String[] sUnits)
                        throws java.io.IOException,
                               AutomationException

Converts the specified degree coordinates and units to strings.

Parameters:

longitude - The longitude (in)

latitude - The latitude (in)

displayUnits - A com.esri.arcgis.controls.esriARUnits constant (in)

sLongitude - The sLongitude (in/out: use single element array)

sLatitude - The sLatitude (in/out: use single element array)

sUnits - The sUnits (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esriUnitsAsAbbreviatedString

java.lang.String esriUnitsAsAbbreviatedString(int units,
                                              int caseAppearance)
                                              throws java.io.IOException,
                                                     AutomationException

Converts the specified units to a string abbreviation in upper or lower case.

Parameters:

units - A com.esri.arcgis.controls.esriARUnits constant (in)

caseAppearance - A com.esri.arcgis.controls.esriARCaseAppearance constant (in)

Returns:

The sUnitString

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.