scaffold.libs_as.feathers.controls.renderers.IListItemRenderer.as Maven / Gradle / Ivy
/*
Feathers
Copyright 2012-2015 Bowler Hat LLC. All Rights Reserved.
This program is free software. You can redistribute and/or modify it in
accordance with the terms of the accompanying license agreement.
*/
package feathers.controls.renderers
{
import feathers.controls.*;
import feathers.core.IToggle;
/**
* Dispatched when the the user taps or clicks the item renderer. The touch
* must remain within the bounds of the item renderer on release to register
* as a tap or a click.
*
* The properties of the event object have the following values:
*
* Property Value bubblesfalse currentTargetThe 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. datanull targetThe 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.
*
* @eventType starling.events.Event.TRIGGERED
*/
[Event(name="triggered",type="starling.events.Event")]
/**
* Interface to implement a renderer for a list item.
*/
public interface IListItemRenderer extends IToggle
{
/**
* An item from the list's data provider. The data may change if this
* item renderer is reused for a new item because it's no longer needed
* for the original item.
*
* This property is set by the list, and should not be set manually.
*/
function get data():Object;
/**
* @private
*/
function set data(value:Object):void;
/**
* The index (numeric position, starting from zero) of the item within
* the list's data provider. Like the data property, this
* value may change if this item renderer is reused by the list for a
* different item.
*
* This property is set by the list, and should not be set manually.
*/
function get index():int;
/**
* @private
*/
function set index(value:int):void;
/**
* The list that contains this item renderer.
*
* This property is set by the list, and should not be set manually.
*/
function get owner():List;
/**
* @private
*/
function set owner(value:List):void;
/**
* The ID of the factory used to create this item renderer.
*
* This property is set by the list, and should not be set manually.
*/
function get factoryID():String;
/**
* @private
*/
function set factoryID(value:String):void;
}
}