com.esri.arcgis.editor
Class FreeLinearConstructor

java.lang.Object
  extended by com.esri.arcgis.editor.FreeLinearConstructor
All Implemented Interfaces:
IDimensionConstructor, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class FreeLinearConstructor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDimensionConstructor, ISupportErrorInfo

A dimension feature constructor for creating linear dimension features.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
FreeLinearConstructor()
          Constructs a FreeLinearConstructor using ArcGIS Engine.
FreeLinearConstructor(Object obj)
          Construct a FreeLinearConstructor using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void addFeedbackPoint(IPoint point)
          Adds a point to the display feedback.
 void constructDimension(IDimensionFeature feature, IGeometry geometry, IDimensionStyle style)
          Creates the dimension shape for a dimension feature given the geometry constructed in the dimension constructor.
 IDisplayFeedback createFeedback()
          The display feedback for the constructor.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getDimensionType()
          The type of dimension created with the dimension constructor.
 String getName()
          Name of the dimension constructor.
 int getSketchGeometryType()
          The type of geometry used for the edit sketch constructor.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isCanFinish(IGeometry sketchGeometry)
          Indicates if the dimension feature can be constructed given the number of points in the edit sketch.
 boolean isHasFeedback()
          Indicates if the constructor will use a custom feedback.
 void shutdown()
          The constructor start event.
 void startFeedback(IPoint point, IDimensionStyle style)
          Starts the display feedback for the dimension constructor.
 void startFeedbackFromShape(IGeometry shape, IDimensionStyle style)
          Starts the display feedback for the dimension constructor from an existing geometry.
 void startup(IDimensionEditExtension extension)
          The dimension editor extension.
 void stopFeedback()
          Stops the display feedback.
 
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

FreeLinearConstructor

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

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

FreeLinearConstructor

public FreeLinearConstructor(Object obj)
                      throws IOException
Construct a FreeLinearConstructor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FreeLinearConstructor.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems FreeLinearConstructor theFreeLinearConstructor = (FreeLinearConstructor) obj;
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

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the dimension constructor.

Remarks

Returns the name of the dimension constructor. This is the name listed in the Dimension Constructors control on the Dimensioning toolbar.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getName in interface IDimensionConstructor
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSketchGeometryType

public int getSketchGeometryType()
                          throws IOException,
                                 AutomationException
The type of geometry used for the edit sketch constructor.

Remarks

Returns the geometry type of the dimension constructor used for the sketch geometry. Most of the standard dimension constructors use esriGeometryMultipoint.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getSketchGeometryType in interface IDimensionConstructor
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDimensionType

public int getDimensionType()
                     throws IOException,
                            AutomationException
The type of dimension created with the dimension constructor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getDimensionType in interface IDimensionConstructor
Returns:
A com.esri.arcgis.carto.esriDimensionType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanFinish

public boolean isCanFinish(IGeometry sketchGeometry)
                    throws IOException,
                           AutomationException
Indicates if the dimension feature can be constructed given the number of points in the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isCanFinish in interface IDimensionConstructor
Parameters:
sketchGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
The canFinish
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

constructDimension

public void constructDimension(IDimensionFeature feature,
                               IGeometry geometry,
                               IDimensionStyle style)
                        throws IOException,
                               AutomationException
Creates the dimension shape for a dimension feature given the geometry constructed in the dimension constructor.

Remarks

When IDimensionConstructor::CanFinish returns True ConstructDimension is called.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
constructDimension in interface IDimensionConstructor
Parameters:
feature - A reference to a com.esri.arcgis.carto.IDimensionFeature (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
style - A reference to a com.esri.arcgis.carto.IDimensionStyle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startup

public void startup(IDimensionEditExtension extension)
             throws IOException,
                    AutomationException
The dimension editor extension.

Remarks

Startup is called when the constructor is instantiated by the DimensionEditExtension.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
startup in interface IDimensionConstructor
Parameters:
extension - A reference to a com.esri.arcgis.editor.IDimensionEditExtension (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException
The constructor start event.

Remarks

Shutdown is called when the DimensionEditExtension's destructor is called, typically when ArcMap is shut down.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
shutdown in interface IDimensionConstructor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createFeedback

public IDisplayFeedback createFeedback()
                                throws IOException,
                                       AutomationException
The display feedback for the constructor.

Remarks

When implementing IDimensionConstructor CreateFeedback is where the chosen feedback object should be instantiated and the necessary properties of the feedback object are set. For example, you should set the DimensionType and ReferenceScale, and ReferenceUnits values on the feedback object at this time.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
createFeedback in interface IDimensionConstructor
Returns:
A reference to a com.esri.arcgis.display.IDisplayFeedback
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startFeedback

public void startFeedback(IPoint point,
                          IDimensionStyle style)
                   throws IOException,
                          AutomationException
Starts the display feedback for the dimension constructor.

Remarks

StartFeedback will start the display of the feedback object when the first point is added to the edit sketch. All properties required by the feedback object should be specified at this point and the feedback should be started.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
startFeedback in interface IDimensionConstructor
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
style - A reference to a com.esri.arcgis.carto.IDimensionStyle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addFeedbackPoint

public void addFeedbackPoint(IPoint point)
                      throws IOException,
                             AutomationException
Adds a point to the display feedback.

Remarks

When the first point is added StartFeedbackFromShape is called. For all subsequent points that are added AddFeedbackPoint is called. The point can be used to update the feedback if desired.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
addFeedbackPoint in interface IDimensionConstructor
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.

stopFeedback

public void stopFeedback()
                  throws IOException,
                         AutomationException
Stops the display feedback.

Remarks

StopFeedback will stop the display feedback. StopFeedback is automatically called when IDimensionConstructor::CanFinish returns True. At this time you should stop the DimensionFeedback object and dereference it. If desired you can use the IDimensionShape returned from INewDimensionFeedback::Stop as the basis for constructing the dimension feature. ConstructDimension is called immediately follwing StopFeedback.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
stopFeedback in interface IDimensionConstructor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasFeedback

public boolean isHasFeedback()
                      throws IOException,
                             AutomationException
Indicates if the constructor will use a custom feedback.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isHasFeedback in interface IDimensionConstructor
Returns:
The hasFeedback
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startFeedbackFromShape

public void startFeedbackFromShape(IGeometry shape,
                                   IDimensionStyle style)
                            throws IOException,
                                   AutomationException
Starts the display feedback for the dimension constructor from an existing geometry.

Remarks

StartFeedbackFromShape is called when the first point is added to the edit sketch. The input geometry should be used to add all the points in the sketchGeometry to the DimensionFeedback object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
startFeedbackFromShape in interface IDimensionConstructor
Parameters:
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
style - A reference to a com.esri.arcgis.carto.IDimensionStyle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.