com.esri.arcgis.location
Interface IHatchTemplate

All Superinterfaces:
Serializable
All Known Implementing Classes:
HatchTemplate

public interface IHatchTemplate
extends Serializable

Provides access to hatch template properties.

Remarks

The IHatchTemplate interface provides access to the hatch template properties. The IHatchTemplate can be used to manage a collection of hatch definitions. The IHatchTemplate interface can be applied to a HatchClass or exist as a hatch style. In order to create a HatchClass, you will need to assign a HatchTemplate to it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


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, Object fromMeasure, Object toMeasure, Object lateralOffset, int measureUnits, IDisplay display, ITrackCancel trackCancel)
          Draws hatches along a given geometry.
 void drawPreview(IGeometry geometry, double scaleFactor, int selectedDef, Object fromMeasure, Object toMeasure, 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.
 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(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.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
The descriptive name of a hatch class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setName

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDefaultHatchInterval

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDefaultHatchInterval

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getHatchDefinitionCount

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

addHatchDefinition

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEnumHatchDefinitions

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

removeHatchDefinition

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

Remarks

The index of a hatch definition is based on it's hatch interval. It is not a zero-based index.
For example, a hatch definition with an interval of 5 would have an index value of 5.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

removeAll

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setEndHatchDefinitionByRef

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

Product Availability

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

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

getEndHatchDefinition

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setEndHatchDrawingTolerance

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEndHatchDrawingTolerance

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setConvertUnits

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isConvertUnits

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDisplayUnits

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDisplayUnits

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStartAtIntervalMultiple

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isStartAtIntervalMultiple

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUIDisplayUnits

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getUIDisplayUnits

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setHatchByPart

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isHatchByPart

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

drawGeometry

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
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 IOException,
                        AutomationException
Draws hatches on along a given feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

drawPreview

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
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 IOException,
                              AutomationException
Converts hatches to graphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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