com.esri.arcgis.display
Interface IAnchorPoint

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnchorPoint

public interface IAnchorPoint
extends Serializable

Provides access to members that control the tracker anchor point.

Description

The anchor point represents a point that can be used when manipulating elements and features. When working with elements, anchor points can be considered a helper object, rather than an essential. You will first need to cocreate the anchor point and then manipulate it. This is useful when implementing your own tools and objects, for example, a custom rotation tool.

Anchor points can be useful in many situations—for rotating elements and features and moving the origin of a text callout.

Product Availability

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

Method Summary

void	draw(IDisplay display) Draw the anchor.
int	getCursor() Cursor displayed when mouse is over anchor.
IPoint	getPoint() Location of anchor point.
ISymbol	getSymbol() Anchor point symbol.
boolean	hitTest(IPoint point, double tol) Check if mouse is over anchor.
void	moveTo(IPoint pPoint, IDisplay display) Move the anchor.
void	setPoint(IPoint point) Location of anchor point.
void	setSymbolByRef(ISymbol symbol) Anchor point symbol.

Method Detail

setPoint

void setPoint(IPoint point)
              throws IOException,
                     AutomationException

Location of anchor point.

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.

getPoint

IPoint getPoint()
                throws IOException,
                       AutomationException

Location of anchor point.

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.

setSymbolByRef

void setSymbolByRef(ISymbol symbol)
                    throws IOException,
                           AutomationException

Anchor point symbol.

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.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

ISymbol getSymbol()
                  throws IOException,
                         AutomationException

Anchor point symbol.

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.ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCursor

int getCursor()
              throws IOException,
                     AutomationException

Cursor displayed when mouse is over anchor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The cursor (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hitTest

boolean hitTest(IPoint point,
                double tol)
                throws IOException,
                       AutomationException

Check if mouse is over anchor.

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)

tol - The tol (in)

Returns:

The hit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display)
          throws IOException,
                 AutomationException

Draw the anchor.

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.

moveTo

void moveTo(IPoint pPoint,
            IDisplay display)
            throws IOException,
                   AutomationException

Move the anchor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (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.