com.esri.arcgis.arcmapui
Class LayerEffectsEnvironment

java.lang.Object
  com.esri.arcgis.arcmapui.LayerEffectsEnvironment

All Implemented Interfaces:

ILayerEffectsEnvironment, ILayerEffectsEnvironment2, ILayerEffectsEnvironment3, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class LayerEffectsEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayerEffectsEnvironment, ILayerEffectsEnvironment2, ILayerEffectsEnvironment3

Singleton instance of the Layer Effects Environment.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

LayerEffectsEnvironment()
Constructs a LayerEffectsEnvironment using ArcGIS Engine.

LayerEffectsEnvironment(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LayerEffectsEnvironment theLayerEffectsEnvironment = (LayerEffectsEnvironment) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
IActiveView	getActiveView() The IActiveView interface of the view to be refreshed.
static String	getClsid() getClsid.
IMxDocument	getDocument() Current document.
ILayerEffects	getEffectsLayer() The ILayerEffects interface of the current effects layer.
ILayer	getSelectedLayer() Currenttly selected layer.
int	hashCode() the hashcode for this object
void	setActiveViewByRef(IActiveView activeView) The IActiveView interface of the view to be refreshed.
void	setDocumentByRef(IMxDocument doc) Current document.
void	setEffectsLayerByRef(ILayerEffects effects) The ILayerEffects interface of the current effects layer.
void	setSelectedLayerByRef(ILayer layer) Currenttly selected layer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

LayerEffectsEnvironment

public LayerEffectsEnvironment()
                        throws IOException,
                               UnknownHostException

Constructs a LayerEffectsEnvironment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LayerEffectsEnvironment

public LayerEffectsEnvironment(Object obj)
                        throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getEffectsLayer

public ILayerEffects getEffectsLayer()
                              throws IOException,
                                     AutomationException

The ILayerEffects interface of the current effects layer.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getEffectsLayer in interface ILayerEffectsEnvironment

Specified by:

getEffectsLayer in interface ILayerEffectsEnvironment2

Specified by:

getEffectsLayer in interface ILayerEffectsEnvironment3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEffectsLayerByRef

public void setEffectsLayerByRef(ILayerEffects effects)
                          throws IOException,
                                 AutomationException

The ILayerEffects interface of the current effects layer.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setEffectsLayerByRef in interface ILayerEffectsEnvironment

Specified by:

setEffectsLayerByRef in interface ILayerEffectsEnvironment2

Specified by:

setEffectsLayerByRef in interface ILayerEffectsEnvironment3

Parameters:

effects - A reference to a com.esri.arcgis.carto.ILayerEffects (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws IOException,
                                 AutomationException

The IActiveView interface of the view to be refreshed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getActiveView in interface ILayerEffectsEnvironment

Specified by:

getActiveView in interface ILayerEffectsEnvironment2

Specified by:

getActiveView in interface ILayerEffectsEnvironment3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveViewByRef

public void setActiveViewByRef(IActiveView activeView)
                        throws IOException,
                               AutomationException

The IActiveView interface of the view to be refreshed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setActiveViewByRef in interface ILayerEffectsEnvironment

Specified by:

setActiveViewByRef in interface ILayerEffectsEnvironment2

Specified by:

setActiveViewByRef in interface ILayerEffectsEnvironment3

Parameters:

activeView - A reference to a com.esri.arcgis.carto.IActiveView (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedLayer

public ILayer getSelectedLayer()
                        throws IOException,
                               AutomationException

Currenttly selected layer.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSelectedLayer in interface ILayerEffectsEnvironment2

Specified by:

getSelectedLayer in interface ILayerEffectsEnvironment3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedLayerByRef

public void setSelectedLayerByRef(ILayer layer)
                           throws IOException,
                                  AutomationException

Currenttly selected layer.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setSelectedLayerByRef in interface ILayerEffectsEnvironment2

Specified by:

setSelectedLayerByRef in interface ILayerEffectsEnvironment3

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocument

public IMxDocument getDocument()
                        throws IOException,
                               AutomationException

Current document.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDocument in interface ILayerEffectsEnvironment3

Returns:

A reference to a com.esri.arcgis.arcmapui.IMxDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentByRef

public void setDocumentByRef(IMxDocument doc)
                      throws IOException,
                             AutomationException

Current document.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDocumentByRef in interface ILayerEffectsEnvironment3

Parameters:

doc - A reference to a com.esri.arcgis.arcmapui.IMxDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.