com.esri.arcgis.display
Interface ITemplate

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITemplateProxy, Template

public interface ITemplate
extends java.io.Serializable

COM Interface 'ITemplate'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to members that control the template.' 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	IID7914e5f4_c892_11d0_8bb6_080009ee4e41
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addPatternElement(double mark, double gap) Adds a pattern element.
void	clearPatternElements() Clears all pattern elements.
void	deletePatternElement(int index) Removes the pattern element at the given index.
IGeometry	getGeometry() The pattern geometry.
double	getInterval() The interval.
void	getPatternElement(int index, double[] mark, double[] gap) Gets pattern element properties for a given index.
int	getPatternElementCount() The number of pattern elements.
void	movePatternElement(int fromIndex, int toIndex) Moves a pattern element.
void	queryNextLine(IGeometry pGeometry) Queries for the next line in the pattern.
void	queryNextPoint(IPoint pPoint, double[] pAngle) Queries for the next point in the pattern.
void	reset() Resets the enumerator.
void	setGeometryByRef(IGeometry ppGeometry) The pattern geometry.
void	setInterval(double interval) The interval.
void	setup(int hDC, ITransformation transformation, ILineSymbol lineSym) Set up items needed by template.

Field Detail

IID7914e5f4_c892_11d0_8bb6_080009ee4e41

static final int IID7914e5f4_c892_11d0_8bb6_080009ee4e41

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

setup

void setup(int hDC,
           ITransformation transformation,
           ILineSymbol lineSym)
           throws java.io.IOException,
                  AutomationException

Set up items needed by template.

Parameters:

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

transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)

lineSym - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPatternElementCount

int getPatternElementCount()
                           throws java.io.IOException,
                                  AutomationException

The number of pattern elements.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPatternElement

void getPatternElement(int index,
                       double[] mark,
                       double[] gap)
                       throws java.io.IOException,
                              AutomationException

Gets pattern element properties for a given index.

Parameters:

index - The index (in)

mark - The mark (out: use single element array)

gap - The gap (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addPatternElement

void addPatternElement(double mark,
                       double gap)
                       throws java.io.IOException,
                              AutomationException

Adds a pattern element.

Parameters:

mark - The mark (in)

gap - The gap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deletePatternElement

void deletePatternElement(int index)
                          throws java.io.IOException,
                                 AutomationException

Removes the pattern element at the given index.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

movePatternElement

void movePatternElement(int fromIndex,
                        int toIndex)
                        throws java.io.IOException,
                               AutomationException

Moves a pattern element.

Parameters:

fromIndex - The fromIndex (in)

toIndex - The toIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearPatternElements

void clearPatternElements()
                          throws java.io.IOException,
                                 AutomationException

Clears all pattern elements.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInterval

double getInterval()
                   throws java.io.IOException,
                          AutomationException

The interval.

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInterval

void setInterval(double interval)
                 throws java.io.IOException,
                        AutomationException

The interval.

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

The pattern geometry.

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

void setGeometryByRef(IGeometry ppGeometry)
                      throws java.io.IOException,
                             AutomationException

The pattern geometry.

Parameters:

ppGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryNextPoint

void queryNextPoint(IPoint pPoint,
                    double[] pAngle)
                    throws java.io.IOException,
                           AutomationException

Queries for the next point in the pattern.

Parameters:

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

pAngle - The pAngle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryNextLine

void queryNextLine(IGeometry pGeometry)
                   throws java.io.IOException,
                          AutomationException

Queries for the next line in the pattern.

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws java.io.IOException,
                  AutomationException

Resets the enumerator.

Throws:

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

AutomationException - If the ArcObject component throws an exception.