|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.networkanalyst.NAStopRenderer
public class NAStopRenderer
COM Class 'NAStopRenderer'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'
Description 'Defines symbology for rendering stops.' 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 =
| Field Summary | |
|---|---|
static long |
serialVersionUID
|
| Fields inherited from interface com.esri.arcgis.networkanalyst.INAStopRenderer2 |
|---|
IID, IID7b5a7712_1579_4471_ba83_c4e34829a9f1, xxDummy |
| Fields inherited from interface com.esri.arcgis.networkanalyst.INAStopRenderer |
|---|
IID86ae5ab2_1908_4234_98b0_98295b95f2a6 |
| Fields inherited from interface com.esri.arcgis.carto.IFeatureSelectionRenderer |
|---|
IID, IIDa0439f35_1298_48c4_b536_985ac09f8e30, 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 |
| Constructor Summary | |
|---|---|
NAStopRenderer()
Constructs a NAStopRenderer using ArcGIS Engine. |
|
NAStopRenderer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. NAStopRenderer theNAStopRenderer = (NAStopRenderer) 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 |
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. |
IMarkerSymbol |
getErrorSymbol()
The symbol used for a stop that has an error. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
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. |
java.lang.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(java.io.ObjectInput in)
|
void |
release()
Release a NAStopRenderer. |
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(java.io.ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final long serialVersionUID
| Constructor Detail |
|---|
public NAStopRenderer()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public NAStopRenderer(java.lang.Object obj)
throws java.io.IOException
NAStopRenderer theNAStopRenderer = (NAStopRenderer) obj;
obj to NAStopRenderer.
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
|---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRefpublic void release()
release in interface com.esri.arcgis.interop.RemoteObjRef
public IMarkerSymbol getStopSymbol()
throws java.io.IOException,
AutomationException
getStopSymbol in interface INAStopRendererjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setStopSymbol(IMarkerSymbol symbol)
throws java.io.IOException,
AutomationException
setStopSymbol in interface INAStopRenderersymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IMarkerSymbol getUnlocatedSymbol()
throws java.io.IOException,
AutomationException
getUnlocatedSymbol in interface INAStopRendererjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUnlocatedSymbol(IMarkerSymbol symbol)
throws java.io.IOException,
AutomationException
setUnlocatedSymbol in interface INAStopRenderersymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IMarkerSymbol getErrorSymbol()
throws java.io.IOException,
AutomationException
getErrorSymbol in interface INAStopRendererjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setErrorSymbol(IMarkerSymbol symbol)
throws java.io.IOException,
AutomationException
setErrorSymbol in interface INAStopRenderersymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IMarkerSymbol getTimeViolationSymbol()
throws java.io.IOException,
AutomationException
getTimeViolationSymbol in interface INAStopRendererjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTimeViolationSymbol(IMarkerSymbol symbol)
throws java.io.IOException,
AutomationException
setTimeViolationSymbol in interface INAStopRenderersymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITextSymbol getTextSymbol()
throws java.io.IOException,
AutomationException
getTextSymbol in interface INAStopRendererjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTextSymbol(ITextSymbol symbol)
throws java.io.IOException,
AutomationException
setTextSymbol in interface INAStopRenderersymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getStopSymbolPosition(int symbolType)
throws java.io.IOException,
AutomationException
getStopSymbolPosition in interface INAStopRenderer2symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void moveStopSymbol(int symbolType,
int newPosition)
throws java.io.IOException,
AutomationException
moveStopSymbol in interface INAStopRenderer2symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)newPosition - The newPosition (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isVisible(int symbolType)
throws java.io.IOException,
AutomationException
isVisible in interface INAStopRenderer2symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVisible(int symbolType,
boolean show)
throws java.io.IOException,
AutomationException
setVisible in interface INAStopRenderer2symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)show - The show (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendClass getLegendClass(int symbolType)
throws java.io.IOException,
AutomationException
getLegendClass in interface INAStopRenderer2symbolType - A com.esri.arcgis.networkanalyst.esriNAStopSymbolType constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLegendGroupCount()
throws java.io.IOException,
AutomationException
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.
getLegendGroupCount in interface ILegendInfojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendGroup getLegendGroup(int index)
throws java.io.IOException,
AutomationException
getLegendGroup in interface ILegendInfoindex - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILegendItem getLegendItem()
throws java.io.IOException,
AutomationException
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.
getLegendItem in interface ILegendInfojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSymbolsAreGraduated()
throws java.io.IOException,
AutomationException
Indicates whether the symbols used for a layer or renderer's legend vary by size.
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.
isSymbolsAreGraduated in interface ILegendInfojava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
throws java.io.IOException,
AutomationException
setSymbolsAreGraduated in interface ILegendInfosymbolsAreGraduated - The symbolsAreGraduated (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canRender(IFeatureClass featClass,
IDisplay display)
throws java.io.IOException,
AutomationException
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.
canRender in interface IFeatureRendererfeatClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)display - A reference to a com.esri.arcgis.display.IDisplay (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void prepareFilter(IFeatureClass fc,
IQueryFilter queryFilter)
throws java.io.IOException,
AutomationException
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.
prepareFilter in interface IFeatureRendererfc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void draw(IFeatureCursor cursor,
int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
throws java.io.IOException,
AutomationException
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.
draw in interface IFeatureRenderercursor - 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISymbol getSymbolByFeature(IFeature feature)
throws java.io.IOException,
AutomationException
getSymbolByFeature in interface IFeatureRendererfeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRenderPhase(int drawPhase)
throws java.io.IOException,
AutomationException
isRenderPhase in interface IFeatureRendererdrawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExclusionSetByRef(IFeatureIDSet rhs1)
throws java.io.IOException,
AutomationException
The list of feature IDs to be excluded from drawing.
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.
setExclusionSetByRef in interface IFeatureRendererrhs1 - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSelectionColor(IColor color)
throws java.io.IOException,
AutomationException
setSelectionColor in interface IFeatureSelectionRenderercolor - A reference to a com.esri.arcgis.display.IColor (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IColor getSelectionColor()
throws java.io.IOException,
AutomationException
getSelectionColor in interface IFeatureSelectionRendererjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCurrentDrawLevel(int rhs1)
throws java.io.IOException,
AutomationException
setCurrentDrawLevel in interface ILevelRendererrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.Object getLevelArray()
throws java.io.IOException,
AutomationException
getLevelArray in interface ILevelRendererjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean applies(java.lang.Object pUnk)
throws java.io.IOException,
AutomationException
applies in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canApply(java.lang.Object pUnk)
throws java.io.IOException,
AutomationException
canApply in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.Object getCurrent(java.lang.Object pUnk)
throws java.io.IOException,
AutomationException
getCurrent in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.Object apply(java.lang.Object newObject)
throws java.io.IOException,
AutomationException
apply in interface IPropertySupportnewObject - A reference to another Object (IUnknown) (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws java.io.IOException,
AutomationException
isDirty in interface IPersistStreamjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws java.io.IOException,
AutomationException
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws java.io.IOException,
AutomationException
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws java.io.IOException,
AutomationException
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws java.io.IOException,
AutomationException
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(java.io.ObjectOutput out)
throws java.io.IOException
writeExternal in interface java.io.Externalizablejava.io.IOException
public void readExternal(java.io.ObjectInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
readExternal in interface java.io.Externalizablejava.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||