com.esri.arcgis.carto
Interface ITinUniqueValueRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

TerrainPointUniqueValueRenderer, TinBreaklineRenderer, TinFaceValueRenderer, TinNodeValueRenderer

public interface ITinUniqueValueRenderer
extends Serializable

Provides access to members that assign symbols to TIN features based upon tag value or edge type.

Product Availability

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

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.
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.
String	getLookupStyleset() Name of Styleset for Lookup Symbols(used in UI only).
String	getReferenceValue(String value) The reference value for the given value.
ISymbol	getSymbol(String value) The symbol associated with the given value.
String	getValue(int index) The value at the given index.
int	getValueCount() The number of values used to categorize the data.
boolean	isUseDefaultSymbol() Indicates if the default symbol is used for drawing unspecified values.
void	removeAllValues() Removes all values.
void	removeValue(String value) Removes a values from the list of categories.
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	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	setSymbol(String value, ISymbol symbol) The symbol associated with the given value.
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.

Method Detail

getDefaultSymbol

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

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

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

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

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

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultLabel

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

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseDefaultSymbol

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseDefaultSymbol

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValueCount

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

Returns:

The valueCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

String getValue(int index)
                throws IOException,
                       AutomationException

The value at the given index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

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.

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

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.

Parameters:

value - The value (in)

Returns:

The refValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addReferenceValue

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

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

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.

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

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.

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

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.

Parameters:

value - The value (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

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.

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

String getDescription(String value)
                      throws IOException,
                             AutomationException

The description for the label.

Product Availability

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

Parameters:

value - The value (in)

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

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.

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

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.

Parameters:

value - The value (in)

Returns:

The heading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeading

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.

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

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

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

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllValues

void removeAllValues()
                     throws IOException,
                            AutomationException

Removes all values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorScheme

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorScheme

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLookupStyleset

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLookupStyleset

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.