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.components.extensions;
029
030import org.opencms.ui.shared.components.CmsHistoryState;
031
032import com.vaadin.server.AbstractExtension;
033import com.vaadin.ui.UI;
034
035/**
036 * Extension to allow clientside history back and forward.<p>
037 */
038public class CmsHistoryExtension extends AbstractExtension {
039
040    /** The serial version id. */
041    private static final long serialVersionUID = -1461819527273730247L;
042
043    /**
044     * Constructor.<p>
045     *
046     * @param ui the UI to extend
047     */
048    public CmsHistoryExtension(UI ui) {
049        extend(ui);
050    }
051
052    /**
053     * Triggers a history back.<p>
054     */
055    public void historyBack() {
056
057        getState().setHistoryDirection(CmsHistoryState.HISTORY_BACK);
058    }
059
060    /**
061     * Triggers a history forward.<p>
062     */
063    public void historyForward() {
064
065        getState().setHistoryDirection(CmsHistoryState.HISTORY_FORWARD);
066    }
067
068    /**
069     * @see com.vaadin.server.AbstractClientConnector#getState()
070     */
071    @Override
072    protected CmsHistoryState getState() {
073
074        return (CmsHistoryState)super.getState();
075    }
076}