Packagejp.nium.api.tweener
Classpublic class TweenerHelper
InheritanceTweenerHelper Inheritance EventIntegrator Inheritance flash.events.EventDispatcher

TweenerHelper クラスは、Tweener クラスの機能を拡張し、インスタンスとして扱えるようにするためのアダプタクラスです。 TweenerHelper class is a adopter class that extends the function of TransitionManager class and let to treat as instance.



Public Methods
 MethodDefined By
  
TweenerHelper(scopes:Object = null, parameters:Object = null)
新しい TransitionHelper インスタンスを作成します。 Creates a new TransitionHelper object.
TweenerHelper
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override] イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventIntegrator instance to get the event notification.
EventIntegrator
 Inherited
addExclusivelyEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーは、IEventIntegrator インスタンスの管理外となるため、removeEventListener() メソッドで削除した場合にも、restoreRemovedListeners() メソッドで再登録させることができません。 Register the event listener object into the EventIntegrator instance to get the event notification.
EventIntegrator
 Inherited
completelyRemoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができません。 Remove the listener from EventIntegrator instance.
EventIntegrator
 Inherited
dispatchEvent(event:Event):Boolean
[override] イベントをイベントフローに送出します。 Dispatches an event into the event flow.
EventIntegrator
  
doTween():Boolean
Tweener を実行します。 Execute the Tweener.
TweenerHelper
 Inherited
hasEventListener(type:String):Boolean
[override] EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventIntegrator
  
pauseTweens(... properties):Boolean
実行中の Tweener を停止します。 Stop the executing Tweener.
TweenerHelper
 Inherited
removeAllListeners(completely:Boolean = false):void
addEventListener() メソッド経由で登録された全てのイベントリスナー登録を削除します。 完全に登録を削除しなかった場合には、削除されたイベントリスナーを restoreRemovedListeners() メソッドで復帰させることができます。 Remove the whole event listener registered via addEventListener() method.
EventIntegrator
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance.
EventIntegrator
  
removeTweens(... properties):Boolean
実行中の Tweener を削除します。 Remove the executing Tweener.
TweenerHelper
 Inherited
removeEventListener() メソッド、または removeAllListeners() メソッド経由で削除された全てイベントリスナーを再登録します。 Re-register the whole event listener removed via removeEventListener() or removeAllListeners() method.
EventIntegrator
  
resumeTweens(... properties):Boolean
停止中の Tweener を再開します。 Restart the stopping Tweener.
TweenerHelper
  
toString():String
[override] 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
TweenerHelper
 Inherited
willTrigger(type:String):Boolean
[override] 指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventIntegrator
Events
 Event Summary Defined By
  Tween 処理が完了した場合に送出されます。 Dispatch when the Tween processing is completed.TweenerHelper
  Tween 処理中にエラーが発生した場合に送出されます。 Dispatch when the error occur during Tween processing.TweenerHelper
  Tween 処理が上書きされた場合に送出されます。 Dispatch when the Tween processing is over written.TweenerHelper
  Tween 処理が開始された場合に送出されます。 Dispatch when the Tween processing is begun.TweenerHelper
  Tween 処理でプロパティ値が変更された場合に送出されます。 Dispatch when the property changed during Tween processing.TweenerHelper
Constructor Detail
TweenerHelper()Constructor
public function TweenerHelper(scopes:Object = null, parameters:Object = null)

新しい TransitionHelper インスタンスを作成します。 Creates a new TransitionHelper object.

Parameters
scopes:Object (default = null) Any object that will suffer a tweening. These objects are usually MovieClip, TextField, or Sound instances, or any other custom object with a numeric property that needs to be tweened.
 
parameters:Object (default = null) An object containing various properties of the original object that you want to tween on the original objects, with their final values assigned (some special properties are also allowed), as well as some built-in Tweener properties used when defining tweening parameters. This is like the recipe for the tweening, declaring both what will be tweened, and how.
Method Detail
doTween()method
public function doTween():Boolean

Tweener を実行します。 Execute the Tweener.

Returns
Boolean
pauseTweens()method 
public function pauseTweens(... properties):Boolean

実行中の Tweener を停止します。 Stop the executing Tweener.

Parameters

... properties The name of the property or properties currently being tweened that you want to pause. This is a string containing the name of the property, and any number of strings can be specified as parameters. If no property name is specified, all tweenings for this specific target target are paused.

Returns
Boolean
removeTweens()method 
public function removeTweens(... properties):Boolean

実行中の Tweener を削除します。 Remove the executing Tweener.

Parameters

... properties The name of the property or properties currently being tweened that you want to remove. This is a string containing the name of the property, and any number of strings can be specified as parameters. If no property name is specified, all tweenings for this specific target are removed.

Returns
Boolean
resumeTweens()method 
public function resumeTweens(... properties):Boolean

停止中の Tweener を再開します。 Restart the stopping Tweener.

Parameters

... properties The name of the property or properties that have paused tweenings that you want to resume. This is a string containing the name of the property, and any number of strings can be specified as parameters. If no property name is specified, all paused tweenings for this specific target target are resumed.

Returns
Boolean
toString()method 
override public function toString():String

指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.

Returns
Stringオブジェクトのストリング表現です。 A string representation of the object.
Event Detail
complete Event
Event Object Type: jp.nium.api.tweener.TweenerEvent
TweenerEvent.type property = jp.nium.api.tweener.TweenerEvent.COMPLETE

Tween 処理が完了した場合に送出されます。 Dispatch when the Tween processing is completed.

complete イベントオブジェクトの type プロパティ値を定義します。 The TweenerEvent.COMPLETE constant defines the value of the type property of an complete event object.
error Event  
Event Object Type: jp.nium.api.tweener.TweenerEvent
TweenerEvent.type property = jp.nium.api.tweener.TweenerEvent.ERROR

Tween 処理中にエラーが発生した場合に送出されます。 Dispatch when the error occur during Tween processing.

error イベントオブジェクトの type プロパティ値を定義します。 The TweenerEvent.ERROR constant defines the value of the type property of an error event object.
overwrite Event  
Event Object Type: jp.nium.api.tweener.TweenerEvent
TweenerEvent.type property = jp.nium.api.tweener.TweenerEvent.OVERWRITE

Tween 処理が上書きされた場合に送出されます。 Dispatch when the Tween processing is over written.

overwrite イベントオブジェクトの type プロパティ値を定義します。 The TweenerEvent.OVERWRITE constant defines the value of the type property of an overwrite event object.
start Event  
Event Object Type: jp.nium.api.tweener.TweenerEvent
TweenerEvent.type property = jp.nium.api.tweener.TweenerEvent.START

Tween 処理が開始された場合に送出されます。 Dispatch when the Tween processing is begun.

start イベントオブジェクトの type プロパティ値を定義します。 The TweenerEvent.START constant defines the value of the type property of an start event object.
update Event  
Event Object Type: jp.nium.api.tweener.TweenerEvent
TweenerEvent.type property = jp.nium.api.tweener.TweenerEvent.UPDATE

Tween 処理でプロパティ値が変更された場合に送出されます。 Dispatch when the property changed during Tween processing.

update イベントオブジェクトの type プロパティ値を定義します。 The TweenerEvent.UPDATE constant defines the value of the type property of an update event object.