scaffold.libs_as.feathers.controls.renderers.IGroupedListHeaderRenderer.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.GroupedList;
import feathers.core.IFeathersControl;
/**
* Interface to implement a renderer for a grouped list header.
*
* @see feathers.controls.GroupedList
*/
public interface IGroupedListHeaderRenderer extends IFeathersControl
{
/**
* Data for a header renderer from the grouped list's data provider.
* A header renderer should be designed with the assumption that its
* data will change as the list scrolls.
*
* This property is set automatically by the list, and it should not
* be set manually.
*/
function get data():Object;
/**
* @private
*/
function set data(value:Object):void;
/**
* The index of the group within the data provider of the grouped list.
*
* This property is set automatically by the list, and it should not
* be set manually.
*/
function get groupIndex():int;
/**
* @private
*/
function set groupIndex(value:int):void;
/**
* The index of this display object within the layout.
*
* This property is set automatically by the list, and it should not
* be set manually.
*/
function get layoutIndex():int;
/**
* @private
*/
function set layoutIndex(value:int):void;
/**
* The grouped list that contains this header renderer.
*
* This property is set automatically by the list, and it should not
* be set manually.
*/
function get owner():GroupedList;
/**
* @private
*/
function set owner(value:GroupedList):void;
/**
* The ID of the factory used to create this header 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;
}
}