com.esri.arcgis.carto
Class IFeatureRendererProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IFeatureRendererProxy

All Implemented Interfaces:

IFeatureRenderer, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for COM Interface 'IFeatureRenderer'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control functionality common to all feature renderers.' 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 =

public class IFeatureRendererProxy
extends com.esri.arcgis.interop.Dispatch
implements IFeatureRenderer, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IFeatureRendererProxy() Deprecated. For internal use only
	IFeatureRendererProxy(java.lang.Object obj) Deprecated.
protected	IFeatureRendererProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IFeatureRendererProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IFeatureRendererProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
boolean	canRender(IFeatureClass featClass, IDisplay display) Deprecated. Indicates if the specified feature class can be rendered on the given display.
void	draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel) Deprecated. Draws features from the specified cursor on the given display.
ISymbol	getSymbolByFeature(IFeature feature) Deprecated. Symbol used to draw the specified feature.
boolean	isRenderPhase(int drawPhase) Deprecated. Indicates if renderer uses the specified draw phase.
void	prepareFilter(IFeatureClass fc, IQueryFilter queryFilter) Deprecated. Prepares the query filter for the rendering process.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	setExclusionSetByRef(IFeatureIDSet rhs1) Deprecated. An object reference to a temporary drawing exclusion set.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IFeatureRendererProxy

public IFeatureRendererProxy(java.lang.String CLSID,
                             java.lang.String host,
                             com.esri.arcgis.interop.AuthInfo authInfo)
                      throws java.net.UnknownHostException,
                             java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IFeatureRendererProxy

public IFeatureRendererProxy()

Deprecated.

For internal use only

IFeatureRendererProxy

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

Deprecated.

Throws:

java.io.IOException

IFeatureRendererProxy

protected IFeatureRendererProxy(java.lang.Object obj,
                                java.lang.String iid)
                         throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IFeatureRendererProxy

protected IFeatureRendererProxy(java.lang.String CLSID,
                                java.lang.String iid,
                                java.lang.String host,
                                com.esri.arcgis.interop.AuthInfo authInfo)
                         throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

canRender

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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.