com.esri.arcgis.carto
Class TinFaceValueRenderer

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

All Implemented Interfaces:

ILegendInfo, ITerrainRenderer, ITinIllumination, ITinRenderer, ITinUniqueValueRenderer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class TinFaceValueRenderer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITinUniqueValueRenderer, ITinRenderer, ITerrainRenderer, ITinIllumination, ILegendInfo, IPersistStream, IPersist, Externalizable

TIN face value renderer component.

Remarks

This coclass handles Face Tag Value Grouped with Unique Symbol TIN renderer. Use the ITinUniqueValueRenderer and ITinIllumination two interfaces that it implements to customize the renderer. The face tag value is of type integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

TinFaceValueRenderer()
Constructs a TinFaceValueRenderer using ArcGIS Engine.

TinFaceValueRenderer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TinFaceValueRenderer theTinFaceValueRenderer = (TinFaceValueRenderer) obj;

Method Summary

void	addReferenceValue(String value, String refValue) Adds a value that references another value.
void	addValue(String value, String heading, ISymbol symbol) Adds a value and a symbol to the list of categories, for multivariate Values, value is a comma separated list of values.
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(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getColorScheme() Name of Color Scheme (used in UI only).
String	getDefaultLabel() The default label used for unspecified values.
ISymbol	getDefaultSymbol() The default symbol used for unspecified values (may be NULL).
String	getDescription(String value) The description for the label.
String	getHeading(String value) The heading in which the given value is contained.
String	getLabel(String value) The label used to display the given value.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
String	getLookupStyleset() Name of Styleset for Lookup Symbols(used in UI only).
String	getName() The descriptive name of a renderer.
String	getReferenceValue(String value) The reference value for the given value.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISymbol	getSymbol(String value) The symbol associated with the given value.
ITerrain	getTerrain() The Terrain associated with the renderer.
ITin	getTin() The TIN associated with the renderer.
String	getValue(int index) The value at the given index.
int	getValueCount() The number of values used to categorize the data.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isIlluminate() Indicates if the shading for TIN triangle faces is illuminated.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isUseDefaultSymbol() Indicates if the default symbol is used for drawing unspecified values.
boolean	isVisible() Indicates if the renderer is currently visible.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	removeAllValues() Removes all values.
void	removeValue(String value) Removes a values from the list of categories.
void	save(IStream pstm, int fClearDirty) save
void	setColorScheme(String name) Name of Color Scheme (used in UI only).
void	setDefaultLabel(String label) The default label used for unspecified values.
void	setDefaultSymbolByRef(ISymbol symbol) The default symbol used for unspecified values (may be NULL).
void	setDescription(String value, String text) The description for the label.
void	setHeading(String value, String heading) The heading in which the given value is contained.
void	setIlluminate(boolean illuminate) Indicates if the shading for TIN triangle faces is illuminated.
void	setLabel(String value, String label) The label used to display the given value.
void	setLookupStyleset(String name) Name of Styleset for Lookup Symbols(used in UI only).
void	setName(String name) The descriptive name of a renderer.
void	setSymbol(String value, ISymbol symbol) The symbol associated with the given value.
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	setUseDefaultSymbol(boolean flag) Indicates if the default symbol is used for drawing unspecified values.
void	setValue(int index, String value) The value at the given index.
void	setVisible(boolean visible) Indicates if the renderer is currently visible.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

TinFaceValueRenderer

public TinFaceValueRenderer()
                     throws IOException,
                            UnknownHostException

Constructs a TinFaceValueRenderer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TinFaceValueRenderer

public TinFaceValueRenderer(Object obj)
                     throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getDefaultSymbol

public ISymbol getDefaultSymbol()
                         throws IOException,
                                AutomationException

The default symbol used for unspecified values (may be NULL).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultSymbol in interface ITinUniqueValueRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultSymbolByRef

public void setDefaultSymbolByRef(ISymbol symbol)
                           throws IOException,
                                  AutomationException

The default symbol used for unspecified values (may be NULL).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultSymbolByRef in interface ITinUniqueValueRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultLabel

public String getDefaultLabel()
                       throws IOException,
                              AutomationException

The default label used for unspecified values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultLabel in interface ITinUniqueValueRenderer

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultLabel

public void setDefaultLabel(String label)
                     throws IOException,
                            AutomationException

The default label used for unspecified values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultLabel in interface ITinUniqueValueRenderer

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseDefaultSymbol

public boolean isUseDefaultSymbol()
                           throws IOException,
                                  AutomationException

Indicates if the default symbol is used for drawing unspecified values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseDefaultSymbol in interface ITinUniqueValueRenderer

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseDefaultSymbol

public void setUseDefaultSymbol(boolean flag)
                         throws IOException,
                                AutomationException

Indicates if the default symbol is used for drawing unspecified values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseDefaultSymbol in interface ITinUniqueValueRenderer

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValueCount

public int getValueCount()
                  throws IOException,
                         AutomationException

The number of values used to categorize the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getValueCount in interface ITinUniqueValueRenderer

Returns:

The valueCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public String getValue(int index)
                throws IOException,
                       AutomationException

The value at the given index.

Product Availability

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

Specified by:

getValue in interface ITinUniqueValueRenderer

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int index,
                     String value)
              throws IOException,
                     AutomationException

The value at the given index.

Product Availability

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

Specified by:

setValue in interface ITinUniqueValueRenderer

Parameters:

index - The index (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceValue

public String getReferenceValue(String value)
                         throws IOException,
                                AutomationException

The reference value for the given value.

Product Availability

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

Specified by:

getReferenceValue in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

Returns:

The refValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addReferenceValue

public void addReferenceValue(String value,
                              String refValue)
                       throws IOException,
                              AutomationException

Adds a value that references another value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addReferenceValue in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

refValue - The refValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol(String value)
                  throws IOException,
                         AutomationException

The symbol associated with the given value.

Product Availability

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

Specified by:

getSymbol in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(String value,
                      ISymbol symbol)
               throws IOException,
                      AutomationException

The symbol associated with the given value.

Product Availability

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

Specified by:

setSymbol in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel(String value)
                throws IOException,
                       AutomationException

The label used to display the given value.

Product Availability

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

Specified by:

getLabel in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(String value,
                     String label)
              throws IOException,
                     AutomationException

The label used to display the given value.

Product Availability

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

Specified by:

setLabel in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription(String value)
                      throws IOException,
                             AutomationException

The description for the label.

Product Availability

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

Specified by:

getDescription in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String value,
                           String text)
                    throws IOException,
                           AutomationException

The description for the label.

Product Availability

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

Specified by:

setDescription in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeading

public String getHeading(String value)
                  throws IOException,
                         AutomationException

The heading in which the given value is contained.

Product Availability

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

Specified by:

getHeading in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

Returns:

The heading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeading

public void setHeading(String value,
                       String heading)
                throws IOException,
                       AutomationException

The heading in which the given value is contained.

Product Availability

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

Specified by:

setHeading in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

heading - The heading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addValue

public void addValue(String value,
                     String heading,
                     ISymbol symbol)
              throws IOException,
                     AutomationException

Adds a value and a symbol to the list of categories, for multivariate Values, value is a comma separated list of values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addValue in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

heading - The heading (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeValue

public void removeValue(String value)
                 throws IOException,
                        AutomationException

Removes a values from the list of categories.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeValue in interface ITinUniqueValueRenderer

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllValues

public void removeAllValues()
                     throws IOException,
                            AutomationException

Removes all values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAllValues in interface ITinUniqueValueRenderer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorScheme

public String getColorScheme()
                      throws IOException,
                             AutomationException

Name of Color Scheme (used in UI only).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColorScheme in interface ITinUniqueValueRenderer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorScheme

public void setColorScheme(String name)
                    throws IOException,
                           AutomationException

Name of Color Scheme (used in UI only).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColorScheme in interface ITinUniqueValueRenderer

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLookupStyleset

public String getLookupStyleset()
                         throws IOException,
                                AutomationException

Name of Styleset for Lookup Symbols(used in UI only).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLookupStyleset in interface ITinUniqueValueRenderer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLookupStyleset

public void setLookupStyleset(String name)
                       throws IOException,
                              AutomationException

Name of Styleset for Lookup Symbols(used in UI only).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLookupStyleset in interface ITinUniqueValueRenderer

Parameters:

name - The name (in)

Throws:

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 IOException,
                 AutomationException

Draws the TIN.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(ITinRenderer pSource)
          throws IOException,
                 AutomationException

Copies the properties of the given renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

copy in interface ITinRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender()
                  throws IOException,
                         AutomationException

Indicates if renderer can draw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canRender in interface ITinRenderer

Returns:

The pCanRender

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTinByRef

public void setTinByRef(ITin ppTin)
                 throws IOException,
                        AutomationException

The TIN associated with the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTinByRef in interface ITinRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTin

public ITin getTin()
            throws IOException,
                   AutomationException

The TIN associated with the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTin in interface ITinRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The descriptive name of a renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ITinRenderer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The descriptive name of a renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ITinRenderer

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the renderer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ITinRenderer

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the renderer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface ITinRenderer

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTerrainByRef

public void setTerrainByRef(ITerrain ppTerrain)
                     throws IOException,
                            AutomationException

The Terrain associated with the renderer.

Product Availability

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

Specified by:

setTerrainByRef in interface ITerrainRenderer

Parameters:

ppTerrain - A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTerrain

public ITerrain getTerrain()
                    throws IOException,
                           AutomationException

The Terrain associated with the renderer.

Product Availability

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

Specified by:

getTerrain in interface ITerrainRenderer

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIlluminate

public boolean isIlluminate()
                     throws IOException,
                            AutomationException

Indicates if the shading for TIN triangle faces is illuminated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIlluminate in interface ITinIllumination

Returns:

The illuminate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIlluminate

public void setIlluminate(boolean illuminate)
                   throws IOException,
                          AutomationException

Indicates if the shading for TIN triangle faces is illuminated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIlluminate in interface ITinIllumination

Parameters:

illuminate - The illuminate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException