com.esri.arcgis.display
Class NewCircleFeedback

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

All Implemented Interfaces:

IDisplayFeedback, IDisplayFeedback2, INewCircleFeedback, INewCircleFeedback2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NewCircleFeedback
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INewCircleFeedback2, IDisplayFeedback2

New circle feedback object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

NewCircleFeedback()
Constructs a NewCircleFeedback using ArcGIS Engine.

NewCircleFeedback(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NewCircleFeedback theNewCircleFeedback = (NewCircleFeedback) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
ICircularArc	getCircle() Get the current circle being constructed.
static String	getClsid() getClsid.
ISymbol	getRadiusLineSymbol() Set the symbol for the radius line.
ISymbol	getSymbol() The symbol the feedback object will use.
int	hashCode() the hashcode for this object
boolean	isSymbolIsWYSIWYG() Determines whether the feedback symbol scales with the display.
boolean	isUseReferenceScale() Determines whether the feedback symbol should respect reference scale.
void	moveTo(IPoint point) Move to the new point.
void	refresh(int hDC) Call this after a refresh to show feedback again.
void	setDisplayByRef(IScreenDisplay rhs1) The display the feedback object will use.
void	setRadiusLineSymbolByRef(ISymbol ppSymbol) Set the symbol for the radius line.
void	setSymbolByRef(ISymbol symbol) The symbol the feedback object will use.
void	setSymbolIsWYSIWYG(boolean isWYSIWYG) Determines whether the feedback symbol scales with the display.
void	setUseReferenceScale(boolean respectsRefScale) Determines whether the feedback symbol should respect reference scale.
void	start(IPoint point) Begins a circular feedback at the given point.
ICircularArc	stop() Stops the feedback and returns the circle.

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

NewCircleFeedback

public NewCircleFeedback()
                  throws IOException,
                         UnknownHostException

Constructs a NewCircleFeedback using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NewCircleFeedback

public NewCircleFeedback(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NewCircleFeedback theNewCircleFeedback = (NewCircleFeedback) obj;

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

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

setRadiusLineSymbolByRef

public void setRadiusLineSymbolByRef(ISymbol ppSymbol)
                              throws IOException,
                                     AutomationException

Set the symbol for the radius line.

Product Availability

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

Specified by:

setRadiusLineSymbolByRef in interface INewCircleFeedback2

Parameters:

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

getRadiusLineSymbol

public ISymbol getRadiusLineSymbol()
                            throws IOException,
                                   AutomationException

Set the symbol for the radius line.

Product Availability

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

Specified by:

getRadiusLineSymbol in interface INewCircleFeedback2

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.

getCircle

public ICircularArc getCircle()
                       throws IOException,
                              AutomationException

Get the current circle being constructed.

Product Availability

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

Specified by:

getCircle in interface INewCircleFeedback2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

start

public void start(IPoint point)
           throws IOException,
                  AutomationException

Begins a circular feedback at the given point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

start in interface INewCircleFeedback

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.

stop

public ICircularArc stop()
                  throws IOException,
                         AutomationException

Stops the feedback and returns the circle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

stop in interface INewCircleFeedback

Returns:

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

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.

isSymbolIsWYSIWYG

public boolean isSymbolIsWYSIWYG()
                          throws IOException,
                                 AutomationException

Determines whether the feedback symbol scales with the display.

Product Availability

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

Specified by:

isSymbolIsWYSIWYG in interface IDisplayFeedback2

Returns:

The isWYSIWYG

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolIsWYSIWYG

public void setSymbolIsWYSIWYG(boolean isWYSIWYG)
                        throws IOException,
                               AutomationException

Determines whether the feedback symbol scales with the display.

Product Availability

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

Specified by:

setSymbolIsWYSIWYG in interface IDisplayFeedback2

Parameters:

isWYSIWYG - The isWYSIWYG (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseReferenceScale

public boolean isUseReferenceScale()
                            throws IOException,
                                   AutomationException

Determines whether the feedback symbol should respect reference scale.

Product Availability

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

Specified by:

isUseReferenceScale in interface IDisplayFeedback2

Returns:

The respectsRefScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseReferenceScale

public void setUseReferenceScale(boolean respectsRefScale)
                          throws IOException,
                                 AutomationException

Determines whether the feedback symbol should respect reference scale.

Product Availability

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

Specified by:

setUseReferenceScale in interface IDisplayFeedback2

Parameters:

respectsRefScale - The respectsRefScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.