////////////////////////////////////////////////////////////////////////////////
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////
package spark.automation.events
{
import flash.events.Event;
import spark.components.IItemRenderer;
/**
* The SparkListItemSelectEvent class represents event objects that are dispatched
* when an item in a list-based control such as a Menu,
* DataGrid, or Tree control is selected or deselected.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public class SparkListItemSelectEvent extends Event
{
include "../../core/Version.as";
//--------------------------------------------------------------------------
//
// Class constants
//
//--------------------------------------------------------------------------
/**
* The SparkListItemSelectEvent.SELECT
constant defines the value of the
* type
property of the event object for an event that is
* dispatched when a single item is selected.
*
*
The properties of the event object have the following values. * Not all properties are meaningful for all kinds of events. * See the detailed property descriptions for more information.
*Property | Value |
---|---|
altKey | Boolean value indicating whether * the Alt key was pressed at the time of the event. |
bubbles | false |
cancelable | false |
ctrlKey | Boolean value indicating whether * the Ctrl key was pressed at the time of the event. |
currentTarget | The Object that defines the
* event listener that handles the event. For example, if you use
* myButton.addEventListener() to register an event listener,
* myButton is the value of the currentTarget . |
itemRenderer | The item renderer object * for the item. |
shiftKey | Boolean value indicating whether * the Shift key was pressed at the time of the event. |
target | The 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. |
triggerEvent | The event, such as a * mouse or keyboard event, that triggered the action. |
type | SparkListItemSelectEvent.SELECT |
SparkListItemSelectEvent.SELECT_INDEX
constant defines the value of the
* type
property of the event object for an event that is
* dispatched when an item's index is selected.
*
* The properties of the event object have the following values. * Not all properties are meaningful for all kinds of events. * See the detailed property descriptions for more information.
*Property | Value |
---|---|
altKey | Boolean value indicating whether * the Alt key was pressed at the time of the event. |
bubbles | false |
cancelable | false |
ctrlKey | Boolean value indicating whether * the Ctrl key was pressed at the time of the event. |
currentTarget | The Object that defines the
* event listener that handles the event. For example, if you use
* myButton.addEventListener() to register an event listener,
* myButton is the value of the currentTarget . |
itemIndex | The data provider index of * the item to be selected. |
shiftKey | Boolean value indicating whether * the Shift key was pressed at the time of the event. |
target | The 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. |
triggerEvent | The event, such as a * mouse or keyboard event, that triggered the action. |
type | SparkListItemSelectEvent.SELECT_INDEX |
true
,
* or not, false
.
*
* @default false
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public var altKey:Boolean;
//----------------------------------
// ctrlKey
//----------------------------------
/**
* Indicates whether the Ctrl key was pressed at the time of the event, true
,
* or not, false
.
*
* @default false
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public var ctrlKey:Boolean;
//----------------------------------
// triggerEvent
//----------------------------------
/**
* Event that triggered the item selection event,
* such as a keyboard or mouse event.
*
* @default null
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public var triggerEvent:Event;
//----------------------------------
// itemRenderer
//----------------------------------
/**
* Item renderer object for the item being selected or deselected.
* You can access the cell data using this property.
*
* @default null
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public var itemRenderer:IItemRenderer;
//----------------------------------
// shiftKey
//----------------------------------
/**
* Indicates whether the Shift key was pressed at the time of the event, true
,
* or not, false
.
*
* @default false
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public var shiftKey:Boolean;
/**
* The automationValue string of the item to be selected.
* This is used when the item to be selected is not visible in the control.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public var itemAutomationValue:String;
/**
* The data provider index of the item to be selected.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.5
* @productversion Flex 4
*/
public var itemIndex:uint;
//--------------------------------------------------------------------------
//
// Overridden methods: Event
//
//--------------------------------------------------------------------------
/**
* @private
*/
override public function clone():Event
{
return new SparkListItemSelectEvent(type, bubbles, cancelable,
itemRenderer, triggerEvent,
ctrlKey, altKey, shiftKey);
}
}
}