scaffold.libs_as.feathers.layout.HorizontalLayoutData.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.layout
{
import starling.events.Event;
import starling.events.EventDispatcher;
/**
* @inheritDoc
*/
[Event(name="change",type="starling.events.Event")]
/**
* Extra, optional data used by an HorizontalLayout instance to
* position and size a display object.
*
* @see HorizontalLayout
* @see ILayoutDisplayObject
*/
public class HorizontalLayoutData extends EventDispatcher implements ILayoutData
{
/**
* Constructor.
*/
public function HorizontalLayoutData(percentWidth:Number = NaN, percentHeight:Number = NaN)
{
this._percentWidth = percentWidth;
this._percentHeight = percentHeight;
}
/**
* @private
*/
protected var _percentWidth:Number;
/**
* The width of the layout object, as a percentage of the container's
* width. The container will calculate the sum of all of its children
* with explicit pixel widths, and then the remaining space will be
* distributed to children with percent widths.
*
* A percentage may be specified in the range from 0
* to 100. If the value is set to NaN, this
* property is ignored. It will also be ignored when the
* useVirtualLayout property of the
* HorizontalLayout is set to false.
*
* @default NaN
*/
public function get percentWidth():Number
{
return this._percentWidth;
}
/**
* @private
*/
public function set percentWidth(value:Number):void
{
if(this._percentWidth == value)
{
return;
}
this._percentWidth = value;
this.dispatchEventWith(Event.CHANGE);
}
/**
* @private
*/
protected var _percentHeight:Number;
/**
* The height of the layout object, as a percentage of the container's
* height.
*
* A percentage may be specified in the range from 0
* to 100. If the value is set to NaN, this
* property is ignored.
*
* Performance tip: If all items in your layout will have 100%
* height, it's better to set the verticalAlign property of
* the HorizontalLayout to
* VerticalAlign.JUSTIFY.
*
* @default NaN
*
* @see feathers.layout.VerticalAlign.JUSTIFY
*/
public function get percentHeight():Number
{
return this._percentHeight;
}
/**
* @private
*/
public function set percentHeight(value:Number):void
{
if(this._percentHeight == value)
{
return;
}
this._percentHeight = value;
this.dispatchEventWith(Event.CHANGE);
}
}
}