com.esri.arcgis.display
Class MoveTextFeedback

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

All Implemented Interfaces:

IDisplayFeedback, IMoveTextFeedback, java.io.Serializable

public class MoveTextFeedback

extends java.lang.Object

implements IMoveTextFeedback

Move Text 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

MoveTextFeedback()
Constructs a MoveTextFeedback using ArcGIS Engine.

MoveTextFeedback(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.
IMoveTextFeedback	getAsIMoveTextFeedback() 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	start(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

MoveTextFeedback

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

Constructs a MoveTextFeedback using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MoveTextFeedback

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

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

Construct a MoveTextFeedback using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MoveTextFeedback.
MoveTextFeedback theMoveTextFeedback = (MoveTextFeedback) 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()

getAsIMoveTextFeedback

public IMoveTextFeedback getAsIMoveTextFeedback()

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: IMoveTextFeedback

Specify the shape to follow.

Supported Platforms

Windows, Solaris, Linux

Specified by:

followShape in interface IMoveTextFeedback

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(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: IMoveTextFeedback

Begins a move feedback of the given shape.

Supported Platforms

Windows, Solaris, Linux

Specified by:

start in interface IMoveTextFeedback

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: IMoveTextFeedback

Stops the feedback and returns the shape.

Supported Platforms

Windows, Solaris, Linux

Specified by:

stop in interface IMoveTextFeedback

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isFlip

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

Description copied from interface: IMoveTextFeedback

Indicates whether to flip the text.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFlip in interface IMoveTextFeedback

Returns:

The flip

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFlip

public void setFlip(boolean flip)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IMoveTextFeedback

Indicates whether to flip the text.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFlip in interface IMoveTextFeedback

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: IMoveTextFeedback

Offset the text from the geometry.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOffset in interface IMoveTextFeedback

Returns:

The offset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setOffset

public void setOffset(double offset)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IMoveTextFeedback

Offset the text from the geometry.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOffset in interface IMoveTextFeedback

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: IMoveTextFeedback

Indicates whether to make the text parallel.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isParallel in interface IMoveTextFeedback

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: IMoveTextFeedback

Indicates whether to make the text parallel.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setParallel in interface IMoveTextFeedback

Parameters:

parallel - The parallel (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

Description copied from interface: IMoveTextFeedback

Constrain the text.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConstraint in interface IMoveTextFeedback

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: IMoveTextFeedback

Constrain the text.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setConstraint in interface IMoveTextFeedback

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.

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.