com.esri.arcgis.carto
Class TerrainPointAttributeRenderer

java.lang.Object
  extended by com.esri.arcgis.carto.TerrainPointAttributeRenderer
All Implemented Interfaces:
IClassBreaksUIProperties, IDataSampling, ILegendInfo, ITerrainAttributeRenderer, ITerrainRenderer, ITerrainRenderer2, ITinColorRampRenderer, ITinRenderer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IPropertySupport, java.io.Externalizable, java.io.Serializable

public class TerrainPointAttributeRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITinColorRampRenderer, IClassBreaksUIProperties, ITerrainRenderer, ITerrainRenderer2, ITerrainAttributeRenderer, IPropertySupport, ILegendInfo, IPersistStream, IPersist, IDataSampling, java.io.Externalizable

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

Description 'Terrain point 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.ITinColorRampRenderer
IID, IID91fb1b61_8944_11d2_81ec_00104bc4cd03, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IClassBreaksUIProperties
IID, IID427788f2_31fe_11d2_aaf0_00c04fa334b3, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITerrainAttributeRenderer
IID, IID6b2403f7_7d51_4647_a46a_5f8ea269f273, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ITerrainRenderer2
IID0a7ea67a_3c04_4204_9fcc_bc56d18c773a
 
Fields inherited from interface com.esri.arcgis.carto.ITerrainRenderer
IID1f991990_0063_419d_9c83_56aa729c77c4
 
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
 
Fields inherited from interface com.esri.arcgis.carto.IDataSampling
IID, IID4eab5690_8f9c_11d2_ab21_00c04fa334b3, xxDummy
 
Constructor Summary
TerrainPointAttributeRenderer()
          Constructs a TerrainPointAttributeRenderer using ArcGIS Engine.
TerrainPointAttributeRenderer(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TerrainPointAttributeRenderer theTerrainPointAttributeRenderer = (TerrainPointAttributeRenderer) 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
 IEnvelope getAreaOfInterest()
          The area of interest to be rendered.
 java.lang.String getAttributeFieldName()
          The name of the reserved field to be used to define drawing symbol.
 double getBreak(int index)
          The value of the break at the index.
 int getBreakCount()
          The number of breaks.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.String getColorRamp()
          File and path name of the color ramp.
 java.lang.Object getCurrent(java.lang.Object pUnk)
          The object currently being used.
 ILongArray getDataSources()
          The embedded data sources to be rendered.
 java.lang.String getDescription(int index)
          The description for the renderer.
 double getDeviationInterval()
          Deviation interval (0-1), where 0 means that no deviation is used.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getLabel(int index)
          The label for the break at the given index.
 ILegendGroup getLegendGroup(int index)
          Legend group at the specified index.
 int getLegendGroupCount()
          Number of legend groups contained by the object.
 ILegendItem getLegendItem()
          Optional.
 double getLowBreak(int index)
          Lower bound of the class at the specified index.
 int getMaxSampleSize()
          Maximum sample size.
 IUID getMethod()
          Classification method.
 double getMinimumBreak()
          The value of the minimum break.
 java.lang.String getName()
          The descriptive name of a renderer.
 INumberFormat getNumberFormat()
          Number format for class labels.
 double getResolution()
          The resolution to be rendered.
 int getSamplingMethod()
          Data sampling method.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISymbol getSymbol(int index)
          The symbol representing the break at the index.
 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 isShowClassGaps()
          Indicates if each lower bound is adjusted up to the nearest existing data value.
 boolean isSortClassesAscending()
          Indicates if the sort direction for the legend class labels is ascending.
 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 redefineSymbols()
          Redefine drawing symbols based on cueernt data sources and attribute field name.
 void release()
          Release a TerrainPointAttributeRenderer.
 void save(IStream pstm, int fClearDirty)
          save
 void setAreaOfInterest(IEnvelope ppAOI)
          The area of interest to be rendered.
 void setAttributeFieldName(java.lang.String pName)
          The name of the reserved field to be used to define drawing symbol.
 void setBreak(int index, double value)
          The value of the break at the index.
 void setBreakCount(int valueCount)
          The number of breaks.
 void setColorRamp(java.lang.String colorRamp)
          File and path name of the color ramp.
 void setDataSources(ILongArray pDataSources)
          The embedded data sources to be rendered.
 void setDescription(int index, java.lang.String text)
          The description for the renderer.
 void setDeviationInterval(double interval)
          Deviation interval (0-1), where 0 means that no deviation is used.
 void setLabel(int index, java.lang.String label)
          The label for the break at the given index.
 void setLowBreak(int index, double value)
          Lower bound of the class at the specified index.
 void setMaxSampleSize(int size)
          Maximum sample size.
 void setMethodByRef(IUID cLSID)
          Classification method.
 void setMinimumBreak(double value)
          The value of the minimum break.
 void setName(java.lang.String name)
          The descriptive name of a renderer.
 void setNumberFormatByRef(INumberFormat format)
          Number format for class labels.
 void setResolution(double pResolution)
          The resolution to be rendered.
 void setSamplingMethod(int method)
          Data sampling method.
 void setShowClassGaps(boolean showGaps)
          Indicates if each lower bound is adjusted up to the nearest existing data value.
 void setSortClassesAscending(boolean ascending)
          Indicates if the sort direction for the legend class labels is ascending.
 void setSymbol(int index, ISymbol sym)
          The symbol representing the break at the index.
 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

TerrainPointAttributeRenderer

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

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

TerrainPointAttributeRenderer

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

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

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

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

getBreakCount

public int getBreakCount()
                  throws java.io.IOException,
                         AutomationException
The number of breaks.

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

setBreakCount

public void setBreakCount(int valueCount)
                   throws java.io.IOException,
                          AutomationException
The number of breaks.

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

getSymbol

public ISymbol getSymbol(int index)
                  throws java.io.IOException,
                         AutomationException
The symbol representing the break at the index.

Specified by:
getSymbol in interface ITinColorRampRenderer
Parameters:
index - The index (in)
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.

setSymbol

public void setSymbol(int index,
                      ISymbol sym)
               throws java.io.IOException,
                      AutomationException
The symbol representing the break at the index.

Specified by:
setSymbol in interface ITinColorRampRenderer
Parameters:
index - The index (in)
sym - 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(int index)
                          throws java.io.IOException,
                                 AutomationException
The label for the break at the given index.

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

setLabel

public void setLabel(int index,
                     java.lang.String label)
              throws java.io.IOException,
                     AutomationException
The label for the break at the given index.

Specified by:
setLabel in interface ITinColorRampRenderer
Parameters:
index - The index (in)
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(int index)
                                throws java.io.IOException,
                                       AutomationException
The description for the renderer.

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

setDescription

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

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

getBreak

public double getBreak(int index)
                throws java.io.IOException,
                       AutomationException
The value of the break at the index.

Specified by:
getBreak in interface ITinColorRampRenderer
Parameters:
index - The index (in)
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBreak

public void setBreak(int index,
                     double value)
              throws java.io.IOException,
                     AutomationException
The value of the break at the index.

Specified by:
setBreak in interface ITinColorRampRenderer
Parameters:
index - The index (in)
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumBreak

public double getMinimumBreak()
                       throws java.io.IOException,
                              AutomationException
The value of the minimum break.

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

setMinimumBreak

public void setMinimumBreak(double value)
                     throws java.io.IOException,
                            AutomationException
The value of the minimum break.

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

isSortClassesAscending

public boolean isSortClassesAscending()
                               throws java.io.IOException,
                                      AutomationException
Indicates if the sort direction for the legend class labels is ascending.

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

setSortClassesAscending

public void setSortClassesAscending(boolean ascending)
                             throws java.io.IOException,
                                    AutomationException
Indicates if the sort direction for the legend class labels is ascending.

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

getLowBreak

public double getLowBreak(int index)
                   throws java.io.IOException,
                          AutomationException
Lower bound of the class at the specified index.

Specified by:
getLowBreak in interface IClassBreaksUIProperties
Parameters:
index - The index (in)
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLowBreak

public void setLowBreak(int index,
                        double value)
                 throws java.io.IOException,
                        AutomationException
Lower bound of the class at the specified index.

Specified by:
setLowBreak in interface IClassBreaksUIProperties
Parameters:
index - The index (in)
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorRamp

public java.lang.String getColorRamp()
                              throws java.io.IOException,
                                     AutomationException
File and path name of the color ramp.

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

setColorRamp

public void setColorRamp(java.lang.String colorRamp)
                  throws java.io.IOException,
                         AutomationException
File and path name of the color ramp.

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

getMethod

public IUID getMethod()
               throws java.io.IOException,
                      AutomationException
Classification method.

Specified by:
getMethod in interface IClassBreaksUIProperties
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMethodByRef

public void setMethodByRef(IUID cLSID)
                    throws java.io.IOException,
                           AutomationException
Classification method.

Specified by:
setMethodByRef in interface IClassBreaksUIProperties
Parameters:
cLSID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws java.io.IOException,
                                     AutomationException
Number format for class labels.

Specified by:
getNumberFormat in interface IClassBreaksUIProperties
Returns:
A reference to a com.esri.arcgis.system.INumberFormat
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumberFormatByRef

public void setNumberFormatByRef(INumberFormat format)
                          throws java.io.IOException,
                                 AutomationException
Number format for class labels.

Specified by:
setNumberFormatByRef in interface IClassBreaksUIProperties
Parameters:
format - A reference to a com.esri.arcgis.system.INumberFormat (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowClassGaps

public boolean isShowClassGaps()
                        throws java.io.IOException,
                               AutomationException
Indicates if each lower bound is adjusted up to the nearest existing data value.

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

setShowClassGaps

public void setShowClassGaps(boolean showGaps)
                      throws java.io.IOException,
                             AutomationException
Indicates if each lower bound is adjusted up to the nearest existing data value.

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

getDeviationInterval

public double getDeviationInterval()
                            throws java.io.IOException,
                                   AutomationException
Deviation interval (0-1), where 0 means that no deviation is used.

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

setDeviationInterval

public void setDeviationInterval(double interval)
                          throws java.io.IOException,
                                 AutomationException
Deviation interval (0-1), where 0 means that no deviation is used.

Specified by:
setDeviationInterval in interface IClassBreaksUIProperties
Parameters:
interval - The interval (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.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope ppAOI)
                       throws java.io.IOException,
                              AutomationException
The area of interest to be rendered.

Specified by:
setAreaOfInterest in interface ITerrainRenderer2
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 ITerrainRenderer2
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 ITerrainRenderer2
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 ITerrainRenderer2
Returns:
The pResolution
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttributeFieldName

public void setAttributeFieldName(java.lang.String pName)
                           throws java.io.IOException,
                                  AutomationException
The name of the reserved field to be used to define drawing symbol.

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

getAttributeFieldName

public java.lang.String getAttributeFieldName()
                                       throws java.io.IOException,
                                              AutomationException
The name of the reserved field to be used to define drawing symbol.

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

setDataSources

public void setDataSources(ILongArray pDataSources)
                    throws java.io.IOException,
                           AutomationException
The embedded data sources to be rendered.

Specified by:
setDataSources in interface ITerrainAttributeRenderer
Parameters:
pDataSources - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSources

public ILongArray getDataSources()
                          throws java.io.IOException,
                                 AutomationException
The embedded data sources to be rendered.

Specified by:
getDataSources in interface ITerrainAttributeRenderer
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

redefineSymbols

public void redefineSymbols()
                     throws java.io.IOException,
                            AutomationException
Redefine drawing symbols based on cueernt data sources and attribute field name.

Specified by:
redefineSymbols in interface ITerrainAttributeRenderer
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.

getMaxSampleSize

public int getMaxSampleSize()
                     throws java.io.IOException,
                            AutomationException
Maximum sample size.

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

setMaxSampleSize

public void setMaxSampleSize(int size)
                      throws java.io.IOException,
                             AutomationException
Maximum sample size.

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

getSamplingMethod

public int getSamplingMethod()
                      throws java.io.IOException,
                             AutomationException
Data sampling method.

Specified by:
getSamplingMethod in interface IDataSampling
Returns:
A com.esri.arcgis.carto.esriDataSampling constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSamplingMethod

public void setSamplingMethod(int method)
                       throws java.io.IOException,
                              AutomationException
Data sampling method.

Specified by:
setSamplingMethod in interface IDataSampling
Parameters:
method - A com.esri.arcgis.carto.esriDataSampling constant (in)
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