com.esri.arcgis.display
Class NewEnvelopeFeedback

java.lang.Object
  extended by com.esri.arcgis.display.NewEnvelopeFeedback
All Implemented Interfaces:
IDisplayFeedback, INewEnvelopeFeedback, INewEnvelopeFeedback2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NewEnvelopeFeedback
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INewEnvelopeFeedback, INewEnvelopeFeedback2

New Envelope 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
NewEnvelopeFeedback()
          Constructs a NewEnvelopeFeedback using ArcGIS Engine.
NewEnvelopeFeedback(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NewEnvelopeFeedback theNewEnvelopeFeedback = (NewEnvelopeFeedback) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 double getAspectRatio()
          The aspect ratio for the custom constraint type.
static String getClsid()
          getClsid.
 int getConstraint()
          The constraint on this rubberbander.
 ISymbol getSymbol()
          The symbol the feedback object will use.
 int hashCode()
          the hashcode for this object
 IGeometry INewEnvelopeFeedback2_stop()
          Stops the feedback and returns the shape.
 void moveTo(IPoint point)
          Move to the new point.
 void refresh(int hDC)
          Call this after a refresh to show feedback again.
 void setAspectRatio(double aspectRatio)
          The aspect ratio for the custom constraint type.
 void setConstraint(int constrain)
          The constraint on this rubberbander.
 void setDisplayByRef(IScreenDisplay rhs1)
          The display the feedback object will use.
 void setSymbolByRef(ISymbol symbol)
          The symbol the feedback object will use.
 void start(IPoint point)
          Begins a normal feedback at the given point.
 IEnvelope stop()
          Stops the feedback and returns the shape.
 
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

NewEnvelopeFeedback

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

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

NewEnvelopeFeedback

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

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

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(IPoint point)
           throws IOException,
                  AutomationException
Begins a normal 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 INewEnvelopeFeedback
Specified by:
start in interface INewEnvelopeFeedback2
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 IEnvelope stop()
               throws IOException,
                      AutomationException
Stops the feedback and returns the shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getConstraint

public int getConstraint()
                  throws IOException,
                         AutomationException
The constraint on this rubberbander.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getConstraint in interface INewEnvelopeFeedback
Specified by:
getConstraint in interface INewEnvelopeFeedback2
Returns:
A com.esri.arcgis.display.esriEnvelopeConstraints constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConstraint

public void setConstraint(int constrain)
                   throws IOException,
                          AutomationException
The constraint on this rubberbander.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setConstraint in interface INewEnvelopeFeedback
Specified by:
setConstraint in interface INewEnvelopeFeedback2
Parameters:
constrain - A com.esri.arcgis.display.esriEnvelopeConstraints constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAspectRatio

public double getAspectRatio()
                      throws IOException,
                             AutomationException
The aspect ratio for the custom constraint type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAspectRatio in interface INewEnvelopeFeedback
Specified by:
getAspectRatio in interface INewEnvelopeFeedback2
Returns:
The aspectRatio
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAspectRatio

public void setAspectRatio(double aspectRatio)
                    throws IOException,
                           AutomationException
The aspect ratio for the custom constraint type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAspectRatio in interface INewEnvelopeFeedback
Specified by:
setAspectRatio in interface INewEnvelopeFeedback2
Parameters:
aspectRatio - The aspectRatio (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.

INewEnvelopeFeedback2_stop

public IGeometry INewEnvelopeFeedback2_stop()
                                     throws IOException,
                                            AutomationException
Stops the feedback and returns the shape. Shape may not be an envelope if the display is rotated.

Product Availability

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

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