scaffold.libs_as.feathers.controls.renderers.LayoutGroupListItemRenderer.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.LayoutGroup;
import feathers.controls.List;
import feathers.skins.IStyleProvider;
import starling.events.Event;
/**
* Based on LayoutGroup, this component is meant as a base
* class for creating a custom item renderer for a List
* component.
*
* Sub-components may be created and added inside initialize().
* This is a good place to add event listeners and to set the layout.
*
* The data property may be parsed inside commitData().
* Use this function to change properties in your sub-components.
*
* Sub-components may be positioned manually, but a layout may be
* provided as well. An AnchorLayout is recommended for fluid
* layouts that can automatically adjust positions when the list resizes.
* Create AnchorLayoutData objects to define the constraints.
*
* @see feathers.controls.List
*/
public class LayoutGroupListItemRenderer extends LayoutGroup implements IListItemRenderer
{
/**
* The default IStyleProvider for all LayoutGroupListItemRenderer
* components.
*
* @default null
* @see feathers.core.FeathersControl#styleProvider
*/
public static var globalStyleProvider:IStyleProvider;
/**
* Constructor.
*/
public function LayoutGroupListItemRenderer()
{
super();
}
/**
* @private
*/
override protected function get defaultStyleProvider():IStyleProvider
{
return LayoutGroupListItemRenderer.globalStyleProvider;
}
/**
* @private
*/
protected var _index:int = -1;
/**
* @inheritDoc
*/
public function get index():int
{
return this._index;
}
/**
* @private
*/
public function set index(value:int):void
{
this._index = value;
}
/**
* @private
*/
protected var _owner:List;
/**
* @inheritDoc
*/
public function get owner():List
{
return this._owner;
}
/**
* @private
*/
public function set owner(value:List):void
{
if(this._owner == value)
{
return;
}
this._owner = value;
this.invalidate(INVALIDATION_FLAG_DATA);
}
/**
* @private
*/
protected var _data:Object;
/**
* @inheritDoc
*/
public function get data():Object
{
return this._data;
}
/**
* @private
*/
public function set data(value:Object):void
{
if(this._data == value)
{
return;
}
this._data = value;
this.invalidate(INVALIDATION_FLAG_DATA);
//LayoutGroup doesn't know about INVALIDATION_FLAG_DATA, so we need
//set set another flag that it understands.
this.invalidate(INVALIDATION_FLAG_SIZE);
}
/**
* @private
*/
protected var _isSelected:Boolean;
/**
* @inheritDoc
*/
public function get isSelected():Boolean
{
return this._isSelected;
}
/**
* @private
*/
public function set isSelected(value:Boolean):void
{
if(this._isSelected == value)
{
return;
}
this._isSelected = value;
this.invalidate(INVALIDATION_FLAG_SELECTED);
this.dispatchEventWith(Event.CHANGE);
}
/**
* @private
*/
protected var _factoryID:String;
/**
* @inheritDoc
*/
public function get factoryID():String
{
return this._factoryID;
}
/**
* @private
*/
public function set factoryID(value:String):void
{
this._factoryID = value;
}
/**
* @private
*/
override public function dispose():void
{
this.owner = null;
super.dispose();
}
/**
* @private
*/
override protected function draw():void
{
var dataInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_DATA);
var scrollInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SCROLL);
var sizeInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_SIZE);
var layoutInvalid:Boolean = this.isInvalid(INVALIDATION_FLAG_LAYOUT);
if(dataInvalid)
{
this.commitData();
}
if(scrollInvalid || sizeInvalid || layoutInvalid)
{
this._ignoreChildChanges = true;
this.preLayout();
this._ignoreChildChanges = false;
}
super.draw();
if(scrollInvalid || sizeInvalid || layoutInvalid)
{
this._ignoreChildChanges = true;
this.postLayout();
this._ignoreChildChanges = false;
}
}
/**
* Makes final changes to the layout before it updates the item
* renderer's children. If your layout requires changing the
* layoutData property on the item renderer's
* sub-components, override the preLayout() function to
* make those changes.
*
* In subclasses, if you create properties that affect the layout,
* invalidate using INVALIDATION_FLAG_LAYOUT to trigger a
* call to the preLayout() function when the component
* validates.
*
* The final width and height of the item renderer are not yet known
* when this function is called. It is meant mainly for adjusting values
* used by fluid layouts, such as constraints or percentages. If you
* need io access the final width and height of the item renderer,
* override the postLayout() function instead.
*
* @see #postLayout()
*/
protected function preLayout():void
{
}
/**
* Called after the layout updates the item renderer's children. If any
* children are excluded from the layout, you can update them in the
* postLayout() function if you need to use the final width
* and height in any calculations.
*
* In subclasses, if you create properties that affect the layout,
* invalidate using INVALIDATION_FLAG_LAYOUT to trigger a
* call to the postLayout() function when the component
* validates.
*
* To make changes to the layout before it updates the item
* renderer's children, override the preLayout() function
* instead.
*
* @see #preLayout()
*/
protected function postLayout():void
{
}
/**
* Updates the renderer to display the item's data. Override this
* function to pass data to sub-components and react to data changes.
*
* Don't forget to handle the case where the data is null.
*/
protected function commitData():void
{
}
}
}