com.esri.arcgis.display
Class VertexFeedback

java.lang.Object
  extended by com.esri.arcgis.display.VertexFeedback
All Implemented Interfaces:
IDisplayFeedback, IVertexFeedback, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class VertexFeedback
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IVertexFeedback

Vertex Display Feedback Object.

Description

The VertexFeedback object allows one or more individual segments to be moved on the display by the user. Like the NewMultiPointFeedback, the VertexFeedback does not return an object at the end of the operation and is used for visual feedback only. The segments in question donít need to belong to the same geometry or even type of geometry. This allows, for example, a segment from a polygon to be moved along with some segments from a polyline or, alternatively, the moving of vertices (and segments) that are part of a shared polygon boundary.

Vertex feedbacks are used to alter paths and rings by moving their vertices and any adjacent segments. Segments are added one by one with either their FromPoint or ToPoint as an anchor. Multiple segments, which may come from different geometry objects, can be moved at the same time. No geometry objects are returned on completion.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
VertexFeedback()
          Constructs a VertexFeedback using ArcGIS Engine.
VertexFeedback(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
VertexFeedback theVertexFeedback = (VertexFeedback) obj;
 
Method Summary
 void addSegment(ISegment segment, boolean fromPointIsAnchor)
          Adds an edge to rubberband.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 ISymbol getSymbol()
          The symbol the feedback object will use.
 int hashCode()
          the hashcode for this object
 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 setSymbolByRef(ISymbol symbol)
          The symbol the feedback object will use.
 
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

VertexFeedback

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

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

VertexFeedback

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

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

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

addSegment

public void addSegment(ISegment segment,
                       boolean fromPointIsAnchor)
                throws IOException,
                       AutomationException
Adds an edge to rubberband.

Description

Adds the segments and specifies which end to use as the anchor point. Each time AddSegment is called, a check is made to see if the segment has already been added; if it has, then it is not added a second time. The methods used to move, symbolize, refresh, and setup the display are accessed through the inherited IDisplayFeedback interface. Since there is no Start method, the first call to MoveTo will begin the feedback operation, that is, draw the feedback, and the feedback will be redrawn with each subsequent MoveTo. To finish the operation, the feedback object should be cleared and the display refreshed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addSegment in interface IVertexFeedback
Parameters:
segment - A reference to a com.esri.arcgis.geometry.ISegment (in)
fromPointIsAnchor - The fromPointIsAnchor (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.