001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Nuxeo - initial API and implementation
016 *
017 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
018 */
019
020package org.nuxeo.ecm.platform.picture.web;
021
022import javax.faces.event.ActionEvent;
023
024import org.nuxeo.ecm.core.api.DocumentModel;
025
026/**
027 * Provide SlideShow related actions.
028 *
029 * @author <a href="mailto:ldoguin@nuxeo.com">Laurent Doguin</a>
030 * @deprecated since 6.0. See NXP-15370.
031 */
032@Deprecated
033public interface SlideShowManager {
034
035    /**
036     * Sets the index.
037     *
038     * @param idx an Integer holding the current document's index.
039     */
040    void setIndex(Integer idx);
041
042    /**
043     * Gets the index.
044     *
045     * @return an Integer holding the current document's index.
046     */
047    Integer getIndex();
048
049    void inputValidation(ActionEvent arg0);
050
051    /**
052     * Reinitializes the values at every changes.
053     *
054     */
055    void resetIndex();
056
057    /**
058     * Increments the index.
059     */
060    void incIndex();
061
062    /**
063     * Decrements the index.
064     */
065    void decIndex();
066
067    /**
068     * Sets the index to 1.
069     */
070    void firstPic();
071
072    /**
073     * Sets the index to the last picture available.
074     */
075    void lastPic();
076
077    /**
078     * Gets the ChildrenSize. The amount of children from the current document.
079     *
080     * @return an Integer holding childrenSize
081     */
082    Integer getChildrenSize();
083
084    /**
085     * Gets the DocumentModel of a child from the index.
086     *
087     * @return a DocumentModel holding the child
088     */
089    DocumentModel getChild();
090
091    /**
092     * Sets the DocumentModel of a child from the index.
093     *
094     * @param child a DocumentModel holding the child
095     */
096    void setChild(DocumentModel child);
097
098}