com.esri.arcgis.display
Class StretchLineFeedback

java.lang.Object
  extended by com.esri.arcgis.display.StretchLineFeedback
All Implemented Interfaces:
IDisplayFeedback, IGeodeticLineFeedback, IStretchLineFeedback, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class StretchLineFeedback
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IStretchLineFeedback, IGeodeticLineFeedback

Stretch Line 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
StretchLineFeedback()
          Constructs a StretchLineFeedback using ArcGIS Engine.
StretchLineFeedback(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StretchLineFeedback theStretchLineFeedback = (StretchLineFeedback) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getGeodeticConstructionMethod()
          The geodetic construction method.
 ISpatialReference getSpatialReference()
          The spatial reference of the feedback line.
 ISymbol getSymbol()
          The symbol the feedback object will use.
 int hashCode()
          the hashcode for this object
 boolean isUseGeodeticConstruction()
          Specifies if geodetic construction will be used.
 void moveTo(IPoint point)
          Move to the new point.
 void refresh(int hDC)
          Call this after a refresh to show feedback again.
 void setAnchor(IPoint rhs1)
          The anchor point of the curve.
 void setDisplayByRef(IScreenDisplay rhs1)
          The display the feedback object will use.
 void setGeodeticConstructionMethod(int gType)
          The geodetic construction method.
 void setSpatialReferenceByRef(ISpatialReference sr)
          The spatial reference of the feedback line.
 void setSymbolByRef(ISymbol symbol)
          The symbol the feedback object will use.
 void setUseGeodeticConstruction(boolean flag)
          Specifies if geodetic construction will be used.
 void start(IPolyline polyline, IPoint point)
          Begins a move of the given shape (a polyline).
 IPolyline stop()
          Stops the feedback and returns the polyline.
 
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

StretchLineFeedback

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

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

StretchLineFeedback

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

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

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

start

public void start(IPolyline polyline,
                  IPoint point)
           throws IOException,
                  AutomationException
Begins a move of the given shape (a polyline).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
start in interface IStretchLineFeedback
Parameters:
polyline - A reference to a com.esri.arcgis.geometry.IPolyline (in)
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 IPolyline stop()
               throws IOException,
                      AutomationException
Stops the feedback and returns the polyline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
stop in interface IStretchLineFeedback
Returns:
A reference to a com.esri.arcgis.geometry.IPolyline
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnchor

public void setAnchor(IPoint rhs1)
               throws IOException,
                      AutomationException
The anchor point of the curve.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAnchor in interface IStretchLineFeedback
Parameters:
rhs1 - 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.

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.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException
The spatial reference of the feedback line.

Product Availability

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

Specified by:
getSpatialReference in interface IGeodeticLineFeedback
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference sr)
                              throws IOException,
                                     AutomationException
The spatial reference of the feedback line.

Product Availability

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

Specified by:
setSpatialReferenceByRef in interface IGeodeticLineFeedback
Parameters:
sr - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseGeodeticConstruction

public boolean isUseGeodeticConstruction()
                                  throws IOException,
                                         AutomationException
Specifies if geodetic construction will be used.

Product Availability

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

Specified by:
isUseGeodeticConstruction in interface IGeodeticLineFeedback
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseGeodeticConstruction

public void setUseGeodeticConstruction(boolean flag)
                                throws IOException,
                                       AutomationException
Specifies if geodetic construction will be used.

Product Availability

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

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

getGeodeticConstructionMethod

public int getGeodeticConstructionMethod()
                                  throws IOException,
                                         AutomationException
The geodetic construction method.

Product Availability

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

Specified by:
getGeodeticConstructionMethod in interface IGeodeticLineFeedback
Returns:
A com.esri.arcgis.geometry.esriGeodeticType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeodeticConstructionMethod

public void setGeodeticConstructionMethod(int gType)
                                   throws IOException,
                                          AutomationException
The geodetic construction method.

Product Availability

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

Specified by:
setGeodeticConstructionMethod in interface IGeodeticLineFeedback
Parameters:
gType - A com.esri.arcgis.geometry.esriGeodeticType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.