scaffold.libs_as.feathers.core.IFeathersControl.as Maven / Gradle / Ivy

Go to download

/*
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.core
{
	import feathers.skins.IStyleProvider;

	import flash.geom.Rectangle;

	/**
	 * Dispatched after the control has been initialized, but before it has
	 * drawn for the first time. Typically, the component's children will have
	 * been created by this point.
	 *
	 * The properties of the event object have the following values:
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Property Value
bubbles false
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.
data null
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.
	 *
	 * @eventType feathers.events.FeathersEventType.INITIALIZE
	 */
	[Event(name="initialize",type="starling.events.Event")]

	/**
	 * Dispatched after the component has validated for the first time. Both
	 * initialize() and draw() will have been called,
	 * and all children will have been created.
	 *
	 * The properties of the event object have the following values:
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Property Value
bubbles false
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.
data null
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.
	 *
	 * @eventType feathers.events.FeathersEventType.CREATION_COMPLETE
	 */
	[Event(name="creationComplete",type="starling.events.Event")]

	/**
	 * Dispatched when the width or height of the control changes.
	 *
	 * The properties of the event object have the following values:
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Property Value
bubbles false
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.
data null
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.
	 *
	 * @eventType feathers.events.FeathersEventType.RESIZE
	 */
	[Event(name="resize",type="starling.events.Event")]

	/**
	 * Basic interface for Feathers UI controls. A Feathers control must also
	 * be a Starling display object.
	 */
	public interface IFeathersControl extends IValidating, IMeasureDisplayObject
	{
		/**
		 * @copy feathers.core.FeathersControl#maxWidth
		 */
		function get maxWidth():Number;

		/**
		 * @private
		 */
		function set maxWidth(value:Number):void;

		/**
		 * @copy feathers.core.FeathersControl#maxHeight
		 */
		function get maxHeight():Number;

		/**
		 * @private
		 */
		function set maxHeight(value:Number):void;
		
		/**
		 * @copy feathers.core.FeathersControl#isEnabled
		 */
		function get isEnabled():Boolean;

		/**
		 * @private
		 */
		function set isEnabled(value:Boolean):void;

		/**
		 * @copy feathers.core.FeathersControl#isInitialized
		 */
		function get isInitialized():Boolean;

		/**
		 * @copy feathers.core.FeathersControl#isCreated
		 */
		function get isCreated():Boolean;

		/**
		 * @copy feathers.core.FeathersControl#styleNameList
		 */
		function get styleNameList():TokenList;

		/**
		 * @copy feathers.core.FeathersControl#styleName
		 */
		function get styleName():String;

		/**
		 * @private
		 */
		function set styleName(value:String):void

		/**
		 * @copy feathers.core.FeathersControl#styleProvider
		 */
		function get styleProvider():IStyleProvider;

		/**
		 * @private
		 */
		function set styleProvider(value:IStyleProvider):void

		/**
		 * @copy feathers.core.FeathersControl#toolTip
		 */
		function get toolTip():String;

		/**
		 * @private
		 */
		function set toolTip(value:String):void

		/**
		 * @copy feathers.core.FeathersControl#setSize()
		 */
		function setSize(width:Number, height:Number):void;

		/**
		 * @copy feathers.core.FeathersControl#move()
		 */
		function move(x:Number, y:Number):void;

		/**
		 * @copy feathers.core.FeathersControl#resetStyleProvider()
		 */
		function resetStyleProvider():void;
	}
}

Property	Value
`bubbles`	false
`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`.
`data`	null
`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.

Property	Value
`bubbles`	false
`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`.
`data`	null
`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.

Property	Value
`bubbles`	false
`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`.
`data`	null
`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.