////////////////////////////////////////////////////////////////////////////////
//  
//  Copyright (c) 2008 Gabriel Montagné Láscaris-Comneno and Alberto
//  Brealey-Guzmán.
//  
//  Permission is hereby granted, free of charge, to any person obtaining a
//  copy of this software and associated documentation files (the "Software"),
//  to deal in the Software without restriction, including without limitation
//  the rights to use, copy, modify, merge, publish, distribute, sublicense,
//  and/or sell copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following conditions:
//  
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//  
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//  DEALINGS IN THE SOFTWARE.
//  
////////////////////////////////////////////////////////////////////////////////

package com.rojored.view.controls.carouselClasses 
{

/**
 *  Basic contract that all Positions Mangers should implement.
 *  
 *  @author Gabriel Montagné Láscaris-Comneno gabriel@rojored.com 
 *  @version $Id$
 */
public interface IPositionManager 
{
    
    //--------------------------------------------------------------------------
    //
    //  Properties
    //
    //--------------------------------------------------------------------------

    //--------------------------------------
    //  offscreenPositionNext  
    //--------------------------------------

    /**
     * Offscreen position to which the carousel renderer on the last position
     * will go to if the carousel went <code>next</code>
     */
    function get offscreenPositionNext():IPosition;

    //--------------------------------------
    //  offscreenPositionPrevious  
    //--------------------------------------

    /**
     * Offscreen position to which the carousel renderer on the first position
     * will go to if the carousel went <code>previous</code>
     */
    function get offscreenPositionPrevious():IPosition;

    //--------------------------------------
    //  originPosition  
    //--------------------------------------

    /**
     * Position at which the carousel renderers are first placed.
     */
    function get originPosition():IPosition;

    //--------------------------------------
    //  totalPositionCount  
    //--------------------------------------

    /**
     * The amount of positions for this position manager.
     */
    function get totalPositionCount():int;

    //--------------------------------------------------------------------------
    //
    //  Methods
    //
    //--------------------------------------------------------------------------

    /** 
     * Returns the cached or calculated position for a position index.
     */
    function getPositionAtIndex(index:int):IPosition;

}
}