com.esri.arcgis.display
Class MoveTextAlongShapeFeedback

java.lang.Object
  extended by com.esri.arcgis.display.MoveTextAlongShapeFeedback
All Implemented Interfaces:
IDisplayFeedback, IMoveTextAlongShapeFeedback, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MoveTextAlongShapeFeedback
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMoveTextAlongShapeFeedback

Move Text Following Geometry Display Feedback Object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
MoveTextAlongShapeFeedback()
          Constructs a MoveTextAlongShapeFeedback using ArcGIS Engine.
MoveTextAlongShapeFeedback(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MoveTextAlongShapeFeedback theMoveTextAlongShapeFeedback = (MoveTextAlongShapeFeedback) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void followShape(IGeometry featureGeometry, double referenceScale)
          Specify the shape to follow.
static String getClsid()
          getClsid.
 int getConstraint()
          Constrain the text.
 double getOffset()
          Offset the text from the geometry.
 ISymbol getSymbol()
          The symbol the feedback object will use.
 int hashCode()
          the hashcode for this object
 boolean isFlip()
          Indicates whether to flip the text.
 boolean isParallel()
          Indicates whether to make the text parallel.
 void moveTo(IPoint point)
          Move to the new point.
 void refresh(int hDC)
          Call this after a refresh to show feedback again.
 void setConstraint(int constraint)
          Constrain the text.
 void setDisplayByRef(IScreenDisplay rhs1)
          The display the feedback object will use.
 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 setSymbolByRef(ISymbol symbol)
          The symbol the feedback object will use.
 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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

MoveTextAlongShapeFeedback

public MoveTextAlongShapeFeedback()
                           throws IOException,
                                  UnknownHostException
Constructs a MoveTextAlongShapeFeedback using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MoveTextAlongShapeFeedback

public MoveTextAlongShapeFeedback(Object obj)
                           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MoveTextAlongShapeFeedback theMoveTextAlongShapeFeedback = (MoveTextAlongShapeFeedback) obj;

Construct a MoveTextAlongShapeFeedback using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MoveTextAlongShapeFeedback.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

followShape

public 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

Specified by:
followShape in interface IMoveTextAlongShapeFeedback
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

public 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

Specified by:
startCurved in interface IMoveTextAlongShapeFeedback
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

public 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

Specified by:
startStraight in interface IMoveTextAlongShapeFeedback
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

public 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

Specified by:
stop in interface IMoveTextAlongShapeFeedback
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

public 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

Specified by:
isFlip in interface IMoveTextAlongShapeFeedback
Returns:
The flip
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlip

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

Product Availability

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

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

getOffset

public 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

Specified by:
getOffset in interface IMoveTextAlongShapeFeedback
Returns:
The offset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffset

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

Product Availability

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

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

isParallel

public 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

Specified by:
isParallel in interface IMoveTextAlongShapeFeedback
Returns:
The parallel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParallel

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

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

getConstraint

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getConstraint in interface IMoveTextAlongShapeFeedback
Returns:
A com.esri.arcgis.display.esriMoveTextConstraints constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConstraint

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

Product Availability

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

Specified by:
setConstraint in interface IMoveTextAlongShapeFeedback
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.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws IOException,
                           AutomationException
The symbol the feedback object will use.

Description

Set Symbol to LineSymbol while working with NewLineFeedback object or to MarkerSymbol with NewMultiPointFeedBack object and so on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbolByRef in interface IDisplayFeedback
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

public ISymbol getSymbol()
                  throws IOException,
                         AutomationException
The symbol the feedback object will use.

Description

Set Symbol to LineSymbol while working with NewLineFeedback object or to MarkerSymbol with NewMultiPointFeedBack object and so on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSymbol in interface IDisplayFeedback
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.

setDisplayByRef

public void setDisplayByRef(IScreenDisplay rhs1)
                     throws IOException,
                            AutomationException
The display the feedback object will use.

Description

Set Display to associate with the screen display area for drawing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayByRef in interface IDisplayFeedback
Parameters:
rhs1 - A reference to a com.esri.arcgis.display.IScreenDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh(int hDC)
             throws IOException,
                    AutomationException
Call this after a refresh to show feedback again.

Description

Refresh redraws the associated screen display area.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
refresh in interface IDisplayFeedback
Parameters:
hDC - The hDC (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

moveTo

public void moveTo(IPoint point)
            throws IOException,
                   AutomationException
Move to the new point.

Description

MoveTo moves to the new location specified by the input. Usually, include this method in the MouseMove event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
moveTo in interface IDisplayFeedback
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.