Packagecom.esri.ags.events
Classpublic class LayerEvent
InheritanceLayerEvent Inheritance flash.events.Event

Represents event objects that are specific to a Layer.

See also

com.esri.ags.layers.Layer


Public Properties
 PropertyDefined By
  fault : Fault
Fault for loadError events and updateEnd events when updateSuccess is false.
LayerEvent
  isInScaleRange : Boolean
The value for the associated layer's isInScaleRange property - only applies for isInScaleRangeChange events.
LayerEvent
  layer : Layer
Reference to the associated layer.
LayerEvent
  updateSuccess : Boolean
This is true if the update event was successful; false otherwise.
LayerEvent
Public Methods
 MethodDefined By
  
LayerEvent(type:String, layer:Layer, fault:Fault = null, updateSuccess:Boolean = false, isInScaleRange:Boolean = false)
Creates a new LayerEvent.
LayerEvent
Public Constants
 ConstantDefined By
  IS_IN_SCALE_RANGE_CHANGE : String = isInScaleRangeChange
[static] Defines the value of the type property of the event object for a isInScaleRangeChange event.
LayerEvent
  LOAD : String = load
[static] Defines the value of the type property of the event object for a load event.
LayerEvent
  LOAD_ERROR : String = loadError
[static] Defines the value of the type property of the event object for a loadError event.
LayerEvent
  UPDATE_END : String = updateEnd
[static] Defines the value of the type property of the event object for a updateEnd event.
LayerEvent
  UPDATE_START : String = updateStart
[static] Defines the value of the type property of the event object for a updateStart event.
LayerEvent
Property Detail
faultproperty
public var fault:Fault

Fault for loadError events and updateEnd events when updateSuccess is false.

isInScaleRangeproperty 
public var isInScaleRange:Boolean

The value for the associated layer's isInScaleRange property - only applies for isInScaleRangeChange events.

layerproperty 
public var layer:Layer

Reference to the associated layer.

updateSuccessproperty 
public var updateSuccess:Boolean

This is true if the update event was successful; false otherwise.

Constructor Detail
LayerEvent()Constructor
public function LayerEvent(type:String, layer:Layer, fault:Fault = null, updateSuccess:Boolean = false, isInScaleRange:Boolean = false)

Creates a new LayerEvent.

Parameters
type:String — The event type; indicates the action that triggered the event.
 
layer:Layer — Reference to the associated layer.
 
fault:Fault (default = null) — Fault for loadError events and updateEnd events when updateSuccess is false.
 
updateSuccess:Boolean (default = false) — This is true if the update event was successful; false otherwise.
 
isInScaleRange:Boolean (default = false)
Constant Detail
IS_IN_SCALE_RANGE_CHANGEConstant
public static const IS_IN_SCALE_RANGE_CHANGE:String = isInScaleRangeChange

Defines the value of the type property of the event object for a isInScaleRangeChange event.

LOADConstant 
public static const LOAD:String = load

Defines the value of the type property of the event object for a load event.

LOAD_ERRORConstant 
public static const LOAD_ERROR:String = loadError

Defines the value of the type property of the event object for a loadError event.

UPDATE_ENDConstant 
public static const UPDATE_END:String = updateEnd

Defines the value of the type property of the event object for a updateEnd event.

UPDATE_STARTConstant 
public static const UPDATE_START:String = updateStart

Defines the value of the type property of the event object for a updateStart event.