Packagecom.esri.bacore.thematicmapping
Classpublic class TMRendererEvent
InheritanceTMRendererEvent Inheritance flash.events.Event

The TMRendererEvent event provides updating a symbol for rendering a graphic.



Public Properties
 PropertyDefined By
  graphic : Graphic
[read-only] Graphic to be rendered.
TMRendererEvent
  priority : int
[read-only] Current priority of update.
TMRendererEvent
  symbol : Symbol
[read-only] Current rendering symbol.
TMRendererEvent
Public Methods
 MethodDefined By
  
TMRendererEvent(graphic:Graphic, symbol:Symbol)
Creates a new instance of the TMRendererEvent class.
TMRendererEvent
  
clone():Event
[override] Creates a clone of the event.
TMRendererEvent
  
toString():String
[override] Gets the description of the event.
TMRendererEvent
  
updateSymbol(newSymbol:Symbol, newPriority:int):Boolean
Updates rendering symbol.
TMRendererEvent
Public Constants
 ConstantDefined By
  RENDER : String = tmRenderer
[static] The TMRendererEvent.RENDER constant defines the value of the type property of the event object for a tmRenderer event.
TMRendererEvent
Property Detail
graphicproperty
graphic:Graphic  [read-only]

Graphic to be rendered.


Implementation
    public function get graphic():Graphic
priorityproperty 
priority:int  [read-only]

Current priority of update.


Implementation
    public function get priority():int
symbolproperty 
symbol:Symbol  [read-only]

Current rendering symbol.


Implementation
    public function get symbol():Symbol
Constructor Detail
TMRendererEvent()Constructor
public function TMRendererEvent(graphic:Graphic, symbol:Symbol)

Creates a new instance of the TMRendererEvent class.

Parameters
graphic:Graphic — Graphic to be rendered.
 
symbol:Symbol — Current rendering symbol.
Method Detail
clone()method
override public function clone():Event

Creates a clone of the event.

Returns
Event — Shallow copy of the event.
toString()method 
override public function toString():String

Gets the description of the event.

Returns
String — String representation of the event.
updateSymbol()method 
public function updateSymbol(newSymbol:Symbol, newPriority:int):Boolean

Updates rendering symbol.

Updates are applied if the newPriority of this operation is greater that or equal to the priority of the last successful update of rendering symbol.

Parameters

newSymbol:Symbol — A new rendering symbol.
 
newPriority:int — Update operation priority.

Returns
Boolean — True value if the rendering symbol is updated.
Constant Detail
RENDERConstant
public static const RENDER:String = tmRenderer

The TMRendererEvent.RENDER constant defines the value of the type property of the event object for a tmRenderer event.

The properties of the event object have the following values:

PropertyValue
babblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event.
graphicGraphic to be rendered.
priorityCurrent priority of update.
symbolCurrent rendering symbol.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.