Packagepegas.transitions
Classpublic class TweenModel
InheritanceTweenModel Inheritance AbstractModel Inheritance CoreEventDispatcher Inheritance CoreObject
ImplementsIterable

The model of the Tween class.


Public Properties
 PropertyDefined by
 Inheritedchannel : String
Indicates the channel of this dispatcher if this instance is global.
CoreEventDispatcher
 Inheritedid : *
Returns the id of this IModelObject.
AbstractModel
 InheritedisGlobal : Boolean
(read-only) Returns the value of the isGlobal flag of this model.
CoreEventDispatcher
Public Methods
 MethodDefined by
  
TweenModel(id:* = null, tweens:Array = null, bGlobal:Boolean = false, sChannel:String = null)
Creates a new TweenModel instance.
TweenModel
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0.0, useWeakReference:Boolean = false):void
Allows the registration of event listeners on the event target.
CoreEventDispatcher
  
clear():void
Clear the model.
TweenModel
  
clone():*
Returns a shallow copy of this object.
TweenModel
  
contains(prop:String):Boolean
Returns true if the specified property exist in this model.
TweenModel
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
CoreEventDispatcher
  
get(prop:String):TweenEntry
Returns the specified TweenEntry reference.
TweenModel
 Inherited
getEventDispatcher():EventDispatcher
Returns the internal EventDispatcher reference.
CoreEventDispatcher
  
getEventTypeADD():String
Returns the event name use in the insert method.
TweenModel
  
getEventTypeCLEAR():String
Returns the event name use in the clear method.
TweenModel
  
getEventTypeREMOVE():String
Returns the event name use in the remove method.
TweenModel
 Inherited
getIsGlobal():Boolean
Returns the value of the isGlobal flag of this model.
CoreEventDispatcher
 Inherited
getLogger():ILogger
Returns the internal ILogger reference of this ILogable object.
CoreObject
  
getProperties():Array
Returns the Array representation of all property names in this model.
TweenModel
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
CoreEventDispatcher
 Inherited
hashCode():uint
Returns a hashcode value for the object.
CoreObject
 Inherited
initEventDispatcher():EventDispatcher
Creates and returns the internal EventDispatcher reference (this method is invoked in the constructor).
CoreEventDispatcher
  
initEventType():void
Initialize the event types of this model.
TweenModel
  
insert(entry:TweenEntry):Boolean
Inserts a new TweenEntry in the model.
TweenModel
 Inherited
isLocked():Boolean
Returns true if the object is locked.
CoreEventDispatcher
  
iterator():Iterator
Returns an iterator of this model.
TweenModel
 Inherited
lock():void
Locks the object.
CoreEventDispatcher
 Inherited
registerEventListener(type:String, listener:Boolean, useCapture:int = false, priority:Boolean = 0, useWeakReference:* = false):void
Allows the registration of event listeners on the event target (Function or EventListener).
CoreEventDispatcher
  
remove(entry:*):Boolean
Removes an entry in the model.
TweenModel
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
CoreEventDispatcher
 Inherited
run(... arguments):void
Run the first process with this model.
AbstractModel
 Inherited
setEventDispatcher(e:EventDispatcher):void
Sets the internal EventDispatcher reference.
CoreEventDispatcher
  
setEventTypeADD(type:String = null):void
Sets the event name use in the insert method.
TweenModel
  
setEventTypeCLEAR(type:String = null):void
Sets the event name use in the clear method.
TweenModel
  
setEventTypeREMOVE(type:String = null):void
Sets the event name use in the remove method.
TweenModel
 Inherited
setGlobal(flag:Boolean = false, channel:String = null):void
Sets if the instance use a global EventDispatcher to dispatch this events, if the flag value is false the instance use a local EventDispatcher.
CoreEventDispatcher
 Inherited
setLogger(log:ILogger = null):void
Sets the internal ILogger reference of this ILogable object.
CoreObject
  
size():Number
Returns the number of elements in the model.
TweenModel
  
toArray():Array
Returns the Array representation of all TweenEntry objects in this model.
TweenModel
  
toMap():Map
Returns the Map representation of all TweenEntry objects in this model.
TweenModel
 Inherited
toSource(indent:int = 0):String
Returns the string representation the source code of the object.
CoreEventDispatcher
  
toString():String
Returns the String representation of this object.
TweenModel
 Inherited
unlock():void
Unlocks the display.
CoreEventDispatcher
 Inherited
unregisterEventListener(type:String, listener:Boolean, useCapture:* = false):void
Removes a listener (Function or EventListener object) from the EventDispatcher object.
CoreEventDispatcher
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
CoreEventDispatcher
Constructor detail
TweenModel()constructor
public function TweenModel(id:* = null, tweens:Array = null, bGlobal:Boolean = false, sChannel:String = null)

Creates a new TweenModel instance.

Parameters
id:* (default = null) — the id of the model.
 
tweens:Array (default = null) — The array to initialize the model with some TweenEntry objects. All no TweenEntry objects are ignored.
 
bGlobal:Boolean (default = false) — the flag to use a global event flow or a local event flow.
 
sChannel:String (default = null) — the name of the global event flow if the bGlobal argument is true.
Method detail
clear()method
public function clear():void

Clear the model.

clone()method 
public function clone():*

Returns a shallow copy of this object. This method keep all Tween entries and the id of the original object. var clone:TweenModel = tp.clone() ;

Returns
* — a shallow copy of this object.
contains()method 
public function contains(prop:String):Boolean

Returns true if the specified property exist in this model.

Parameters
prop:String

Returns
Boolean — true if the specified property exist in this model.
get()method 
public function get(prop:String):TweenEntry

Returns the specified TweenEntry reference.

Parameters
prop:String

Returns
TweenEntry — the specified TweenEntry reference.
getEventTypeADD()method 
public function getEventTypeADD():String

Returns the event name use in the insert method.

Returns
String — the event name use in the insert method.
getEventTypeCLEAR()method 
public function getEventTypeCLEAR():String

Returns the event name use in the clear method.

Returns
String — the event name use in the clear method.
getEventTypeREMOVE()method 
public function getEventTypeREMOVE():String

Returns the event name use in the remove method.

Returns
String — the event name use in the remove method.
getProperties()method 
public function getProperties():Array

Returns the Array representation of all property names in this model.

Returns
Array — the Array representation of all property names in this model.
initEventType()method 
public function initEventType():void

Initialize the event types of this model.

insert()method 
public function insert(entry:TweenEntry):Boolean

Inserts a new TweenEntry in the model.

Parameters
entry:TweenEntry

Returns
Boolean
iterator()method 
public function iterator():Iterator

Returns an iterator of this model.

Returns
Iterator — an iterator of this model.
remove()method 
public function remove(entry:*):Boolean

Removes an entry in the model.

Parameters
entry:*

Returns
Boolean
setEventTypeADD()method 
public function setEventTypeADD(type:String = null):void

Sets the event name use in the insert method.

Parameters
type:String (default = null)
setEventTypeCLEAR()method 
public function setEventTypeCLEAR(type:String = null):void

Sets the event name use in the clear method.

Parameters
type:String (default = null)
setEventTypeREMOVE()method 
public function setEventTypeREMOVE(type:String = null):void

Sets the event name use in the remove method.

Parameters
type:String (default = null)
size()method 
public function size():Number

Returns the number of elements in the model.

Returns
Number — the number of elements in the model.
toArray()method 
public function toArray():Array

Returns the Array representation of all TweenEntry objects in this model.

Returns
Array — the Array representation of all TweenEntry objects in this model.
toMap()method 
public function toMap():Map

Returns the Map representation of all TweenEntry objects in this model.

Returns
Map — the Map representation of all TweenEntry objects in this model.
toString()method 
public override function toString():String

Returns the String representation of this object.

Returns
String — the String representation of this object.