com.esri.arcgis.editor
Interface IDimensionConstructor

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AlignedConstructor, FreeAlignedConstructor, FreeLinearConstructor, IDimensionConstructorProxy, LinearConstructor, RotatedLinearConstructor, SimpleAlignedConstructor

public interface IDimensionConstructor
extends java.io.Serializable

COM Interface 'IDimensionConstructor'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description: 'Provides access to members that control the dimension feature edit sketch constructor.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID3099c3ce_6630_4065_92b0_9009eaab1303
           
static int xxDummy
          Deprecated. Internal use only
 
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.
 int getDimensionType()
          The type of dimension created with the dimension constructor.
 java.lang.String getName()
          Name of the dimension constructor.
 int getSketchGeometryType()
          The type of geometry used for the edit sketch constructor.
 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.
 

Field Detail

IID3099c3ce_6630_4065_92b0_9009eaab1303

static final int IID3099c3ce_6630_4065_92b0_9009eaab1303
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the dimension constructor.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSketchGeometryType

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

Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDimensionType

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

Returns:
A com.esri.arcgis.carto.esriDimensionType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanFinish

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

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

constructDimension

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startup

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

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

shutdown

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

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createFeedback

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

Returns:
A reference to a com.esri.arcgis.display.IDisplayFeedback
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startFeedback

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

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
style - 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.

addFeedbackPoint

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

Parameters:
point - 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.

stopFeedback

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

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasFeedback

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

Returns:
The hasFeedback
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startFeedbackFromShape

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

Parameters:
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
style - 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.