com.esri.arcgis.controls
Interface ILayerEffectProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

CommandsEnvironment

public interface ILayerEffectProperties
extends Serializable

Provides access to layer effect settings that are used by the control commands.

Description

The ILayerEffectProperties interface controls the layer used by the ControlsMapSwipeTool, ControlsGlobeSwipeTool, ControlsLayerTransparencyCommand, ControlsMapFlickerCommand and ControlsGlobeFlickerCommand.

Product Availability

Available with ArcGIS Engine.

Method Summary

ILayer	getFlickerLayer() The layer the Flicker command uses.
int	getFlickerRate() Rate in milliseconds used to Flicker the screen with the Flicker command.
ILayer	getSwipeLayer() The layer the Swipe command uses.
ILayer	getTransparencyLayer() The layer the Transparency command uses.
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	setSwipeLayerByRef(ILayer ppSwiperLayer) The layer the Swipe command uses.
void	setTransparencyLayerByRef(ILayer ppLayer) The layer the Transparency command uses.

Method Detail

setSwipeLayerByRef

void setSwipeLayerByRef(ILayer ppSwiperLayer)
                        throws IOException,
                               AutomationException

The layer the Swipe command uses.

Product Availability

Available with ArcGIS Engine.

Parameters:

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

getSwipeLayer

ILayer getSwipeLayer()
                     throws IOException,
                            AutomationException

The layer the Swipe command uses.

Description

The layer used by the ControlsMapSwipeTool and ControlsGlobeSwipeTool. The SwipeLayer can be set programmatically or interactively by the end user selecting a layer using ControlsLayerListToolControl or ControlsGlobeLayerListToolControl.

Product Availability

Available with ArcGIS Engine.

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.

setFlickerLayerByRef

void setFlickerLayerByRef(ILayer ppFlickerLayer)
                          throws IOException,
                                 AutomationException

The layer the Flicker command uses.

Product Availability

Available with ArcGIS Engine.

Parameters:

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

getFlickerLayer

ILayer getFlickerLayer()
                       throws IOException,
                              AutomationException

The layer the Flicker command uses.

Description

The layer used by the ControlsMapFlickerCommand and ControlsGlobeFlickerCommand. The FlickerLayer can be set programmatically or interactively by the end user selecting a layer using ControlsLayerListToolControl or ControlsGlobeLayerListToolControl.

Product Availability

Available with ArcGIS Engine.

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.

setTransparencyLayerByRef

void setTransparencyLayerByRef(ILayer ppLayer)
                               throws IOException,
                                      AutomationException

The layer the Transparency command uses.

Product Availability

Available with ArcGIS Engine.

Parameters:

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

getTransparencyLayer

ILayer getTransparencyLayer()
                            throws IOException,
                                   AutomationException

The layer the Transparency command uses.

Description

The layer used by the ControlsLayerTransparencyCommand. The TransparencyLayer can be set programmatically or interactively by the end user selecting a layer using ControlsLayerListToolControl or ControlsGlobeLayerListToolControl.

Product Availability

Available with ArcGIS Engine.

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.

setFlickerRate

void setFlickerRate(int lRate)
                    throws IOException,
                           AutomationException

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

Product Availability

Available with ArcGIS Engine.

Parameters:

lRate - The lRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlickerRate

int getFlickerRate()
                   throws IOException,
                          AutomationException

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

Description

The flicker rate in milliseconds used by the ControlsMapFlickerCommand and ControlsGlobeFlickerCommand. The FlickerRate can be set programmatically or interactively by the end user selecting a rate using ControlsFlickerRateToolControl. By default the FlickerRate is 500.

Product Availability

Available with ArcGIS Engine.

Returns:

The lRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.