scaffold.libs_as.feathers.themes.IAsyncTheme.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.themes
{
	import feathers.core.IFeathersEventDispatcher;

	import starling.core.Starling;

	/**
	 * Dispatched when the theme's assets are loaded, and the theme has
	 * initialized. Feathers component cannot be skinned automatically by the
	 * theme until this event is dispatched.
	 *
	 * 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 The Starling instance that
	 *   is associated with the assets that have finished loading.
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.
	 * 
	 * @see #isCompleteForStarling()
	 *
	 * @eventType starling.events.Event.COMPLETE
	 */
	[Event(name="complete",type="starling.events.Event")]

	/**
	 * A theme that uses an asynchronous loading mechanism (such as the Starling
	 * AssetManager), during initialization to load textures and
	 * other assets. This type of theme may not be ready to style components
	 * immediately, and it will dispatch Event.COMPLETE once the
	 * it has fully initialized. Attempting to create Feathers components before
	 * the theme has dispatched Event.COMPLETE may result in no
	 * skins or even runtime errors.
	 */
	public interface IAsyncTheme extends IFeathersEventDispatcher
	{
		/**
		 * Indicates if the assets have been loaded and the theme has been
		 * initialized for a specific Starling instance.
		 * 
		 * @see #event:complete starling.events.Event.COMPLETE
		 */
		function isCompleteForStarling(starling:Starling):Boolean;
	}
}

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`	The `Starling` instance that * is associated with the assets that have finished loading.
`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.