com.esri.arcgis.globecore
Class GlobeGraphicsLayer

java.lang.Object
  com.esri.arcgis.globecore.GlobeGraphicsLayer

All Implemented Interfaces:

IGraphicsContainer3D, IGraphicsSelection, IGraphicsContainer, IGraphicsLayer, ILayer, ILayerEffects, ILayerEvents, ILayerExtensions, IPublishLayer, IConnectionPointContainer, IGeoDataset, ICustomGlobeLayer, IGlobeGraphicsLayer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class GlobeGraphicsLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, IGraphicsLayer, IGlobeGraphicsLayer, ICustomGlobeLayer, IGraphicsContainer, IGraphicsContainer3D, IGraphicsSelection, ILayerExtensions, ILayerEvents, ILayerEffects, IGeoDataset, IConnectionPointContainer, IPersistStream, IPublishLayer, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'GlobeGraphicsLayer'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGlobeCore.olb'

Description 'The Globe Graphics 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.IGraphicsLayer

IID, IID34b2ef81_f4ac_11d1_a245_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.globecore.IGlobeGraphicsLayer

IID, IID5ae75603_dd33_4d19_8116_4e6169b2eb9f, xxDummy

Fields inherited from interface com.esri.arcgis.globecore.ICustomGlobeLayer

IID, IID28416400_6965_4df1_9823_48973b44179c, xxDummy

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

IID, IIDd09411d1_4bb4_11d1_b6cc_080009b996cc, xxDummy

Fields inherited from interface com.esri.arcgis.analyst3d.IGraphicsContainer3D

IID, IIDef879196_01de_11d4_ab69_0008c73fd50c, xxDummy

Fields inherited from interface com.esri.arcgis.analyst3d.IGraphicsSelection

IID, IID79103a54_1e53_11d4_a109_00c04f8ece27, xxDummy

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

IID, IIDbb6a78ca_9c28_4f75_899f_dff65174082c, xxDummy

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

IID, IIDbda426b2_a692_11d2_a300_080009b6f22b, xxDummy

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

IID, IID09998199_1fb8_11d3_ab4e_000000000000, 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.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

GlobeGraphicsLayer()
Constructs a GlobeGraphicsLayer using ArcGIS Engine.

GlobeGraphicsLayer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeGraphicsLayer theGlobeGraphicsLayer = (GlobeGraphicsLayer) obj;

Method Summary

void	activate(IScreenDisplay containerScreen) Prepare to display graphic on screen.
void	addElement(IElement element) Adds a new graphic element to the container.
void	addElement(IElement pElement, IGlobeGraphicsElementProperties pProps, int[] pElementIndex) Adds a Graphics Element with specific Globe properties.
void	addElement(IElement element, int zorder) Add a new graphic element to the layer.
void	addElements(IElementCollection elements) Adds a collection of new graphic elements to the container.
void	addElements(IElementCollection elements, int zorder) Add new graphic elements to the layer.
void	addExtension(java.lang.Object ext) Adds a new extension.
void	addIActiveViewEventsListener(IActiveViewEvents theListener) addIActiveViewEventsListener.
void	beginBatchUpdate() Initiates a batch update of the container.
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	deleteAllSelectedElements() Deletes all selected elements.
void	deleteElement(IElement element) Delete the given element.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
void	drawImmediate(IGlobeViewer pGlobeViewer) For custom OpenGL layers, perform immediate drawing.
boolean	elementSelected(IElement element) Indicates if the element selected.
void	endBatchUpdate() Terminates a batch update of the container.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	findElement(java.lang.String name, IElement[] ppElement, int[] pElementIndex) Find an element by name.
void	findElementIndex(IElement pElement, int[] pElementIndex) Find an element index for fast access.
IFrameElement	findFrame(java.lang.Object frameObject) Find the frame that contains the specified object.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
ILayer	getAssociatedLayer() Layer that is associated with this graphics layer.
short	getBrightness() Layer brightness in percent (-100 - 100).
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
short	getContrast() Layer contrast in percent (-100 - 100).
java.lang.String	getDataDetails(java.lang.String bsPadding) Details of the layer's data.
int	getDrawType() The custom draw method.
IElement	getElement(int index) The element in the container defined by the given index.
int	getElementCount() The number of elements in the container.
void	getElementName(IElement pElement, java.lang.String[] pName) Gets the name of an element.
java.lang.Object	getElementOrder(IEnumElement elements) Private order object.
void	getElementTransformation(int elementIndex, IVector3D[] ppTrans, IVector3D[] ppScale, IVector3D[] ppRotate) Get the transformation of an element.
java.lang.Object	getExtension(int index) The extension at the specified index.
int	getExtensionCount() Number of extensions.
IEnvelope	getExtent() The extent of the GeoDataset.
void	getGlobeProperties(IElement pElement, IGlobeGraphicsElementProperties[] ppProps) Gets specific Globe properties.
void	getIsElementVisible(int elementIndex, boolean[] pbVisible) Get the visibility of an element.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getMaximumScale() Maximum scale (representative fraction) at which the layer will display.
double	getMinimumCellSize() For rasterized types, defines highest resolution.
double	getMinimumScale() Minimum scale (representative fraction) at which the layer will display.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
java.lang.String	getName() Layer name.
java.lang.String	getPublishingDescription() The layer description reported to the publisher.
int	getSelectedElementCount() The number of selected elements.
IEnumElement	getSelectedElements() The selected elements.
IEnvelope	getSelectedElementsExtent() The extent of selected elements.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The spatial reference of the GeoDataset.
int	getSupportedDrawPhases() Supported draw phases.
double	getSymbologyScalingFactor() The symbol scale factor for the custom rasterized type.
void	getTile(int tilesize, int face, int level, int row, int col, byte[][] pData) Gets a rasterized data tile for the given globe tesselation coordinates.
java.lang.String	getTipText(double x, double y, double tolerance) Map tip text at the specified location.
short	getTransparency() Layer transparency in percent (0-100).
int	hashCode() the hashcode for this object
void	hit(int hitObjectID, IHit3D pHit3D) The layer is hit by a picking operation.
boolean	isCached() Indicates if the layer needs its own display cache.
boolean	isDataValid() Indicates if the data for the layer is currently valid.
void	isDirty() isDirty
boolean	isHandlesLocalOrigin() The option to use a local coordinate system origin for high precision drawing.
boolean	isHasPerElementIllumination() The option to apply per-element illumination.
boolean	isHasVisibleRasterizedElements() Indicates if there are visible rasterized elements.
boolean	isHidden() The option to hide the graphics layer from the TOC and avoid persistency.
boolean	isSelectable() The option to allow element selection.
boolean	isShowTips() Indicates if the layer shows map tips.
boolean	isSupportsBrightnessChange() Indicates if the layer supports brightness changes.
boolean	isSupportsContrastChange() Indicates if the layer supports contrast changes.
boolean	isSupportsInteractive() Indicates if the layer supports interactive effects changes.
boolean	isSupportsPublishing() Indicates if the layer supports the publishing process.
boolean	isSupportsTransparency() Indicates if the layer supports transparency.
boolean	isUseAssociatedLayerVisibility() Indicates if the layer that is associated with this graphics layer controls the visibility.
boolean	isUseCache() The option to use Globe's disk caching.
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 pGroup, IElement pElement) Move the specified element from the group to the container.
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	putElementName(IElement pElement, java.lang.String name) Puts the name of an element.
void	putElementOrder(java.lang.Object order) Private order object.
void	putIsElementVisible(int elementIndex, boolean bVisible) Set the visibility of an element.
void	readExternal(java.io.ObjectInput in)
void	release() Release a GlobeGraphicsLayer.
void	removeExtension(int index) Removes the specified extension.
void	removeIActiveViewEventsListener(IActiveViewEvents theListener) removeIActiveViewEventsListener.
void	reset() Reset internal cursor so that Next returns the first element.
void	save(IStream pstm, int fClearDirty) save
void	selectAllElements() Selects all elements.
void	selectElement(IElement pElement) Selects the specified element.
void	selectElements(IEnumElement pElements) Selects the specified elements.
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	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAssociatedLayerByRef(ILayer layer) Layer that is associated with this graphics layer.
void	setBrightness(short brightnessValue) Layer brightness in percent (-100 - 100).
void	setCached(boolean cached) Indicates if the layer needs its own display cache.
void	setContrast(short contrastValue) Layer contrast in percent (-100 - 100).
void	setElementTransformation(int elementIndex, IVector3D pTrans, IVector3D pScale, IVector3D pRotate) Set the transformation of an element.
void	setGlobeProperties(IElement pElement, IGlobeGraphicsElementProperties pProps) Sets specific Globe properties.
void	setHasPerElementIllumination(boolean bHasPerElementIllumination) The option to apply per-element illumination.
void	setIsHidden(boolean pbHide) The option to hide the graphics layer from the TOC and avoid persistency.
void	setIsSelectable(boolean bIsSelectable) The option to allow element selection.
void	setLocalOrigin(_WKSPointZ rhs1) The local coordinate system origin for high precision drawing.
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	setRasterizedSymbologyScalingFactor(double rhs1) The symbol scale factor for rasterized graphics elements.
void	setShowTips(boolean show) Indicates if the layer shows map tips.
void	setSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference for the layer.
void	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
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	switchSelection() Switches the selection between elements.
void	unselectAllElements() Unselects all elements.
void	unselectElement(IElement pElement) Unselects the specified element.
void	unselectElements(IEnumElement pElements) Unselects the specified elements.
void	updateAllElements() Refresh all elements.
void	updateElement(IElement element) The graphic element's properties have changed.
void	updateElementByIndex(int elementIndex) Updates an element given its index.
void	visibilityChanged(ILayerEventsVisibilityChangedEvent theEvent) Occurs when layer visibility changes.
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

GlobeGraphicsLayer

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

Constructs a GlobeGraphicsLayer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GlobeGraphicsLayer

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

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

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

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

addIActiveViewEventsListener

public void addIActiveViewEventsListener(IActiveViewEvents theListener)
                                  throws java.io.IOException

addIActiveViewEventsListener. Listen to events generated by this class.

Parameters:

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

Throws:

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

removeIActiveViewEventsListener

public void removeIActiveViewEventsListener(IActiveViewEvents theListener)
                                     throws java.io.IOException

removeIActiveViewEventsListener. Stop listening to events generated by this class.

Parameters:

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

Throws:

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

release

public void release()

Release a GlobeGraphicsLayer.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

addElement

public void addElement(IElement pElement,
                       IGlobeGraphicsElementProperties pProps,
                       int[] pElementIndex)
                throws java.io.IOException,
                       AutomationException

Adds a Graphics Element with specific Globe properties.

Specified by:

addElement in interface IGlobeGraphicsLayer

Parameters:

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

pProps - A reference to a com.esri.arcgis.globecore.IGlobeGraphicsElementProperties (in)

pElementIndex - The pElementIndex (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGlobeProperties

public void setGlobeProperties(IElement pElement,
                               IGlobeGraphicsElementProperties pProps)
                        throws java.io.IOException,
                               AutomationException

Sets specific Globe properties.

Specified by:

setGlobeProperties in interface IGlobeGraphicsLayer

Parameters:

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

pProps - A reference to a com.esri.arcgis.globecore.IGlobeGraphicsElementProperties (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGlobeProperties

public void getGlobeProperties(IElement pElement,
                               IGlobeGraphicsElementProperties[] ppProps)
                        throws java.io.IOException,
                               AutomationException

Gets specific Globe properties.

Specified by:

getGlobeProperties in interface IGlobeGraphicsLayer

Parameters:

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

ppProps - A reference to a com.esri.arcgis.globecore.IGlobeGraphicsElementProperties (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putElementName

public void putElementName(IElement pElement,
                           java.lang.String name)
                    throws java.io.IOException,
                           AutomationException

Puts the name of an element.

Specified by:

putElementName in interface IGlobeGraphicsLayer

Parameters:

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

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementName

public void getElementName(IElement pElement,
                           java.lang.String[] pName)
                    throws java.io.IOException,
                           AutomationException

Gets the name of an element.

Specified by:

getElementName in interface IGlobeGraphicsLayer

Parameters:

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

pName - The pName (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findElement

public void findElement(java.lang.String name,
                        IElement[] ppElement,
                        int[] pElementIndex)
                 throws java.io.IOException,
                        AutomationException

Find an element by name.

Specified by:

findElement in interface IGlobeGraphicsLayer

Parameters:

name - The name (in)

ppElement - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

pElementIndex - The pElementIndex (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findElementIndex

public void findElementIndex(IElement pElement,
                             int[] pElementIndex)
                      throws java.io.IOException,
                             AutomationException

Find an element index for fast access.

Specified by:

findElementIndex in interface IGlobeGraphicsLayer

Parameters:

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

pElementIndex - The pElementIndex (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateElementByIndex

public void updateElementByIndex(int elementIndex)
                          throws java.io.IOException,
                                 AutomationException

Updates an element given its index.

Specified by:

updateElementByIndex in interface IGlobeGraphicsLayer

Parameters:

elementIndex - The elementIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putIsElementVisible

public void putIsElementVisible(int elementIndex,
                                boolean bVisible)
                         throws java.io.IOException,
                                AutomationException

Set the visibility of an element.

Specified by:

putIsElementVisible in interface IGlobeGraphicsLayer

Parameters:

elementIndex - The elementIndex (in)

bVisible - The bVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIsElementVisible

public void getIsElementVisible(int elementIndex,
                                boolean[] pbVisible)
                         throws java.io.IOException,
                                AutomationException

Get the visibility of an element.

Specified by:

getIsElementVisible in interface IGlobeGraphicsLayer

Parameters:

elementIndex - The elementIndex (in)

pbVisible - The pbVisible (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElementTransformation

public void setElementTransformation(int elementIndex,
                                     IVector3D pTrans,
                                     IVector3D pScale,
                                     IVector3D pRotate)
                              throws java.io.IOException,
                                     AutomationException

Set the transformation of an element.

Specified by:

setElementTransformation in interface IGlobeGraphicsLayer

Parameters:

elementIndex - The elementIndex (in)

pTrans - A reference to a com.esri.arcgis.geometry.IVector3D (in)

pScale - A reference to a com.esri.arcgis.geometry.IVector3D (in)

pRotate - A reference to a com.esri.arcgis.geometry.IVector3D (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementTransformation

public void getElementTransformation(int elementIndex,
                                     IVector3D[] ppTrans,
                                     IVector3D[] ppScale,
                                     IVector3D[] ppRotate)
                              throws java.io.IOException,
                                     AutomationException

Get the transformation of an element.

Specified by:

getElementTransformation in interface IGlobeGraphicsLayer

Parameters:

elementIndex - The elementIndex (in)

ppTrans - A reference to a com.esri.arcgis.geometry.IVector3D (out: use single element array)

ppScale - A reference to a com.esri.arcgis.geometry.IVector3D (out: use single element array)

ppRotate - A reference to a com.esri.arcgis.geometry.IVector3D (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsHidden

public void setIsHidden(boolean pbHide)
                 throws java.io.IOException,
                        AutomationException

The option to hide the graphics layer from the TOC and avoid persistency.

Specified by:

setIsHidden in interface IGlobeGraphicsLayer

Parameters:

pbHide - The pbHide (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHidden

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

The option to hide the graphics layer from the TOC and avoid persistency.

Specified by:

isHidden in interface IGlobeGraphicsLayer

Returns:

The pbHide

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateAllElements

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

Refresh all elements.

Specified by:

updateAllElements in interface IGlobeGraphicsLayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasVisibleRasterizedElements

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

Indicates if there are visible rasterized elements.

Specified by:

isHasVisibleRasterizedElements in interface IGlobeGraphicsLayer

Returns:

The pbVisibleRasterized

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterizedSymbologyScalingFactor

public void setRasterizedSymbologyScalingFactor(double rhs1)
                                         throws java.io.IOException,
                                                AutomationException

The symbol scale factor for rasterized graphics elements.

Specified by:

setRasterizedSymbologyScalingFactor in interface IGlobeGraphicsLayer

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasPerElementIllumination

public void setHasPerElementIllumination(boolean bHasPerElementIllumination)
                                  throws java.io.IOException,
                                         AutomationException

The option to apply per-element illumination.

Specified by:

setHasPerElementIllumination in interface IGlobeGraphicsLayer

Parameters:

bHasPerElementIllumination - The bHasPerElementIllumination (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasPerElementIllumination

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

The option to apply per-element illumination.

Specified by:

isHasPerElementIllumination in interface IGlobeGraphicsLayer

Returns:

The bHasPerElementIllumination

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsSelectable

public void setIsSelectable(boolean bIsSelectable)
                     throws java.io.IOException,
                            AutomationException

The option to allow element selection.

Specified by:

setIsSelectable in interface IGlobeGraphicsLayer

Parameters:

bIsSelectable - The bIsSelectable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSelectable

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

The option to allow element selection.

Specified by:

isSelectable in interface IGlobeGraphicsLayer

Returns:

The bIsSelectable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDrawType

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

The custom draw method.

Specified by:

getDrawType in interface ICustomGlobeLayer

Returns:

A com.esri.arcgis.globecore.esriGlobeCustomDrawType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseCache

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

The option to use Globe's disk caching.

Specified by:

isUseCache in interface ICustomGlobeLayer

Returns:

The pbUseCache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumCellSize

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

For rasterized types, defines highest resolution. Zero value indicates that globe-generated default value should be used.

Specified by:

getMinimumCellSize in interface ICustomGlobeLayer

Returns:

The pMinCellSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbologyScalingFactor

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

The symbol scale factor for the custom rasterized type.

Specified by:

getSymbologyScalingFactor in interface ICustomGlobeLayer

Returns:

The pMetersPerPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTile

public void getTile(int tilesize,
                    int face,
                    int level,
                    int row,
                    int col,
                    byte[][] pData)
             throws java.io.IOException,
                    AutomationException

Gets a rasterized data tile for the given globe tesselation coordinates.

Specified by:

getTile in interface ICustomGlobeLayer

Parameters:

tilesize - The tilesize (in)

face - The face (in)

level - The level (in)

row - The row (in)

col - The col (in)

pData - An unsigned byte (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawImmediate

public void drawImmediate(IGlobeViewer pGlobeViewer)
                   throws java.io.IOException,
                          AutomationException

For custom OpenGL layers, perform immediate drawing.

Specified by:

drawImmediate in interface ICustomGlobeLayer

Parameters:

pGlobeViewer - A reference to a com.esri.arcgis.globecore.IGlobeViewer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hit

public void hit(int hitObjectID,
                IHit3D pHit3D)
         throws java.io.IOException,
                AutomationException

The layer is hit by a picking operation.

Specified by:

hit in interface ICustomGlobeLayer

Parameters:

hitObjectID - The hitObjectID (in)

pHit3D - A reference to a com.esri.arcgis.analyst3d.IHit3D (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHandlesLocalOrigin

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

The option to use a local coordinate system origin for high precision drawing.

Specified by:

isHandlesLocalOrigin in interface ICustomGlobeLayer

Returns:

The pbHandlesLocalOrigin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLocalOrigin

public void setLocalOrigin(_WKSPointZ rhs1)
                    throws java.io.IOException,
                           AutomationException

The local coordinate system origin for high precision drawing.

Specified by:

setLocalOrigin in interface ICustomGlobeLayer

Parameters:

rhs1 - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (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 IGraphicsContainer3D

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 IGraphicsContainer3D

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 IGraphicsContainer3D

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 IGraphicsContainer3D

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 IGraphicsContainer3D

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 IGraphicsContainer3D

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 IGraphicsContainer3D

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.

getElementCount

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

The number of elements in the container.

Specified by:

getElementCount in interface IGraphicsContainer3D

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElement

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

The element in the container defined by the given index.

Specified by:

getElement in interface IGraphicsContainer3D

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.

beginBatchUpdate

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

Initiates a batch update of the container.

Specified by:

beginBatchUpdate in interface IGraphicsContainer3D

Throws:

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

AutomationException - If the ArcObject component throws an exception.

endBatchUpdate

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

Terminates a batch update of the container.

Specified by:

endBatchUpdate in interface IGraphicsContainer3D

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addElement

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

Adds a new graphic element to the container.

Specified by:

addElement in interface IGraphicsContainer3D

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.

addElements

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

Adds a collection of new graphic elements to the container.

Specified by:

addElements in interface IGraphicsContainer3D

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.

moveElementFromGroup

public void moveElementFromGroup(IGroupElement pGroup,
                                 IElement pElement)
                          throws java.io.IOException,
                                 AutomationException

Move the specified element from the group to the container.

Specified by:

moveElementFromGroup in interface IGraphicsContainer3D

Parameters:

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

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.

selectElement

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

Selects the specified element.

Specified by:

selectElement in interface IGraphicsSelection

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.

selectElements

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

Selects the specified elements.

Specified by:

selectElements in interface IGraphicsSelection

Parameters:

pElements - 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 IGraphicsSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unselectElement

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

Unselects the specified element.

Specified by:

unselectElement in interface IGraphicsSelection

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.

unselectElements

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

Unselects the specified elements.

Specified by:

unselectElements in interface IGraphicsSelection

Parameters:

pElements - 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 IGraphicsSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteAllSelectedElements

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

Deletes all selected elements.

Specified by:

deleteAllSelectedElements in interface IGraphicsSelection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

switchSelection

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

Switches the selection between elements.

Specified by:

switchSelection in interface IGraphicsSelection

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 IGraphicsSelection

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.

getSelectedElementCount

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

The number of selected elements.

Specified by:

getSelectedElementCount in interface IGraphicsSelection

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedElementsExtent

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

The extent of selected elements.

Specified by:

getSelectedElementsExtent in interface IGraphicsSelection

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.

elementSelected

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

Indicates if the element selected.

Specified by:

elementSelected in interface IGraphicsSelection

Parameters:

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

Returns:

The pbIsSelected

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

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

Number of extensions.

Specified by:

getExtensionCount in interface ILayerExtensions

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

public java.lang.Object getExtension(int index)
                              throws java.io.IOException,
                                     AutomationException

The extension at the specified index.

Specified by:

getExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(java.lang.Object ext)
                  throws java.io.IOException,
                         AutomationException

Adds a new extension.

Specified by:

addExtension in interface ILayerExtensions

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws java.io.IOException,
                            AutomationException

Removes the specified extension.

Specified by:

removeExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

visibilityChanged

public void visibilityChanged(ILayerEventsVisibilityChangedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Occurs when layer visibility changes.

Specified by:

visibilityChanged in interface ILayerEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

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

Indicates if the layer supports transparency.

Specified by:

isSupportsTransparency in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

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

Indicates if the layer supports contrast changes.

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

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

Indicates if the layer supports brightness changes.

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

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

Indicates if the layer supports interactive effects changes.

Specified by:

isSupportsInteractive in interface ILayerEffects

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws java.io.IOException,
                             AutomationException

Layer transparency in percent (0-100).

Specified by:

getTransparency in interface ILayerEffects

Returns:

The alpha

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws java.io.IOException,
                            AutomationException

Layer transparency in percent (0-100).

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws java.io.IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws java.io.IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws java.io.IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws java.io.IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

setBrightness in interface ILayerEffects

Parameters:

brightnessValue - The brightnessValue (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.

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.

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.

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.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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