com.esri.arcgis.display
Class MoveTextAlongShapeFeedback

java.lang.Object
  com.esri.arcgis.display.MoveTextAlongShapeFeedback

All Implemented Interfaces:

IDisplayFeedback, IMoveTextAlongShapeFeedback, java.io.Serializable

public class MoveTextAlongShapeFeedback

extends java.lang.Object

implements 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(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
void	followShape(IGeometry featureGeometry, double referenceScale) Specify the shape to follow.
IMoveTextAlongShapeFeedback	getAsIMoveTextAlongShapeFeedback() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	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

Constructor Detail

MoveTextAlongShapeFeedback

public MoveTextAlongShapeFeedback()
                           throws java.io.IOException,
                                  java.net.UnknownHostException

Constructs a MoveTextAlongShapeFeedback using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MoveTextAlongShapeFeedback

public MoveTextAlongShapeFeedback(java.lang.Object obj)
                           throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
MoveTextAlongShapeFeedback theMoveTextAlongShapeFeedback = (MoveTextAlongShapeFeedback) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIMoveTextAlongShapeFeedback

public IMoveTextAlongShapeFeedback getAsIMoveTextAlongShapeFeedback()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

followShape

public void followShape(IGeometry featureGeometry,
                        double referenceScale)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMoveTextAlongShapeFeedback

Specify the shape to follow.

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:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

startCurved

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

Description copied from interface: IMoveTextAlongShapeFeedback

Begins a move feedback of the given shape.

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:

java.io.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 java.io.IOException,
                          AutomationException

Description copied from interface: IMoveTextAlongShapeFeedback

Begins a move feedback of the given shape.

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:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

stop

public IGeometry stop()
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IMoveTextAlongShapeFeedback

Stops the feedback and returns the shape.

Supported Platforms

Windows, Solaris, Linux

Specified by:

stop in interface IMoveTextAlongShapeFeedback

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

Description copied from interface: IMoveTextAlongShapeFeedback

Indicates whether to flip the text.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFlip in interface IMoveTextAlongShapeFeedback

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

Description copied from interface: IMoveTextAlongShapeFeedback

Indicates whether to flip the text.

Specified by:

setFlip in interface IMoveTextAlongShapeFeedback

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

Description copied from interface: IMoveTextAlongShapeFeedback

Offset the text from the geometry.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOffset in interface IMoveTextAlongShapeFeedback

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

Description copied from interface: IMoveTextAlongShapeFeedback

Offset the text from the geometry.

Specified by:

setOffset in interface IMoveTextAlongShapeFeedback

Parameters:

offset - The offset (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isParallel

public boolean isParallel()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IMoveTextAlongShapeFeedback

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isParallel in interface IMoveTextAlongShapeFeedback

Returns:

The parallel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParallel

public void setParallel(boolean parallel)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMoveTextAlongShapeFeedback

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

Specified by:

setParallel in interface IMoveTextAlongShapeFeedback

Parameters:

parallel - The parallel (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getConstraint

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

Description copied from interface: IMoveTextAlongShapeFeedback

Constrain the text.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConstraint in interface IMoveTextAlongShapeFeedback

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

Description copied from interface: IMoveTextAlongShapeFeedback

Constrain the text.

Specified by:

setConstraint in interface IMoveTextAlongShapeFeedback

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IDisplayFeedback

The symbol the feedback object will use.

Specified by:

setSymbolByRef in interface IDisplayFeedback

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getSymbol

public ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDisplayFeedback

The symbol the feedback object will use.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSymbol in interface IDisplayFeedback

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayByRef

public void setDisplayByRef(IScreenDisplay rhs1)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IDisplayFeedback

The display the feedback object will use.

Specified by:

setDisplayByRef in interface IDisplayFeedback

Parameters:

rhs1 - A reference to a com.esri.arcgis.display.IScreenDisplay (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

refresh

public void refresh(int hDC)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IDisplayFeedback

Call this after a refresh to show feedback again.

Supported Platforms

Windows, Solaris, Linux

Description

Refresh redraws the associated screen display area.

Specified by:

refresh in interface IDisplayFeedback

Parameters:

hDC - The hDC (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveTo

public void moveTo(IPoint point)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IDisplayFeedback

Move to the new point.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

moveTo in interface IDisplayFeedback

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.