com.esri.arcgis.trackinganalyst
Class UniqueValueTextRenderer

java.lang.Object
  com.esri.arcgis.trackinganalyst.UniqueValueTextRenderer

All Implemented Interfaces:

IFeatureRenderer, ILegendInfo, ILevelRenderer, IRendererClasses, IRotationRenderer, ITransparencyRenderer, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IUniqueValueTextRenderer, java.io.Externalizable, java.io.Serializable

public class UniqueValueTextRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IUniqueValueTextRenderer, IClone, IFeatureRenderer, ILegendInfo, ILevelRenderer, IRendererClasses, IRotationRenderer, ITransparencyRenderer, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'UniqueValueTextRenderer'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'This is a feature renderer that supports rendering points using values from a field in the feature class.' 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.trackinganalyst.IUniqueValueTextRenderer

IID, IIDf0ec44ef_f2b4_4433_b5ab_9908c5e740e7, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IIDdc3d8097_c1ed_11d2_9f21_00c04f6bc709, xxDummy

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

IID, IID3f25cc56_cc66_4930_a5fd_bc981601cea6, xxDummy

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

IID, IID2f2047a6_42bd_11d2_aafd_00c04fa334b3, xxDummy

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

IID, IIDfb20665d_db1c_11d2_9f2e_00c04f6bc709, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

UniqueValueTextRenderer()
Constructs a UniqueValueTextRenderer using ArcGIS Engine.

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

Method Summary

void	addReferenceValue(java.lang.String value, java.lang.String refValue) Adds a value to the renderer to be grouped with the refValue, which has already ben added to the renderer.
void	addValue(java.lang.String value, java.lang.String heading, ISymbol symbol) Adds a value and correstonding symbol to the list.
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	canRender(IFeatureClass featClass, IDisplay display) Indicates if the specified feature class can be rendered on the given display.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws features from the specified cursor on the given display.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
java.lang.String	esri_getClass(int index) Class name.
int	getClassCount() Number of classes.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getColorScheme() Color scheme (user interface property only).
java.lang.String	getDefaultLabel() Label used for unspecified values.
ISymbol	getDefaultSymbol() Symbol used to draw any unspecified values (may be NULL).
java.lang.String	getDescription(java.lang.String value) Description for the specified label.
java.lang.String	getField(int index) Field at the specified index that is used to categorize features.
int	getFieldCount() Number of fields used by the renderer (0-3).
java.lang.String	getFieldDelimiter() Delimiter used to separate field values.
java.lang.String	getHeading(java.lang.String value) Heading that contains the specified value.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLabel(java.lang.String value) Label for the specified value.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
java.lang.Object	getLevelArray() Array that contains all levels used by the symbols, (symbols without a level get a level of 0).
java.lang.String	getLookupStyleset() Style used for matching (user interface property only).
java.lang.String	getReferenceValue(java.lang.String value) Reference value for the specified value.
java.lang.String	getRotationField() Rotation field.
int	getRotationType() Rotation type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISymbol	getSymbol(java.lang.String value) Symbol associated with the specified value.
ISymbol	getSymbolByFeature(IFeature feature) Symbol used to draw the specified feature.
java.lang.String	getTransparencyField() Transparency field.
java.lang.String	getValue(int index) Value at the specified index.
int	getValueCount() Number of unique values used to categorieze the data.
java.lang.String	getWhereClause(int index, ITable table) WhereClause.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isRenderPhase(int drawPhase) Indicates if renderer uses the specified draw phase.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isUseDefaultSymbol() Indicates if DefaultSymbol is used for drawing unspecified values.
void	load(IStream pstm) load
void	prepareFilter(IFeatureClass fc, IQueryFilter queryFilter) Prepares the query filter for the rendering process.
void	readExternal(java.io.ObjectInput in)
void	release() Release a UniqueValueTextRenderer.
void	removeAllValues() Removes all values from teh renderer.
void	removeValue(java.lang.String value) Removes a value from the renderer.
void	save(IStream pstm, int fClearDirty) save
void	setColorScheme(java.lang.String name) Color scheme (user interface property only).
void	setCurrentDrawLevel(int rhs1) The current draw level, (set to -1 to draw all levels).
void	setDefaultLabel(java.lang.String pLabel) Label used for unspecified values.
void	setDefaultSymbol(ISymbol pVal) Symbol used to draw any unspecified values (may be NULL).
void	setDescription(java.lang.String value, java.lang.String pVal) Description for the specified label.
void	setExclusionSetByRef(IFeatureIDSet rhs1) An object reference to a temporary drawing exclusion set.
void	setField(int index, java.lang.String pVal) Field at the specified index that is used to categorize features.
void	setFieldCount(int pVal) Number of fields used by the renderer (0-3).
void	setFieldDelimiter(java.lang.String pVal) Delimiter used to separate field values.
void	setFieldType(int index, boolean rhs2) Indicates if the field at eth specified index is a string.
void	setHeading(java.lang.String value, java.lang.String pVal) Heading that contains the specified value.
void	setLabel(java.lang.String value, java.lang.String pVal) Label for the specified value.
void	setLookupStyleset(java.lang.String pVal) Style used for matching (user interface property only).
void	setRotationField(java.lang.String fieldName) Rotation field.
void	setRotationType(int type) Rotation type.
void	setSymbol(java.lang.String value, ISymbol pVal) Symbol associated with the specified value.
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTransparencyField(java.lang.String fieldName) Transparency field.
void	setUseDefaultSymbol(boolean pVal) Indicates if DefaultSymbol is used for drawing unspecified values.
void	setValue(int index, java.lang.String pVal) Value at the specified index.
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

UniqueValueTextRenderer

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

Constructs a UniqueValueTextRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

UniqueValueTextRenderer

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

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

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

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

Specified by:

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

addReferenceValue

public void addReferenceValue(java.lang.String value,
                              java.lang.String refValue)
                       throws java.io.IOException,
                              AutomationException

Adds a value to the renderer to be grouped with the refValue, which has already ben added to the renderer.

Specified by:

addReferenceValue in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

refValue - The refValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addValue

public void addValue(java.lang.String value,
                     java.lang.String heading,
                     ISymbol symbol)
              throws java.io.IOException,
                     AutomationException

Adds a value and correstonding symbol to the list.

Specified by:

addValue in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

heading - The heading (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColorScheme

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

Color scheme (user interface property only).

Specified by:

getColorScheme in interface IUniqueValueTextRenderer

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColorScheme

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

Color scheme (user interface property only).

Specified by:

setColorScheme in interface IUniqueValueTextRenderer

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultLabel

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

Label used for unspecified values.

Specified by:

getDefaultLabel in interface IUniqueValueTextRenderer

Returns:

The pLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultLabel

public void setDefaultLabel(java.lang.String pLabel)
                     throws java.io.IOException,
                            AutomationException

Label used for unspecified values.

Specified by:

setDefaultLabel in interface IUniqueValueTextRenderer

Parameters:

pLabel - The pLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSymbol

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

Symbol used to draw any unspecified values (may be NULL).

Specified by:

getDefaultSymbol in interface IUniqueValueTextRenderer

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.

setDefaultSymbol

public void setDefaultSymbol(ISymbol pVal)
                      throws java.io.IOException,
                             AutomationException

Symbol used to draw any unspecified values (may be NULL).

Specified by:

setDefaultSymbol in interface IUniqueValueTextRenderer

Parameters:

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

getDescription

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

Description for the specified label.

Specified by:

getDescription in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String value,
                           java.lang.String pVal)
                    throws java.io.IOException,
                           AutomationException

Description for the specified label.

Specified by:

setDescription in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

public java.lang.String getField(int index)
                          throws java.io.IOException,
                                 AutomationException

Field at the specified index that is used to categorize features.

Specified by:

getField in interface IUniqueValueTextRenderer

Parameters:

index - The index (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setField

public void setField(int index,
                     java.lang.String pVal)
              throws java.io.IOException,
                     AutomationException

Field at the specified index that is used to categorize features.

Specified by:

setField in interface IUniqueValueTextRenderer

Parameters:

index - The index (in)

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldCount

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

Number of fields used by the renderer (0-3).

Specified by:

getFieldCount in interface IUniqueValueTextRenderer

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldCount

public void setFieldCount(int pVal)
                   throws java.io.IOException,
                          AutomationException

Number of fields used by the renderer (0-3).

Specified by:

setFieldCount in interface IUniqueValueTextRenderer

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldDelimiter

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

Delimiter used to separate field values.

Specified by:

getFieldDelimiter in interface IUniqueValueTextRenderer

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldDelimiter

public void setFieldDelimiter(java.lang.String pVal)
                       throws java.io.IOException,
                              AutomationException

Delimiter used to separate field values.

Specified by:

setFieldDelimiter in interface IUniqueValueTextRenderer

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldType

public void setFieldType(int index,
                         boolean rhs2)
                  throws java.io.IOException,
                         AutomationException

Indicates if the field at eth specified index is a string.

Specified by:

setFieldType in interface IUniqueValueTextRenderer

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeading

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

Heading that contains the specified value.

Specified by:

getHeading in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeading

public void setHeading(java.lang.String value,
                       java.lang.String pVal)
                throws java.io.IOException,
                       AutomationException

Heading that contains the specified value.

Specified by:

setHeading in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

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

Label for the specified value.

Specified by:

getLabel in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(java.lang.String value,
                     java.lang.String pVal)
              throws java.io.IOException,
                     AutomationException

Label for the specified value.

Specified by:

setLabel in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLookupStyleset

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

Style used for matching (user interface property only).

Specified by:

getLookupStyleset in interface IUniqueValueTextRenderer

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLookupStyleset

public void setLookupStyleset(java.lang.String pVal)
                       throws java.io.IOException,
                              AutomationException

Style used for matching (user interface property only).

Specified by:

setLookupStyleset in interface IUniqueValueTextRenderer

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceValue

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

Reference value for the specified value.

Specified by:

getReferenceValue in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllValues

public void removeAllValues()
                     throws java.io.IOException,
                            AutomationException

Removes all values from teh renderer.

Specified by:

removeAllValues in interface IUniqueValueTextRenderer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeValue

public void removeValue(java.lang.String value)
                 throws java.io.IOException,
                        AutomationException

Removes a value from the renderer.

Specified by:

removeValue in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol(java.lang.String value)
                  throws java.io.IOException,
                         AutomationException

Symbol associated with the specified value.

Specified by:

getSymbol in interface IUniqueValueTextRenderer

Parameters:

value - The value (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(java.lang.String value,
                      ISymbol pVal)
               throws java.io.IOException,
                      AutomationException

Symbol associated with the specified value.

Specified by:

setSymbol in interface IUniqueValueTextRenderer

Parameters:

value - The value (in)

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

isUseDefaultSymbol

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

Indicates if DefaultSymbol is used for drawing unspecified values.

Specified by:

isUseDefaultSymbol in interface IUniqueValueTextRenderer

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseDefaultSymbol

public void setUseDefaultSymbol(boolean pVal)
                         throws java.io.IOException,
                                AutomationException

Indicates if DefaultSymbol is used for drawing unspecified values.

Specified by:

setUseDefaultSymbol in interface IUniqueValueTextRenderer

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

public java.lang.String getValue(int index)
                          throws java.io.IOException,
                                 AutomationException

Value at the specified index.

Specified by:

getValue in interface IUniqueValueTextRenderer

Parameters:

index - The index (in)

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int index,
                     java.lang.String pVal)
              throws java.io.IOException,
                     AutomationException

Value at the specified index.

Specified by:

setValue in interface IUniqueValueTextRenderer

Parameters:

index - The index (in)

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValueCount

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

Number of unique values used to categorieze the data.

Specified by:

getValueCount in interface IUniqueValueTextRenderer

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender(IFeatureClass featClass,
                         IDisplay display)
                  throws java.io.IOException,
                         AutomationException

Indicates if the specified feature class can be rendered on the given display.

Remarks

If the renderer is not applicable to a feature layer, then it can return False in response to a CanRender method. For example, the dot-density renderer is only applicable to polygon feature layers and returns False in response to other feature layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canRender in interface IFeatureRenderer

Parameters:

featClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

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

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareFilter

public void prepareFilter(IFeatureClass fc,
                          IQueryFilter queryFilter)
                   throws java.io.IOException,
                          AutomationException

Prepares the query filter for the rendering process.

Remarks

This method is called prior to the Draw method and gives the renderer a chance to adjust the query filter to incorporate extra constraints. For example, if a particular field is required for the renderer, it would add this field to the filter to ensure it is accessible during the Draw method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

prepareFilter in interface IFeatureRenderer

Parameters:

fc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

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

Draws features from the specified cursor on the given display.

Remarks

This method is typically called by the framework to renderer features to a display. This could be in response to a refresh on the map. This method typically iterates through all the features and renders each feature with an appropriate symbol.

An individual feature is typically drawn by calling the Draw method on the feature's IFeatureDraw with the symbol created by the renderer. However, when writing a custom feature renderer you can draw anything you want using a number of different methods. To learn more see the section on writing a custom feature renderer in Extending ArcObjects.

To allow complex rendering to be canceled halfway through a draw, the renderer typically checks the TrackCancel object after each feature or set of features. If a cancel action has occurred, the renderer will exit.

There are three drawing phases: selection, annotation, and geography, and this method can be called by the framework up to three times. With the exception of the selection phase, this method will only be called for a particular draw phase if the call by the framework to RenderPhase returns true for that phase.

Feature renderers typically only draw features during the geography phase, though in some cases features are drawn in the annotation phase. Take for example a case where proportional symbols are drawn for polygon features. The ProportionalSymbolRenderer draws the background fill symbol during the geography phase and the proportionally sized marker symbol during the annotation phase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IFeatureRenderer

Parameters:

cursor - A reference to a com.esri.arcgis.geodatabase.IFeatureCursor (in)

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

display - A reference to a com.esri.arcgis.display.IDisplay (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.

getSymbolByFeature

public ISymbol getSymbolByFeature(IFeature feature)
                           throws java.io.IOException,
                                  AutomationException

Symbol used to draw the specified feature.

Product Availability

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

Specified by:

getSymbolByFeature in interface IFeatureRenderer

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (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.

isRenderPhase

public boolean isRenderPhase(int drawPhase)
                      throws java.io.IOException,
                             AutomationException

Indicates if renderer uses the specified draw phase.

Product Availability

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

Specified by:

isRenderPhase in interface IFeatureRenderer

Parameters:

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

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

public void setExclusionSetByRef(IFeatureIDSet rhs1)
                          throws java.io.IOException,
                                 AutomationException

An object reference to a temporary drawing exclusion set.

Description

The list of feature IDs to be excluded from drawing.

Remarks

Some feature renderers support IDataExclusion which allows you to build a where clause to exclude features.

Exclusion prevents features from drawing. To prevent features from drawing as well as from appearing in tables and in query results, set a layer definition query using IFeatureLayerDefinition.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExclusionSetByRef in interface IFeatureRenderer

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)

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.

setCurrentDrawLevel

public void setCurrentDrawLevel(int rhs1)
                         throws java.io.IOException,
                                AutomationException

The current draw level, (set to -1 to draw all levels).

Specified by:

setCurrentDrawLevel in interface ILevelRenderer

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLevelArray

public java.lang.Object getLevelArray()
                               throws java.io.IOException,
                                      AutomationException

Array that contains all levels used by the symbols, (symbols without a level get a level of 0).

Specified by:

getLevelArray in interface ILevelRenderer

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassCount

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

Number of classes.

Specified by:

getClassCount in interface IRendererClasses

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getClass

public java.lang.String esri_getClass(int index)
                               throws java.io.IOException,
                                      AutomationException

Class name.

Specified by:

esri_getClass in interface IRendererClasses

Parameters:

index - The index (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public java.lang.String getWhereClause(int index,
                                       ITable table)
                                throws java.io.IOException,
                                       AutomationException

WhereClause.

Specified by:

getWhereClause in interface IRendererClasses

Parameters:

index - The index (in)

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Returns:

The whereClause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRotationField

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

Rotation field.

Specified by:

getRotationField in interface IRotationRenderer

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRotationField

public void setRotationField(java.lang.String fieldName)
                      throws java.io.IOException,
                             AutomationException

Rotation field.

Specified by:

setRotationField in interface IRotationRenderer

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRotationType

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

Rotation type.

Specified by:

getRotationType in interface IRotationRenderer

Returns:

A com.esri.arcgis.carto.esriSymbolRotationType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRotationType

public void setRotationType(int type)
                     throws java.io.IOException,
                            AutomationException

Rotation type.

Specified by:

setRotationType in interface IRotationRenderer

Parameters:

type - A com.esri.arcgis.carto.esriSymbolRotationType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparencyField

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

Transparency field.

Specified by:

getTransparencyField in interface ITransparencyRenderer

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparencyField

public void setTransparencyField(java.lang.String fieldName)
                          throws java.io.IOException,
                                 AutomationException

Transparency field.

Specified by:

setTransparencyField in interface ITransparencyRenderer

Parameters:

fieldName - The fieldName (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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

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