com.esri.arcgis.carto
Class TerrainDirtyAreaRenderer

java.lang.Object
  extended by com.esri.arcgis.carto.TerrainDirtyAreaRenderer
All Implemented Interfaces:
ILegendInfo, ITerrainRenderer, ITinRenderer, ITinSingleSymbolRenderer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IPropertySupport, java.io.Externalizable, java.io.Serializable

public class TerrainDirtyAreaRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITinSingleSymbolRenderer, ITerrainRenderer, IPropertySupport, ILegendInfo, IPersistStream, IPersist, java.io.Externalizable

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

Description 'Terrain dirty area 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.ITinSingleSymbolRenderer
IID, IIDf12e6ded_384c_11d2_b1f2_00c04f8edeff, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITerrainRenderer
IID, IID1f991990_0063_419d_9c83_56aa729c77c4, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITinRenderer
IID466db6cd_80a6_11d2_81eb_00104bc4cd03
 
Fields inherited from interface com.esri.arcgis.system.IPropertySupport
IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, 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
TerrainDirtyAreaRenderer()
          Constructs a TerrainDirtyAreaRenderer using ArcGIS Engine.
TerrainDirtyAreaRenderer(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TerrainDirtyAreaRenderer theTerrainDirtyAreaRenderer = (TerrainDirtyAreaRenderer) obj;
 
Method Summary
 boolean applies(java.lang.Object pUnk)
          Indicates if the receiver can apply the given object at any given time.
 java.lang.Object apply(java.lang.Object newObject)
          Applies the given property to the receiver and returns the old object.
 boolean canApply(java.lang.Object pUnk)
          Indicates if the receiver can apply the given object at that particular moment.
 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
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.Object getCurrent(java.lang.Object pUnk)
          The object currently being used.
 java.lang.String getDescription()
          The description for the label.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getLabel()
          The descriptive symbol text.
 ILegendGroup getLegendGroup(int index)
          Legend group at the specified index.
 int getLegendGroupCount()
          Number of legend groups contained by the object.
 ILegendItem getLegendItem()
          Optional.
 java.lang.String getName()
          The descriptive name of a renderer.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISymbol getSymbol()
          The symbol used to render faces.
 ITerrain getTerrain()
          The Terrain associated with the renderer.
 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 TerrainDirtyAreaRenderer.
 void save(IStream pstm, int fClearDirty)
          save
 void setDescription(java.lang.String text)
          The description for the label.
 void setLabel(java.lang.String label)
          The descriptive symbol text.
 void setName(java.lang.String name)
          The descriptive name of a renderer.
 void setSymbolByRef(ISymbol symbol)
          The symbol used to render faces.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setTerrainByRef(ITerrain ppTerrain)
          The Terrain associated with the renderer.
 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

TerrainDirtyAreaRenderer

public TerrainDirtyAreaRenderer()
                         throws java.io.IOException,
                                java.net.UnknownHostException
Constructs a TerrainDirtyAreaRenderer using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

TerrainDirtyAreaRenderer

public TerrainDirtyAreaRenderer(java.lang.Object obj)
                         throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TerrainDirtyAreaRenderer theTerrainDirtyAreaRenderer = (TerrainDirtyAreaRenderer) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getSymbol

public ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException
The symbol used to render faces.

Specified by:
getSymbol in interface ITinSingleSymbolRenderer
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.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException
The symbol used to render faces.

Specified by:
setSymbolByRef in interface ITinSingleSymbolRenderer
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.

getLabel

public java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException
The descriptive symbol text.

Specified by:
getLabel in interface ITinSingleSymbolRenderer
Returns:
The label
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException
The descriptive symbol text.

Specified by:
setLabel in interface ITinSingleSymbolRenderer
Parameters:
label - The label (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
The description for the label.

Specified by:
getDescription in interface ITinSingleSymbolRenderer
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String text)
                    throws java.io.IOException,
                           AutomationException
The description for the label.

Specified by:
setDescription in interface ITinSingleSymbolRenderer
Parameters:
text - The text (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTerrainByRef

public void setTerrainByRef(ITerrain ppTerrain)
                     throws java.io.IOException,
                            AutomationException
The Terrain associated with the renderer.

Specified by:
setTerrainByRef in interface ITerrainRenderer
Parameters:
ppTerrain - A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTerrain

public ITerrain getTerrain()
                    throws java.io.IOException,
                           AutomationException
The Terrain associated with the renderer.

Specified by:
getTerrain in interface ITerrainRenderer
Returns:
A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain
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.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException
Indicates if the receiver can apply the given object at any given time.

Specified by:
applies in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The applies
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException
Indicates if the receiver can apply the given object at that particular moment.

Specified by:
canApply in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The canApply
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException
The object currently being used.

Specified by:
getCurrent in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException
Applies the given property to the receiver and returns the old object.

Specified by:
apply in interface IPropertySupport
Parameters:
newObject - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
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