|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.ScaleDependentRenderer
public class ScaleDependentRenderer
COM Class 'ScaleDependentRenderer'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'
Description 'A scale dependent renderer that is composed of multiple renderers, each operating within a particular scale range.' 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.carto.IScaleDependentRenderer |
---|
IID, IIDc86b3d95_ed80_11d0_8bba_080009ee4e41, 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.IExportSupport |
---|
IID, IIDf6448010_3cc8_435e_b042_540e9a328f3b, xxDummy |
Constructor Summary | |
---|---|
ScaleDependentRenderer()
Constructs a ScaleDependentRenderer using ArcGIS Engine. |
|
ScaleDependentRenderer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ScaleDependentRenderer theScaleDependentRenderer = (ScaleDependentRenderer) obj; |
Method Summary | |
---|---|
void |
addRenderer(IFeatureRenderer renderer)
Adds a renderer to the end of the list. |
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 |
double |
getBreak(int index)
Scale value at which to break for the specified index. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
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 |
getRenderer(int index)
The renderer at the specified index. |
int |
getRendererCount()
Number of renderers. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
ISymbol |
getSymbolByFeature(IFeature feature)
Symbol used to draw the specified feature. |
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. |
void |
load(IStream pstm)
load |
void |
moveRenderer(IFeatureRenderer renderer,
int toIndex)
Moves renderer to the specified location in the list. |
void |
prepareFilter(IFeatureClass fc,
IQueryFilter queryFilter)
Prepares the query filter for the rendering process. |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a ScaleDependentRenderer. |
void |
removeRenderer(IFeatureRenderer renderer)
Removes the specified renderer from the list. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setBreak(int index,
double breakValue)
Scale value at which to break for the specified index. |
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 |
setRendererByRef(int index,
java.lang.Object renderer)
The renderer at the specified index. |
void |
setRendererCount(int rendererCount)
Number of renderers. |
void |
setSymbolsAreGraduated(boolean symbolsAreGraduated)
Indicates if symbols are graduated. |
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 ScaleDependentRenderer() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic ScaleDependentRenderer(java.lang.Object obj) throws java.io.IOException
ScaleDependentRenderer theScaleDependentRenderer = (ScaleDependentRenderer) obj;
obj
to ScaleDependentRenderer
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public int getRendererCount() throws java.io.IOException, AutomationException
getRendererCount
in interface IScaleDependentRenderer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRendererCount(int rendererCount) throws java.io.IOException, AutomationException
setRendererCount
in interface IScaleDependentRenderer
rendererCount
- The rendererCount (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object getRenderer(int index) throws java.io.IOException, AutomationException
getRenderer
in interface IScaleDependentRenderer
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRendererByRef(int index, java.lang.Object renderer) throws java.io.IOException, AutomationException
setRendererByRef
in interface IScaleDependentRenderer
index
- The index (in)renderer
- A reference to another Object (IUnknown) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getBreak(int index) throws java.io.IOException, AutomationException
getBreak
in interface IScaleDependentRenderer
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBreak(int index, double breakValue) throws java.io.IOException, AutomationException
setBreak
in interface IScaleDependentRenderer
index
- The index (in)breakValue
- The breakValue (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addRenderer(IFeatureRenderer renderer) throws java.io.IOException, AutomationException
addRenderer
in interface IScaleDependentRenderer
renderer
- A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeRenderer(IFeatureRenderer renderer) throws java.io.IOException, AutomationException
removeRenderer
in interface IScaleDependentRenderer
renderer
- A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void moveRenderer(IFeatureRenderer renderer, int toIndex) throws java.io.IOException, AutomationException
moveRenderer
in interface IScaleDependentRenderer
renderer
- A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)toIndex
- The toIndex (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 IFeatureRenderer
featClass
- 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 IFeatureRenderer
fc
- 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 IFeatureRenderer
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)
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 IFeatureRenderer
feature
- 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 IFeatureRenderer
drawPhase
- 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 IFeatureRenderer
rhs1
- 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 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 ILegendInfo
java.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 ILegendInfo
index
- 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 ILegendInfo
java.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 ILegendInfo
java.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 ILegendInfo
symbolsAreGraduated
- The symbolsAreGraduated (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 IPersistStream
java.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 IPersistStream
pstm
- 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 IPersistStream
pstm
- 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 IPersistStream
pcbSize
- 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 IPersist
pClassID
- 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 setExportInfoByRef(IFeatureExportInfoGenerator rhs1) throws java.io.IOException, AutomationException
setExportInfoByRef
in interface IExportSupport
rhs1
- A reference to a com.esri.arcgis.carto.IFeatureExportInfoGenerator (in)
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.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |