Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.location
Interface IHatchTemplate

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
HatchTemplate, IHatchTemplateProxy
public interface IHatchTemplate
extends java.io.Serializable

COM Interface 'IHatchTemplate'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description: 'Provides access to hatch template properties.' 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 IIDa6e400d1_a2ea_49f4_b520_485df0417025
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addHatchDefinition(int multipleHatchInterval, IHatchDefinition hatchDefinition)
          Adds a hatch definition to the hatch class.
 void convertToGraphics(IFeature feature, IHatchInputValue interval, IHatchInputValue fromMeasure, IHatchInputValue toMeasure, IHatchInputValue lateralOffset, int measureUnits, IDisplay display, IGraphicsLayer pGraphicsLayer)
          Converts hatches to graphics.
 void drawFeature(IFeature feature, IHatchInputValue interval, IHatchInputValue fromMeasure, IHatchInputValue toMeasure, IHatchInputValue lateralOffset, int measureUnits, IDisplay display, ITrackCancel trackCancel)
          Draws hatches on along a given feature.
 void drawGeometry(IGeometry geometry, double interval, java.lang.Object fromMeasure, java.lang.Object toMeasure, java.lang.Object lateralOffset, int measureUnits, IDisplay display, ITrackCancel trackCancel)
          Draws hatches along a given geometry.
 void drawPreview(IGeometry geometry, double scaleFactor, int selectedDef, java.lang.Object fromMeasure, java.lang.Object toMeasure, java.lang.Object lateralOffset, int measureUnits, IDisplay display, ITrackCancel trackCancel)
          Draws a sample of hatching to a given display.
 double getDefaultHatchInterval()
          The hatch interval.
 int getDisplayUnits()
          The units to be used for displaying M values in hatch text.
 IHatchDefinition getEndHatchDefinition()
          The hatch definition to be used on the ends of a feature.
 double getEndHatchDrawingTolerance()
          The end hatch drawing tolerance.
 IEnumHatchDefinition getEnumHatchDefinitions()
          The hatch definition enumeration.
 int getHatchDefinitionCount()
          The number of hatch definitions.
 java.lang.String getName()
          The descriptive name of a hatch class.
 int getUIDisplayUnits()
          The user interface display units.
 boolean isConvertUnits()
          Indicates whether to convert units for displaying Ms in hatch text.
 boolean isHatchByPart()
          Indicates whether to hatch by part vs.
 boolean isStartAtIntervalMultiple()
          Indicates whether to start at the interval multiple.
 void removeAll()
          Removes all definitions from the hatch class.
 void removeHatchDefinition(int index)
          Removes a hatch definition from the hatch class.
 void setConvertUnits(boolean convertUnits)
          Indicates whether to convert units for displaying Ms in hatch text.
 void setDefaultHatchInterval(double pDefaultHatchInterval)
          The hatch interval.
 void setDisplayUnits(int units)
          The units to be used for displaying M values in hatch text.
 void setEndHatchDefinitionByRef(IHatchDefinition hatchDefinition)
          The hatch definition to be used on the ends of a feature.
 void setEndHatchDrawingTolerance(double drawingTolerance)
          The end hatch drawing tolerance.
 void setHatchByPart(boolean hatchByPart)
          Indicates whether to hatch by part vs.
 void setName(java.lang.String name)
          The descriptive name of a hatch class.
 void setStartAtIntervalMultiple(boolean startAtIntervalMultiple)
          Indicates whether to start at the interval multiple.
 void setUIDisplayUnits(int units)
          The user interface display units.
 

Field Detail

IIDa6e400d1_a2ea_49f4_b520_485df0417025

static final int IIDa6e400d1_a2ea_49f4_b520_485df0417025
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
The descriptive name of a hatch class.

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

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
The descriptive name of a hatch class.

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

getDefaultHatchInterval

double getDefaultHatchInterval()
                               throws java.io.IOException,
                                      AutomationException
The hatch interval.

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

setDefaultHatchInterval

void setDefaultHatchInterval(double pDefaultHatchInterval)
                             throws java.io.IOException,
                                    AutomationException
The hatch interval.

Parameters:
pDefaultHatchInterval - The pDefaultHatchInterval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHatchDefinitionCount

int getHatchDefinitionCount()
                            throws java.io.IOException,
                                   AutomationException
The number of hatch definitions.

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

addHatchDefinition

void addHatchDefinition(int multipleHatchInterval,
                        IHatchDefinition hatchDefinition)
                        throws java.io.IOException,
                               AutomationException
Adds a hatch definition to the hatch class.

Parameters:
multipleHatchInterval - The multipleHatchInterval (in)
hatchDefinition - A reference to a com.esri.arcgis.location.IHatchDefinition (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnumHatchDefinitions

IEnumHatchDefinition getEnumHatchDefinitions()
                                             throws java.io.IOException,
                                                    AutomationException
The hatch definition enumeration.

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

removeHatchDefinition

void removeHatchDefinition(int index)
                           throws java.io.IOException,
                                  AutomationException
Removes a hatch definition from the hatch class.

Parameters:
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws java.io.IOException,
                      AutomationException
Removes all definitions from the hatch class.

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

setEndHatchDefinitionByRef

void setEndHatchDefinitionByRef(IHatchDefinition hatchDefinition)
                                throws java.io.IOException,
                                       AutomationException
The hatch definition to be used on the ends of a feature.

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

getEndHatchDefinition

IHatchDefinition getEndHatchDefinition()
                                       throws java.io.IOException,
                                              AutomationException
The hatch definition to be used on the ends of a feature.

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

setEndHatchDrawingTolerance

void setEndHatchDrawingTolerance(double drawingTolerance)
                                 throws java.io.IOException,
                                        AutomationException
The end hatch drawing tolerance.

Parameters:
drawingTolerance - The drawingTolerance (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndHatchDrawingTolerance

double getEndHatchDrawingTolerance()
                                   throws java.io.IOException,
                                          AutomationException
The end hatch drawing tolerance.

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

setConvertUnits

void setConvertUnits(boolean convertUnits)
                     throws java.io.IOException,
                            AutomationException
Indicates whether to convert units for displaying Ms in hatch text.

Parameters:
convertUnits - The convertUnits (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isConvertUnits

boolean isConvertUnits()
                       throws java.io.IOException,
                              AutomationException
Indicates whether to convert units for displaying Ms in hatch text.

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

getDisplayUnits

int getDisplayUnits()
                    throws java.io.IOException,
                           AutomationException
The units to be used for displaying M values in hatch text.

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

setDisplayUnits

void setDisplayUnits(int units)
                     throws java.io.IOException,
                            AutomationException
The units to be used for displaying M values in hatch text.

Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartAtIntervalMultiple

void setStartAtIntervalMultiple(boolean startAtIntervalMultiple)
                                throws java.io.IOException,
                                       AutomationException
Indicates whether to start at the interval multiple.

Parameters:
startAtIntervalMultiple - The startAtIntervalMultiple (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStartAtIntervalMultiple

boolean isStartAtIntervalMultiple()
                                  throws java.io.IOException,
                                         AutomationException
Indicates whether to start at the interval multiple.

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

setUIDisplayUnits

void setUIDisplayUnits(int units)
                       throws java.io.IOException,
                              AutomationException
The user interface display units.

Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUIDisplayUnits

int getUIDisplayUnits()
                      throws java.io.IOException,
                             AutomationException
The user interface display units.

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

setHatchByPart

void setHatchByPart(boolean hatchByPart)
                    throws java.io.IOException,
                           AutomationException
Indicates whether to hatch by part vs. by polyline.

Parameters:
hatchByPart - The hatchByPart (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHatchByPart

boolean isHatchByPart()
                      throws java.io.IOException,
                             AutomationException
Indicates whether to hatch by part vs. by polyline.

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

drawGeometry

void drawGeometry(IGeometry geometry,
                  double interval,
                  java.lang.Object fromMeasure,
                  java.lang.Object toMeasure,
                  java.lang.Object lateralOffset,
                  int measureUnits,
                  IDisplay display,
                  ITrackCancel trackCancel)
                  throws java.io.IOException,
                         AutomationException
Draws hatches along a given geometry.

Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
interval - The interval (in)
fromMeasure - A Variant (in)
toMeasure - A Variant (in)
lateralOffset - A Variant (in)
measureUnits - A com.esri.arcgis.system.esriUnits constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawFeature

void drawFeature(IFeature feature,
                 IHatchInputValue interval,
                 IHatchInputValue fromMeasure,
                 IHatchInputValue toMeasure,
                 IHatchInputValue lateralOffset,
                 int measureUnits,
                 IDisplay display,
                 ITrackCancel trackCancel)
                 throws java.io.IOException,
                        AutomationException
Draws hatches on along a given feature.

Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
interval - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
fromMeasure - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
toMeasure - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
lateralOffset - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
measureUnits - A com.esri.arcgis.system.esriUnits constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawPreview

void drawPreview(IGeometry geometry,
                 double scaleFactor,
                 int selectedDef,
                 java.lang.Object fromMeasure,
                 java.lang.Object toMeasure,
                 java.lang.Object lateralOffset,
                 int measureUnits,
                 IDisplay display,
                 ITrackCancel trackCancel)
                 throws java.io.IOException,
                        AutomationException
Draws a sample of hatching to a given display.

Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
scaleFactor - The scaleFactor (in)
selectedDef - The selectedDef (in)
fromMeasure - A Variant (in)
toMeasure - A Variant (in)
lateralOffset - A Variant (in)
measureUnits - A com.esri.arcgis.system.esriUnits constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToGraphics

void convertToGraphics(IFeature feature,
                       IHatchInputValue interval,
                       IHatchInputValue fromMeasure,
                       IHatchInputValue toMeasure,
                       IHatchInputValue lateralOffset,
                       int measureUnits,
                       IDisplay display,
                       IGraphicsLayer pGraphicsLayer)
                       throws java.io.IOException,
                              AutomationException
Converts hatches to graphics.

Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
interval - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
fromMeasure - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
toMeasure - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
lateralOffset - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
measureUnits - A com.esri.arcgis.system.esriUnits constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
pGraphicsLayer - A reference to a com.esri.arcgis.carto.IGraphicsLayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD