com.esri.arcgis.carto.CompositeGraphicsLayer
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class CompositeGraphicsLayer
A collection of graphics layers that behave like single layer.
| Constructor Summary | |
|---|---|
CompositeGraphicsLayer()
Constructs a CompositeGraphicsLayer using ArcGIS Engine. |
|
CompositeGraphicsLayer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. CompositeGraphicsLayer theCompositeGraphicsLayer = (CompositeGraphicsLayer) obj; |
|
| Method Summary | |
|---|---|
void |
activate(IScreenDisplay containerScreen)
Prepare to display graphic on screen. |
void |
addElement(IElement element,
int zorder)
Add a new graphic element to the layer. |
void |
addElements(IElementCollection elements,
int zorder)
Add new graphic elements to the layer. |
void |
addIGraphicsContainerEventsListener(IGraphicsContainerEvents theListener)
addIGraphicsContainerEventsListener. |
void |
addISelectionEventsListener(ISelectionEvents theListener)
addISelectionEventsListener. |
IGraphicsLayer |
addLayer(String layerName,
IFeatureLayer featureLayer)
Adds a layer to the composite graphics layer. |
void |
addOverflowElement(IElement pElement)
Add an element to the collection. |
void |
alterSpatialReference(ISpatialReference spatialReference)
Alters the spatial reference of the dataset to match the coordinate system of the input spatial reference, does not reproject the data. |
void |
bringForward(IEnumElement elements)
Move the specified elements one step closer to the top of the stack of elements. |
void |
bringToFront(IEnumElement elements)
Make the specified elements draw in front of all other elements. |
void |
deactivate()
ActiveView that graphics are displayed on is no longer visible. |
void |
deleteAllElements()
Delete all the elements. |
void |
deleteAllOverflowElements()
Delete all the element in the collection. |
void |
deleteElement(IElement element)
Delete the given element. |
void |
deleteLayer(String layerName)
Removes a layer from the composite graphics layer. |
void |
deleteOverflowElement(IElement pElement)
Delete an element in the collection. |
void |
draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
Draws the layer to the specified display for the given draw phase. |
void |
drawDefault(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
Draws the default graphics layer. |
boolean |
elementSelected(IElement element)
Indicates if the element is selected. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(Object o)
Compare this object with another |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
IFrameElement |
findFrame(Object frameObject)
Find the frame that contains the specified object. |
IGraphicsLayer |
findLayer(String layerName)
Finds a layer in the composite graphics layer. |
IEnvelope |
getAreaOfInterest()
The default area of interest for the layer. |
ILayer |
getAssociatedLayer()
Layer that is associated with this graphics layer. |
void |
getBarriers(IDisplay display,
IGeometryCollection pBarriers,
IEnvelope extent)
List of barriers within the specified extent, or all barriers if no extent given. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
int |
getCount()
Number of layers in the collection. |
String |
getDataDetails(String bsPadding)
Details of the layer's data. |
IElement |
getDominantElement()
Dominant element. |
Object |
getElementOrder(IEnumElement elements)
Private order object. |
int |
getElementSelectionCount()
The number of selected elements. |
IEnvelope |
getExtent()
The extent of the GeoDataset. |
int |
getLargeImage()
Large image that represents the layer. |
int |
getLargeSelectedImage()
Large image that represents the layer when it is selected. |
double |
getLastMaximumScale()
Last maximum scale setting used by layer. |
double |
getLastMinimumScale()
Last minimum scale setting used by layer. |
ILayer |
getLayer(int index)
Layer in the collection at the specified index. |
double |
getMaximumScale()
Maximum scale (representative fraction) at which the layer will display. |
double |
getMinimumScale()
Minimum scale (representative fraction) at which the layer will display. |
String |
getName()
Layer name. |
IElementCollection |
getOverflowElements()
Element collection. |
String |
getPublishingDescription()
The layer description reported to the publisher. |
double |
getReferenceScale()
Reference scale of the layer as a representative fraction. |
IEnumElement |
getSelectedElements()
The selected elements. |
IEnvelope |
getSelectionBounds(IDisplay display)
The bounds of the selection. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
getSmallImage()
Small image that represents the layer. |
int |
getSmallSelectedImage()
Small image that represents the layer when it is selected. |
ISpatialReference |
getSpatialReference()
The spatial reference of the GeoDataset. |
int |
getSupportedDrawPhases()
Supported draw phases. |
String |
getTipText(double x,
double y,
double tolerance)
Map tip text at the specified location. |
int |
getUnits()
Units the reference scale is in. |
int |
getWeight()
Weight of the barriers in this layer. |
int |
hashCode()
the hashcode for this object |
String |
ILayerGeneralProperties_getLayerDescription()
Description for the layer. |
boolean |
isCached()
Indicates if the layer needs its own display cache. |
boolean |
isCanAlterSpatialReference()
Indicates if the spatial reference of the dataset can be altered. |
boolean |
isDataValid()
Indicates if the data for the layer is currently valid. |
void |
isDirty()
isDirty |
boolean |
isScaleRangeReadOnly()
Indicates if the minimum and maximum scale range values are read-only. |
boolean |
isShowTips()
Indicates if the layer shows map tips. |
boolean |
isSupportsPublishing()
Indicates if the layer supports the publishing process. |
boolean |
isUseAssociatedLayerVisibility()
Indicates if the layer that is associated with this graphics layer controls the visibility. |
boolean |
isValid()
Indicates if the layer is currently valid. |
boolean |
isVisible()
Indicates if the layer is currently visible. |
void |
load(IStream pstm)
load |
IEnumElement |
locateElements(IPoint point,
double tolerance)
Returns the elements at the given coordinate. |
IEnumElement |
locateElementsByEnvelope(IEnvelope envelope)
Returns the elements inside the given envelope. |
void |
moveElementFromGroup(IGroupElement group,
IElement element,
int zorder)
Move the element from the group to the container. |
void |
moveElementToGroup(IElement element,
IGroupElement group)
Move the element from the container to the group. |
IElement |
next()
Returns the next graphic in the container. |
void |
prepareForPublishing()
Prepare the layer for the publishing process. |
void |
putElementOrder(Object order)
Private order object. |
void |
queryBarriers(IDisplay display,
IGeometryCollection pBarriers,
IEnvelope extent,
ITrackCancel trackCancel)
List of barriers within the specified extent, or all barriers if no extent given. |
void |
readExternal(ObjectInput in)
|
void |
removeIGraphicsContainerEventsListener(IGraphicsContainerEvents theListener)
removeIGraphicsContainerEventsListener. |
void |
removeISelectionEventsListener(ISelectionEvents theListener)
removeISelectionEventsListener. |
void |
reset()
Reset internal cursor so that Next returns the first element. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
selectAllElements()
Selects all elements. |
IElement |
selectedElement(int index)
Returns the nth selected element. |
void |
selectElement(IElement element)
Selects the specified element. |
void |
selectElements(IEnumElement elements)
Selects the specified elements. |
ISelectionTracker |
selectionTracker(int index)
Returns the tracker for the nth selected element. |
void |
sendBackward(IEnumElement elements)
Move the specified elements one step closer to the bottom of the stack of elements. |
void |
sendToBack(IEnumElement elements)
Make the specified elements draw behind all other elements. |
void |
setAreaOfInterest(IEnvelope aoi)
The default area of interest for the layer. |
void |
setAssociatedLayerByRef(ILayer layer)
Layer that is associated with this graphics layer. |
void |
setCached(boolean cached)
Indicates if the layer needs its own display cache. |
void |
setDominantElementByRef(IElement dominantItem)
Dominant element. |
void |
setLayerDescription(String text)
Description for the layer. |
void |
setMaximumScale(double maxScale)
Maximum scale (representative fraction) at which the layer will display. |
void |
setMinimumScale(double minScale)
Minimum scale (representative fraction) at which the layer will display. |
void |
setName(String name)
Layer name. |
void |
setOverflowElementsByRef(IElementCollection elements)
Element collection. |
void |
setReferenceScale(double pScaleRF)
Reference scale of the layer as a representative fraction. |
void |
setShowTips(boolean show)
Indicates if the layer shows map tips. |
void |
setSpatialReferenceByRef(ISpatialReference rhs1)
Spatial reference for the layer. |
void |
setUnits(int units)
Units the reference scale is in. |
void |
setUseAssociatedLayerVisibility(boolean useLayer)
Indicates if the layer that is associated with this graphics layer controls the visibility. |
void |
setVisible(boolean visible)
Indicates if the layer is currently visible. |
void |
setWeight(int weight)
Weight of the barriers in this layer. |
void |
unselectAllElements()
Unselects all elements. |
void |
unselectElement(IElement element)
Unselects the specified element. |
void |
unselectElements(IEnumElement elements)
Unselects the specified elements. |
void |
updateElement(IElement element)
The graphic element's properties have changed. |
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 |
|---|
public CompositeGraphicsLayer()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public CompositeGraphicsLayer(Object obj)
throws IOException
CompositeGraphicsLayer theCompositeGraphicsLayer = (CompositeGraphicsLayer) obj;
obj to CompositeGraphicsLayer.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void addISelectionEventsListener(ISelectionEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.
IOException - If there are communications problems.
public void removeISelectionEventsListener(ISelectionEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.
IOException - If there are communications problems.
public void addIGraphicsContainerEventsListener(IGraphicsContainerEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IGraphicsContainerEvents interface.
IOException - If there are communications problems.
public void removeIGraphicsContainerEventsListener(IGraphicsContainerEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IGraphicsContainerEvents interface.
IOException - If there are communications problems.
public String getName()
throws IOException,
AutomationException
Use this property to associate a string with a layer.
getName in interface ILayergetName in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(String name)
throws IOException,
AutomationException
setName in interface ILayersetName in interface ILayer2name - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isValid()
throws IOException,
AutomationException
The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.
isValid in interface ILayerisValid in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getAreaOfInterest()
throws IOException,
AutomationException
Returns the spatial-referenced extent of the layer.
getAreaOfInterest in interface ILayergetAreaOfInterest in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMinimumScale()
throws IOException,
AutomationException
Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.
getMinimumScale in interface ILayergetMinimumScale in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMinimumScale(double minScale)
throws IOException,
AutomationException
setMinimumScale in interface ILayersetMinimumScale in interface ILayer2minScale - The minScale (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMaximumScale()
throws IOException,
AutomationException
Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.
getMaximumScale in interface ILayergetMaximumScale in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaximumScale(double maxScale)
throws IOException,
AutomationException
setMaximumScale in interface ILayersetMaximumScale in interface ILayer2maxScale - The maxScale (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isVisible()
throws IOException,
AutomationException
isVisible in interface ILayerisVisible in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVisible(boolean visible)
throws IOException,
AutomationException
setVisible in interface ILayersetVisible in interface ILayer2visible - The visible (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isShowTips()
throws IOException,
AutomationException
Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.
isShowTips in interface ILayerisShowTips in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setShowTips(boolean show)
throws IOException,
AutomationException
setShowTips in interface ILayersetShowTips in interface ILayer2show - The show (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTipText(double x,
double y,
double tolerance)
throws IOException,
AutomationException
getTipText in interface ILayergetTipText in interface ILayer2x - The x (in)y - The y (in)tolerance - The tolerance (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCached()
throws IOException,
AutomationException
This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.
The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.
isCached in interface ILayerisCached in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCached(boolean cached)
throws IOException,
AutomationException
Informational property. Container is responsible for cache management.
setCached in interface ILayersetCached in interface ILayer2cached - The cached (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSupportedDrawPhases()
throws IOException,
AutomationException
Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.
getSupportedDrawPhases in interface ILayergetSupportedDrawPhases in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSpatialReferenceByRef(ISpatialReference rhs1)
throws IOException,
AutomationException
This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.
setSpatialReferenceByRef in interface ILayersetSpatialReferenceByRef in interface ILayer2rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
throws IOException,
AutomationException
This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.
draw in interface ILayerdraw in interface ILayer2drawPhase - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isScaleRangeReadOnly()
throws IOException,
AutomationException
Some layer types do not support a writeable MinimumScale or MaximumScale. Use this property to determine whether or not a layer supports this.
isScaleRangeReadOnly in interface ILayer2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAreaOfInterest(IEnvelope aoi)
throws IOException,
AutomationException
setAreaOfInterest in interface ILayer2aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGraphicsLayer addLayer(String layerName,
IFeatureLayer featureLayer)
throws IOException,
AutomationException
addLayer in interface ICompositeGraphicsLayerlayerName - The layerName (in)featureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteLayer(String layerName)
throws IOException,
AutomationException
deleteLayer in interface ICompositeGraphicsLayerlayerName - The layerName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGraphicsLayer findLayer(String layerName)
throws IOException,
AutomationException
findLayer in interface ICompositeGraphicsLayerlayerName - The layerName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void activate(IScreenDisplay containerScreen)
throws IOException,
AutomationException
activate in interface IGraphicsLayercontainerScreen - A reference to a com.esri.arcgis.display.IScreenDisplay (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deactivate()
throws IOException,
AutomationException
deactivate in interface IGraphicsLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUseAssociatedLayerVisibility()
throws IOException,
AutomationException
isUseAssociatedLayerVisibility in interface IGraphicsLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseAssociatedLayerVisibility(boolean useLayer)
throws IOException,
AutomationException
setUseAssociatedLayerVisibility in interface IGraphicsLayeruseLayer - The useLayer (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILayer getAssociatedLayer()
throws IOException,
AutomationException
getAssociatedLayer in interface IGraphicsLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAssociatedLayerByRef(ILayer layer)
throws IOException,
AutomationException
setAssociatedLayerByRef in interface IGraphicsLayerlayer - A reference to a com.esri.arcgis.carto.ILayer (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void drawDefault(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
throws IOException,
AutomationException
drawDefault in interface ICompositeGraphicsLayer2drawPhase - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getCount()
throws IOException,
AutomationException
Returns the count, or number of layers. Use the methods in the IGroupLayer interface to manage the contents of GroupLayers.
getCount in interface ICompositeLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILayer getLayer(int index)
throws IOException,
AutomationException
getLayer in interface ICompositeLayerindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getReferenceScale()
throws IOException,
AutomationException
getReferenceScale in interface IGraphicsLayerScaleIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReferenceScale(double pScaleRF)
throws IOException,
AutomationException
setReferenceScale in interface IGraphicsLayerScalepScaleRF - The pScaleRF (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getUnits()
throws IOException,
AutomationException
getUnits in interface IGraphicsLayerScaleIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUnits(int units)
throws IOException,
AutomationException
setUnits in interface IGraphicsLayerScaleunits - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IElement next()
throws IOException,
AutomationException
next in interface IGraphicsContainerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void reset()
throws IOException,
AutomationException
reset in interface IGraphicsContainerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addElement(IElement element,
int zorder)
throws IOException,
AutomationException
This method adds the input element the graphics container referenced. The parameter zorder is currently not utilized by all of the IGraphicsContainer implementations and is typically set to 0 when calling this method.
addElement in interface IGraphicsContainerelement - A reference to a com.esri.arcgis.carto.IElement (in)zorder - The zorder (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addElements(IElementCollection elements,
int zorder)
throws IOException,
AutomationException
addElements in interface IGraphicsContainerelements - A reference to a com.esri.arcgis.carto.IElementCollection (in)zorder - The zorder (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteElement(IElement element)
throws IOException,
AutomationException
deleteElement in interface IGraphicsContainerelement - A reference to a com.esri.arcgis.carto.IElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteAllElements()
throws IOException,
AutomationException
deleteAllElements in interface IGraphicsContainerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void moveElementToGroup(IElement element,
IGroupElement group)
throws IOException,
AutomationException
moveElementToGroup in interface IGraphicsContainerelement - A reference to a com.esri.arcgis.carto.IElement (in)group - A reference to a com.esri.arcgis.carto.IGroupElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void moveElementFromGroup(IGroupElement group,
IElement element,
int zorder)
throws IOException,
AutomationException
moveElementFromGroup in interface IGraphicsContainergroup - A reference to a com.esri.arcgis.carto.IGroupElement (in)element - A reference to a com.esri.arcgis.carto.IElement (in)zorder - The zorder (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumElement locateElements(IPoint point,
double tolerance)
throws IOException,
AutomationException
locateElements in interface IGraphicsContainerpoint - A reference to a com.esri.arcgis.geometry.IPoint (in)tolerance - The tolerance (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumElement locateElementsByEnvelope(IEnvelope envelope)
throws IOException,
AutomationException
locateElementsByEnvelope in interface IGraphicsContainerenvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFrameElement findFrame(Object frameObject)
throws IOException,
AutomationException
findFrame in interface IGraphicsContainerframeObject - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void updateElement(IElement element)
throws IOException,
AutomationException
updateElement in interface IGraphicsContainerelement - A reference to a com.esri.arcgis.carto.IElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getElementOrder(IEnumElement elements)
throws IOException,
AutomationException
getElementOrder in interface IGraphicsContainerelements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void putElementOrder(Object order)
throws IOException,
AutomationException
putElementOrder in interface IGraphicsContainerorder - A Variant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void bringToFront(IEnumElement elements)
throws IOException,
AutomationException
bringToFront in interface IGraphicsContainerelements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void sendToBack(IEnumElement elements)
throws IOException,
AutomationException
sendToBack in interface IGraphicsContainerelements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void sendBackward(IEnumElement elements)
throws IOException,
AutomationException
sendBackward in interface IGraphicsContainerelements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void bringForward(IEnumElement elements)
throws IOException,
AutomationException
bringForward in interface IGraphicsContainerelements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void selectElement(IElement element)
throws IOException,
AutomationException
Adds the specified element to the element selection and fires the IActiveViewEvents::SelectionChanged event.
selectElement in interface IGraphicsContainerSelectelement - A reference to a com.esri.arcgis.carto.IElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void selectElements(IEnumElement elements)
throws IOException,
AutomationException
Adds the specified elements to the element selection and fires the IActiveViewEvents::SelectionChanged event.
selectElements in interface IGraphicsContainerSelectelements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void selectAllElements()
throws IOException,
AutomationException
Selects all elements in the container and fires the IActiveViewEvents::SelectionChanged event.
selectAllElements in interface IGraphicsContainerSelectIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void unselectElement(IElement element)
throws IOException,
AutomationException
Removes the specified element from the element selection and fires the IActiveViewEvents::SelectionChanged event.
unselectElement in interface IGraphicsContainerSelectelement - A reference to a com.esri.arcgis.carto.IElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void unselectElements(IEnumElement elements)
throws IOException,
AutomationException
Removes the specified elements from the element selection and fires the IActiveViewEvents::SelectionChanged event.
unselectElements in interface IGraphicsContainerSelectelements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void unselectAllElements()
throws IOException,
AutomationException
Clears the element selection and fires the IActiveViewEvents::SelectionChanged event.
unselectAllElements in interface IGraphicsContainerSelectIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumElement getSelectedElements()
throws IOException,
AutomationException
Returns an IEnumElement containing all of the selected elements.
An IEnumElement reference to the element selection is also available from IViewManager::ElementSelection and IActiveView::Selection (QI from ISelection).
getSelectedElements in interface IGraphicsContainerSelectIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IViewManager.getElementSelection()
public int getElementSelectionCount()
throws IOException,
AutomationException
getElementSelectionCount in interface IGraphicsContainerSelectIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IElement selectedElement(int index)
throws IOException,
AutomationException
selectedElement in interface IGraphicsContainerSelectindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionTracker selectionTracker(int index)
throws IOException,
AutomationException
Elements have associated selection tracker objects which provide reshaping functionality. For example, in ArcMap after adding an element, the element is drawn with a selection tracker around it and users can then drag one of the selection handles on the selection tracker to modify the element's shape.
There are several types of selection tracker objects including EnvelopeTracker, MarkerTracker, PointTracker, and PolygonTracker. When an element is first selected, an EnvelopeTracker is created for it. However, if the element has its IElementEditVertices::MovingVertices property set to TRUE, then the geometry of the element dictates the type of selection tracker created. For example, a line element will create a LineTracker.
IElement::SelectionTracker checks if the elements IElementEditVertices::MovingVertices property is set to TRUE; if so, IElementEditVertices::GetMoveVerticesSelectionTracker is called to create the appropriate tracker object for the element. If MovingVertices returns FALSE, then an EnvelopeTracker is created for the element.
In ArcMap, selecting an element creates an EnvelopeTracker but the 'Edit Vertices' command swaps the it out with a PolygonTracker or LineTracker. Some elements such as a MarkerElement, CircleElement, EllipseElement, and RectangleElement, only create EnvelopeTrackers and the vertices of the these elements cannot be edited.
selectionTracker in interface IGraphicsContainerSelectindex - The index (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IElement
public boolean elementSelected(IElement element)
throws IOException,
AutomationException
Returns TRUE if the specified element is selected.
elementSelected in interface IGraphicsContainerSelectelement - A reference to a com.esri.arcgis.carto.IElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IElement getDominantElement()
throws IOException,
AutomationException
The dominant element is by default the first element selected. The alignment commands make use of the dominant element to arrange elements more precisely.
getDominantElement in interface IGraphicsContainerSelectIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDominantElementByRef(IElement dominantItem)
throws IOException,
AutomationException
setDominantElementByRef in interface IGraphicsContainerSelectdominantItem - A reference to a com.esri.arcgis.carto.IElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getSelectionBounds(IDisplay display)
throws IOException,
AutomationException
getSelectionBounds in interface IGraphicsContainerSelectdisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IElementCollection getOverflowElements()
throws IOException,
AutomationException
getOverflowElements in interface IOverflowGraphicsContainerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOverflowElementsByRef(IElementCollection elements)
throws IOException,
AutomationException
setOverflowElementsByRef in interface IOverflowGraphicsContainerelements - A reference to a com.esri.arcgis.carto.IElementCollection (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteAllOverflowElements()
throws IOException,
AutomationException
deleteAllOverflowElements in interface IOverflowGraphicsContainerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteOverflowElement(IElement pElement)
throws IOException,
AutomationException
deleteOverflowElement in interface IOverflowGraphicsContainerpElement - A reference to a com.esri.arcgis.carto.IElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addOverflowElement(IElement pElement)
throws IOException,
AutomationException
addOverflowElement in interface IOverflowGraphicsContainerpElement - A reference to a com.esri.arcgis.carto.IElement (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getWeight()
throws IOException,
AutomationException
A Long value corresponding to a weight in esriBasicOverposterWeight.
getWeight in interface IBarrierPropertiesgetWeight in interface IBarrierProperties2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setWeight(int weight)
throws IOException,
AutomationException
setWeight in interface IBarrierPropertiessetWeight in interface IBarrierProperties2weight - The weight (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getBarriers(IDisplay display,
IGeometryCollection pBarriers,
IEnvelope extent)
throws IOException,
AutomationException
getBarriers in interface IBarrierPropertiesdisplay - A reference to a com.esri.arcgis.display.IDisplay (in)pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in, optional, pass 0 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryBarriers(IDisplay display,
IGeometryCollection pBarriers,
IEnvelope extent,
ITrackCancel trackCancel)
throws IOException,
AutomationException
queryBarriers in interface IBarrierProperties2display - A reference to a com.esri.arcgis.display.IDisplay (in)pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISpatialReference getSpatialReference()
throws IOException,
AutomationException
This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.
Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.
Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.
getSpatialReference in interface IGeoDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getExtent()
throws IOException,
AutomationException
The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.
Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.
If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.
If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.
ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.
getExtent in interface IGeoDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCanAlterSpatialReference()
throws IOException,
AutomationException
isCanAlterSpatialReference in interface IGeoDatasetSchemaEditIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void alterSpatialReference(ISpatialReference spatialReference)
throws IOException,
AutomationException
alterSpatialReference in interface IGeoDatasetSchemaEditspatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints in interface IConnectionPointContainerppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint in interface IConnectionPointContainerriid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportsPublishing()
throws IOException,
AutomationException
isSupportsPublishing in interface IPublishLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getPublishingDescription()
throws IOException,
AutomationException
getPublishingDescription in interface IPublishLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDataValid()
throws IOException,
AutomationException
isDataValid in interface IPublishLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getDataDetails(String bsPadding)
throws IOException,
AutomationException
getDataDetails in interface IPublishLayerbsPadding - The bsPadding (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void prepareForPublishing()
throws IOException,
AutomationException
prepareForPublishing in interface IPublishLayerIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getLastMinimumScale()
throws IOException,
AutomationException
getLastMinimumScale in interface ILayerGeneralPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getLastMaximumScale()
throws IOException,
AutomationException
getLastMaximumScale in interface ILayerGeneralPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String ILayerGeneralProperties_getLayerDescription()
throws IOException,
AutomationException
ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLayerDescription(String text)
throws IOException,
AutomationException
setLayerDescription in interface ILayerGeneralPropertiestext - The text (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSmallImage()
throws IOException,
AutomationException
The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.
getSmallImage in interface ILayerInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSmallSelectedImage()
throws IOException,
AutomationException
The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.
getSmallSelectedImage in interface ILayerInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLargeImage()
throws IOException,
AutomationException
The icon used to represent the layer in ArcCatalog's 'Large Icon' view.
getLargeImage in interface ILayerInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLargeSelectedImage()
throws IOException,
AutomationException
The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.
getLargeSelectedImage in interface ILayerInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||