com.esri.arcgis.system.LatLonFormat
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class LatLonFormat
An object for formatting numbers in a lat/lon format.
LatLonFormat is the ILatLonFormat interface coclass whose members determine how the ValueToString method in the associated INumberFormat interface formats numbers in a latitudinal or longitudinal format.
LatLonFormat also inherits the INumericFormat interface, so both these interface's properties determine how numbers are formatted.
The LatLonFormat object formats numbers from decimal values to degrees, minutes, and
seconds. For example, the value 55.87 would be converted to the string ‘55°52’12"N’.
ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat,
Serialized Form| Constructor Summary | |
|---|---|
LatLonFormat()
Constructs a LatLonFormat using ArcGIS Engine. |
|
LatLonFormat(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. LatLonFormat theLatLonFormat = (LatLonFormat) obj; |
|
| Method Summary | |
|---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
int |
getAlignmentOption()
The alignment option applied to the ValueToString method. |
int |
getAlignmentWidth()
The alignment width applied to the ValueToString method. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
void |
getDMS(double value,
int[] degrees,
int[] minutes,
double[] seconds)
Obtains the degrees, minutes, and seconds for a lat/lon number. |
int |
getRoundingOption()
The rounding option applied to the ValueToString method. |
int |
getRoundingValue()
The rounding value, whose meaning depends on the rounding option. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
double |
increment(double value)
Increments a value according to the numbers format. |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isLatitude()
Indicates if a formatted number is a latitude or not. |
boolean |
isShowDirections()
Indicates if a directional letter (N-S-E-W) is appended to the formatted number. |
boolean |
isShowPlusSign()
Indicates if formatted numbers contain a plus sign for positive numbers. |
boolean |
isShowZeroMinutes()
Indicates if zero minutes are included in formatted output. |
boolean |
isShowZeroSeconds()
Indicates if zero seconds are included in formatted output. |
boolean |
isUseSeparator()
Indicates if formatted numbers contain digit grouping symbols. |
boolean |
isZeroPad()
Indicates if formatted numbers contain padded zeros to the right of the decimal. |
void |
load(IStream pstm)
load |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setAlignmentOption(int option)
The alignment option applied to the ValueToString method. |
void |
setAlignmentWidth(int width)
The alignment width applied to the ValueToString method. |
void |
setIsLatitude(boolean rhs1)
Indicates if a formatted number is a latitude or not. |
void |
setRoundingOption(int pption)
The rounding option applied to the ValueToString method. |
void |
setRoundingValue(int value)
The rounding value, whose meaning depends on the rounding option. |
void |
setShowDirections(boolean show)
Indicates if a directional letter (N-S-E-W) is appended to the formatted number. |
void |
setShowPlusSign(boolean show)
Indicates if formatted numbers contain a plus sign for positive numbers. |
void |
setShowZeroMinutes(boolean show)
Indicates if zero minutes are included in formatted output. |
void |
setShowZeroSeconds(boolean show)
Indicates if zero seconds are included in formatted output. |
void |
setUseSeparator(boolean sep)
Indicates if formatted numbers contain digit grouping symbols. |
void |
setZeroPad(boolean pad)
Indicates if formatted numbers contain padded zeros to the right of the decimal. |
double |
stringToValue(String str)
Converts a formatted string to a numeric value. |
String |
valueToString(double value)
Converts a numeric value to a formatted string. |
void |
writeExternal(ObjectOutput out)
|
| 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 |
|---|
public LatLonFormat()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public LatLonFormat(Object obj)
throws IOException
LatLonFormat theLatLonFormat = (LatLonFormat) obj;
obj to LatLonFormat.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public String valueToString(double value)
throws IOException,
AutomationException
The ValueToString method expresses a numeric value as a formatted string. The string is formatted based on the property settings of the number formatting interface that is used. See the particular number formatting interface you're interested in under See Also above for more information.
valueToString in interface INumberFormatvalue - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public double stringToValue(String str)
throws IOException,
AutomationException
The StringToValue method obtains a numerical value from a formatted string. The string doesn't necessarily need to have been formatted with the ValueToString method, but the string needs to look like it would be if it was formatted with the associated interface's implementation of the ValueToString method. See the particular number formatting interface you're interested in under See Also above for more information.
When using the StringToValue method to obtain a ValueToString argument value, the properties in the associated interface must be set the same as they were when the ValueToString method was used. This applies in cases where ValueToString may perform a numerical conversion (in the IAngleFormat, IFractionFormat, IPercentageFormat, and IRateFormat interfaces).
stringToValue in interface INumberFormatstr - The str (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setRoundingOption(int pption)
throws IOException,
AutomationException
The RoundingOption property sets or returns the rounding option to be used when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for RoundingOption are:
| Setting | Description |
|
esriRoundNumberOfDecimals |
(Default) Numbers are rounded to the number of decimal places defined in the RoundingValue property. If ZeroPad is also set True, decimal zeros are appended at the right up to the number of places indicated in the RoundingValue property. |
|
esriRoundNumberOfSignificantDigits |
Numbers are rounded to the number of significant digits indicated in the RoundingValue property. To format numbers and express significant zeros at the right of the decimal, set ZeroPad True. For example, the number 12.0345 in 8 significant digits is the number 12.034500. In order to express the rightmost significant zeros, ZeroPad should be set True. With ZeroPad set False, the formatted number would be 12.0345. |
setRoundingOption in interface INumericFormatpption - A com.esri.arcgis.system.esriRoundingOptionEnum constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public int getRoundingOption()
throws IOException,
AutomationException
The RoundingOption property sets or returns the rounding option to be used when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for RoundingOption are:
| Setting | Description |
|
esriRoundNumberOfDecimals |
(Default) Numbers are rounded to the number of decimal places defined in the RoundingValue property. If ZeroPad is also set True, decimal zeros are appended at the right up to the number of places indicated in the RoundingValue property. |
|
esriRoundNumberOfSignificantDigits |
Numbers are rounded to the number of significant digits indicated in the RoundingValue property. To format numbers and express significant zeros at the right of the decimal, set ZeroPad True. For example, the number 12.0345 in 8 significant digits is the number 12.034500. In order to express the rightmost significant zeros, ZeroPad should be set True. With ZeroPad set False, the formatted number would be 12.0345. |
getRoundingOption in interface INumericFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setRoundingValue(int value)
throws IOException,
AutomationException
The RoundingValue property sets or returns the number of decimal places or significant digits (default: 6) to round a number to when the ValueToString method in the associated INumberFormat interface formats numbers.
setRoundingValue in interface INumericFormatvalue - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public int getRoundingValue()
throws IOException,
AutomationException
The RoundingValue property sets or returns the number of decimal places or significant digits (default: 6) to round a number to when the ValueToString method in the associated INumberFormat interface formats numbers.
getRoundingValue in interface INumericFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setAlignmentOption(int option)
throws IOException,
AutomationException
The AlignmentOption property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface how to align formatted numbers
The settings for AlignmentOption are:
| Setting | Description |
|
esriAlignRight |
(Default) Numbers are aligned to the right. If the AlignmentWidth property is wider than the resulting formatted number, spaces are padded at the left to make the output AlignmentWidth characters wide. If the formatted number is wider than AlignmentWidth, the number is not truncated (the same as it would be if AlignmentOption were set to esriAlignLeft). |
|
esriAlignLeft |
Numbers are aligned to the left. No spaces are padded either at the left or right. If AlignmentOption is set to esriAlignLeft, the AlignmentWidth property is ignored. |
setAlignmentOption in interface INumericFormatoption - A com.esri.arcgis.system.esriNumericAlignmentEnum constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public int getAlignmentOption()
throws IOException,
AutomationException
The AlignmentOption property sets or returns an option that tells the ValueToString method in the associated INumberFormat interface how to align formatted numbers. For example, the value “0.34”, formatted as a string with an AlignmentWidth of 5, is returned as “0.34” with an AlignmentOption of esriAlignRight and “0.34” with an AlignmentOption of esriAlignLeft.
The settings for AlignmentOption are:
| Setting | Description |
|
esriAlignRight |
(Default) Numbers are aligned to the right. If the AlignmentWidth property is wider than the resulting formatted number, spaces are padded at the left to make the output AlignmentWidth characters wide. If the formatted number is wider than AlignmentWidth, the number is not truncated (the same as it would be if AlignmentOption were set to esriAlignLeft). |
|
esriAlignLeft |
Numbers are aligned to the left. No spaces are padded either at the left or right. If AlignmentOption is set to esriAlignLeft, the AlignmentWidth property is ignored. |
getAlignmentOption in interface INumericFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setAlignmentWidth(int width)
throws IOException,
AutomationException
The AlignmentWidth property sets or returns the width (default: 12) of the resulting string the ValueToString method in the associated INumberFormat interface produces.
If the AlignmentOption property is set to esriAlignRight, the formatted number will be AlignmentWidth characters wide, padding spaces to the left of the number as needed. If AlignmentOption = esriAlignLeft, the AlignmentWidth property is ignored.
If AlignmentOption = esriAlignRight, make sure AlignmentWidth is set wide enough to handle the resulting formatted number. If it is not, the number will not be truncated, but the length of the formatted number will be longer than the AlignmentWidth.
setAlignmentWidth in interface INumericFormatwidth - The width (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public int getAlignmentWidth()
throws IOException,
AutomationException
The AlignmentWidth property sets or returns the width (default: 12) of the resulting string the ValueToString method in the associated INumberFormat interface produces.
If the AlignmentOption property is set to esriAlignRight, the formatted number will be AlignmentWidth characters wide, padding spaces to the left of the number as needed. If AlignmentOption = esriAlignLeft, the AlignmentWidth property is ignored. The width includes plus signs and any decimal points. For example, +1,234.56 has a width of 9.
If AlignmentOption = esriAlignRight, make sure AlignmentWidth is set wide enough to handle the resulting formatted number. If it is not, the number will not be truncated, but the length of the formatted number will be longer than the AlignmentWidth.
getAlignmentWidth in interface INumericFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setUseSeparator(boolean sep)
throws IOException,
AutomationException
The UseSeparator property sets or returns an indicator that tells whether to include a digit grouping symbol when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for UseSeparator are:
| Setting | Description |
|
False |
(Default) Numbers are formatted without a digit grouping symbol, for example, 1234567.89. |
|
True |
Numbers are formatted with a digit grouping symbol, for example, 1,234,567.89. |
Numbers are formatted using the current regional settings defined for the system at runtime. To change the separator symbol or where the separator appears in the formatted number, change the settings on the Number tab of Control Panel's Regional Settings applet.
setUseSeparator in interface INumericFormatsep - The sep (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public boolean isUseSeparator()
throws IOException,
AutomationException
The UseSeparator property sets or returns an indicator that tells whether to include a digit grouping symbol when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for UseSeparator are:
| Setting | Description |
|
False |
(Default) Numbers are formatted without a digit grouping symbol, for example, 1234567.89. |
|
True |
Numbers are formatted with a digit grouping symbol, for example, 1,234,567.89. |
Numbers are formatted using the current regional settings defined for the system at runtime. To change the separator symbol or where the separator appears in the formatted number, change the settings on the Number tab of Control Panel's Regional Settings applet.
isUseSeparator in interface INumericFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setZeroPad(boolean pad)
throws IOException,
AutomationException
The ZeroPad property sets or returns an indicator that tells whether to pad zeros at the right of the decimal when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ZeroPad are:
| Setting | Description |
|
False |
(Default) Numbers are formatted without padding decimal zeros. The last decimal digit is a non-zero digit. |
|
True |
Decimal zeros or significant digit zeros are appended at the right of the decimal point up to the number of places indicated in the RoundingValue property. The RoundingOption setting determines whether decimal zeros or significant digit zeros are appended. |
To format numbers and express significant zeros at the right of the decimal, set ZeroPad True. For example, the number 12.0345 in 8 significant digits is the number 12.034500. In order to express the rightmost significant zeros, ZeroPad should be set True. With ZeroPad set False, the formatted number would be 12.0345.
setZeroPad in interface INumericFormatpad - The pad (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public boolean isZeroPad()
throws IOException,
AutomationException
The ZeroPad property sets or returns an indicator that tells whether to pad zeros at the right of the decimal when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ZeroPad are:
| Setting | Description |
|
False |
(Default) Numbers are formatted without padding decimal zeros. The last decimal digit (to the right of the decimal point) is a non-zero digit. |
|
True |
Decimal zeros or significant digit zeros are appended at the right of the decimal point up to the number of places indicated in the RoundingValue property. The RoundingOption setting determines whether decimal zeros or significant digit zeros are appended. |
To format numbers and express significant zeros at the right of the decimal, set ZeroPad True. For example, the number 12.0345 in 8 significant digits is the number 12.034500. In order to express the rightmost significant zeros, ZeroPad should be set True. With ZeroPad set False, the formatted number would be 12.0345.
isZeroPad in interface INumericFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setShowPlusSign(boolean show)
throws IOException,
AutomationException
The ShowPlusSign property sets or returns an indicator that tells whether or not a plus sign symbol is used for positive numbers when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ShowPlusSign are:
| Setting | Description |
|
False |
(Default) Positive numbers and zero values are formatted without a plus sign. Negative values are formatted with a minus (-) sign. |
|
True |
Positive numbers are formatted with a plus (+) sign. Zero values are formatted without a plus sign. Negative numbers are formatted with a minus (-) sign. |
Using ShowPlusSign can be useful in conjunction with IFormattedGridLabel, where a user might not know if the number is above or below the Equator, or east or west of the Central Meridian.
Also see the ShowDirections property in ILatLonFormat.
setShowPlusSign in interface INumericFormatshow - The show (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public boolean isShowPlusSign()
throws IOException,
AutomationException
The ShowPlusSign property sets or returns an indicator that tells whether or not a plus sign symbol (+) is to be prefixed to positive numbers when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ShowPlusSign are:
|
Setting |
Description |
|
False |
(Default) Positive numbers and zero values are formatted without a plus sign. Negative values are formatted with a minus (-) sign. |
|
True |
Positive numbers are formatted with a plus (+) sign. Zero values are formatted without a plus sign. Negative numbers are formatted with a minus (-) sign. |
Using ShowPlusSign can be useful in conjunction with IFormattedGridLabel, where a user might not know if the number is above or below the Equator, or east or west of the Central Meridian.
Also see the ShowDirections property in ILatLonFormat.
isShowPlusSign in interface INumericFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public double increment(double value)
throws IOException,
AutomationException
The Increment method reacts differently depending on the number format object used and how that object is configured. A NumericFormat configured for a specific number of decimal places will increment to the last decimal place. For example, if two decimal places are specified, 22.533 would increment to 22.54; if the object is configured for two significant digits, 22.533 would increment to 24. For an AngleFormat, the input value is converted to the display format first then the same rules apply as for a NumericFormat.
increment in interface INumberFormatOperationsvalue - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setShowDirections(boolean show)
throws IOException,
AutomationException
The ShowDirections property sets or returns an indicator that tells whether to append a directional letter designation (N, S, E, or W) when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ShowDirections are:
| Setting | Description |
|
False |
(Default) A directional letter designation is not appended to the format, for example, 270°. |
|
True |
A directional letter designation is appended to the format, for example, 270°E. |
setShowDirections in interface ILatLonFormatsetShowDirections in interface ILatLonFormat2show - The show (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
IDMSGridLabel.getLabelType(),
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
IDMSGridLabel,
esriDMSGridLabelType,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public boolean isShowDirections()
throws IOException,
AutomationException
The ShowDirections property sets or returns an indicator that tells whether to append a directional letter designation (N, S, E, or W) when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ShowDirections are:
| Setting | Description |
|
False |
(Default) A directional letter designation is not appended to the format, for example, 270°. |
|
True |
A directional letter designation is appended to the format, for example, 270°E. |
As an alternative, the ShowPlusSign property from INumericFormat can be used to show similar information since the LatLonFormat coclass also supports this interface.
isShowDirections in interface ILatLonFormatisShowDirections in interface ILatLonFormat2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
IDMSGridLabel.getLabelType(),
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
IDMSGridLabel,
esriDMSGridLabelType,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setIsLatitude(boolean rhs1)
throws IOException,
AutomationException
The IsLatitude property sets an indicator that tells whether the curvature of the coordinate system causes latitude labels to be placed on top or below the dataframe border, or for longitude labels that appear to the right or left of the dataframe border. It also determines the directional label appended to the format when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ShowDirections are:
| Setting | Description |
|
False |
(Default) Latitude labels are placed on top of the dataframe border. Longitude labels are placed to the left of the dataframe border. If ShowDirections is True, a directional letter designation of either E or W is appended to the format, for example, 23°E. |
|
True |
Latitude labels are placed below the dataframe border. Longitude labels are placed to the right of the dataframe border. If ShowDirections is True, a directional letter designation of either N or S is appended to the format, for example, 17°N. |
When used with the IDMSGridLabel interface, it sets an indicator to specify that latitude labels will be placed on top of the data frame border, and longitude labels will be placed to the left of the data frame border. If True, the directional letter will be either N or S; with IDMSGridLabel, latitude labels are placed below the data frame border and longitude labels are placed to the right.
setIsLatitude in interface ILatLonFormatsetIsLatitude in interface ILatLonFormat2rhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
IDMSGridLabel.getLabelType(),
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
IDMSGridLabel,
esriDMSGridLabelType,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void getDMS(double value,
int[] degrees,
int[] minutes,
double[] seconds)
throws IOException,
AutomationException
The GetDMS method returns the degrees, minutes, and seconds values for a given decimal degree latitudinal or longitudinal value.
To use it you should pass in the input decimal degree value and also pass in three double values representing the output degrees, minutes, and seconds that will be populated by the method.
getDMS in interface ILatLonFormatgetDMS in interface ILatLonFormat2value - The value (in)degrees - The degrees (out: use single element array)minutes - The minutes (out: use single element array)seconds - The seconds (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
IDMSGridLabel.getLabelType(),
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
IDMSGridLabel,
esriDMSGridLabelType,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setShowZeroMinutes(boolean show)
throws IOException,
AutomationException
The ShowZeroMinutes property sets or returns an indicator that tells whether or not a zero value in the minutes location is expressed when the ValueToString method in the associated INumberFormat interface formats numbers. Non-zero values are always expressed in the format.
The settings for ShowZeroMinutes are:
| Setting | Description |
|
False |
(Default) Zero values in the minutes location are not shown, for example 17°N . |
|
True |
Zero values in the minutes location are shown, for example 17°0'N . |
setShowZeroMinutes in interface ILatLonFormatsetShowZeroMinutes in interface ILatLonFormat2show - The show (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public boolean isShowZeroMinutes()
throws IOException,
AutomationException
The ShowZeroMinutes property sets or returns an indicator that tells whether or not a zero value in the minutes location is expressed when the ValueToString method in the associated INumberFormat interface formats numbers. Non-zero values are always expressed in the format.
The settings for ShowZeroMinutes are:
| Setting | Description |
|
False |
(Default) Zero values in the minutes location are not shown, for example 17°N. |
|
True |
Zero values in the minutes location are shown, for example 17°0'N. |
isShowZeroMinutes in interface ILatLonFormatisShowZeroMinutes in interface ILatLonFormat2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public void setShowZeroSeconds(boolean show)
throws IOException,
AutomationException
The ShowZeroSeconds property sets or returns an indicator that tells whether or not a zero value in the seconds location is expressed when the ValueToString method in the associated INumberFormat interface formats numbers. Non-zero values are always expressed in the format.
The settings for ShowZeroSeconds are:
| Setting | Description |
|
False |
(Default) Zero values in the seconds location are not shown, for example 17°N . |
|
True |
Zero values in the seconds location are shown, for example 17°0'0"N . |
If ShowZeroSeconds is True, zero values in the minutes location are also shown regardless of the ShowZeroMinutes setting.
setShowZeroSeconds in interface ILatLonFormatsetShowZeroSeconds in interface ILatLonFormat2show - The show (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public boolean isShowZeroSeconds()
throws IOException,
AutomationException
The ShowZeroSeconds property sets or returns an indicator that tells whether or not a zero value in the seconds location is expressed when the ValueToString method in the associated INumberFormat interface formats numbers. Non-zero values are always expressed in the format.
The settings for ShowZeroSeconds are:
| Setting | Description |
|
False |
(Default) Zero values in the seconds location are not shown, for example 17°N . |
|
True |
Zero values in the seconds location are shown, for example 17°0'0"N . |
If ShowZeroSeconds is True, zero values in the minutes location are also shown regardless of the ShowZeroMinutes setting.
isShowZeroSeconds in interface ILatLonFormatisShowZeroSeconds in interface ILatLonFormat2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public boolean isLatitude()
throws IOException,
AutomationException
The IsLatitude property sets or returns an indicator that tells whether the curvature of the coordinate system causes latitude labels to be placed on top or below the dataframe border, or for longitude labels that appear to the right or left of the dataframe border. It also determines the directional label appended to the format when the ValueToString method in the associated INumberFormat interface formats numbers.
The settings for ShowDirections are:
| Setting | Description |
|
False |
(Default) Latitude labels are placed on top of the dataframe border. Longitude labels are placed to the left of the dataframe border. If ShowDirections is True, a directional letter designation of either E or W is appended to the format, for example, 23°E. |
|
True |
Latitude labels are placed below the dataframe border. Longitude labels are placed to the right of the dataframe border. If ShowDirections is True, a directional letter designation of either N or S is appended to the format, for example, 17°N. |
When used with the IDMSGridLabel interface, it sets an indicator to specify that latitude labels will be placed on top of the data frame border, and longitude labels will be placed to the left of the data frame border. If True, the directional letter will be either N or S; with IDMSGridLabel, latitude labels are placed below the data frame border and longitude labels are placed to the right.
isLatitude in interface ILatLonFormat2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ILatLonFormat2,
IDMSGridLabel.getLabelType(),
CustomNumberFormat,
IRateFormat,
IAngleFormat,
NumericFormat,
IDMSGridLabel,
esriDMSGridLabelType,
LatLonFormat,
CurrencyFormat,
INumericFormat,
IFractionFormat,
RateFormat,
IScientificNumberFormat,
ICustomNumberFormat,
ILatLonFormat,
IPercentageFormat,
INumberFormat,
ScientificFormat,
FractionFormat,
PercentageFormat,
AngleFormat
public IClone esri_clone()
throws IOException,
AutomationException
esri_clone in interface ICloneIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws IOException,
AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws IOException,
AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||