001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ui.shared.components;
029
030import com.vaadin.shared.AbstractComponentState;
031
032/**
033 * The history state.<p>
034 */
035public class CmsHistoryState extends AbstractComponentState {
036
037    /** The history back flag. */
038    public static final int HISTORY_BACK = 1;
039
040    /** The history forward flag. */
041    public static final int HISTORY_FORWARD = 2;
042
043    /** the serial version id. */
044    private static final long serialVersionUID = -7299145857595566596L;
045
046    /** The history direction. */
047    private int m_historyDirection;
048
049    /**
050     * Returns the history direction.<p>
051     *
052     * @return the history direction
053     */
054    public int getHistoryDirection() {
055
056        return m_historyDirection;
057    }
058
059    /**
060     * Returns if the history direction is back.<p>
061     *
062     * @return <code>true</code> if the history direction is back
063     */
064    public boolean isHistoryBack() {
065
066        return m_historyDirection == HISTORY_BACK;
067    }
068
069    /**
070     * Returns if the history direction is forward.<p>
071     *
072     * @return <code>true</code> if the history direction is forward
073     */
074    public boolean isHistoryForward() {
075
076        return m_historyDirection == HISTORY_FORWARD;
077    }
078
079    /**
080     * Sets the history direction.<p>
081     * Use -1 for history back, and +1 for history forward.<p>
082     *
083     * @param direction the history direction
084     */
085    public void setHistoryDirection(int direction) {
086
087        m_historyDirection = direction;
088    }
089}