com.esri.arcgis.display
Interface IMoveTextAlongShapeFeedback

All Superinterfaces:
IDisplayFeedback, java.io.Serializable
All Known Implementing Classes:
IMoveTextAlongShapeFeedbackProxy, MoveTextAlongShapeFeedback

public interface IMoveTextAlongShapeFeedback
extends IDisplayFeedback, java.io.Serializable

COM Interface 'IMoveTextAlongShapeFeedback'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to members that control the move text along shape feedback.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDb44637c6_f488_41b4_b222_07aa9c04a3d6
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.display.IDisplayFeedback
IIDd2c13e55_4bea_11d1_b6cc_080009b996cc
 
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
 

Field Detail

IIDb44637c6_f488_41b4_b222_07aa9c04a3d6

static final int IIDb44637c6_f488_41b4_b222_07aa9c04a3d6
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

followShape

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

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.

startCurved

void startCurved(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.

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.

startStraight

void startStraight(IGeometry textGeometry,
                   double labelWidth,
                   double labelHeight,
                   double referenceScale,
                   IPoint point,
                   double offset,
                   boolean parallel,
                   int constraint)
                   throws java.io.IOException,
                          AutomationException
Begins a move feedback of the given shape.

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

stop

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

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

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

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

setFlip

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

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

getOffset

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

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

setOffset

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

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

isParallel

boolean isParallel()
                   throws java.io.IOException,
                          AutomationException
Indicates whether to make the text parallel. Only valid for straight.

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

setParallel

void setParallel(boolean parallel)
                 throws java.io.IOException,
                        AutomationException
Indicates whether to make the text parallel. Only valid for straight.

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

getConstraint

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

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

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

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.