com.esri.arcgis.carto
Class NewDimensionFeedback

java.lang.Object
  com.esri.arcgis.carto.NewDimensionFeedback

All Implemented Interfaces:

IDisplayFeedback, INewDimensionFeedback, java.io.Serializable

public class NewDimensionFeedback

extends java.lang.Object

implements IDisplayFeedback, INewDimensionFeedback

A display feedback for creating new dimension features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

NewDimensionFeedback()
Constructs a NewDimensionFeedback using ArcGIS Engine.

NewDimensionFeedback(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	addPoint(IPoint point) Adds a point to the display feedback.
boolean	equals(java.lang.Object o) Compare this object with another
IDisplayFeedback	getAsIDisplayFeedback() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
INewDimensionFeedback	getAsINewDimensionFeedback() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	getClsid()
int	getDimensionType() The dimension type of the display feedback.
double	getReferenceScale() The reference scale of the display feedback.
int	getReferenceScaleUnits() The reference scale units of the display feedback.
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	setDimensionType(int type) The dimension type of the display feedback.
void	setDisplayByRef(IScreenDisplay rhs1) The display the feedback object will use.
void	setReferenceScale(double scale) The reference scale of the display feedback.
void	setReferenceScaleUnits(int units) The reference scale units of the display feedback.
void	setStyle(IDimensionStyle rhs1) The dimension style for the display feedback.
void	setSymbolByRef(ISymbol symbol) The symbol the feedback object will use.
void	start(IPoint begin) Starts the display feedback.
IDimensionShape	stop() Stops the display feedback and returns the points.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NewDimensionFeedback

public NewDimensionFeedback()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a NewDimensionFeedback using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NewDimensionFeedback

public NewDimensionFeedback(java.lang.Object obj)
                     throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a NewDimensionFeedback using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NewDimensionFeedback.
NewDimensionFeedback theNewDimensionFeedback = (NewDimensionFeedback) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIDisplayFeedback

public IDisplayFeedback getAsIDisplayFeedback()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsINewDimensionFeedback

public INewDimensionFeedback getAsINewDimensionFeedback()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IDisplayFeedback

The symbol the feedback object will use.

Specified by:

setSymbolByRef in interface IDisplayFeedback

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getSymbol

public ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IDisplayFeedback

The symbol the feedback object will use.

Supported Platforms

Windows, Solaris, Linux

Description

Set Symbol to LineSymbol while working with NewLineFeedback object or to MarkerSymbol with NewMultiPointFeedBack object and so on.

Specified by:

getSymbol in interface IDisplayFeedback

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayByRef

public void setDisplayByRef(IScreenDisplay rhs1)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IDisplayFeedback

The display the feedback object will use.

Specified by:

setDisplayByRef in interface IDisplayFeedback

Parameters:

rhs1 - A reference to a com.esri.arcgis.display.IScreenDisplay (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

refresh

public void refresh(int hDC)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IDisplayFeedback

Call this after a refresh to show feedback again.

Supported Platforms

Windows, Solaris, Linux

Description

Refresh redraws the associated screen display area.

Specified by:

refresh in interface IDisplayFeedback

Parameters:

hDC - The hDC (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveTo

public void moveTo(IPoint point)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IDisplayFeedback

Move to the new point.

Supported Platforms

Windows, Solaris, Linux

Description

MoveTo moves to the new location specified by the input. Usually, include this method in the MouseMove event.

Specified by:

moveTo in interface IDisplayFeedback

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setStyle

public void setStyle(IDimensionStyle rhs1)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: INewDimensionFeedback

The dimension style for the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStyle in interface INewDimensionFeedback

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IDimensionStyle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

start

public void start(IPoint begin)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: INewDimensionFeedback

Starts the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

start in interface INewDimensionFeedback

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addPoint

public void addPoint(IPoint point)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: INewDimensionFeedback

Adds a point to the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addPoint in interface INewDimensionFeedback

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

stop

public IDimensionShape stop()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: INewDimensionFeedback

Stops the display feedback and returns the points.

Supported Platforms

Windows, Solaris, Linux

Specified by:

stop in interface INewDimensionFeedback

Returns:

A reference to a com.esri.arcgis.carto.IDimensionShape

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getDimensionType

public int getDimensionType()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: INewDimensionFeedback

The dimension type of the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDimensionType in interface INewDimensionFeedback

Returns:

A com.esri.arcgis.carto.esriDimensionType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setDimensionType

public void setDimensionType(int type)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: INewDimensionFeedback

The dimension type of the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDimensionType in interface INewDimensionFeedback

Parameters:

type - A com.esri.arcgis.carto.esriDimensionType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: INewDimensionFeedback

The reference scale of the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceScale in interface INewDimensionFeedback

Returns:

The scale

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setReferenceScale

public void setReferenceScale(double scale)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: INewDimensionFeedback

The reference scale of the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceScale in interface INewDimensionFeedback

Parameters:

scale - The scale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScaleUnits

public int getReferenceScaleUnits()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: INewDimensionFeedback

The reference scale units of the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceScaleUnits in interface INewDimensionFeedback

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setReferenceScaleUnits

public void setReferenceScaleUnits(int units)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: INewDimensionFeedback

The reference scale units of the display feedback.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceScaleUnits in interface INewDimensionFeedback

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.