com.esri.arcgis.carto
Class DMSGridLabel

java.lang.Object
  com.esri.arcgis.carto.DMSGridLabel

All Implemented Interfaces:

IDMSGridLabel, IDMSGridLabel2, IDMSGridLabel3, IGridLabel, IGridLabel2, IGridLabelExport, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class DMSGridLabel
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGridLabel, IDMSGridLabel, IGridLabel2, IDMSGridLabel2, IDMSGridLabel3, IGridLabelExport, IPersistStream, Externalizable

A grid label in degrees, minutes and seconds.

Description

DMSGridLabel are labels that display coordinate system information in various displays of degrees, minutes, and seconds, including as decimal degrees.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

DMSGridLabel()
Constructs a DMSGridLabel using ArcGIS Engine.

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

Method Summary

IElement	createElement(double labelValue, IPoint location, int axis, IDisplay display) Creates a graphic element for a label on the specified grid axis.
void	draw(double labelValue, IPoint location, int axis, IDisplay display) Draws a label on the specified grid axis.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IColor	getColor() The color of the grid label.
String	getDisplayName() The display name for the type of grid label.
Object	getEditObject() The interface to an object that can be edited with a property sheet.
Font	getFont() The font used by the grid label.
double	getFontSize() The font size used by the grid label.
double	getLabelOffset() The offset of the grid label from the border in points.
int	getLabelType() The type of the DMS grid label.
ILatLonFormat	getLatLonFormat() The format with which the latitudes and longitudes are displayed.
IColor	getMinutesColor() The color used to display the minutes.
Font	getMinutesFont() The font used to display the minutes.
double	getMinutesFontSize() The font size used to display the minutes.
IColor	getSecondsColor() The color used to display the seconds.
Font	getSecondsFont() The font used to display the seconds.
double	getSecondsFontSize() The font size used to display the seconds.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isAbbreviateLabels() Indicates if the DMS labels should be abbreviated when the value is not a whole degree.
boolean	isApplies(IMapGrid grid) Indicates if this grid label can be used with the specified map grid.
void	isDirty() isDirty
boolean	isLabelAlignment(int axis) Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.
boolean	isShowMinusSign() Indicates if the DMS labels should show the minus sign (if format is not showing direction).
boolean	isShowZeroMinutes() Indicates if zero minutes are shown.
boolean	isShowZeroSeconds() Indicates if zero seconds are shown.
void	load(IStream pstm) load
void	preview(int hDC, tagRECT rectangle) Draws a preview of the grid label into the specified hdc.
void	queryTextExtent(double labelValue, IPoint location, int axis, IDisplay display, IEnvelope extent) Determines the extent of a label's text on the specified grid axis.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setAbbreviateLabels(boolean abbrev) Indicates if the DMS labels should be abbreviated when the value is not a whole degree.
void	setColor(IColor color) The color of the grid label.
void	setEditObject(Object ppObject) The interface to an object that can be edited with a property sheet.
void	setFont(Font font) The font used by the grid label.
void	setFontSize(double size) The font size used by the grid label.
void	setLabelAlignment(int axis, boolean horizontal) Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.
void	setLabelOffset(double offsetPoints) The offset of the grid label from the border in points.
void	setLabelType(int labelType) The type of the DMS grid label.
void	setLatLonFormat(ILatLonFormat format) The format with which the latitudes and longitudes are displayed.
void	setMinutesColor(IColor color) The color used to display the minutes.
void	setMinutesFont(Font font) The font used to display the minutes.
void	setMinutesFontSize(double size) The font size used to display the minutes.
void	setSecondsColor(IColor color) The color used to display the seconds.
void	setSecondsFont(Font font) The font used to display the seconds.
void	setSecondsFontSize(double size) The font size used to display the seconds.
void	setShowMinusSign(boolean showMinus) Indicates if the DMS labels should show the minus sign (if format is not showing direction).
void	setShowZeroMinutes(boolean show) Indicates if zero minutes are shown.
void	setShowZeroSeconds(boolean show) Indicates if zero seconds are shown.
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

DMSGridLabel

public DMSGridLabel()
             throws IOException,
                    UnknownHostException

Constructs a DMSGridLabel using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DMSGridLabel

public DMSGridLabel(Object obj)
             throws IOException

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

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

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

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

The display name for the type of grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDisplayName in interface IGridLabel

Specified by:

getDisplayName in interface IGridLabel2

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplies

public boolean isApplies(IMapGrid grid)
                  throws IOException,
                         AutomationException

Indicates if this grid label can be used with the specified map grid.

Product Availability

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

Specified by:

isApplies in interface IGridLabel

Specified by:

isApplies in interface IGridLabel2

Parameters:

grid - A reference to a com.esri.arcgis.carto.IMapGrid (in)

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEditObject

public Object getEditObject()
                     throws IOException,
                            AutomationException

The interface to an object that can be edited with a property sheet. The object is either the grid label itself or a single editable property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEditObject in interface IGridLabel

Specified by:

getEditObject in interface IGridLabel2

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEditObject

public void setEditObject(Object ppObject)
                   throws IOException,
                          AutomationException

The interface to an object that can be edited with a property sheet. The object is either the grid label itself or a single editable property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEditObject in interface IGridLabel

Specified by:

setEditObject in interface IGridLabel2

Parameters:

ppObject - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFont

public Font getFont()
             throws IOException,
                    AutomationException

The font used by the grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFont in interface IGridLabel

Specified by:

getFont in interface IGridLabel2

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFont

public void setFont(Font font)
             throws IOException,
                    AutomationException

The font used by the grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFont in interface IGridLabel

Specified by:

setFont in interface IGridLabel2

Parameters:

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor()
                throws IOException,
                       AutomationException

The color of the grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColor in interface IGridLabel

Specified by:

getColor in interface IGridLabel2

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColor

public void setColor(IColor color)
              throws IOException,
                     AutomationException

The color of the grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColor in interface IGridLabel

Specified by:

setColor in interface IGridLabel2

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelOffset

public double getLabelOffset()
                      throws IOException,
                             AutomationException

The offset of the grid label from the border in points.

Description

LabelOffset is the distance in points (approx. 1/72 inch) that your labels will be drawn outside of the map border. Use a negative number to inset the labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelOffset in interface IGridLabel

Specified by:

getLabelOffset in interface IGridLabel2

Returns:

The offsetPoints

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelOffset

public void setLabelOffset(double offsetPoints)
                    throws IOException,
                           AutomationException

The offset of the grid label from the border in points.

Description

LabelOffset is the distance in points (approx. 1/72 inch) that your labels will be drawn outside of the map border. Use a negative number to inset the labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelOffset in interface IGridLabel

Specified by:

setLabelOffset in interface IGridLabel2

Parameters:

offsetPoints - The offsetPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelAlignment

public boolean isLabelAlignment(int axis)
                         throws IOException,
                                AutomationException

Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.

Product Availability

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

Specified by:

isLabelAlignment in interface IGridLabel

Specified by:

isLabelAlignment in interface IGridLabel2

Parameters:

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

Returns:

The horizontal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelAlignment

public void setLabelAlignment(int axis,
                              boolean horizontal)
                       throws IOException,
                              AutomationException

Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.

Product Availability

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

Specified by:

setLabelAlignment in interface IGridLabel

Specified by:

setLabelAlignment in interface IGridLabel2

Parameters:

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

horizontal - The horizontal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTextExtent

public void queryTextExtent(double labelValue,
                            IPoint location,
                            int axis,
                            IDisplay display,
                            IEnvelope extent)
                     throws IOException,
                            AutomationException

Determines the extent of a label's text on the specified grid axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryTextExtent in interface IGridLabel

Specified by:

queryTextExtent in interface IGridLabel2

Parameters:

labelValue - The labelValue (in)

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

display - A reference to a com.esri.arcgis.display.IDisplay (in)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(double labelValue,
                 IPoint location,
                 int axis,
                 IDisplay display)
          throws IOException,
                 AutomationException

Draws a label on the specified grid axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IGridLabel

Specified by:

draw in interface IGridLabel2

Parameters:

labelValue - The labelValue (in)

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

display - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

preview

public void preview(int hDC,
                    tagRECT rectangle)
             throws IOException,
                    AutomationException

Draws a preview of the grid label into the specified hdc.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

preview in interface IGridLabel

Specified by:

preview in interface IGridLabel2

Parameters:

hDC - The hDC (A COM typedef) (in)

rectangle - A Structure: com.esri.arcgis.system.tagRECT (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelType

public int getLabelType()
                 throws IOException,
                        AutomationException

The type of the DMS grid label.

Description

LabelType is the presentation type that the degrees, minutes, and seconds will be displayed in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelType in interface IDMSGridLabel

Specified by:

getLabelType in interface IDMSGridLabel3

Returns:

A com.esri.arcgis.carto.esriDMSGridLabelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILatLonFormat2, IDMSGridLabel.getLabelType(), IDMSGridLabel, esriDMSGridLabelType, ILatLonFormat

setLabelType

public void setLabelType(int labelType)
                  throws IOException,
                         AutomationException

The type of the DMS grid label.

Description

LabelType is the presentation type that the degrees, minutes, and seconds will be displayed in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelType in interface IDMSGridLabel

Specified by:

setLabelType in interface IDMSGridLabel3

Parameters:

labelType - A com.esri.arcgis.carto.esriDMSGridLabelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILatLonFormat2, IDMSGridLabel.getLabelType(), IDMSGridLabel, esriDMSGridLabelType, ILatLonFormat

getLatLonFormat

public ILatLonFormat getLatLonFormat()
                              throws IOException,
                                     AutomationException

The format with which the latitudes and longitudes are displayed.

Description

LatLonFormat is the ILatLonFormat interface for the IDMSGridLabel .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLatLonFormat in interface IDMSGridLabel

Specified by:

getLatLonFormat in interface IDMSGridLabel3

Returns:

A reference to a com.esri.arcgis.system.ILatLonFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLatLonFormat

public void setLatLonFormat(ILatLonFormat format)
                     throws IOException,
                            AutomationException

The format with which the latitudes and longitudes are displayed.

Description

LatLonFormat is the ILatLonFormat interface for the IDMSGridLabel .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLatLonFormat in interface IDMSGridLabel

Specified by:

setLatLonFormat in interface IDMSGridLabel3

Parameters:

format - A reference to a com.esri.arcgis.system.ILatLonFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowZeroMinutes

public boolean isShowZeroMinutes()
                          throws IOException,
                                 AutomationException

Indicates if zero minutes are shown.

Description

ShowZeroMinutes is whether the minutes will be displayed if their value is zero. For example, 30 degrees, 0 minutes, and 0 seconds would be displayed as 30 if ShowZeroMinutes was set to False , but would be 30 00 if set to True .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowZeroMinutes in interface IDMSGridLabel

Specified by:

isShowZeroMinutes in interface IDMSGridLabel3

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowZeroMinutes

public void setShowZeroMinutes(boolean show)
                        throws IOException,
                               AutomationException

Indicates if zero minutes are shown.

Description

ShowZeroMinutes is whether the minutes will be displayed if their value is zero. For example, 30 degrees, 0 minutes, and 0 seconds would be displayed as 30 if ShowZeroMinutes was set to False , but would be 30 00 if set to True .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowZeroMinutes in interface IDMSGridLabel

Specified by:

setShowZeroMinutes in interface IDMSGridLabel3

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowZeroSeconds

public boolean isShowZeroSeconds()
                          throws IOException,
                                 AutomationException

Indicates if zero seconds are shown.

Description

ShowZeroSeconds is whether the minutes will be displayed if their value is zero. For example, 30 degrees, 0 minutes, and 0 seconds would be displayed as 30 if ShowZeroSeconds was set to False , but would be 30 00 00 if set to True .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowZeroSeconds in interface IDMSGridLabel

Specified by:

isShowZeroSeconds in interface IDMSGridLabel3

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowZeroSeconds

public void setShowZeroSeconds(boolean show)
                        throws IOException,
                               AutomationException

Indicates if zero seconds are shown.

Description

ShowZeroSeconds is whether the minutes will be displayed if their value is zero. For example, 30 degrees, 0 minutes, and 0 seconds would be displayed as 30 if ShowZeroSeconds was set to False , but would be 30 00 00 if set to True .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowZeroSeconds in interface IDMSGridLabel

Specified by:

setShowZeroSeconds in interface IDMSGridLabel3

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinutesFont

public Font getMinutesFont()
                    throws IOException,
                           AutomationException

The font used to display the minutes.

Description

MinutesFont is the font used to display the minutes value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinutesFont in interface IDMSGridLabel

Specified by:

getMinutesFont in interface IDMSGridLabel3

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinutesFont

public void setMinutesFont(Font font)
                    throws IOException,
                           AutomationException

The font used to display the minutes.

Description

MinutesFont is the font used to display the minutes value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinutesFont in interface IDMSGridLabel

Specified by:

setMinutesFont in interface IDMSGridLabel3

Parameters:

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinutesColor

public IColor getMinutesColor()
                       throws IOException,
                              AutomationException

The color used to display the minutes.

Description

MinutesColor is the color used to display the minutes value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinutesColor in interface IDMSGridLabel

Specified by:

getMinutesColor in interface IDMSGridLabel3

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinutesColor

public void setMinutesColor(IColor color)
                     throws IOException,
                            AutomationException

The color used to display the minutes.

Description

MinutesColor is the color used to display the minutes value.
.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinutesColor in interface IDMSGridLabel

Specified by:

setMinutesColor in interface IDMSGridLabel3

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSecondsFont

public Font getSecondsFont()
                    throws IOException,
                           AutomationException

The font used to display the seconds.

Description

SecondsFont is the font used to display the seconds value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSecondsFont in interface IDMSGridLabel

Specified by:

getSecondsFont in interface IDMSGridLabel3

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSecondsFont

public void setSecondsFont(Font font)
                    throws IOException,
                           AutomationException

The font used to display the seconds.

Description

SecondsFont is the font used to display the seconds value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSecondsFont in interface IDMSGridLabel

Specified by:

setSecondsFont in interface IDMSGridLabel3

Parameters:

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSecondsColor

public IColor getSecondsColor()
                       throws IOException,
                              AutomationException

The color used to display the seconds.

Description

SecondsColor is the color used to display the seconds value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSecondsColor in interface IDMSGridLabel

Specified by:

getSecondsColor in interface IDMSGridLabel3

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSecondsColor

public void setSecondsColor(IColor color)
                     throws IOException,
                            AutomationException

The color used to display the seconds.

Description

SecondsColor is the color used to display the seconds value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSecondsColor in interface IDMSGridLabel

Specified by:

setSecondsColor in interface IDMSGridLabel3

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontSize

public double getFontSize()
                   throws IOException,
                          AutomationException

The font size used by the grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontSize in interface IGridLabel2

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontSize

public void setFontSize(double size)
                 throws IOException,
                        AutomationException

The font size used by the grid label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFontSize in interface IGridLabel2

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbbreviateLabels

public boolean isAbbreviateLabels()
                           throws IOException,
                                  AutomationException

Indicates if the DMS labels should be abbreviated when the value is not a whole degree.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAbbreviateLabels in interface IDMSGridLabel2

Specified by:

isAbbreviateLabels in interface IDMSGridLabel3

Returns:

The abbrev

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbbreviateLabels

public void setAbbreviateLabels(boolean abbrev)
                         throws IOException,
                                AutomationException

Indicates if the DMS labels should be abbreviated when the value is not a whole degree.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAbbreviateLabels in interface IDMSGridLabel2

Specified by:

setAbbreviateLabels in interface IDMSGridLabel3

Parameters:

abbrev - The abbrev (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinutesFontSize

public double getMinutesFontSize()
                          throws IOException,
                                 AutomationException

The font size used to display the minutes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinutesFontSize in interface IDMSGridLabel2

Specified by:

getMinutesFontSize in interface IDMSGridLabel3

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinutesFontSize

public void setMinutesFontSize(double size)
                        throws IOException,
                               AutomationException

The font size used to display the minutes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinutesFontSize in interface IDMSGridLabel2

Specified by:

setMinutesFontSize in interface IDMSGridLabel3

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSecondsFontSize

public double getSecondsFontSize()
                          throws IOException,
                                 AutomationException

The font size used to display the seconds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSecondsFontSize in interface IDMSGridLabel2

Specified by:

getSecondsFontSize in interface IDMSGridLabel3

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSecondsFontSize

public void setSecondsFontSize(double size)
                        throws IOException,
                               AutomationException

The font size used to display the seconds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSecondsFontSize in interface IDMSGridLabel2

Specified by:

setSecondsFontSize in interface IDMSGridLabel3

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowMinusSign

public boolean isShowMinusSign()
                        throws IOException,
                               AutomationException

Indicates if the DMS labels should show the minus sign (if format is not showing direction).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowMinusSign in interface IDMSGridLabel3

Returns:

The showMinus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowMinusSign

public void setShowMinusSign(boolean showMinus)
                      throws IOException,
                             AutomationException

Indicates if the DMS labels should show the minus sign (if format is not showing direction).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowMinusSign in interface IDMSGridLabel3

Parameters:

showMinus - The showMinus (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createElement

public IElement createElement(double labelValue,
                              IPoint location,
                              int axis,
                              IDisplay display)
                       throws IOException,
                              AutomationException

Creates a graphic element for a label on the specified grid axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createElement in interface IGridLabelExport

Parameters:

labelValue - The labelValue (in)

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)

display - A reference to a com.esri.arcgis.display.IDisplay (in)

Returns:

A reference to a com.esri.arcgis.carto.IElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException