パッケージmx.events
public class DataGridEvent
継承DataGridEvent Inheritance Event Inheritance Object

DataGridEvent クラスは、DataGrid コントロール固有のイベントオブジェクトを表します。たとえば、編集可能なグリッドアイテムにフォーカスが置かれた場合に送出されるイベントなどがあります。

関連項目

mx.controls.DataGrid


パブリックプロパティ
 プロパティ定義
 Inheritedbubbles : Boolean
イベントがバブリングイベントかどうかを示します。
Event
 Inheritedcancelable : Boolean
イベントに関連付けられたビヘイビアを回避できるかどうかを示します。
Event
  columnIndex : int
DataGrid オブジェクトの columns 配列の、イベントに関連付けられた列の 0 から始まるインデックスです。
DataGridEvent
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcurrentTarget : Object
イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
Event
  dataField : String
列に関連付けられているデータ内のフィールドまたはプロパティの名前です。
DataGridEvent
 InheritedeventPhase : uint
イベントフローの現在の段階です。
Event
  itemRenderer : IListItemRenderer
編集中のアイテムに対応するアイテムレンダラーか、クリックまたは展開されたヘッダレンダラーです。
DataGridEvent
  localX : Number
列の伸縮イベントを再生する場合の列の x 方向の位置です。
DataGridEvent
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  reason : String
itemEditEnd イベントが送出された理由です。
DataGridEvent
  rowIndex : int
データプロバイダのアイテムの 0 から始まるインデックスです。
DataGridEvent
 Inheritedtarget : Object
イベントターゲットです。
Event
 Inheritedtype : String
イベントの型です。
Event
パブリックメソッド
 メソッド定義
  DataGridEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, dataField:String = null, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null, localX:Number)
コンストラクタ。
DataGridEvent
 Inheritedclone():Event
Event サブクラスのインスタンスを複製します。
Event
 InheritedformatToString(className:String, ... arguments):String
カスタム Event クラスに toString() メソッドを実装するためのユーティリティ関数です。
Event
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisDefaultPrevented():Boolean
イベントで preventDefault() が呼び出されたかどうかをチェックします。
Event
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpreventDefault():void
イベントのデフォルトビヘイビアをキャンセルできる場合に、そのビヘイビアをキャンセルします。
Event
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedstopImmediatePropagation():void
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
Event
 InheritedstopPropagation():void
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
Event
 InheritedtoString():String
Event オブジェクトのすべてのプロパティを含むストリングを返します。
Event
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
パブリック定数
 定数定義
 InheritedACTIVATE : String = "activate"
[static] activate イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedADDED : String = "added"
[static] added イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCANCEL : String = "cancel"
[static] cancelイベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCHANGE : String = "change"
[static] change イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCLOSE : String = "close"
[static] close イベントオブジェクトの type プロパティの値を定義します。
Event
  COLUMN_STRETCH : String = "columnStretch"
[static] DataGridEvent.COLUMN_STRETCH 定数は columnStretch イベントのイベントオブジェクトの type プロパティ値を定義し、ユーザーが列を水平方向に展開したことを示します。
DataGridEvent
 InheritedCOMPLETE : String = "complete"
[static] complete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCONNECT : String = "connect"
[static] connect イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] deactivate イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] enterFrame イベントオブジェクトの type プロパティの値を定義します。
Event
  HEADER_RELEASE : String = "headerRelease"
[static] DataGridEvent.HEADER_RELEASE 定数は headerRelease イベントのイベントオブジェクトの type プロパティ値を定義し、ユーザーが列ヘッダの上でマウスを押して離したことを示します。
DataGridEvent
 InheritedID3 : String = "id3"
[static] id3 イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedINIT : String = "init"
[static] init イベントオブジェクトの type プロパティの値を定義します。
Event
  ITEM_EDIT_BEGIN : String = "itemEditBegin"
[static] DataGridEvent.ITEM_EDIT_BEGIN 定数は itemEditBegin イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムが編集可能であることを示します。
DataGridEvent
  ITEM_EDIT_BEGINNING : String = "itemEditBeginning"
[static] DataGridEvent.ITEM__EDIT_BEGINNING 定数は itemEditBeginning イベントの ListEvent オブジェクトの type プロパティ値を定義し、ユーザーがアイテム上でマウスボタンを離すなどの操作によってアイテムを編集できる状態にあることを示します。
DataGridEvent
  ITEM_EDIT_END : String = "itemEditEnd"
[static] DataGridEvent.ITEM_EDIT_END 定数は itemEditEnd イベントのイベントオブジェクトの type プロパティ値を定義し、編集セッションが終了することを示します。
DataGridEvent
  ITEM_FOCUS_IN : String = "itemFocusIn"
[static] DataGridEvent.ITEM_FOCUS_IN 定数は itemFocusIn イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムがフォーカスを受け取ったことを示します。
DataGridEvent
  ITEM_FOCUS_OUT : String = "itemFocusOut"
[static] DataGridEvent.ITEM_FOCUS_OUT 定数は itemFocusOut イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムがフォーカスを失ったことを示します。
DataGridEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] mouseLeave イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedOPEN : String = "open"
[static] open イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedREMOVED : String = "removed"
[static] removed イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRENDER : String = "render"
[static] render イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRESIZE : String = "resize"
[static] resize イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSCROLL : String = "scroll"
[static] scroll イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSELECT : String = "select"
[static] select イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] soundComplete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] tabChildrenChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] tabEnabledChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] tabIndexChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedUNLOAD : String = "unload"
[static] unload イベントオブジェクトの type プロパティの値を定義します。
Event
プロパティの詳細
columnIndexプロパティ
public var columnIndex:int

DataGrid オブジェクトの columns 配列の、イベントに関連付けられた列の 0 から始まるインデックスです。

dataFieldプロパティ 
public var dataField:String

列に関連付けられているデータ内のフィールドまたはプロパティの名前です。

itemRendererプロパティ 
public var itemRenderer:IListItemRenderer

編集中のアイテムに対応するアイテムレンダラーか、クリックまたは展開されたヘッダレンダラーです。このプロパティを使用してデータプロバイダアイテムにアクセスできます。

localXプロパティ 
public var localX:Number

列の伸縮イベントを再生する場合の列の x 方向の位置です。

reasonプロパティ 
public var reason:String

itemEditEnd イベントが送出された理由です。タイプが ITEM_EDIT_END のイベントに対してのみ有効です。有効な値は、DataGridEventReason クラスに定義されています。

関連項目

rowIndexプロパティ 
public var rowIndex:int

データプロバイダのアイテムの 0 から始まるインデックスです。

コンストラクタの詳細
DataGridEvent()コンストラクタ
public 関数 DataGridEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, columnIndex:int = -1, dataField:String = null, rowIndex:int = -1, reason:String = null, itemRenderer:IListItemRenderer = null, localX:Number)

コンストラクタ。通常は DataGrid オブジェクトによって呼び出されます。アプリケーションコードでは使用されません。

パラメータ
type:String — イベントタイプ。イベントの基となるアクションを示します。
 
bubbles:Boolean (default = false) — イベントが表示リスト階層を上方にバブルできるかどうかを指定します。
 
cancelable:Boolean (default = false) — イベントに関連付けられた動作をキャンセルできるかどうかを指定します。
 
columnIndex:int (default = -1) — イベントが発生した列の 0 から始まるインデックスです。
 
dataField:String (default = null) — 列に関連付けられているデータ内のフィールドまたはプロパティの名前です。
 
rowIndex:int (default = -1) — データプロバイダのアイテムの 0 から始まるインデックスです。
 
reason:String (default = null)itemEditEnd イベントの理由です。
 
itemRenderer:IListItemRenderer (default = null) — 編集中のアイテムレンダラーか、クリックされたヘッダレンダラーです。
 
localX:NumbercolumnStretch イベントを再生する場合の列の x 方向の位置です。
定数の詳細
COLUMN_STRETCH定数
public static const COLUMN_STRETCH:String = "columnStretch"

DataGridEvent.COLUMN_STRETCH 定数は columnStretch イベントのイベントオブジェクトの type プロパティ値を定義し、ユーザーが列を水平方向に展開したことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelablefalse
columnIndex DataGrid オブジェクトの columns 配列内のアイテムの列の 0 から始まるインデックスです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
dataField列に関連付けられているデータ内のフィールドまたはプロパティの名前です。
itemRenderernull
localXマウスの x 座標です。
reasonnull
rowIndexデータプロバイダのアイテムの 0 から始まるインデックスです。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
TypeDataGridEvent.COLUMN_STRETCH
HEADER_RELEASE定数 
public static const HEADER_RELEASE:String = "headerRelease"

DataGridEvent.HEADER_RELEASE 定数は headerRelease イベントのイベントオブジェクトの type プロパティ値を定義し、ユーザーが列ヘッダの上でマウスを押して離したことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelabletrue
columnIndex DataGrid オブジェクトの columns 配列内のアイテムの列の 0 から始まるインデックスです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
dataField列に関連付けられているデータ内のフィールドまたはプロパティの名前です。
itemRendererリリース中のヘッダレンダラーです。
localXNaN
reasonnull
rowIndexnull
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
TypeDataGridEvent.HEADER_RELEASE
ITEM_EDIT_BEGIN定数 
public static const ITEM_EDIT_BEGIN:String = "itemEditBegin"

DataGridEvent.ITEM_EDIT_BEGIN 定数は itemEditBegin イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムが編集可能であることを示します。

このイベントのデフォルトリスナーは、次のアクションを実行します。

このイベントのイベントリスナーを記述して、アイテムエディタに渡されるデータを変更できます。たとえば、データ、データのフォーマット、またはアイテムエディタで使用するその他の情報を変更できます。

イベントリスナーを作成して、アイテムの編集に使用するアイテムエディタを指定することもできます。たとえば、2 つの異なるアイテムエディタがあるとします。イベントリスナー内で編集するデータまたは他の情報を調べ、以下の手順に従って適切なアイテムエディタを開くことができます。

  1. preventDefault() を呼び出すと、Flex が createItemEditor() メソッドがデフォルトイベントリスナーの一部として呼び出されるのを阻止できます。
  2. 適切なエディタに itemEditor プロパティを設定します。
  3. createItemEditor() メソッドを呼び出します。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelabletrue
columnIndex DataGrid オブジェクトの columns 配列内のアイテムの列の 0 から始まるインデックスです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
dataFieldnull
itemRenderer編集中のアイテムに対応するアイテムレンダラーです。
localXNaN
reasonnull
rowIndexデータプロバイダのアイテムの 0 から始まるインデックスです。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
TypeDataGridEvent.ITEM_EDIT_BEGIN
ITEM_EDIT_BEGINNING定数 
public static const ITEM_EDIT_BEGINNING:String = "itemEditBeginning"

DataGridEvent.ITEM__EDIT_BEGINNING 定数は itemEditBeginning イベントの ListEvent オブジェクトの type プロパティ値を定義し、ユーザーがアイテム上でマウスボタンを離すなどの操作によってアイテムを編集できる状態にあることを示します。

このイベントのデフォルトリスナーによって、DataGrid.editedItemPosition プロパティがフォーカスを持つアイテムに設定されて、アイテムの編集セッションが開始されます。

通常では、このイベントに対する独自のイベントリスナーを記述して、特定のアイテムを編集できないようにします。このイベントの独自のイベントリスナー内から preventDefault() メソッドを呼び出すことによって、デフォルトリスナーの実行が阻止されます。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelabletrue
columnIndex DataGrid オブジェクトの columns 配列内のアイテムの列の 0 から始まるインデックスです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
dataFieldアイテムの列に関連付けられているデータ内のフィールドまたはプロパティの名前です。
itemRenderer編集対象のアイテムに対応するアイテムレンダラーです。このイベントがキーボードから生成された場合は、編集するアイテムが画面外である可能性があるため、このプロパティは null です。
localXNaN
reasonnull
rowIndexデータプロバイダのアイテムの 0 から始まるインデックスです。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
TypeDataGridEvent.ITEM_EDIT_BEGINNING
ITEM_EDIT_END定数 
public static const ITEM_EDIT_END:String = "itemEditEnd"

DataGridEvent.ITEM_EDIT_END 定数は itemEditEnd イベントのイベントオブジェクトの type プロパティ値を定義し、編集セッションが終了することを示します。

List コンポーネントには、このイベントのデフォルトハンドラがあり、アイテムエディタから List コントロールのデータプロバイダにデータをコピーします。デフォルトのイベントリスナーは、次のアクションを実行します。

通常では、このイベントのイベントリスナーを記述して、次のアクションを実行します。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelabletrue
columnIndex DataGrid オブジェクトの columns 配列内のアイテムの列の 0 から始まるインデックスです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
dataFieldアイテムの列に関連付けられているデータ内のフィールドまたはプロパティの名前です。
itemRenderer編集中のアイテムに対応するアイテムレンダラーです。
localXNaN
reasonイベントの理由を定義する定数です。値は DataGridEventReason クラスのメンバーである必要があります。
rowIndexデータプロバイダのアイテムの 0 から始まるインデックスです。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
TypeDataGridEvent.ITEM_EDIT_END
ITEM_FOCUS_IN定数 
public static const ITEM_FOCUS_IN:String = "itemFocusIn"

DataGridEvent.ITEM_FOCUS_IN 定数は itemFocusIn イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムがフォーカスを受け取ったことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelablefalse
columnIndex DataGrid オブジェクトの columns 配列内のアイテムの列の 0 から始まるインデックスです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
dataFieldnull
itemRenderer編集中のアイテムに対応するアイテムエディタインスタンスです。
localXNaN
reasonnull
rowIndexデータプロバイダのアイテムの 0 から始まるインデックスです。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
TypeDataGridEvent.ITEM_FOCUS_IN
ITEM_FOCUS_OUT定数 
public static const ITEM_FOCUS_OUT:String = "itemFocusOut"

DataGridEvent.ITEM_FOCUS_OUT 定数は itemFocusOut イベントのイベントオブジェクトの type プロパティ値を定義し、アイテムがフォーカスを失ったことを示します。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ
bubblesfalse
cancelablefalse
columnIndex DataGrid オブジェクトの columns 配列内のアイテムの列の 0 から始まるインデックスです。
currentTargetイベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
dataFieldnull
itemRenderer編集中のアイテムに対応するアイテムエディタインスタンスです。
localXNaN
reasonnull
rowIndexデータプロバイダのアイテムの 0 から始まるインデックスです。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
TypeDataGridEvent.ITEM_FOCUS_OUT