com.esri.arcgis.display
Interface IMoveCurvedTextFeedback

All Superinterfaces:
IDisplayFeedback, java.io.Serializable
All Known Implementing Classes:
IMoveCurvedTextFeedbackProxy, MoveCurvedTextFeedback

public interface IMoveCurvedTextFeedback
extends IDisplayFeedback, java.io.Serializable

Provides access to members that control the move curved text feedback.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


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.
 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 start(IPoint fromPoint, double referenceScale, IPoint cursorPoint, double offset, int constraint, boolean flipped)
          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

public void followShape(IGeometry featureGeometry,
                        double referenceScale)
                 throws java.io.IOException,
                        AutomationException
Specify the shape to follow.

Supported Platforms

Windows, Solaris, Linux

Parameters:
featureGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
referenceScale - The referenceScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

start

public void start(IPoint fromPoint,
                  double referenceScale,
                  IPoint cursorPoint,
                  double offset,
                  int constraint,
                  boolean flipped)
           throws java.io.IOException,
                  AutomationException
Begins a move feedback of the given shape.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stop

public IGeometry stop()
               throws java.io.IOException,
                      AutomationException
Stops the feedback and returns the shape.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFlip

public boolean isFlip()
               throws java.io.IOException,
                      AutomationException
Indicates whether to flip the text.

Supported Platforms

Windows, Solaris, Linux

Returns:
The flip
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlip

public void setFlip(boolean flip)
             throws java.io.IOException,
                    AutomationException
Indicates whether to flip the text.

Supported Platforms

Windows, Solaris, Linux

Parameters:
flip - The flip (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOffset

public double getOffset()
                 throws java.io.IOException,
                        AutomationException
Offset the text from the geometry.

Supported Platforms

Windows, Solaris, Linux

Returns:
The offset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffset

public void setOffset(double offset)
               throws java.io.IOException,
                      AutomationException
Offset the text from the geometry.

Supported Platforms

Windows, Solaris, Linux

Parameters:
offset - The offset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConstraint

public int getConstraint()
                  throws java.io.IOException,
                         AutomationException
Constrain the text.

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.display.esriMoveTextConstraints constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConstraint

public void setConstraint(int constraint)
                   throws java.io.IOException,
                          AutomationException
Constrain the text.

Supported Platforms

Windows, Solaris, Linux

Parameters:
constraint - A com.esri.arcgis.display.esriMoveTextConstraints constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.