com.esri.arcgis.controls
Class CommandsEnvironment

java.lang.Object
  com.esri.arcgis.controls.CommandsEnvironment

All Implemented Interfaces:

IGraphicProperties, ILayerEffectProperties, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class CommandsEnvironment
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGraphicProperties, ILayerEffectProperties

COM Class 'CommandsEnvironment'. Generated 3/19/2015 1:20:48 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'Defines the commands environment.' 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

Fields inherited from interface com.esri.arcgis.controls.IGraphicProperties

IID, IID72b8b18e_50ea_46bf_85d1_66b379931378, xxDummy

Fields inherited from interface com.esri.arcgis.controls.ILayerEffectProperties

IID, IIDaf8f6879_7718_47de_8a52_cb393f2d12da, xxDummy

Constructor Summary

CommandsEnvironment()
Constructs a CommandsEnvironment using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IFormattedTextSymbol	getCallout() The callout symbol used by the CommandsEnvironment singleton.
static java.lang.String	getClsid() getClsid.
IFillSymbol	getFillSymbol() The fill symbol used by the CommandsEnvironment singleton.
ILayer	getFlickerLayer() The layer the Flicker command uses.
int	getFlickerRate() Rate in milliseconds used to Flicker the screen with the Flicker command.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILineSymbol	getLineSymbol() The line symbol used by the CommandsEnvironment singleton.
IMarkerSymbol	getMarkerSymbol() The marker symbol used by the CommandsEnvironment singleton.
ILayer	getSwipeLayer() The layer the Swipe command uses.
ITextSymbol	getTextSymbol() The text symbol used by the CommandsEnvironment singleton.
ILayer	getTransparencyLayer() The layer the Transparency command uses.
int	hashCode() the hashcode for this object
void	release() Release a CommandsEnvironment.
void	setCallout(IFormattedTextSymbol ppCallout) The callout symbol used by the CommandsEnvironment singleton.
void	setFillSymbol(IFillSymbol ppFillSymbol) The fill symbol used by the CommandsEnvironment singleton.
void	setFlickerLayerByRef(ILayer ppFlickerLayer) The layer the Flicker command uses.
void	setFlickerRate(int lRate) Rate in milliseconds used to Flicker the screen with the Flicker command.
void	setLineSymbol(ILineSymbol ppLineSymbol) The line symbol used by the CommandsEnvironment singleton.
void	setMarkerSymbol(IMarkerSymbol ppMarkerSymbol) The marker symbol used by the CommandsEnvironment singleton.
void	setSwipeLayerByRef(ILayer ppSwiperLayer) The layer the Swipe command uses.
void	setTextSymbol(ITextSymbol ppTextSymbol) The text symbol used by the CommandsEnvironment singleton.
void	setTransparencyLayerByRef(ILayer ppLayer) The layer the Transparency command uses.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandsEnvironment

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

Constructs a CommandsEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CommandsEnvironment

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

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

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

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

release

public void release()

Release a CommandsEnvironment.

Specified by:

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

setMarkerSymbol

public void setMarkerSymbol(IMarkerSymbol ppMarkerSymbol)
                     throws java.io.IOException,
                            AutomationException

The marker symbol used by the CommandsEnvironment singleton.

Specified by:

setMarkerSymbol in interface IGraphicProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMarkerSymbol

public IMarkerSymbol getMarkerSymbol()
                              throws java.io.IOException,
                                     AutomationException

The marker symbol used by the CommandsEnvironment singleton.

Specified by:

getMarkerSymbol in interface IGraphicProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineSymbol

public void setLineSymbol(ILineSymbol ppLineSymbol)
                   throws java.io.IOException,
                          AutomationException

The line symbol used by the CommandsEnvironment singleton.

Specified by:

setLineSymbol in interface IGraphicProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineSymbol

public ILineSymbol getLineSymbol()
                          throws java.io.IOException,
                                 AutomationException

The line symbol used by the CommandsEnvironment singleton.

Specified by:

getLineSymbol in interface IGraphicProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFillSymbol

public void setFillSymbol(IFillSymbol ppFillSymbol)
                   throws java.io.IOException,
                          AutomationException

The fill symbol used by the CommandsEnvironment singleton.

Specified by:

setFillSymbol in interface IGraphicProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol()
                          throws java.io.IOException,
                                 AutomationException

The fill symbol used by the CommandsEnvironment singleton.

Specified by:

getFillSymbol in interface IGraphicProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextSymbol

public void setTextSymbol(ITextSymbol ppTextSymbol)
                   throws java.io.IOException,
                          AutomationException

The text symbol used by the CommandsEnvironment singleton.

Specified by:

setTextSymbol in interface IGraphicProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException

The text symbol used by the CommandsEnvironment singleton.

Specified by:

getTextSymbol in interface IGraphicProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCallout

public void setCallout(IFormattedTextSymbol ppCallout)
                throws java.io.IOException,
                       AutomationException

The callout symbol used by the CommandsEnvironment singleton.

Specified by:

setCallout in interface IGraphicProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCallout

public IFormattedTextSymbol getCallout()
                                throws java.io.IOException,
                                       AutomationException

The callout symbol used by the CommandsEnvironment singleton.

Specified by:

getCallout in interface IGraphicProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSwipeLayerByRef

public void setSwipeLayerByRef(ILayer ppSwiperLayer)
                        throws java.io.IOException,
                               AutomationException

The layer the Swipe command uses.

Specified by:

setSwipeLayerByRef in interface ILayerEffectProperties

Parameters:

ppSwiperLayer - 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.

getSwipeLayer

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

The layer the Swipe command uses.

Specified by:

getSwipeLayer in interface ILayerEffectProperties

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.

setFlickerLayerByRef

public void setFlickerLayerByRef(ILayer ppFlickerLayer)
                          throws java.io.IOException,
                                 AutomationException

The layer the Flicker command uses.

Specified by:

setFlickerLayerByRef in interface ILayerEffectProperties

Parameters:

ppFlickerLayer - 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.

getFlickerLayer

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

The layer the Flicker command uses.

Specified by:

getFlickerLayer in interface ILayerEffectProperties

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.

setTransparencyLayerByRef

public void setTransparencyLayerByRef(ILayer ppLayer)
                               throws java.io.IOException,
                                      AutomationException

The layer the Transparency command uses.

Specified by:

setTransparencyLayerByRef in interface ILayerEffectProperties

Parameters:

ppLayer - 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.

getTransparencyLayer

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

The layer the Transparency command uses.

Specified by:

getTransparencyLayer in interface ILayerEffectProperties

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.

setFlickerRate

public void setFlickerRate(int lRate)
                    throws java.io.IOException,
                           AutomationException

Rate in milliseconds used to Flicker the screen with the Flicker command.

Specified by:

setFlickerRate in interface ILayerEffectProperties

Parameters:

lRate - The lRate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFlickerRate

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

Rate in milliseconds used to Flicker the screen with the Flicker command.

Specified by:

getFlickerRate in interface ILayerEffectProperties

Returns:

The lRate

Throws:

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

AutomationException - If the ArcObject component throws an exception.