com.esri.arcgis.display
Interface IMoveTextAlongShapeFeedback

All Superinterfaces:

IDisplayFeedback, Serializable

All Known Implementing Classes:

MoveTextAlongShapeFeedback

public interface IMoveTextAlongShapeFeedback
extends IDisplayFeedback, Serializable

Provides access to members that control the move text along shape feedback.

Product Availability

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

Method Summary

void	followShape(IGeometry featureGeometry, double referenceScale) Specify the shape to follow.
int	getConstraint() Constrain the text.
double	getOffset() Offset the text from the geometry.
boolean	isFlip() Indicates whether to flip the text.
boolean	isParallel() Indicates whether to make the text parallel.
void	setConstraint(int constraint) Constrain the text.
void	setFlip(boolean flip) Indicates whether to flip the text.
void	setOffset(double offset) Offset the text from the geometry.
void	setParallel(boolean parallel) Indicates whether to make the text parallel.
void	startCurved(IPoint fromPoint, double referenceScale, IPoint cursorPoint, double offset, int constraint, boolean flipped) Begins a move feedback of the given shape.
void	startStraight(IGeometry textGeometry, double labelWidth, double labelHeight, double referenceScale, IPoint point, double offset, boolean parallel, int constraint) Begins a move feedback of the given shape.
IGeometry	stop() Stops the feedback and returns the shape.

Methods inherited from interface com.esri.arcgis.display.IDisplayFeedback

getSymbol, moveTo, refresh, setDisplayByRef, setSymbolByRef

Method Detail

followShape

void followShape(IGeometry featureGeometry,
                 double referenceScale)
                 throws IOException,
                        AutomationException

Specify the shape to follow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

featureGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

referenceScale - The referenceScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startCurved

void startCurved(IPoint fromPoint,
                 double referenceScale,
                 IPoint cursorPoint,
                 double offset,
                 int constraint,
                 boolean flipped)
                 throws IOException,
                        AutomationException

Begins a move feedback of the given shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

referenceScale - The referenceScale (in)

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

offset - The offset (in)

constraint - A com.esri.arcgis.display.esriMoveTextConstraints constant (in)

flipped - The flipped (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startStraight

void startStraight(IGeometry textGeometry,
                   double labelWidth,
                   double labelHeight,
                   double referenceScale,
                   IPoint point,
                   double offset,
                   boolean parallel,
                   int constraint)
                   throws IOException,
                          AutomationException

Begins a move feedback of the given shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

textGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

labelWidth - The labelWidth (in)

labelHeight - The labelHeight (in)

referenceScale - The referenceScale (in)

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

offset - The offset (in)

parallel - The parallel (in)

constraint - A com.esri.arcgis.display.esriMoveTextConstraints constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

IGeometry stop()
               throws IOException,
                      AutomationException

Stops the feedback and returns the shape.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFlip

boolean isFlip()
               throws IOException,
                      AutomationException

Indicates whether to flip the text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlip

void setFlip(boolean flip)
             throws IOException,
                    AutomationException

Indicates whether to flip the text.

Product Availability

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

Parameters:

flip - The flip (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

double getOffset()
                 throws IOException,
                        AutomationException

Offset the text from the geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

void setOffset(double offset)
               throws IOException,
                      AutomationException

Offset the text from the geometry.

Product Availability

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

Parameters:

offset - The offset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isParallel

boolean isParallel()
                   throws IOException,
                          AutomationException

Indicates whether to make the text parallel. Only valid for straight.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The parallel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParallel

void setParallel(boolean parallel)
                 throws IOException,
                        AutomationException

Indicates whether to make the text parallel. Only valid for straight.

Product Availability

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

Parameters:

parallel - The parallel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConstraint

int getConstraint()
                  throws IOException,
                         AutomationException

Constrain the text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriMoveTextConstraints constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstraint

void setConstraint(int constraint)
                   throws IOException,
                          AutomationException

Constrain the text.

Product Availability

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

Parameters:

constraint - A com.esri.arcgis.display.esriMoveTextConstraints constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.