com.esri.arcgis.carto
Class SimpleRenderer

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

All Implemented Interfaces:

IExportSupport, IFeatureRenderer, ILegendInfo, ILevelRenderer, ILookupSymbol, IRotationRenderer, IRotationRenderer2, ISimpleRenderer, ISizeRenderer, ITransparencyRenderer, IDisplayAdmin, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IPropertySupport, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class SimpleRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISimpleRenderer, IFeatureRenderer, ILevelRenderer, IPropertySupport, ILegendInfo, IPersistStream, IPersist, IRotationRenderer, IRotationRenderer2, ISizeRenderer, ITransparencyRenderer, IDisplayAdmin, ILookupSymbol, IXMLSerialize, IXMLVersionSupport, IExportSupport, java.io.Externalizable

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

Description 'A simple renderer where the same symbol is drawn for each feature.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

IID, IIDf3435800_5779_11d0_98bf_00805f7ced21, xxDummy

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

IID, IIDdc3d8097_c1ed_11d2_9f21_00c04f6bc709, xxDummy

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

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

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

IID, IID2f2047a6_42bd_11d2_aafd_00c04fa334b3, xxDummy

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

IID, IIDd85e5b0c_68b3_48c8_b8d2_087806273b47, xxDummy

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

IID, IID5ba3418a_4ba5_431a_b879_f2539c7be5ff, xxDummy

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

IID, IIDfb20665d_db1c_11d2_9f2e_00c04f6bc709, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin

IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy

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

IID, IID736a377d_a1eb_4ce4_84b9_90f9588374c2, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

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

IID, IIDf6448010_3cc8_435e_b042_540e9a328f3b, xxDummy

Constructor Summary

SimpleRenderer()
Constructs a SimpleRenderer using ArcGIS Engine.

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

Method Summary

boolean	applies(java.lang.Object pUnk) Indicates if the receiver can apply the given object at any given time.
java.lang.Object	apply(java.lang.Object newObject) Applies the given property to the receiver and returns the old object.
boolean	canApply(java.lang.Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
boolean	canRender(IFeatureClass featClass, IDisplay display) Indicates if the specified feature class can be rendered on the given display.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
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
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
java.lang.String	getDescription() Renderer description.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLabel() Renderer label.
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	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
java.lang.String	getRotationField() Rotation field.
int	getRotationType() Rotation type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getSizeRendererExpression() Gets size expression.
int	getSizeRendererFlags() Gets sizing flags composed of enum esriSizeRendererFlags.
void	getSizeRendererRandomRange(double[] pMinSize, double[] pMaxSize) Gets size range for random sizing.
ISymbol	getSymbol() Symbol used to draw each feature.
ISymbol	getSymbolByFeature(IFeature feature) Symbol used to draw the specified feature.
void	getSymbolRotation3DExpressions(java.lang.String[] pExpressionX, java.lang.String[] pExpressionY, java.lang.String[] pExpressionZ) Gets expressions for rotation about each axis.
int	getSymbolRotation3DFlags() Gets rotation flags composed of enum esriSymbolRotation3DFlags.
void	getSymbolRotation3DFlags2(int[] pFlagX, int[] pFlagY, int[] pFlagZ) Gets one flag for each axis.
void	getSymbolRotation3DRandomRanges(double[] pMinRotationX, double[] pMinRotationY, double[] pMinRotationZ, double[] pMaxRotationX, double[] pMaxRotationY, double[] pMaxRotationZ) Gets rotation range for each axis (for random rotation).
int	getSymbolRotation3DRotationTypeZ() Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes).
java.lang.String	getTransparencyField() Transparency field.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isRenderPhase(int drawPhase) Indicates if renderer uses the specified draw phase.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
void	load(IStream pstm) load
ISymbol	lookupSymbol(boolean firstPass, IFeature feature) Returns a reference to the renderer's symbol for the input feature.
void	prepareFilter(IFeatureClass fc, IQueryFilter queryFilter) Prepares the query filter for the rendering process.
void	readExternal(java.io.ObjectInput in)
void	release() Release a SimpleRenderer.
void	resetLookupSymbol(ISymbol symbol) Resets temporary options on the symbol (e.g.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCurrentDrawLevel(int rhs1) The current draw level, (set to -1 to draw all levels).
void	setDescription(java.lang.String text) Renderer description.
void	setExclusionSetByRef(IFeatureIDSet rhs1) An object reference to a temporary drawing exclusion set.
void	setExportInfoByRef(IFeatureExportInfoGenerator rhs1) The helper oject to generate export information.
void	setLabel(java.lang.String label) Renderer label.
void	setRotationField(java.lang.String fieldName) Rotation field.
void	setRotationType(int type) Rotation type.
void	setSizeRendererExpression(java.lang.String pExpression) Gets size expression.
void	setSizeRendererFlags(int pFlags) Gets sizing flags composed of enum esriSizeRendererFlags.
void	setSizeRendererRandomRange(double minSize, double maxSize) Sets size range for random sizing.
void	setSymbolByRef(ISymbol symbol) Symbol used to draw each feature.
void	setSymbolRotation3DExpressions(java.lang.String expressionX, java.lang.String expressionY, java.lang.String expressionZ) Sets expressions for rotation about each axis.
void	setSymbolRotation3DFlags(int pFlags) Gets rotation flags composed of enum esriSymbolRotation3DFlags.
void	setSymbolRotation3DFlags2(int flagX, int flagY, int flagZ) Sets one flag for each axis.
void	setSymbolRotation3DRandomRanges(double minRotationX, double minRotationY, double minRotationZ, double maxRotationX, double maxRotationY, double maxRotationZ) Sets rotation range for each axis (for random rotation).
void	setSymbolRotation3DRotationTypeZ(int pType) Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes).
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTransparencyField(java.lang.String fieldName) Transparency field.
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

SimpleRenderer

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

Constructs a SimpleRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SimpleRenderer

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

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

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

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

Specified by:

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

getSymbol

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

Symbol used to draw each feature.

Specified by:

getSymbol in interface ISimpleRenderer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Symbol used to draw each feature.

Specified by:

setSymbolByRef in interface ISimpleRenderer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

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

Renderer label.

Specified by:

getLabel in interface ISimpleRenderer

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

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

Renderer label.

Specified by:

setLabel in interface ISimpleRenderer

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Renderer description.

Specified by:

getDescription in interface ISimpleRenderer

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

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

Renderer description.

Specified by:

setDescription in interface ISimpleRenderer

Parameters:

text - The text (in)

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.

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.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Specified by:

applies in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Specified by:

canApply in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The canApply

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrent

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

The object currently being used.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

apply

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

Applies the given property to the receiver and returns the old object.

Specified by:

apply in interface IPropertySupport

Parameters:

newObject - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

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

Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendGroupCount in interface ILegendInfo

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:

getLegendGroup in interface ILegendInfo

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.ILegendGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException

Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendItem in interface ILegendInfo

Returns:

A reference to a com.esri.arcgis.carto.ILegendItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

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

Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSymbolsAreGraduated in interface ILegendInfo

Returns:

The symbolsAreGraduated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolsAreGraduated in interface ILegendInfo

Parameters:

symbolsAreGraduated - The symbolsAreGraduated (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

getSymbolRotation3DFlags

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

Gets rotation flags composed of enum esriSymbolRotation3DFlags. Not just for 3D rotation.

Specified by:

getSymbolRotation3DFlags in interface IRotationRenderer2

Returns:

The pFlags

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DFlags

public void setSymbolRotation3DFlags(int pFlags)
                              throws java.io.IOException,
                                     AutomationException

Gets rotation flags composed of enum esriSymbolRotation3DFlags. Not just for 3D rotation.

Specified by:

setSymbolRotation3DFlags in interface IRotationRenderer2

Parameters:

pFlags - The pFlags (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolRotation3DFlags2

public void getSymbolRotation3DFlags2(int[] pFlagX,
                                      int[] pFlagY,
                                      int[] pFlagZ)
                               throws java.io.IOException,
                                      AutomationException

Gets one flag for each axis. Serves same purpose as SymbolRotation3DFlags (get_, put_).

Specified by:

getSymbolRotation3DFlags2 in interface IRotationRenderer2

Parameters:

pFlagX - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)

pFlagY - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)

pFlagZ - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DFlags2

public void setSymbolRotation3DFlags2(int flagX,
                                      int flagY,
                                      int flagZ)
                               throws java.io.IOException,
                                      AutomationException

Sets one flag for each axis. For axis which is not to be rotated, set to esriSymbolRotation3DNone. Serves same purpose as SymbolRotation3DFlags (get_, put_).

Specified by:

setSymbolRotation3DFlags2 in interface IRotationRenderer2

Parameters:

flagX - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)

flagY - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)

flagZ - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolRotation3DRotationTypeZ

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

Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes).

Specified by:

getSymbolRotation3DRotationTypeZ in interface IRotationRenderer2

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.

setSymbolRotation3DRotationTypeZ

public void setSymbolRotation3DRotationTypeZ(int pType)
                                      throws java.io.IOException,
                                             AutomationException

Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes).

Specified by:

setSymbolRotation3DRotationTypeZ in interface IRotationRenderer2

Parameters:

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

getSymbolRotation3DExpressions

public void getSymbolRotation3DExpressions(java.lang.String[] pExpressionX,
                                           java.lang.String[] pExpressionY,
                                           java.lang.String[] pExpressionZ)
                                    throws java.io.IOException,
                                           AutomationException

Gets expressions for rotation about each axis. In case of non-3D rotation, Z axis is used.

Specified by:

getSymbolRotation3DExpressions in interface IRotationRenderer2

Parameters:

pExpressionX - The pExpressionX (out: use single element array)

pExpressionY - The pExpressionY (out: use single element array)

pExpressionZ - The pExpressionZ (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DExpressions

public void setSymbolRotation3DExpressions(java.lang.String expressionX,
                                           java.lang.String expressionY,
                                           java.lang.String expressionZ)
                                    throws java.io.IOException,
                                           AutomationException

Sets expressions for rotation about each axis. In case of non-3D rotation, Z axis is used.

Specified by:

setSymbolRotation3DExpressions in interface IRotationRenderer2

Parameters:

expressionX - The expressionX (in)

expressionY - The expressionY (in)

expressionZ - The expressionZ (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolRotation3DRandomRanges

public void getSymbolRotation3DRandomRanges(double[] pMinRotationX,
                                            double[] pMinRotationY,
                                            double[] pMinRotationZ,
                                            double[] pMaxRotationX,
                                            double[] pMaxRotationY,
                                            double[] pMaxRotationZ)
                                     throws java.io.IOException,
                                            AutomationException

Gets rotation range for each axis (for random rotation).

Specified by:

getSymbolRotation3DRandomRanges in interface IRotationRenderer2

Parameters:

pMinRotationX - The pMinRotationX (out: use single element array)

pMinRotationY - The pMinRotationY (out: use single element array)

pMinRotationZ - The pMinRotationZ (out: use single element array)

pMaxRotationX - The pMaxRotationX (out: use single element array)

pMaxRotationY - The pMaxRotationY (out: use single element array)

pMaxRotationZ - The pMaxRotationZ (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DRandomRanges

public void setSymbolRotation3DRandomRanges(double minRotationX,
                                            double minRotationY,
                                            double minRotationZ,
                                            double maxRotationX,
                                            double maxRotationY,
                                            double maxRotationZ)
                                     throws java.io.IOException,
                                            AutomationException

Sets rotation range for each axis (for random rotation).

Specified by:

setSymbolRotation3DRandomRanges in interface IRotationRenderer2

Parameters:

minRotationX - The minRotationX (in)

minRotationY - The minRotationY (in)

minRotationZ - The minRotationZ (in)

maxRotationX - The maxRotationX (in)

maxRotationY - The maxRotationY (in)

maxRotationZ - The maxRotationZ (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeRendererFlags

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

Gets sizing flags composed of enum esriSizeRendererFlags.

Specified by:

getSizeRendererFlags in interface ISizeRenderer

Returns:

The pFlags

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSizeRendererFlags

public void setSizeRendererFlags(int pFlags)
                          throws java.io.IOException,
                                 AutomationException

Gets sizing flags composed of enum esriSizeRendererFlags.

Specified by:

setSizeRendererFlags in interface ISizeRenderer

Parameters:

pFlags - The pFlags (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeRendererExpression

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

Gets size expression.

Specified by:

getSizeRendererExpression in interface ISizeRenderer

Returns:

The pExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSizeRendererExpression

public void setSizeRendererExpression(java.lang.String pExpression)
                               throws java.io.IOException,
                                      AutomationException

Gets size expression.

Specified by:

setSizeRendererExpression in interface ISizeRenderer

Parameters:

pExpression - The pExpression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeRendererRandomRange

public void getSizeRendererRandomRange(double[] pMinSize,
                                       double[] pMaxSize)
                                throws java.io.IOException,
                                       AutomationException

Gets size range for random sizing.

Specified by:

getSizeRendererRandomRange in interface ISizeRenderer

Parameters:

pMinSize - The pMinSize (out: use single element array)

pMaxSize - The pMaxSize (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSizeRendererRandomRange

public void setSizeRendererRandomRange(double minSize,
                                       double maxSize)
                                throws java.io.IOException,
                                       AutomationException

Sets size range for random sizing.

Specified by:

setSizeRendererRandomRange in interface ISizeRenderer

Parameters:

minSize - The minSize (in)

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

isUsesFilter

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

Indicates if the current object draws using a filter.

Specified by:

isUsesFilter in interface IDisplayAdmin

Returns:

The usesFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

lookupSymbol

public ISymbol lookupSymbol(boolean firstPass,
                            IFeature feature)
                     throws java.io.IOException,
                            AutomationException

Returns a reference to the renderer's symbol for the input feature.

Specified by:

lookupSymbol in interface ILookupSymbol

Parameters:

firstPass - The firstPass (in)

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.

resetLookupSymbol

public void resetLookupSymbol(ISymbol symbol)
                       throws java.io.IOException,
                              AutomationException

Resets temporary options on the symbol (e.g. Rotation).

Specified by:

resetLookupSymbol in interface ILookupSymbol

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExportInfoByRef

public void setExportInfoByRef(IFeatureExportInfoGenerator rhs1)
                        throws java.io.IOException,
                               AutomationException

The helper oject to generate export information.

Specified by:

setExportInfoByRef in interface IExportSupport

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException