package com.showitfast.sites.plugins
{
	import flash.text.StyleSheet;
	
	public interface IPlugin
	{
		//Returns a key value pair object as specified in the Plugin design doc that indicates 
		//what variables and types of parameters can be adjusted on the plugin
		function getParametersDefinition():Object;
		
		//Sets the values that were defined in the builder for each of the variables requested
		//If the variable was set to the default, that key is not passed in
		function setParameters(params:Object):void;
		
		//Sets a reference to the plugin manager
		function setPluginManager(pluginManager:Object):void;
		
		//Sets a list to be used by the plugin
		function setListXML(paramName:String, list:XML):void;
		
		//Sets the StyleSheet used to display this object
		function setStyleSheet(ss:flash.text.StyleSheet):void;
		
		//Deprecated
		//function getNavigatePage():String;
		
		//Called to tell the plugin how many seconds to fade any sound out
		function fadeSoundOut(numSeconds:Number):void;
		
		//Called when the plugin is being displayed on the builder stage
		function builderMode():void;
		
		//If the plugin is on a Preload Layer, this method is called to update the loading progress of the next page
		function setProgress(progress:int):void;
		
		//True if the plugin will dynamically resize based on the area given to it
		function handlesResize():Boolean;
		
		//Called every time the sizing of the plugin changes if the plugin returned true for handlesResize()
		function setDisplaySize(width:Number, height:Number):void;
		
		//Used for linking to a point to start the plugin at
		//Example:  Link to start a gallery on image number 5
		//Order of function calls to plugin will always be: setParameters, startDisplayOn, setListXML
		function startDisplayOn(startNumber:int):void;
		
		// Deprecated
		//function startPlayBack():void

		//Once the swf is loaded, this function is called to check and see if it is ready for display.
		//If the swf needs to load other content before it is ready to display, it can return false
		//And the site will delay display and check back until it returns true
		function isLoaded():Boolean;
		
		function mouseOver():void;
		
		function mouseOut():void;
		
		//Called to clear up any resources before being dereferenced
		function halt():void;
		
		function pageReady():void;
		
		function transitionInStart(time:Number, delay:Number):void
		
		function transitionInComplete():void
		
		function transitionOutStart(time:Number, delay:Number):void
		
		function transitionOutComplete():void
		
		//  Used by channel callers to add/remove listeners.
		function channelAddListener(listener:Object):void
		function channelRemoveListener(listener:Object):void
		
		//  Used by channel listeners to add/remove callers.
		function channelAddCaller(caller:Object):void
		function channelRemoveCaller(caller:Object):void
		
		//  Used by channel callers to receive updates.
		function channelUpdateCaller(data:Object):void
		
		//  Used by channel listeners to receive updates.
		function channelUpdateListener(data:Object):void
	}
}