001/*
002 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id: JOOoConvertPluginImpl.java 18651 2007-05-13 20:28:53Z sfermigier $
020 */
021
022package org.nuxeo.ecm.platform.picture.web;
023
024import javax.faces.event.ActionEvent;
025
026import org.nuxeo.ecm.core.api.DocumentModel;
027
028/**
029 * Provide SlideShow related actions.
030 *
031 * @author <a href="mailto:[email protected]">Laurent Doguin</a>
032 * @deprecated since 6.0. See NXP-15370.
033 */
034@Deprecated
035public interface SlideShowManager {
036
037    /**
038     * Sets the index.
039     *
040     * @param idx an Integer holding the current document's index.
041     */
042    void setIndex(Integer idx);
043
044    /**
045     * Gets the index.
046     *
047     * @return an Integer holding the current document's index.
048     */
049    Integer getIndex();
050
051    void inputValidation(ActionEvent arg0);
052
053    /**
054     * Reinitializes the values at every changes.
055     *
056     */
057    void resetIndex();
058
059    /**
060     * Increments the index.
061     */
062    void incIndex();
063
064    /**
065     * Decrements the index.
066     */
067    void decIndex();
068
069    /**
070     * Sets the index to 1.
071     */
072    void firstPic();
073
074    /**
075     * Sets the index to the last picture available.
076     */
077    void lastPic();
078
079    /**
080     * Gets the ChildrenSize. The amount of children from the current document.
081     *
082     * @return an Integer holding childrenSize
083     */
084    Integer getChildrenSize();
085
086    /**
087     * Gets the DocumentModel of a child from the index.
088     *
089     * @return a DocumentModel holding the child
090     */
091    DocumentModel getChild();
092
093    /**
094     * Sets the DocumentModel of a child from the index.
095     *
096     * @param child a DocumentModel holding the child
097     */
098    void setChild(DocumentModel child);
099
100}