com.esri.arcgis.display
Class NewArcFeedback

java.lang.Object
  extended by com.esri.arcgis.display.NewArcFeedback
All Implemented Interfaces:
IDisplayFeedback, IDisplayFeedback2, INewArcFeedback, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NewArcFeedback
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDisplayFeedback, IDisplayFeedback2, INewArcFeedback

Feedback object for creating a new circular arc.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NewArcFeedback()
          Constructs a NewArcFeedback using ArcGIS Engine.
NewArcFeedback(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NewArcFeedback theNewArcFeedback = (NewArcFeedback) obj;
 
Method Summary
 void abort()
          Abort the feedback.
 boolean equals(Object o)
          Compare this object with another
 ICircularArc getArc()
          The arc as it is currently being drawn.
static String getClsid()
          getClsid.
 double getRadius()
          The current radius of the arc.
 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 next(boolean forward)
          Switch the feedback to the next solution.
 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 setEndpoint(IPoint point)
          Fix the to point of the arc.
 void setMidpoint(IPoint point)
          Fix a midpoint of the arc.
 void setRadius(double radius)
          The current radius of the arc.
 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)
          Start the feedback, for an arc with the specified from point.
 void startTangent(IPoint point, ISegment tangent)
          Start the feedback, fo an ar with the specified from point & tangent direction.
 void stop(IPoint point, ICircularArc[] arc)
          Stop the feedback, returning the final arc.
 
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

NewArcFeedback

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

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

NewArcFeedback

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

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

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

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.

start

public void start(IPoint point)
           throws IOException,
                  AutomationException
Start the feedback, for an arc with the specified from point.

Product Availability

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

Specified by:
start in interface INewArcFeedback
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.

startTangent

public void startTangent(IPoint point,
                         ISegment tangent)
                  throws IOException,
                         AutomationException
Start the feedback, fo an ar with the specified from point & tangent direction.

Product Availability

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

Specified by:
startTangent in interface INewArcFeedback
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
tangent - A reference to a com.esri.arcgis.geometry.ISegment (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndpoint

public void setEndpoint(IPoint point)
                 throws IOException,
                        AutomationException
Fix the to point of the arc.

Product Availability

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

Specified by:
setEndpoint in interface INewArcFeedback
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.

setMidpoint

public void setMidpoint(IPoint point)
                 throws IOException,
                        AutomationException
Fix a midpoint of the arc.

Product Availability

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

Specified by:
setMidpoint in interface INewArcFeedback
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.

next

public void next(boolean forward)
          throws IOException,
                 AutomationException
Switch the feedback to the next solution.

Product Availability

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

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

getRadius

public double getRadius()
                 throws IOException,
                        AutomationException
The current radius of the arc.

Product Availability

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

Specified by:
getRadius in interface INewArcFeedback
Returns:
The radius
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRadius

public void setRadius(double radius)
               throws IOException,
                      AutomationException
The current radius of the arc.

Product Availability

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

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

getArc

public ICircularArc getArc()
                    throws IOException,
                           AutomationException
The arc as it is currently being drawn.

Product Availability

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

Specified by:
getArc in interface INewArcFeedback
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.

stop

public void stop(IPoint point,
                 ICircularArc[] arc)
          throws IOException,
                 AutomationException
Stop the feedback, returning the final arc.

Product Availability

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

Specified by:
stop in interface INewArcFeedback
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
arc - A reference to a com.esri.arcgis.geometry.ICircularArc (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

abort

public void abort()
           throws IOException,
                  AutomationException
Abort the feedback.

Product Availability

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

Specified by:
abort in interface INewArcFeedback
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.