com.esri.arcgis.analyst3d
Class GraphicsLayer3D

java.lang.Object
  com.esri.arcgis.analyst3d.GraphicsLayer3D

All Implemented Interfaces:

java.util.EventListener, IConnectionPointContainer, IGeoDataset, IGraphicsContainer, IGraphicsContainer3D, IGraphicsLayer, IGraphicsSelection, ILayer, ILayerEffects, ILayerEvents, ILayerExtensions, IPersist, IPersistStream, IPublishLayer, java.io.Serializable

public class GraphicsLayer3D

extends java.lang.Object

implements ILayer, IGraphicsLayer, IGraphicsContainer, IGraphicsContainer3D, IGraphicsSelection, ILayerExtensions, ILayerEvents, ILayerEffects, IGeoDataset, IConnectionPointContainer, IPersistStream, IPublishLayer

A 3D Graphics Layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

GraphicsLayer3D()
Constructs a GraphicsLayer3D using ArcGIS Engine.

GraphicsLayer3D(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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 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)
void	addISceneRendererEventsListener(ISceneRendererEvents theListener)
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	draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the layer to the specified display for the given draw phase.
boolean	elementSelected(IElement element) Indicates if the element selected.
void	endBatchUpdate() Terminates a batch update of the container.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) Supported Platforms
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) Supported Platforms
IFrameElement	findFrame(java.lang.Object frameObject) Find the frame that contains the specified object.
IEnvelope	getAreaOfInterest() The default area of interest for the layer.
IConnectionPointContainer	getAsIConnectionPointContainer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGeoDataset	getAsIGeoDataset() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGraphicsContainer	getAsIGraphicsContainer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGraphicsContainer3D	getAsIGraphicsContainer3D() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGraphicsLayer	getAsIGraphicsLayer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGraphicsSelection	getAsIGraphicsSelection() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILayer	getAsILayer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILayerEffects	getAsILayerEffects() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILayerEvents	getAsILayerEvents() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILayerExtensions	getAsILayerExtensions() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPublishLayer	getAsIPublishLayer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILayer	getAssociatedLayer() Layer that is associated with this graphics layer.
short	getBrightness() Layer brightness in percent (-100 - 100).
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
short	getContrast() Layer contrast in percent (-100 - 100).
java.lang.String	getDataDetails(java.lang.String bsPadding) Details of the layer's data.
IElement	getElement(int index) The element in the container defined by the given index.
int	getElementCount() The number of elements in the container.
java.lang.Object	getElementOrder(IEnumElement elements) Private order object.
java.lang.Object	getExtension(int index) The extension at the specified index.
int	getExtensionCount() Number of extensions.
IEnvelope	getExtent() The extent of the GeoDataset.
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.
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) Supported Platforms
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.
short	getTransparency() Layer transparency in percent (0-100).
int	hashCode() the hashcode for this object
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() Supported Platforms
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	isValid() Indicates if the layer is currently valid.
boolean	isVisible() Indicates if the layer is currently visible.
void	load(IStream pstm) Supported Platforms
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	putElementOrder(java.lang.Object order) Private order object.
void	removeExtension(int index) Removes the specified extension.
void	removeIActiveViewEventsListener(IActiveViewEvents theListener)
void	removeISceneRendererEventsListener(ISceneRendererEvents theListener)
void	reset() Reset internal cursor so that Next returns the first element.
void	save(IStream pstm, int fClearDirty) Supported Platforms
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	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	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	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	updateElement(IElement element) The graphic element's properties have changed.
void	visibilityChanged(ILayerEventsVisibilityChangedEvent theEvent) Occurs when layer visibility changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicsLayer3D

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

Constructs a GraphicsLayer3D using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GraphicsLayer3D

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a GraphicsLayer3D using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GraphicsLayer3D.
GraphicsLayer3D theGraphicsLayer3D = (GraphicsLayer3D) obj;

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

getAsILayer

public ILayer getAsILayer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGraphicsLayer

public IGraphicsLayer getAsIGraphicsLayer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGraphicsContainer

public IGraphicsContainer getAsIGraphicsContainer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGraphicsContainer3D

public IGraphicsContainer3D getAsIGraphicsContainer3D()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGraphicsSelection

public IGraphicsSelection getAsIGraphicsSelection()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsILayerExtensions

public ILayerExtensions getAsILayerExtensions()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsILayerEvents

public ILayerEvents getAsILayerEvents()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsILayerEffects

public ILayerEffects getAsILayerEffects()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeoDataset

public IGeoDataset getAsIGeoDataset()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIConnectionPointContainer

public IConnectionPointContainer getAsIConnectionPointContainer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPublishLayer

public IPublishLayer getAsIPublishLayer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

addISceneRendererEventsListener

public void addISceneRendererEventsListener(ISceneRendererEvents theListener)
                                     throws java.io.IOException

Throws:

java.io.IOException

removeISceneRendererEventsListener

public void removeISceneRendererEventsListener(ISceneRendererEvents theListener)
                                        throws java.io.IOException

Throws:

java.io.IOException

addIActiveViewEventsListener

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

Throws:

java.io.IOException

removeIActiveViewEventsListener

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

Throws:

java.io.IOException

getName

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

Description copied from interface: ILayer

Layer name.

Supported Platforms

Windows, Solaris, Linux

Description

Remarks

Use this property to associate a string with a layer.

Specified by:

getName in interface ILayer

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setName

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

Description copied from interface: ILayer

Layer name.

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: ILayer

Indicates if the layer is currently valid.

Supported Platforms

Windows, Solaris, Linux

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.

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

Description copied from interface: ILayer

The default area of interest for the layer.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns the spatial-referenced extent of the layer.

Specified by:

getAreaOfInterest in interface ILayer

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMinimumScale

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

Description copied from interface: ILayer

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

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getMinimumScale in interface ILayer

Returns:

The minScale

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMinimumScale

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

Description copied from interface: ILayer

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

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: ILayer

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

Supported Platforms

Windows, Solaris, Linux

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.

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

Description copied from interface: ILayer

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

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: ILayer

Indicates if the layer is currently visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ILayer

Returns:

The visible

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setVisible

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

Description copied from interface: ILayer

Indicates if the layer is currently visible.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

setVisible in interface ILayer

Parameters:

visible - The visible (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isShowTips

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

Description copied from interface: ILayer

Indicates if the layer shows map tips.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

isShowTips in interface ILayer

Returns:

The show

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setShowTips

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

Description copied from interface: ILayer

Indicates if the layer shows map tips.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

setShowTips in interface ILayer

Parameters:

show - The show (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTipText

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

Description copied from interface: ILayer

Map tip text at the specified location.

Supported Platforms

Windows, Solaris, Linux

Remarks

The text string that gets displayed as a map tip if ShowTips = True. For a FeatureLayer this comes from the data in IFeatureLayer::DisplayField.

Specified by:

getTipText in interface ILayer

Parameters:

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

Returns:

The text

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCached

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

Description copied from interface: ILayer

Indicates if the layer needs its own display cache.

Supported Platforms

Windows, Solaris, Linux

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.

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

Description copied from interface: ILayer

Indicates if the layer needs its own display cache.

Supported Platforms

Windows, Solaris, Linux

Description

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

Remarks

Informational property. Container is responsible for cache management.

Specified by:

setCached in interface ILayer

Parameters:

cached - The cached (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSupportedDrawPhases

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

Description copied from interface: ILayer

Supported draw phases.

Supported Platforms

Windows, Solaris, Linux

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.

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

Description copied from interface: ILayer

Spatial reference for the layer.

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

Description copied from interface: ILayer

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

Supported Platforms

Windows, Solaris, Linux

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.

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:

AutomationException - If the ArcObject component throws an exception.

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

activate

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

Description copied from interface: IGraphicsLayer

Prepare to display graphic on screen.

Supported Platforms

Windows, Solaris, Linux

Specified by:

activate in interface IGraphicsLayer

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

deactivate

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

Description copied from interface: IGraphicsLayer

ActiveView that graphics are displayed on is no longer visible.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deactivate in interface IGraphicsLayer

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isUseAssociatedLayerVisibility

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

Description copied from interface: IGraphicsLayer

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseAssociatedLayerVisibility in interface IGraphicsLayer

Returns:

The useLayer

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setUseAssociatedLayerVisibility

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

Description copied from interface: IGraphicsLayer

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

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsLayer

Layer that is associated with this graphics layer.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAssociatedLayer in interface IGraphicsLayer

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setAssociatedLayerByRef

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

Description copied from interface: IGraphicsLayer

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.

next

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

Description copied from interface: IGraphicsContainer

Returns the next graphic in the container.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

Reset internal cursor so that Next returns the first element.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

Add a new graphic element to the layer.

Supported Platforms

Windows, Solaris, Linux

Description

This method adds the input element the graphics container referenced. The parameter zorder is currently not utilized by all of the IGraphicsContainer implementations and is typically set to 0 when calling this method.

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

Description copied from interface: IGraphicsContainer

Add new graphic elements to the layer.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

Delete the given element.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

Delete all the elements.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteAllElements in interface IGraphicsContainer

Throws:

AutomationException - If the ArcObject component throws an exception.

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

moveElementToGroup

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

Description copied from interface: IGraphicsContainer

Move the element from the container to the group.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

Move the element from the group to the container.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

Returns the elements at the given coordinate.

Supported Platforms

Windows, Solaris, Linux

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:

AutomationException - If the ArcObject component throws an exception.

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

locateElementsByEnvelope

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

Description copied from interface: IGraphicsContainer

Returns the elements inside the given envelope.

Supported Platforms

Windows, Solaris, Linux

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:

AutomationException - If the ArcObject component throws an exception.

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

findFrame

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

Description copied from interface: IGraphicsContainer

Find the frame that contains the specified object.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

The graphic element's properties have changed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

updateElement in interface IGraphicsContainer

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getElementOrder

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

Description copied from interface: IGraphicsContainer

Private order object. Used to undo ordering operations.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getElementOrder in interface IGraphicsContainer

Parameters:

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

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

putElementOrder

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

Description copied from interface: IGraphicsContainer

Private order object. Used to undo ordering operations.

Supported Platforms

Windows, Solaris, Linux

Specified by:

putElementOrder in interface IGraphicsContainer

Parameters:

order - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

bringToFront

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

Description copied from interface: IGraphicsContainer

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

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

Make the specified elements draw behind all other elements.

Supported Platforms

Windows, Solaris, Linux

Specified by:

sendToBack in interface IGraphicsContainer

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

sendBackward

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

Description copied from interface: IGraphicsContainer

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

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

bringForward in interface IGraphicsContainer

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getElementCount

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

Description copied from interface: IGraphicsContainer3D

The number of elements in the container.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer3D

The element in the container defined by the given index.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getElement in interface IGraphicsContainer3D

Parameters:

index - The index (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

beginBatchUpdate

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

Description copied from interface: IGraphicsContainer3D

Initiates a batch update of the container.

Supported Platforms

Windows, Solaris, Linux

Specified by:

beginBatchUpdate in interface IGraphicsContainer3D

Throws:

AutomationException - If the ArcObject component throws an exception.

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

endBatchUpdate

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

Description copied from interface: IGraphicsContainer3D

Terminates a batch update of the container.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer3D

Adds a new graphic element to the container.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsContainer3D

Adds a collection of new graphic elements to the container.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addElements in interface IGraphicsContainer3D

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

moveElementFromGroup

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

Description copied from interface: IGraphicsContainer3D

Move the specified element from the group to the container.

Supported Platforms

Windows, Solaris, Linux

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:

AutomationException - If the ArcObject component throws an exception.

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

selectElement

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

Description copied from interface: IGraphicsSelection

Selects the specified element.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsSelection

Selects the specified elements.

Supported Platforms

Windows, Solaris, Linux

Specified by:

selectElements in interface IGraphicsSelection

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

selectAllElements

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

Description copied from interface: IGraphicsSelection

Selects all elements.

Supported Platforms

Windows, Solaris, Linux

Specified by:

selectAllElements in interface IGraphicsSelection

Throws:

AutomationException - If the ArcObject component throws an exception.

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

unselectElement

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

Description copied from interface: IGraphicsSelection

Unselects the specified element.

Supported Platforms

Windows, Solaris, Linux

Specified by:

unselectElement in interface IGraphicsSelection

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

unselectElements

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

Description copied from interface: IGraphicsSelection

Unselects the specified elements.

Supported Platforms

Windows, Solaris, Linux

Specified by:

unselectElements in interface IGraphicsSelection

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

unselectAllElements

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

Description copied from interface: IGraphicsSelection

Unselects all elements.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsSelection

Deletes all selected elements.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteAllSelectedElements in interface IGraphicsSelection

Throws:

AutomationException - If the ArcObject component throws an exception.

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

switchSelection

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

Description copied from interface: IGraphicsSelection

Switches the selection between elements.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsSelection

The selected elements.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsSelection

The number of selected elements.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSelectedElementCount in interface IGraphicsSelection

Returns:

The pCount

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSelectedElementsExtent

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

Description copied from interface: IGraphicsSelection

The extent of selected elements.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGraphicsSelection

Indicates if the element selected.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ILayerExtensions

Number of extensions.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ILayerExtensions

The extension at the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

addExtension

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

Description copied from interface: ILayerExtensions

Adds a new extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addExtension in interface ILayerExtensions

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

removeExtension

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

Description copied from interface: ILayerExtensions

Removes the specified extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeExtension in interface ILayerExtensions

Parameters:

index - The index (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

visibilityChanged

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

Description copied from interface: ILayerEvents

Occurs when layer visibility changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:

visibilityChanged in interface ILayerEvents

Parameters:

theEvent - The event

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isSupportsTransparency

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

Description copied from interface: ILayerEffects

Indicates if the layer supports transparency.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ILayerEffects

Indicates if the layer supports contrast changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isSupportsBrightnessChange

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

Description copied from interface: ILayerEffects

Indicates if the layer supports brightness changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSupportsInteractive

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

Description copied from interface: ILayerEffects

Indicates if the layer supports interactive effects changes.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isSupportsInteractive

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

Description copied from interface: ILayerEffects

Indicates if the layer supports interactive effects changes.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: ILayerEffects

Layer transparency in percent (0-100).

Supported Platforms

Windows, Solaris, Linux

Remarks

When you set Transparency for a FeatureLayer, a TransparencyDisplayFilter is created and applied to the layer. You can accomplish the same effect by manually creating a new TransparencyDisplayFilter using IDisplayFilter, and then assigning it to a layer using IDisplayFilterManager.

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

Description copied from interface: ILayerEffects

Layer transparency in percent (0-100).

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getContrast

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

Description copied from interface: ILayerEffects

Layer contrast in percent (-100 - 100).

Supported Platforms

Windows, Solaris, Linux

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setContrast

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

Description copied from interface: ILayerEffects

Layer contrast in percent (-100 - 100).

Supported Platforms

Windows, Solaris, Linux

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBrightness

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

Description copied from interface: ILayerEffects

Layer brightness in percent (-100 - 100).

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBrightness

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

Description copied from interface: ILayerEffects

Layer brightness in percent (-100 - 100).

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IGeoDataset

The spatial reference of the GeoDataset.

Supported Platforms

Windows, Solaris, Linux

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.

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

Description copied from interface: IGeoDataset

The extent of the GeoDataset.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getExtent in interface IGeoDataset

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

enumConnectionPoints

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

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

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

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

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:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isSupportsPublishing

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

Description copied from interface: IPublishLayer

Indicates if the layer supports the publishing process.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsPublishing in interface IPublishLayer

Returns:

The bValid

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPublishingDescription

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

Description copied from interface: IPublishLayer

The layer description reported to the publisher.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IPublishLayer

Indicates if the data for the layer is currently valid.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IPublishLayer

Details of the layer's data.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDataDetails in interface IPublishLayer

Parameters:

bsPadding - The bsPadding (in)

Returns:

The bsDataDetails

Throws:

AutomationException - If the ArcObject component throws an exception.

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

prepareForPublishing

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

Description copied from interface: IPublishLayer

Prepare the layer for the publishing process.

Supported Platforms

Windows, Solaris, Linux

Specified by:

prepareForPublishing in interface IPublishLayer

Throws:

AutomationException - If the ArcObject component throws an exception.

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