com.esri.arcgis.carto
Class CompositeGraphicsLayer

java.lang.Object
  com.esri.arcgis.carto.CompositeGraphicsLayer

All Implemented Interfaces:

IBarrierProperties, IBarrierProperties2, ICompositeGraphicsLayer, ICompositeGraphicsLayer2, ICompositeLayer, IGraphicsContainer, IGraphicsContainerSelect, IGraphicsLayer, IGraphicsLayerScale, ILayer, ILayer2, ILayerGeneralProperties, ILayerInfo, IOverflowGraphicsContainer, IPublishLayer, IConnectionPointContainer, IGeoDataset, IGeoDatasetSchemaEdit, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class CompositeGraphicsLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, ILayer2, ICompositeGraphicsLayer, ICompositeGraphicsLayer2, IGraphicsLayer, ICompositeLayer, IGraphicsLayerScale, IGraphicsContainer, IGraphicsContainerSelect, IOverflowGraphicsContainer, IBarrierProperties, IBarrierProperties2, IGeoDataset, IGeoDatasetSchemaEdit, IConnectionPointContainer, IPersist, IPersistStream, IPublishLayer, ILayerGeneralProperties, ILayerInfo, java.io.Externalizable

COM Class 'CompositeGraphicsLayer'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A collection of graphics layers that behave like single layer.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.ILayer2

IID, IID599dee2e_2182_4e54_8a86_725145c9d989, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ICompositeGraphicsLayer2

IID, IID93e56956_347a_4a37_bae3_46f5515270d1, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ICompositeGraphicsLayer

IID9646bb82_9512_11d2_a2f6_080009b6f22b

Fields inherited from interface com.esri.arcgis.carto.IGraphicsLayer

IID34b2ef81_f4ac_11d1_a245_080009b6f22b

Fields inherited from interface com.esri.arcgis.carto.ICompositeLayer

IID, IIDba119bc4_939a_11d2_a2f4_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicsLayerScale

IID, IID85c3dac5_6578_11d3_9fba_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicsContainer

IID, IIDd09411d1_4bb4_11d1_b6cc_080009b996cc, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicsContainerSelect

IID, IIDd09411d2_4bb4_11d1_b6cc_080009b996cc, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IOverflowGraphicsContainer

IID, IID9c0520c1_a0d8_11d2_a2fe_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IBarrierProperties

IID, IID01c12b91_a3fb_11d2_a2fe_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IBarrierProperties2

IID, IIDe2d07333_5605_4ea6_87bd_7830927452e0, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGeoDatasetSchemaEdit

IID, IID6b267c02_28cc_11d3_9f67_00c04f6bdf0c, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, 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.IPublishLayer

IID, IID7453c805_9d64_44a6_bf2f_73e477dce18f, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerInfo

IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy

Constructor Summary

CompositeGraphicsLayer()
Constructs a CompositeGraphicsLayer using ArcGIS Engine.

CompositeGraphicsLayer(java.lang.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(java.lang.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(java.lang.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(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
IFrameElement	findFrame(java.lang.Object frameObject) Find the frame that contains the specified object.
IGraphicsLayer	findLayer(java.lang.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 java.lang.String	getClsid() getClsid.
int	getCount() Number of layers in the collection.
java.lang.String	getDataDetails(java.lang.String bsPadding) Details of the layer's data.
IElement	getDominantElement() Dominant element.
java.lang.Object	getElementOrder(IEnumElement elements) Private order object.
int	getElementSelectionCount() The number of selected elements.
IEnvelope	getExtent() The extent of the GeoDataset.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
java.lang.String	getName() Layer name.
IElementCollection	getOverflowElements() Element collection.
java.lang.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.
java.lang.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
java.lang.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(java.lang.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(java.io.ObjectInput in)
void	release() Release a CompositeGraphicsLayer.
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(java.lang.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(java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

CompositeGraphicsLayer

public CompositeGraphicsLayer()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a CompositeGraphicsLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CompositeGraphicsLayer

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addISelectionEventsListener

public void addISelectionEventsListener(ISelectionEvents theListener)
                                 throws java.io.IOException

addISelectionEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.

Throws:

java.io.IOException - If there are communications problems.

removeISelectionEventsListener

public void removeISelectionEventsListener(ISelectionEvents theListener)
                                    throws java.io.IOException

removeISelectionEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.

Throws:

java.io.IOException - If there are communications problems.

addIGraphicsContainerEventsListener

public void addIGraphicsContainerEventsListener(IGraphicsContainerEvents theListener)
                                         throws java.io.IOException

addIGraphicsContainerEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IGraphicsContainerEvents interface.

Throws:

java.io.IOException - If there are communications problems.

removeIGraphicsContainerEventsListener

public void removeIGraphicsContainerEventsListener(IGraphicsContainerEvents theListener)
                                            throws java.io.IOException

removeIGraphicsContainerEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IGraphicsContainerEvents interface.

Throws:

java.io.IOException - If there are communications problems.

release

public void release()

Release a CompositeGraphicsLayer.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Layer name.

Description

Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ILayer

Specified by:

getName in interface ILayer2

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Layer name.

Description

Use the Name property to associate a string with the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ILayer

Specified by:

setName in interface ILayer2

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently valid.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isValid in interface ILayer

Specified by:

isValid in interface ILayer2

Returns:

The valid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws java.io.IOException,
                                   AutomationException

The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaOfInterest in interface ILayer

Specified by:

getAreaOfInterest in interface ILayer2

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws java.io.IOException,
                              AutomationException

Minimum scale (representative fraction) at which the layer will display.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumScale in interface ILayer

Specified by:

getMinimumScale in interface ILayer2

Returns:

The minScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws java.io.IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Description

MinimumScale property specifies the minimum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumScale in interface ILayer

Specified by:

setMinimumScale in interface ILayer2

Parameters:

minScale - The minScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws java.io.IOException,
                              AutomationException

Maximum scale (representative fraction) at which the layer will display.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaximumScale in interface ILayer

Specified by:

getMaximumScale in interface ILayer2

Returns:

The maxScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws java.io.IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Description

MaximumScale property specifies the maximum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaximumScale in interface ILayer

Specified by:

setMaximumScale in interface ILayer2

Parameters:

maxScale - The maxScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ILayer

Specified by:

isVisible in interface ILayer2

Returns:

The visible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the layer is currently visible.

Description

Use Visible property to set the visibility of the layer. When assigned False, the layer is invisible in the current view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface ILayer

Specified by:

setVisible in interface ILayer2

Parameters:

visible - The visible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws java.io.IOException,
                          AutomationException

Indicates if the layer shows map tips.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowTips in interface ILayer

Specified by:

isShowTips in interface ILayer2

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer shows map tips.

Description

ShowTips is set to True when the layer shows map tips specified in the TipText property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowTips in interface ILayer

Specified by:

setShowTips in interface ILayer2

Parameters:

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTipText

public java.lang.String getTipText(double x,
                                   double y,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Map tip text at the specified location.

Product Availability

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

Specified by:

getTipText in interface ILayer

Specified by:

getTipText in interface ILayer2

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws java.io.IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCached in interface ILayer

Specified by:

isCached in interface ILayer2

Returns:

The cached

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws java.io.IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Description

Use Cached property to indicate if the layer needs its own cache for display.

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCached in interface ILayer

Specified by:

setCached in interface ILayer2

Parameters:

cached - The cached (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws java.io.IOException,
                                  AutomationException

Supported draw phases.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSupportedDrawPhases in interface ILayer

Specified by:

getSupportedDrawPhases in interface ILayer2

Returns:

The drawPhases

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.IOException,
                                     AutomationException

Spatial reference for the layer.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpatialReferenceByRef in interface ILayer

Specified by:

setSpatialReferenceByRef in interface ILayer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ILayer

Specified by:

draw in interface ILayer2

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the minimum and maximum scale range values are read-only.

Specified by:

isScaleRangeReadOnly in interface ILayer2

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException

The default area of interest for the layer.

Specified by:

setAreaOfInterest in interface ILayer2

Parameters:

aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

public IGraphicsLayer addLayer(java.lang.String layerName,
                               IFeatureLayer featureLayer)
                        throws java.io.IOException,
                               AutomationException

Adds a layer to the composite graphics layer.

Specified by:

addLayer in interface ICompositeGraphicsLayer

Parameters:

layerName - The layerName (in)

featureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteLayer

public void deleteLayer(java.lang.String layerName)
                 throws java.io.IOException,
                        AutomationException

Removes a layer from the composite graphics layer.

Specified by:

deleteLayer in interface ICompositeGraphicsLayer

Parameters:

layerName - The layerName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findLayer

public IGraphicsLayer findLayer(java.lang.String layerName)
                         throws java.io.IOException,
                                AutomationException

Finds a layer in the composite graphics layer.

Specified by:

findLayer in interface ICompositeGraphicsLayer

Parameters:

layerName - The layerName (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IScreenDisplay containerScreen)
              throws java.io.IOException,
                     AutomationException

Prepare to display graphic on screen.

Specified by:

activate in interface IGraphicsLayer

Parameters:

containerScreen - A reference to a com.esri.arcgis.display.IScreenDisplay (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException

ActiveView that graphics are displayed on is no longer visible.

Specified by:

deactivate in interface IGraphicsLayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseAssociatedLayerVisibility

public boolean isUseAssociatedLayerVisibility()
                                       throws java.io.IOException,
                                              AutomationException

Indicates if the layer that is associated with this graphics layer controls the visibility.

Specified by:

isUseAssociatedLayerVisibility in interface IGraphicsLayer

Returns:

The useLayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseAssociatedLayerVisibility

public void setUseAssociatedLayerVisibility(boolean useLayer)
                                     throws java.io.IOException,
                                            AutomationException

Indicates if the layer that is associated with this graphics layer controls the visibility.

Specified by:

setUseAssociatedLayerVisibility in interface IGraphicsLayer

Parameters:

useLayer - The useLayer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedLayer

public ILayer getAssociatedLayer()
                          throws java.io.IOException,
                                 AutomationException

Layer that is associated with this graphics layer.

Specified by:

getAssociatedLayer in interface IGraphicsLayer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAssociatedLayerByRef

public void setAssociatedLayerByRef(ILayer layer)
                             throws java.io.IOException,
                                    AutomationException

Layer that is associated with this graphics layer.

Specified by:

setAssociatedLayerByRef in interface IGraphicsLayer

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawDefault

public void drawDefault(int drawPhase,
                        IDisplay display,
                        ITrackCancel trackCancel)
                 throws java.io.IOException,
                        AutomationException

Draws the default graphics layer.

Specified by:

drawDefault in interface ICompositeGraphicsLayer2

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

Number of layers in the collection.

Specified by:

getCount in interface ICompositeLayer

Returns:

The layerCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException

Layer in the collection at the specified index.

Specified by:

getLayer in interface ICompositeLayer

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException

Reference scale of the layer as a representative fraction.

Specified by:

getReferenceScale in interface IGraphicsLayerScale

Returns:

The pScaleRF

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double pScaleRF)
                       throws java.io.IOException,
                              AutomationException

Reference scale of the layer as a representative fraction.

Specified by:

setReferenceScale in interface IGraphicsLayerScale

Parameters:

pScaleRF - The pScaleRF (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

public int getUnits()
             throws java.io.IOException,
                    AutomationException

Units the reference scale is in.

Specified by:

getUnits in interface IGraphicsLayerScale

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

public void setUnits(int units)
              throws java.io.IOException,
                     AutomationException

Units the reference scale is in.

Specified by:

setUnits in interface IGraphicsLayerScale

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public IElement next()
              throws java.io.IOException,
                     AutomationException

Returns the next graphic in the container.

Specified by:

next in interface IGraphicsContainer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Reset internal cursor so that Next returns the first element.

Specified by:

reset in interface IGraphicsContainer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addElement

public void addElement(IElement element,
                       int zorder)
                throws java.io.IOException,
                       AutomationException

Add a new graphic element to the layer.

Specified by:

addElement in interface IGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

zorder - The zorder (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addElements

public void addElements(IElementCollection elements,
                        int zorder)
                 throws java.io.IOException,
                        AutomationException

Add new graphic elements to the layer.

Specified by:

addElements in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IElementCollection (in)

zorder - The zorder (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteElement

public void deleteElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

Delete the given element.

Specified by:

deleteElement in interface IGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteAllElements

public void deleteAllElements()
                       throws java.io.IOException,
                              AutomationException

Delete all the elements.

Specified by:

deleteAllElements in interface IGraphicsContainer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveElementToGroup

public void moveElementToGroup(IElement element,
                               IGroupElement group)
                        throws java.io.IOException,
                               AutomationException

Move the element from the container to the group.

Specified by:

moveElementToGroup in interface IGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

group - A reference to a com.esri.arcgis.carto.IGroupElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveElementFromGroup

public void moveElementFromGroup(IGroupElement group,
                                 IElement element,
                                 int zorder)
                          throws java.io.IOException,
                                 AutomationException

Move the element from the group to the container.

Specified by:

moveElementFromGroup in interface IGraphicsContainer

Parameters:

group - 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)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locateElements

public IEnumElement locateElements(IPoint point,
                                   double tolerance)
                            throws java.io.IOException,
                                   AutomationException

Returns the elements at the given coordinate.

Specified by:

locateElements in interface IGraphicsContainer

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locateElementsByEnvelope

public IEnumElement locateElementsByEnvelope(IEnvelope envelope)
                                      throws java.io.IOException,
                                             AutomationException

Returns the elements inside the given envelope.

Specified by:

locateElementsByEnvelope in interface IGraphicsContainer

Parameters:

envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFrame

public IFrameElement findFrame(java.lang.Object frameObject)
                        throws java.io.IOException,
                               AutomationException

Find the frame that contains the specified object.

Specified by:

findFrame in interface IGraphicsContainer

Parameters:

frameObject - A Variant (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateElement

public void updateElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

The graphic element's properties have changed.

Specified by:

updateElement in interface IGraphicsContainer

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementOrder

public java.lang.Object getElementOrder(IEnumElement elements)
                                 throws java.io.IOException,
                                        AutomationException

Private order object. Used to undo ordering operations.

Specified by:

getElementOrder in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putElementOrder

public void putElementOrder(java.lang.Object order)
                     throws java.io.IOException,
                            AutomationException

Private order object. Used to undo ordering operations.

Specified by:

putElementOrder in interface IGraphicsContainer

Parameters:

order - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bringToFront

public void bringToFront(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Make the specified elements draw in front of all other elements.

Specified by:

bringToFront in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendToBack

public void sendToBack(IEnumElement elements)
                throws java.io.IOException,
                       AutomationException

Make the specified elements draw behind all other elements.

Specified by:

sendToBack in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendBackward

public void sendBackward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Move the specified elements one step closer to the bottom of the stack of elements.

Specified by:

sendBackward in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bringForward

public void bringForward(IEnumElement elements)
                  throws java.io.IOException,
                         AutomationException

Move the specified elements one step closer to the top of the stack of elements.

Specified by:

bringForward in interface IGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectElement

public void selectElement(IElement element)
                   throws java.io.IOException,
                          AutomationException

Selects the specified element.

Specified by:

selectElement in interface IGraphicsContainerSelect

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectElements

public void selectElements(IEnumElement elements)
                    throws java.io.IOException,
                           AutomationException

Selects the specified elements.

Specified by:

selectElements in interface IGraphicsContainerSelect

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectAllElements

public void selectAllElements()
                       throws java.io.IOException,
                              AutomationException

Selects all elements.

Specified by:

selectAllElements in interface IGraphicsContainerSelect

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unselectElement

public void unselectElement(IElement element)
                     throws java.io.IOException,
                            AutomationException

Unselects the specified element.

Specified by:

unselectElement in interface IGraphicsContainerSelect

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unselectElements

public void unselectElements(IEnumElement elements)
                      throws java.io.IOException,
                             AutomationException

Unselects the specified elements.

Specified by:

unselectElements in interface IGraphicsContainerSelect

Parameters:

elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unselectAllElements

public void unselectAllElements()
                         throws java.io.IOException,
                                AutomationException

Unselects all elements.

Specified by:

unselectAllElements in interface IGraphicsContainerSelect

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedElements

public IEnumElement getSelectedElements()
                                 throws java.io.IOException,
                                        AutomationException

The selected elements.

Specified by:

getSelectedElements in interface IGraphicsContainerSelect

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementSelectionCount

public int getElementSelectionCount()
                             throws java.io.IOException,
                                    AutomationException

The number of selected elements.

Specified by:

getElementSelectionCount in interface IGraphicsContainerSelect

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectedElement

public IElement selectedElement(int index)
                         throws java.io.IOException,
                                AutomationException

Returns the nth selected element. Use Selection count to get the number of selected elements.

Specified by:

selectedElement in interface IGraphicsContainerSelect

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectionTracker

public ISelectionTracker selectionTracker(int index)
                                   throws java.io.IOException,
                                          AutomationException

Returns the tracker for the nth selected element. Use Selection count to get the number of selected elements.

Specified by:

selectionTracker in interface IGraphicsContainerSelect

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

elementSelected

public boolean elementSelected(IElement element)
                        throws java.io.IOException,
                               AutomationException

Indicates if the element is selected.

Specified by:

elementSelected in interface IGraphicsContainerSelect

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Returns:

The elementSelected

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDominantElement

public IElement getDominantElement()
                            throws java.io.IOException,
                                   AutomationException

Dominant element.

Specified by:

getDominantElement in interface IGraphicsContainerSelect

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDominantElementByRef

public void setDominantElementByRef(IElement dominantItem)
                             throws java.io.IOException,
                                    AutomationException

Dominant element.

Specified by:

setDominantElementByRef in interface IGraphicsContainerSelect

Parameters:

dominantItem - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionBounds

public IEnvelope getSelectionBounds(IDisplay display)
                             throws java.io.IOException,
                                    AutomationException

The bounds of the selection.

Specified by:

getSelectionBounds in interface IGraphicsContainerSelect

Parameters:

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

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverflowElements

public IElementCollection getOverflowElements()
                                       throws java.io.IOException,
                                              AutomationException

Element collection.

Specified by:

getOverflowElements in interface IOverflowGraphicsContainer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverflowElementsByRef

public void setOverflowElementsByRef(IElementCollection elements)
                              throws java.io.IOException,
                                     AutomationException

Element collection.

Specified by:

setOverflowElementsByRef in interface IOverflowGraphicsContainer

Parameters:

elements - A reference to a com.esri.arcgis.carto.IElementCollection (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteAllOverflowElements

public void deleteAllOverflowElements()
                               throws java.io.IOException,
                                      AutomationException

Delete all the element in the collection.

Specified by:

deleteAllOverflowElements in interface IOverflowGraphicsContainer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteOverflowElement

public void deleteOverflowElement(IElement pElement)
                           throws java.io.IOException,
                                  AutomationException

Delete an element in the collection.

Specified by:

deleteOverflowElement in interface IOverflowGraphicsContainer

Parameters:

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addOverflowElement

public void addOverflowElement(IElement pElement)
                        throws java.io.IOException,
                               AutomationException

Add an element to the collection.

Specified by:

addOverflowElement in interface IOverflowGraphicsContainer

Parameters:

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWeight

public int getWeight()
              throws java.io.IOException,
                     AutomationException

Weight of the barriers in this layer.

Specified by:

getWeight in interface IBarrierProperties

Specified by:

getWeight in interface IBarrierProperties2

Returns:

The weight

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWeight

public void setWeight(int weight)
               throws java.io.IOException,
                      AutomationException

Weight of the barriers in this layer.

Specified by:

setWeight in interface IBarrierProperties

Specified by:

setWeight in interface IBarrierProperties2

Parameters:

weight - The weight (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBarriers

public void getBarriers(IDisplay display,
                        IGeometryCollection pBarriers,
                        IEnvelope extent)
                 throws java.io.IOException,
                        AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Specified by:

getBarriers in interface IBarrierProperties

Parameters:

display - 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)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBarriers

public void queryBarriers(IDisplay display,
                          IGeometryCollection pBarriers,
                          IEnvelope extent,
                          ITrackCancel trackCancel)
                   throws java.io.IOException,
                          AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Specified by:

queryBarriers in interface IBarrierProperties2

Parameters:

display - 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)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanAlterSpatialReference

public boolean isCanAlterSpatialReference()
                                   throws java.io.IOException,
                                          AutomationException

Indicates if the spatial reference of the dataset can be altered.

Specified by:

isCanAlterSpatialReference in interface IGeoDatasetSchemaEdit

Returns:

The canAlter

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterSpatialReference

public void alterSpatialReference(ISpatialReference spatialReference)
                           throws java.io.IOException,
                                  AutomationException

Alters the spatial reference of the dataset to match the coordinate system of the input spatial reference, does not reproject the data.

Specified by:

alterSpatialReference in interface IGeoDatasetSchemaEdit

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - 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)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the layer supports the publishing process.

Specified by:

isSupportsPublishing in interface IPublishLayer

Returns:

The bValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPublishingDescription

public java.lang.String getPublishingDescription()
                                          throws java.io.IOException,
                                                 AutomationException

The layer description reported to the publisher.

Specified by:

getPublishingDescription in interface IPublishLayer

Returns:

The bsDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDataValid

public boolean isDataValid()
                    throws java.io.IOException,
                           AutomationException

Indicates if the data for the layer is currently valid.

Specified by:

isDataValid in interface IPublishLayer

Returns:

The bDataValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataDetails

public java.lang.String getDataDetails(java.lang.String bsPadding)
                                throws java.io.IOException,
                                       AutomationException

Details of the layer's data.

Specified by:

getDataDetails in interface IPublishLayer

Parameters:

bsPadding - The bsPadding (in)

Returns:

The bsDataDetails

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareForPublishing

public void prepareForPublishing()
                          throws java.io.IOException,
                                 AutomationException

Prepare the layer for the publishing process.

Specified by:

prepareForPublishing in interface IPublishLayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

public double getLastMinimumScale()
                           throws java.io.IOException,
                                  AutomationException

Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMinimumScale in interface ILayerGeneralProperties

Returns:

The minScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws java.io.IOException,
                                  AutomationException

Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLastMaximumScale in interface ILayerGeneralProperties

Returns:

The maxScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public java.lang.String ILayerGeneralProperties_getLayerDescription()
                                                             throws java.io.IOException,
                                                                    AutomationException

Description for the layer.

Product Availability

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

Specified by:

ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(java.lang.String text)
                         throws java.io.IOException,
                                AutomationException

Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerDescription in interface ILayerGeneralProperties

Parameters:

text - The text (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws java.io.IOException,
                         AutomationException

Small image that represents the layer.

Specified by:

getSmallImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws java.io.IOException,
                                 AutomationException

Small image that represents the layer when it is selected.

Specified by:

getSmallSelectedImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws java.io.IOException,
                         AutomationException

Large image that represents the layer.

Specified by:

getLargeImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws java.io.IOException,
                                 AutomationException

Large image that represents the layer when it is selected.

Specified by:

getLargeSelectedImage in interface ILayerInfo

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException