com.esri.arcgis.carto
Class IPushPinProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.ISpatialBookmarkProxy
          extended by com.esri.arcgis.carto.IPushPinProxy
All Implemented Interfaces:
IPushPin, ISpatialBookmark, Externalizable, Serializable

public class IPushPinProxy
extends ISpatialBookmarkProxy
implements IPushPin, Serializable

Provides access to members that control a push pin.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IPushPinProxy()
           
  IPushPinProxy(Object obj)
           
protected IPushPinProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 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.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.carto.ISpatialBookmarkProxy
getBookmarkType, getName, setName, zoomTo
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.carto.ISpatialBookmark
getBookmarkType, getName, setName, zoomTo
 

Constructor Detail

IPushPinProxy

public IPushPinProxy()

IPushPinProxy

public IPushPinProxy(Object obj)
              throws IOException
Throws:
IOException

IPushPinProxy

protected IPushPinProxy(Object obj,
                        String iid)
                 throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class ISpatialBookmarkProxy
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class ISpatialBookmarkProxy
Throws:
IOException

getLocation

public 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

Specified by:
getLocation in interface IPushPin
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

public 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

Specified by:
setLocationByRef in interface IPushPin
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

public 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

Specified by:
getMarkerSymbol in interface IPushPin
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

public 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

Specified by:
setMarkerSymbolByRef in interface IPushPin
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

public 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

Specified by:
getTextSymbol in interface IPushPin
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

public 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

Specified by:
setTextSymbolByRef in interface IPushPin
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

public 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

Specified by:
getMaxLabelWidthPts in interface IPushPin
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxLabelWidthPts

public 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

Specified by:
setMaxLabelWidthPts in interface IPushPin
Parameters:
width - The width (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flash

public 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

Specified by:
flash in interface IPushPin
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

public 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

Specified by:
draw in interface IPushPin
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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException