com.esri.arcgis.carto
Class TinContourRenderer

java.lang.Object
  com.esri.arcgis.carto.TinContourRenderer

All Implemented Interfaces:

ILegendInfo, IMultiResolutionRenderer, ITinContourRenderer, ITinRenderer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class TinContourRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITinContourRenderer, ITinRenderer, IMultiResolutionRenderer, ILegendInfo, IPersistStream, IPersist, java.io.Externalizable

COM Class 'TinContourRenderer'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'TIN contour renderer component.' 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.carto.ITinContourRenderer

IID, IID8a4eea7b_a3f7_4651_8bbd_b6bf08b11a19, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ITinRenderer

IID, IID466db6cd_80a6_11d2_81eb_00104bc4cd03, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IMultiResolutionRenderer

IID, IIDd16a4d52_a926_4e8e_a7a2_535950c86afa, 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

Constructor Summary

TinContourRenderer()
Constructs a TinContourRenderer using ArcGIS Engine.

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

Method Summary

boolean	canRender() Indicates if renderer can draw.
void	copy(ITinRenderer pSource) Copies the properties of the given renderer.
void	draw(int drawPhase, IDisplay display, ISpatialReference aSpatialReference, ITrackCancel trackCancel) Draws the TIN.
boolean	equals(java.lang.Object o) Compare this object with another
IEnvelope	getAreaOfInterest() The area of interest to be rendered.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getContourDescription() The description for the label.
double	getContourInterval() The contour interval.
java.lang.String	getContourLabel() The descriptive symbol text.
ISymbol	getContourSymbol() The symbol used to render the contour.
java.lang.String	getIndexContourDescription() The description for the index contour.
int	getIndexContourFactor() The index contour factor.
java.lang.String	getIndexContourLabel() The label for the index contour.
ISymbol	getIndexContourSymbol() The symbol used to render index contour.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
double	getMinVisibleResolution() The minimum resolution at which data are rendered.
java.lang.String	getName() The descriptive name of a renderer.
double	getReferenceContourHeight() The reference contour height.
double	getResolution() The resolution to be rendered.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITin	getTin() The TIN associated with the renderer.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isVisible() Indicates if the renderer is currently visible.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a TinContourRenderer.
void	save(IStream pstm, int fClearDirty) save
void	setAreaOfInterest(IEnvelope ppAOI) The area of interest to be rendered.
void	setContourDescription(java.lang.String text) The description for the label.
void	setContourInterval(double interval) The contour interval.
void	setContourLabel(java.lang.String label) The descriptive symbol text.
void	setContourSymbolByRef(ISymbol symbol) The symbol used to render the contour.
void	setIndexContourDescription(java.lang.String text) The description for the index contour.
void	setIndexContourFactor(int factor) The index contour factor.
void	setIndexContourLabel(java.lang.String label) The label for the index contour.
void	setIndexContourSymbolByRef(ISymbol symbol) The symbol used to render index contour.
void	setMinVisibleResolution(double pResolution) The minimum resolution at which data are rendered.
void	setName(java.lang.String name) The descriptive name of a renderer.
void	setReferenceContourHeight(double height) The reference contour height.
void	setResolution(double pResolution) The resolution to be rendered.
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTinByRef(ITin ppTin) The TIN associated with the renderer.
void	setVisible(boolean visible) Indicates if the renderer is currently visible.
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

TinContourRenderer

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

Constructs a TinContourRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TinContourRenderer

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

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

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

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 TinContourRenderer.

Specified by:

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

getReferenceContourHeight

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

The reference contour height.

Specified by:

getReferenceContourHeight in interface ITinContourRenderer

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReferenceContourHeight

public void setReferenceContourHeight(double height)
                               throws java.io.IOException,
                                      AutomationException

The reference contour height.

Specified by:

setReferenceContourHeight in interface ITinContourRenderer

Parameters:

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContourInterval

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

The contour interval.

Specified by:

getContourInterval in interface ITinContourRenderer

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContourInterval

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

The contour interval.

Specified by:

setContourInterval in interface ITinContourRenderer

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexContourFactor

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

The index contour factor.

Specified by:

getIndexContourFactor in interface ITinContourRenderer

Returns:

The factor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIndexContourFactor

public void setIndexContourFactor(int factor)
                           throws java.io.IOException,
                                  AutomationException

The index contour factor.

Specified by:

setIndexContourFactor in interface ITinContourRenderer

Parameters:

factor - The factor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContourSymbol

public ISymbol getContourSymbol()
                         throws java.io.IOException,
                                AutomationException

The symbol used to render the contour.

Specified by:

getContourSymbol in interface ITinContourRenderer

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContourSymbolByRef

public void setContourSymbolByRef(ISymbol symbol)
                           throws java.io.IOException,
                                  AutomationException

The symbol used to render the contour.

Specified by:

setContourSymbolByRef in interface ITinContourRenderer

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContourLabel

public java.lang.String getContourLabel()
                                 throws java.io.IOException,
                                        AutomationException

The descriptive symbol text.

Specified by:

getContourLabel in interface ITinContourRenderer

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContourLabel

public void setContourLabel(java.lang.String label)
                     throws java.io.IOException,
                            AutomationException

The descriptive symbol text.

Specified by:

setContourLabel in interface ITinContourRenderer

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContourDescription

public java.lang.String getContourDescription()
                                       throws java.io.IOException,
                                              AutomationException

The description for the label.

Specified by:

getContourDescription in interface ITinContourRenderer

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContourDescription

public void setContourDescription(java.lang.String text)
                           throws java.io.IOException,
                                  AutomationException

The description for the label.

Specified by:

setContourDescription in interface ITinContourRenderer

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexContourSymbol

public ISymbol getIndexContourSymbol()
                              throws java.io.IOException,
                                     AutomationException

The symbol used to render index contour.

Specified by:

getIndexContourSymbol in interface ITinContourRenderer

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIndexContourSymbolByRef

public void setIndexContourSymbolByRef(ISymbol symbol)
                                throws java.io.IOException,
                                       AutomationException

The symbol used to render index contour.

Specified by:

setIndexContourSymbolByRef in interface ITinContourRenderer

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexContourLabel

public java.lang.String getIndexContourLabel()
                                      throws java.io.IOException,
                                             AutomationException

The label for the index contour.

Specified by:

getIndexContourLabel in interface ITinContourRenderer

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIndexContourLabel

public void setIndexContourLabel(java.lang.String label)
                          throws java.io.IOException,
                                 AutomationException

The label for the index contour.

Specified by:

setIndexContourLabel in interface ITinContourRenderer

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexContourDescription

public java.lang.String getIndexContourDescription()
                                            throws java.io.IOException,
                                                   AutomationException

The description for the index contour.

Specified by:

getIndexContourDescription in interface ITinContourRenderer

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIndexContourDescription

public void setIndexContourDescription(java.lang.String text)
                                throws java.io.IOException,
                                       AutomationException

The description for the index contour.

Specified by:

setIndexContourDescription in interface ITinContourRenderer

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ISpatialReference aSpatialReference,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the TIN.

Specified by:

draw in interface ITinRenderer

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

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

aSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (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.

copy

public void copy(ITinRenderer pSource)
          throws java.io.IOException,
                 AutomationException

Copies the properties of the given renderer.

Specified by:

copy in interface ITinRenderer

Parameters:

pSource - A reference to a com.esri.arcgis.carto.ITinRenderer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender()
                  throws java.io.IOException,
                         AutomationException

Indicates if renderer can draw.

Specified by:

canRender in interface ITinRenderer

Returns:

The pCanRender

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTinByRef

public void setTinByRef(ITin ppTin)
                 throws java.io.IOException,
                        AutomationException

The TIN associated with the renderer.

Specified by:

setTinByRef in interface ITinRenderer

Parameters:

ppTin - A reference to a com.esri.arcgis.geodatabase.ITin (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTin

public ITin getTin()
            throws java.io.IOException,
                   AutomationException

The TIN associated with the renderer.

Specified by:

getTin in interface ITinRenderer

Returns:

A reference to a com.esri.arcgis.geodatabase.ITin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The descriptive name of a renderer.

Specified by:

getName in interface ITinRenderer

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The descriptive name of a renderer.

Specified by:

setName in interface ITinRenderer

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the renderer is currently visible.

Specified by:

isVisible in interface ITinRenderer

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the renderer is currently visible.

Specified by:

setVisible in interface ITinRenderer

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope ppAOI)
                       throws java.io.IOException,
                              AutomationException

The area of interest to be rendered.

Specified by:

setAreaOfInterest in interface IMultiResolutionRenderer

Parameters:

ppAOI - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

The area of interest to be rendered.

Specified by:

getAreaOfInterest in interface IMultiResolutionRenderer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResolution

public void setResolution(double pResolution)
                   throws java.io.IOException,
                          AutomationException

The resolution to be rendered.

Specified by:

setResolution in interface IMultiResolutionRenderer

Parameters:

pResolution - The pResolution (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResolution

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

The resolution to be rendered.

Specified by:

getResolution in interface IMultiResolutionRenderer

Returns:

The pResolution

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinVisibleResolution

public void setMinVisibleResolution(double pResolution)
                             throws java.io.IOException,
                                    AutomationException

The minimum resolution at which data are rendered.

Specified by:

setMinVisibleResolution in interface IMultiResolutionRenderer

Parameters:

pResolution - The pResolution (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinVisibleResolution

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

The minimum resolution at which data are rendered.

Specified by:

getMinVisibleResolution in interface IMultiResolutionRenderer

Returns:

The pResolution

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

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

Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendGroupCount in interface ILegendInfo

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:

getLegendGroup in interface ILegendInfo

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.ILegendGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException

Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendItem in interface ILegendInfo

Returns:

A reference to a com.esri.arcgis.carto.ILegendItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.IOException,
                                     AutomationException

Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSymbolsAreGraduated in interface ILegendInfo

Returns:

The symbolsAreGraduated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolsAreGraduated in interface ILegendInfo

Parameters:

symbolsAreGraduated - The symbolsAreGraduated (in)

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.

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