com.esri.arcgis.display
Interface INewRectangleFeedback

All Superinterfaces:

IDisplayFeedback, IDisplayFeedback2, Serializable

All Known Implementing Classes:

NewRectangleFeedback

public interface INewRectangleFeedback
extends IDisplayFeedback2, Serializable

Provides access to members that control the creation of a new rectangle.

Product Availability

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

Method Summary

double	getAngle() The angle of the current rectangle being constructed.
double	getAspectRatio() The aspect ratio for the custom constraint type.
int	getConstraint() The constraint on this rubberbander.
double	getLength() The length of the current rectangle being constructed.
double	getWidth() The width of the current rectangle being constructed.
boolean	isEnvelope() Indicates whether the rectangle is an envelope or angled.
boolean	isSnapLength() Indicates whether the rectangle's length is fixed.
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	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	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 interface com.esri.arcgis.display.IDisplayFeedback2

isSymbolIsWYSIWYG, isUseReferenceScale, setSymbolIsWYSIWYG, setUseReferenceScale

Methods inherited from interface com.esri.arcgis.display.IDisplayFeedback

getSymbol, moveTo, refresh, setDisplayByRef, setSymbolByRef

Method Detail

start

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.

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

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.

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

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.

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

double getLength()
                 throws IOException,
                        AutomationException

The length of the current rectangle being constructed.

Product Availability

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

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLength

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.

Parameters:

length - The length (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

double getWidth()
                throws IOException,
                       AutomationException

The width of the current rectangle being constructed.

Product Availability

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

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

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.

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngle

double getAngle()
                throws IOException,
                       AutomationException

The angle of the current rectangle being constructed.

Product Availability

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

Returns:

The angle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngle

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.

Parameters:

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnvelope

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.

Returns:

The isEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsEnvelope

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.

Parameters:

isEnvelope - The isEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSnapLength

boolean isSnapLength()
                     throws IOException,
                            AutomationException

Indicates whether the rectangle's length is fixed.

Product Availability

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

Returns:

The snapLength

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapLength

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.

Parameters:

snapLength - The snapLength (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConstraint

int getConstraint()
                  throws IOException,
                         AutomationException

The constraint on this rubberbander.

Product Availability

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

Returns:

A com.esri.arcgis.display.esriEnvelopeConstraints constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstraint

void setConstraint(int constrain)
                   throws IOException,
                          AutomationException

The constraint on this rubberbander.

Product Availability

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

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

double getAspectRatio()
                      throws IOException,
                             AutomationException

The aspect ratio for the custom constraint type.

Product Availability

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

Returns:

The aspectRatio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAspectRatio

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.

Parameters:

aspectRatio - The aspectRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.