com.esri.arcgis.carto
Interface IPushPin

All Superinterfaces:

ISpatialBookmark, Serializable

All Known Implementing Classes:

IPushPinProxy

public interface IPushPin
extends ISpatialBookmark, Serializable

Provides access to members that control a push pin.

Product Availability

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

Method Summary

void	draw(IDisplay display) Draws the pin on the map display.
void	flash(IDisplay display) Flashes the pin on the map display.
IPoint	getLocation() The location of the pin.
IMarkerSymbol	getMarkerSymbol() The marker symbol used to draw the push pin.
double	getMaxLabelWidthPts() The maximum label width in points (1/72 inch).
ITextSymbol	getTextSymbol() The text symbol used to draw the push pin.
void	setLocationByRef(IPoint point) The location of the pin.
void	setMarkerSymbolByRef(IMarkerSymbol symbol) The marker symbol used to draw the push pin.
void	setMaxLabelWidthPts(double width) The maximum label width in points (1/72 inch).
void	setTextSymbolByRef(ITextSymbol symbol) The text symbol used to draw the push pin.

Methods inherited from interface com.esri.arcgis.carto.ISpatialBookmark

getBookmarkType, getName, setName, zoomTo

Method Detail

getLocation

IPoint getLocation()
                   throws IOException,
                          AutomationException

The location of the pin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationByRef

void setLocationByRef(IPoint point)
                      throws IOException,
                             AutomationException

The location of the pin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMarkerSymbol

IMarkerSymbol getMarkerSymbol()
                              throws IOException,
                                     AutomationException

The marker symbol used to draw the push pin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarkerSymbolByRef

void setMarkerSymbolByRef(IMarkerSymbol symbol)
                          throws IOException,
                                 AutomationException

The marker symbol used to draw the push pin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

The text symbol used to draw the push pin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

void setTextSymbolByRef(ITextSymbol symbol)
                        throws IOException,
                               AutomationException

The text symbol used to draw the push pin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxLabelWidthPts

double getMaxLabelWidthPts()
                           throws IOException,
                                  AutomationException

The maximum label width in points (1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxLabelWidthPts

void setMaxLabelWidthPts(double width)
                         throws IOException,
                                AutomationException

The maximum label width in points (1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flash

void flash(IDisplay display)
           throws IOException,
                  AutomationException

Flashes the pin on the map display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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.

draw

void draw(IDisplay display)
          throws IOException,
                 AutomationException

Draws the pin on the map display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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.