001/**
002 * Get more info at : www.jrebirth.org .
003 * Copyright JRebirth.org © 2011-2013
004 * Contact : sebastien.bordes@jrebirth.org
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.jrebirth.af.presentation.ui.base;
019
020import javafx.animation.Animation;
021
022import org.jrebirth.af.api.ui.Model;
023import org.jrebirth.af.presentation.ui.base.AbstractSlideModel.SlideFlow;
024
025/**
026 * The class <strong>SlideModel</strong>.
027 *
028 * @author Sébastien Bordes
029 *
030 * @param <S> The SlideStep to use
031 */
032public interface SlideModel<S extends SlideStep> extends Model {
033
034    /**
035     * @param slideNumber The slideNumber to set.
036     */
037    void setSlideNumber(final int slideNumber);
038
039    /**
040     * Show the step.
041     *
042     * @param slideStep the step to show
043     */
044    void showSlideStep(final S slideStep);
045
046    /**
047     * @param currentFlow The currentFlow to set.
048     */
049    void setCurrentFlow(final SlideFlow currentFlow);
050
051    /**
052     * Check if the next step is available.
053     *
054     * @return true if no more steps are available
055     */
056    boolean nextStep();
057
058    /**
059     * Check if the previous step is available.
060     *
061     * @return true if no more steps are available
062     */
063    boolean previousStep();
064
065    /**
066     * Get the hide animation.
067     *
068     * @return the hide animation
069     */
070    Animation getHideAnimation();
071
072    /**
073     * Get the show animation.
074     *
075     * @return the show animation
076     */
077    Animation getShowAnimation();
078}