com.esri.arcgis.networkanalyst
Class NAStopRenderer

java.lang.Object
  com.esri.arcgis.networkanalyst.NAStopRenderer

All Implemented Interfaces:

IFeatureRenderer, IFeatureSelectionRenderer, ILegendInfo, ILevelRenderer, com.esri.arcgis.interop.RemoteObjRef, INAStopRenderer, INAStopRenderer2, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable

public class NAStopRenderer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAStopRenderer, INAStopRenderer2, ILegendInfo, IFeatureRenderer, IFeatureSelectionRenderer, ILevelRenderer, IPropertySupport, IPersistStream, Externalizable

Defines symbology for rendering stops.

Remarks

The NAStopRenderer is a specialized renderer for drawing Stops. It provides specialized symbology for regular stops, as well as for stops that have errors, are unlocated, or have a time window violation. It also draws the sequence number of the stop within the stop symbol. You can configure a FeatureLayer that is referencing an NAClass representing stops to use this renderer.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NAStopRenderer()
Constructs a NAStopRenderer using ArcGIS Engine.

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

Method Summary

boolean	applies(Object pUnk) Indicates if the receiver can apply the given object at any given time.
Object	apply(Object newObject) Applies the given property to the receiver and returns the old object.
boolean	canApply(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	draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws features from the specified cursor on the given display.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getCurrent(Object pUnk) The object currently being used.
IMarkerSymbol	getErrorSymbol() The symbol used for a stop that has an error.
ILegendClass	getLegendClass(int symbolType) The legend class associated with the stop symbol type.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
Object	getLevelArray() Array that contains all levels used by the symbols, (symbols without a level get a level of 0).
IColor	getSelectionColor() Selection color.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IMarkerSymbol	getStopSymbol() The symbol used for a located stop.
int	getStopSymbolPosition(int symbolType) The stop symbol position of the symbol type in the group of all stop renderer symbol types.
ISymbol	getSymbolByFeature(IFeature feature) Symbol used to draw the specified feature.
ITextSymbol	getTextSymbol() The text symbol used for a stop.
IMarkerSymbol	getTimeViolationSymbol() The symbol used for a stop that has a time window violation.
IMarkerSymbol	getUnlocatedSymbol() The symbol used for a stop that could not be found on the network.
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	isVisible(int symbolType) Indicates if the stop symbol type is visible.
void	load(IStream pstm) load
void	moveStopSymbol(int symbolType, int newPosition) Move the stop symbol type to the new position in the group of all stop renderer symbol types.
void	prepareFilter(IFeatureClass fc, IQueryFilter queryFilter) Prepares the query filter for the rendering process.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setCurrentDrawLevel(int rhs1) The current draw level, (set to -1 to draw all levels).
void	setErrorSymbol(IMarkerSymbol symbol) The symbol used for a stop that has an error.
void	setExclusionSetByRef(IFeatureIDSet rhs1) An object reference to a temporary drawing exclusion set.
void	setSelectionColor(IColor color) Selection color.
void	setStopSymbol(IMarkerSymbol symbol) The symbol used for a located stop.
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTextSymbol(ITextSymbol symbol) The text symbol used for a stop.
void	setTimeViolationSymbol(IMarkerSymbol symbol) The symbol used for a stop that has a time window violation.
void	setUnlocatedSymbol(IMarkerSymbol symbol) The symbol used for a stop that could not be found on the network.
void	setVisible(int symbolType, boolean show) Indicates if the stop symbol type is visible.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

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

getJintegraDispatch, release

Constructor Detail

NAStopRenderer

public NAStopRenderer()
               throws IOException,
                      UnknownHostException

Constructs a NAStopRenderer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NAStopRenderer

public NAStopRenderer(Object obj)
               throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getStopSymbol

public IMarkerSymbol getStopSymbol()
                            throws IOException,
                                   AutomationException

The symbol used for a located stop.

Remarks

The StopSymbol specifies the marker symbol to use for drawing ordinary stops with no error status.

Product Availability

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

Specified by:

getStopSymbol in interface INAStopRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStopSymbol

public void setStopSymbol(IMarkerSymbol symbol)
                   throws IOException,
                          AutomationException

The symbol used for a located stop.

Remarks

The StopSymbol specifies the marker symbol to use for drawing ordinary stops with no error status.

Product Availability

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

Specified by:

setStopSymbol in interface INAStopRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnlocatedSymbol

public IMarkerSymbol getUnlocatedSymbol()
                                 throws IOException,
                                        AutomationException

The symbol used for a stop that could not be found on the network.

Remarks

The UnlocatedSymbol specifies the marker symbol to use for drawing unlocated stops.

Product Availability

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

Specified by:

getUnlocatedSymbol in interface INAStopRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnlocatedSymbol

public void setUnlocatedSymbol(IMarkerSymbol symbol)
                        throws IOException,
                               AutomationException

The symbol used for a stop that could not be found on the network.

Remarks

The UnlocatedSymbol specifies the marker symbol to use for drawing unlocated stops.

Product Availability

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

Specified by:

setUnlocatedSymbol in interface INAStopRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorSymbol

public IMarkerSymbol getErrorSymbol()
                             throws IOException,
                                    AutomationException

The symbol used for a stop that has an error.

Remarks

The ErrorSymbol specifies the marker symbol to use for drawing stops with one or more errors determined during solve.

Product Availability

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

Specified by:

getErrorSymbol in interface INAStopRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorSymbol

public void setErrorSymbol(IMarkerSymbol symbol)
                    throws IOException,
                           AutomationException

The symbol used for a stop that has an error.

Remarks

The ErrorSymbol specifies the marker symbol to use for drawing stops with one or more errors determined during solve.

Product Availability

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

Specified by:

setErrorSymbol in interface INAStopRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeViolationSymbol

public IMarkerSymbol getTimeViolationSymbol()
                                     throws IOException,
                                            AutomationException

The symbol used for a stop that has a time window violation.

Remarks

The TimeViolationSymbol specifies the marker symbol to use for drawing stops with time window violations.

Product Availability

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

Specified by:

getTimeViolationSymbol in interface INAStopRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeViolationSymbol

public void setTimeViolationSymbol(IMarkerSymbol symbol)
                            throws IOException,
                                   AutomationException

The symbol used for a stop that has a time window violation.

Remarks

The TimeViolationSymbol specifies the marker symbol to use for drawing stops with time window violations.

Product Availability

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

Specified by:

setTimeViolationSymbol in interface INAStopRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

The text symbol used for a stop.

Remarks

The TextSymbol property specifies the text symbol that is drawn on top of the ErrorSymbol, StopSymbol, TimeWindowViolationSymbol, and UnlocatedSymbol. The text used for each stop is the value in the Sequence field.

Product Availability

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

Specified by:

getTextSymbol in interface INAStopRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbol

public void setTextSymbol(ITextSymbol symbol)
                   throws IOException,
                          AutomationException

The text symbol used for a stop.

Remarks

The TextSymbol property specifies the text symbol that is drawn on top of the ErrorSymbol, StopSymbol, TimeWindowViolationSymbol, and UnlocatedSymbol. The text used for each stop is the value in the Sequence field.

Product Availability

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

Specified by:

setTextSymbol in interface INAStopRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStopSymbolPosition

public int getStopSymbolPosition(int symbolType)
                          throws IOException,
                                 AutomationException

The stop symbol position of the symbol type in the group of all stop renderer symbol types.

Product Availability

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

Specified by:

getStopSymbolPosition in interface INAStopRenderer2

Parameters:

symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)

Returns:

The position

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveStopSymbol

public void moveStopSymbol(int symbolType,
                           int newPosition)
                    throws IOException,
                           AutomationException

Move the stop symbol type to the new position in the group of all stop renderer symbol types.

Remarks

This method moves the specified stop symbol to another position within the NAStopRenderer.

Product Availability

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

Specified by:

moveStopSymbol in interface INAStopRenderer2

Parameters:

symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)

newPosition - The newPosition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible(int symbolType)
                  throws IOException,
                         AutomationException

Indicates if the stop symbol type is visible.

Product Availability

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

Specified by:

isVisible in interface INAStopRenderer2

Parameters:

symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(int symbolType,
                       boolean show)
                throws IOException,
                       AutomationException

Indicates if the stop symbol type is visible.

Product Availability

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

Specified by:

setVisible in interface INAStopRenderer2

Parameters:

symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendClass

public ILegendClass getLegendClass(int symbolType)
                            throws IOException,
                                   AutomationException

The legend class associated with the stop symbol type.

Product Availability

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

Specified by:

getLegendClass in interface INAStopRenderer2

Parameters:

symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws IOException,
                               AutomationException

Number of legend groups contained by the object.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendGroupCount in interface ILegendInfo

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:

getLegendGroup in interface ILegendInfo

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws IOException,
                                 AutomationException

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendItem in interface ILegendInfo

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws IOException,
                                     AutomationException

Indicates if symbols are graduated.

Description

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

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSymbolsAreGraduated in interface ILegendInfo

Returns:

The symbolsAreGraduated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolsAreGraduated in interface ILegendInfo

Parameters:

symbolsAreGraduated - The symbolsAreGraduated (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender(IFeatureClass featClass,
                         IDisplay display)
                  throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareFilter

public void prepareFilter(IFeatureClass fc,
                          IQueryFilter queryFilter)
                   throws 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:

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 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbolByFeature

public ISymbol getSymbolByFeature(IFeature feature)
                           throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRenderPhase

public boolean isRenderPhase(int drawPhase)
                      throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

public void setExclusionSetByRef(IFeatureIDSet rhs1)
                          throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionColor

public void setSelectionColor(IColor color)
                       throws IOException,
                              AutomationException

Selection color.

Product Availability

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

Specified by:

setSelectionColor in interface IFeatureSelectionRenderer

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionColor

public IColor getSelectionColor()
                         throws IOException,
                                AutomationException

Selection color.

Product Availability

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

Specified by:

getSelectionColor in interface IFeatureSelectionRenderer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentDrawLevel

public void setCurrentDrawLevel(int rhs1)
                         throws IOException,
                                AutomationException

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

Remarks

This property is set by the framework at draw time to specify which symbol level the renderer is to draw. If implementing a custom renderer that implements ILevelRenderer, you can check this property in your implementation of IFeatureRenderer::Draw to know which symbol level to draw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCurrentDrawLevel in interface ILevelRenderer

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevelArray

public Object getLevelArray()
                     throws IOException,
                            AutomationException

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

Remarks

This property returns an array of long integers representing all the the symbol levels of the symbols used by the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLevelArray in interface ILevelRenderer

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

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

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

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

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

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

Specified by:

getCurrent in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

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

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

apply in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException