com.esri.arcgis.display
Class NewRectangleFeedback

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

All Implemented Interfaces:

IDisplayFeedback, IDisplayFeedback2, INewRectangleFeedback, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NewRectangleFeedback
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDisplayFeedback2, INewRectangleFeedback

New Rectangle Feedback Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NewRectangleFeedback()
Constructs a NewRectangleFeedback using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
double	getAngle() The angle of the current rectangle being constructed.
double	getAspectRatio() The aspect ratio for the custom constraint type.
static String	getClsid() getClsid.
int	getConstraint() The constraint on this rubberbander.
double	getLength() The length of the current rectangle being constructed.
ISymbol	getSymbol() The symbol the feedback object will use.
double	getWidth() The width of the current rectangle being constructed.
int	hashCode() the hashcode for this object
boolean	isEnvelope() Indicates whether the rectangle is an envelope or angled.
boolean	isSnapLength() Indicates whether the rectangle's length is fixed.
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	setAngle(double angle) The angle of the current rectangle being constructed.
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	setIsEnvelope(boolean isEnvelope) Indicates whether the rectangle is an envelope or angled.
void	setLength(double length) The length of the current rectangle being constructed.
void	setPoint(IPoint point) Set the location of the second location.
void	setSnapLength(boolean snapLength) Indicates whether the rectangle's length is fixed.
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	setWidth(double width) The width of the current rectangle being constructed.
void	start(IPoint point) Begins a normal feedback at the given point.
IGeometry	stop(IPoint point) 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

NewRectangleFeedback

public NewRectangleFeedback()
                     throws IOException,
                            UnknownHostException

Constructs a NewRectangleFeedback using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NewRectangleFeedback

public NewRectangleFeedback(Object obj)
                     throws IOException

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

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

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

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.

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.

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.

Specified by:

start in interface INewRectangleFeedback

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.

setPoint

public void setPoint(IPoint point)
              throws IOException,
                     AutomationException

Set the location of the second location.

Product Availability

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

Specified by:

setPoint in interface INewRectangleFeedback

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 IGeometry stop(IPoint point)
               throws IOException,
                      AutomationException

Stops the feedback and returns the shape.

Product Availability

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

Specified by:

stop in interface INewRectangleFeedback

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

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.

getLength

public double getLength()
                 throws IOException,
                        AutomationException

The length of the current rectangle being constructed.

Product Availability

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

Specified by:

getLength in interface INewRectangleFeedback

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLength

public void setLength(double length)
               throws IOException,
                      AutomationException

The length of the current rectangle being constructed.

Product Availability

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

Specified by:

setLength in interface INewRectangleFeedback

Parameters:

length - The length (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws IOException,
                       AutomationException

The width of the current rectangle being constructed.

Product Availability

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

Specified by:

getWidth in interface INewRectangleFeedback

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(double width)
              throws IOException,
                     AutomationException

The width of the current rectangle being constructed.

Product Availability

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

Specified by:

setWidth in interface INewRectangleFeedback

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

public double getAngle()
                throws IOException,
                       AutomationException

The angle of the current rectangle being constructed.

Product Availability

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

Specified by:

getAngle in interface INewRectangleFeedback

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngle

public void setAngle(double angle)
              throws IOException,
                     AutomationException

The angle of the current rectangle being constructed.

Product Availability

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

Specified by:

setAngle in interface INewRectangleFeedback

Parameters:

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnvelope

public boolean isEnvelope()
                   throws IOException,
                          AutomationException

Indicates whether the rectangle is an envelope or angled.

Product Availability

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

Specified by:

isEnvelope in interface INewRectangleFeedback

Returns:

The isEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsEnvelope

public void setIsEnvelope(boolean isEnvelope)
                   throws IOException,
                          AutomationException

Indicates whether the rectangle is an envelope or angled.

Product Availability

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

Specified by:

setIsEnvelope in interface INewRectangleFeedback

Parameters:

isEnvelope - The isEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSnapLength

public boolean isSnapLength()
                     throws IOException,
                            AutomationException

Indicates whether the rectangle's length is fixed.

Product Availability

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

Specified by:

isSnapLength in interface INewRectangleFeedback

Returns:

The snapLength

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapLength

public void setSnapLength(boolean snapLength)
                   throws IOException,
                          AutomationException

Indicates whether the rectangle's length is fixed.

Product Availability

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

Specified by:

setSnapLength in interface INewRectangleFeedback

Parameters:

snapLength - The snapLength (in)

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.

Specified by:

getConstraint in interface INewRectangleFeedback

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.

Specified by:

setConstraint in interface INewRectangleFeedback

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.

Specified by:

getAspectRatio in interface INewRectangleFeedback

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.

Specified by:

setAspectRatio in interface INewRectangleFeedback

Parameters:

aspectRatio - The aspectRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.