com.esri.arcgis.display
Class Template

java.lang.Object
  com.esri.arcgis.display.Template

All Implemented Interfaces:

ITemplate, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class Template
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemplate, IPersistStream, IPersist, IClone, java.io.Externalizable

COM Class 'Template'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'Stores information on the mark and gap patterns for lines.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.display.ITemplate

IID, IID7914e5f4_c892_11d0_8bb6_080009ee4e41, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

Template()
Constructs a Template using ArcGIS Engine.

Template(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Template theTemplate = (Template) obj;

Method Summary

void	addPatternElement(double mark, double gap) Adds a pattern element.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	clearPatternElements() Clears all pattern elements.
void	deletePatternElement(int index) Removes the pattern element at the given index.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IGeometry	getGeometry() The pattern geometry.
double	getInterval() The interval.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getPatternElement(int index, double[] mark, double[] gap) Gets pattern element properties for a given index.
int	getPatternElementCount() The number of pattern elements.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
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	readExternal(java.io.ObjectInput in)
void	release() Release a Template.
void	reset() Resets the enumerator.
void	save(IStream pstm, int fClearDirty) save
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Template

public Template()
         throws java.io.IOException,
                java.net.UnknownHostException

Constructs a Template using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Template

public Template(java.lang.Object obj)
         throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Template theTemplate = (Template) obj;

Construct a Template using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Template.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a Template.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setup

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

Set up items needed by template.

Specified by:

setup in interface ITemplate

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

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

The number of pattern elements.

Specified by:

getPatternElementCount in interface ITemplate

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPatternElement

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

Gets pattern element properties for a given index.

Specified by:

getPatternElement in interface ITemplate

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

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

Adds a pattern element.

Specified by:

addPatternElement in interface ITemplate

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

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

Removes the pattern element at the given index.

Specified by:

deletePatternElement in interface ITemplate

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

movePatternElement

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

Moves a pattern element.

Specified by:

movePatternElement in interface ITemplate

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

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

Clears all pattern elements.

Specified by:

clearPatternElements in interface ITemplate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInterval

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

The interval.

Specified by:

getInterval in interface ITemplate

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInterval

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

The interval.

Specified by:

setInterval in interface ITemplate

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometry

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

The pattern geometry.

Specified by:

getGeometry in interface ITemplate

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

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

The pattern geometry.

Specified by:

setGeometryByRef in interface ITemplate

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

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

Queries for the next point in the pattern.

Specified by:

queryNextPoint in interface ITemplate

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

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

Queries for the next line in the pattern.

Specified by:

queryNextLine in interface ITemplate

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

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

Resets the enumerator.

Specified by:

reset in interface ITemplate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException