Packagejp.nium.models
Classpublic dynamic class Model
InheritanceModel Inheritance flash.utils.Proxy
Implementsflash.events.IEventDispatcher

Model クラスは、データの状態を管理し、データ構造の入出力をサポートするモデルクラスです。


Example


Public Methods
 MethodDefined by
  
Model(name:String, xml:XML = null)
新しい Model インスタンスを作成します。 Creates a new Model object.
Model
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventIntegrator instance to get the event notification.
Model
  
clone():Model
Model インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an Model subclass.
Model
  
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。 Dispatches an event into the event flow.
Model
  
getParent():Model
親のモデルを取得します。
Model
  
hasEventListener(type:String):Boolean
EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Model
  
parse(xml:XML):void
渡された XML インスタンスに設定されているデータをモデルに対して割り当てます。
Model
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance.
Model
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
Model
  
toXML():XML
指定されたオブジェクトの XML 表現を返します。 Returns the XML representation of the specified object.
Model
  
toXMLString():String
指定されたオブジェクトの XML ストリング表現を返します。 Returns the XML string representation of the specified object.
Model
  
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
Model
Protected Methods
 MethodDefined by
  
getProperty(name:String):*
指定された名前と関連付けられたデータを取得します。
Model
  
preventEnumeratable(name:String):void
指定されたプロパティが列挙されないように指定します。
Model
  
setDefaultFormat(dataType:String):void
標準の構造種別を設定します。
Model
  
setFormat(name:String, dataType:String):void
指定されたフィールドの構造種別を設定します。
Model
  
setProperty(name:String, value:*):void
データに対して名前を付けて登録します。
Model
Events
 EventSummaryDefined by
  
modelAdded
モデルオブジェクトがモデルリストに追加されたときに送出されます。 Model
  
modelRemoved
モデルオブジェクトがモデルリストから削除されようとしているときに送出されます。 Model
  
modelUpdateBefore
モデルオブジェクトが管理する値が更新される直前に送出されます。 Model
  
modelUpdateFailure
モデルオブジェクトが管理する値の更新に失敗した場合に送出されます。 Model
  
modelUpdateSuccess
モデルオブジェクトが管理する値の更新に成功した場合に送出されます。 Model
Public Constants
 ConstantDefined by
  TYPE_ATTRIBUTE : String = "attribute"
[static]
Model
  TYPE_NODE : String = "node"
[static]
Model
Constructor detail
Model()constructor
public function Model(name:String, xml:XML = null)

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

Parameters
name:String — モデル名です。
 
xml:XML (default = null) — モデルデータとなる XML インスタンスです。
Method detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

イベントリスナーオブジェクトを EventIntegrator インスタンスに登録し、リスナーがイベントの通知を受け取るようにします。 このメソッドを使用して登録されたリスナーを removeEventListener() メソッドで削除した場合には、restoreRemovedListeners() メソッドで再登録させることができます。 Register the event listener object into the EventIntegrator instance to get the event notification. If the registered listener by this method removed by using removeEventListener() method, it can re-register using restoreRemovedListeners() method.

Parameters
type:String — イベントのタイプです。 The type of event.
 
listener:Function — イベントを処理するリスナー関数です。この関数は Event インスタンスを唯一のパラメータとして受け取り、何も返さないものである必要があります。関数は任意の名前を持つことができます。 The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing. The function can have any name.
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。useCapture を true に設定すると、リスナーはキャプチャ段階のみでイベントを処理し、ターゲット段階またはバブリング段階では処理しません。useCapture を false に設定すると、リスナーはターゲット段階またはバブリング段階のみでイベントを処理します。3 つの段階すべてでイベントを受け取るには、addEventListener を 2 回呼び出します。useCapture を true に設定して 1 度呼び出し、useCapture を false に設定してもう一度呼び出します。 Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener twice, once with useCapture set to true, then again with useCapture set to false.
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。優先度は、符号付き 32 ビット整数で指定します。数値が大きくなるほど優先度が高くなります。優先度が n のすべてのリスナーは、優先度が n -1 のリスナーよりも前に処理されます。複数のリスナーに対して同じ優先度が設定されている場合、それらは追加された順番に処理されます。デフォルトの優先度は 0 です。 The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。デフォルトである強参照の場合は、リスナーのガベージコレクションが回避されます。弱参照では回避されません。 Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.
clone()method 
public function clone():Model

Model インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an Model subclass.

Returns
Model — 元のオブジェクトと同じプロパティ値を含む新しい Model インスタンスです。 A new Model object that is identical to the original.
dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

イベントをイベントフローに送出します。 Dispatches an event into the event flow.

Parameters
event:Event — イベントフローに送出されるイベントオブジェクトです。イベントが再度送出されると、イベントのクローンが自動的に作成されます。イベントが送出された後にそのイベントの target プロパティは変更できないため、再送出処理のためにはイベントの新しいコピーを作成する必要があります。 The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically. After an event is dispatched, its target property cannot be changed, so you must create a new copy of the event for redispatching to work.

Returns
Boolean — 値が true の場合、イベントは正常に送出されました。値が false の場合、イベントの送出に失敗したか、イベントで preventDefault() が呼び出されたことを示しています。 A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called on the event.
getParent()method 
public function getParent():Model

親のモデルを取得します。

Returns
Model — 親のモデルです。
getProperty()method 
protected function getProperty(name:String):*

指定された名前と関連付けられたデータを取得します。

Parameters
name:String — 取得したいプロパティ名です。

Returns
* — 対応するデータです。
hasEventListener()method 
public function hasEventListener(type:String):Boolean

EventIntegrator インスタンスに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.

Parameters
type:String — イベントのタイプです。 The type of event.

Returns
Boolean — 指定したタイプのリスナーが登録されている場合は true に、それ以外の場合は false になります。 A value of true if a listener of the specified type is registered; false otherwise.
parse()method 
public function parse(xml:XML):void

渡された XML インスタンスに設定されているデータをモデルに対して割り当てます。

Parameters
xml:XML — パースしたい XML インスタンスです。
preventEnumeratable()method 
protected function preventEnumeratable(name:String):void

指定されたプロパティが列挙されないように指定します。

Parameters
name:String — 列挙したくないプロパティ名です。
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

EventIntegrator インスタンスからリスナーを削除します。 このメソッドを使用して削除されたリスナーは、restoreRemovedListeners() メソッドで再登録させることができます。 Remove the listener from EventIntegrator instance. The listener removed by using this method can re-register by restoreRemovedListeners() method.

Parameters
type:String — イベントのタイプです。 The type of event.
 
listener:Function — 削除するリスナーオブジェクトです。 The listener object to remove.
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階に対して登録されたかどうかを示します。リスナーがキャプチャ段階だけでなくターゲット段階とバブリング段階にも登録されている場合は、removeEventListener() を 2 回呼び出して両方のリスナーを削除する必要があります。1 回は useCapture() を true に設定し、もう 1 回は useCapture() を false に設定する必要があります。 Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both, one call with useCapture() set to true, and another call with useCapture() set to false.
setDefaultFormat()method 
protected function setDefaultFormat(dataType:String):void

標準の構造種別を設定します。

Parameters
dataType:String — 設定される構造種別です。
setFormat()method 
protected function setFormat(name:String, dataType:String):void

指定されたフィールドの構造種別を設定します。

Parameters
name:String — 構造種別を設定したいフィールド名です。
 
dataType:String — 設定される構造種別です。
setProperty()method 
protected function setProperty(name:String, value:*):void

データに対して名前を付けて登録します。

Parameters
name:String — 登録したいプロパティ名です。
 
value:* — 登録したいデータです。
toString()method 
public function toString():String

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

Returns
String — オブジェクトのストリング表現です。 A string representation of the object.
toXML()method 
public function toXML():XML

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

Returns
XML — オブジェクトの XML 表現です。 A XML representation of the object.
toXMLString()method 
public function toXMLString():String

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

Returns
String — オブジェクトの XML ストリング表現です。 A XML string representation of the object.
willTrigger()method 
public function willTrigger(type:String):Boolean

指定されたイベントタイプについて、この EventIntegrator インスタンスまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.

Parameters
type:String — イベントのタイプです。 The type of event.

Returns
Boolean — 指定したタイプのリスナーがトリガされた場合は true に、それ以外の場合は false になります。 A value of true if a listener of the specified type will be triggered; false otherwise.
Event detail
modelAddedevent 
Event object type: jp.nium.events.ModelEvent

モデルオブジェクトがモデルリストに追加されたときに送出されます。

modelRemovedevent  
Event object type: jp.nium.events.ModelEvent

モデルオブジェクトがモデルリストから削除されようとしているときに送出されます。

modelUpdateBeforeevent  
Event object type: jp.nium.events.ModelEvent

モデルオブジェクトが管理する値が更新される直前に送出されます。

modelUpdateFailureevent  
Event object type: jp.nium.events.ModelEvent

モデルオブジェクトが管理する値の更新に失敗した場合に送出されます。

modelUpdateSuccessevent  
Event object type: jp.nium.events.ModelEvent

モデルオブジェクトが管理する値の更新に成功した場合に送出されます。

Constant detail
TYPE_ATTRIBUTEconstant
public static const TYPE_ATTRIBUTE:String = "attribute"

TYPE_NODEconstant 
public static const TYPE_NODE:String = "node"




Copyright (C) 2007-2010 taka:nium.jp. All Rights Reserved.