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.client;
029
030import org.opencms.ui.components.extensions.CmsHistoryExtension;
031import org.opencms.ui.shared.components.CmsHistoryState;
032
033import com.google.gwt.user.client.History;
034import com.vaadin.client.ServerConnector;
035import com.vaadin.client.communication.StateChangeEvent;
036import com.vaadin.client.extensions.AbstractExtensionConnector;
037import com.vaadin.shared.ui.Connect;
038
039/**
040 * The history extension connector.<p>
041 */
042@Connect(CmsHistoryExtension.class)
043public class CmsHistoryConnector extends AbstractExtensionConnector {
044
045    /** Serial version id. */
046    private static final long serialVersionUID = 1172858679530092378L;
047
048    /**
049     * @see com.vaadin.client.ui.AbstractConnector#getState()
050     */
051    @Override
052    public CmsHistoryState getState() {
053
054        return (CmsHistoryState)super.getState();
055
056    }
057
058    /**
059     * @see com.vaadin.client.ui.AbstractConnector#onStateChanged(com.vaadin.client.communication.StateChangeEvent)
060     */
061    @Override
062    public void onStateChanged(StateChangeEvent stateChangeEvent) {
063
064        super.onStateChanged(stateChangeEvent);
065
066        executeHistoryAction();
067    }
068
069    /**
070     * @see com.vaadin.client.extensions.AbstractExtensionConnector#extend(com.vaadin.client.ServerConnector)
071     */
072    @Override
073    protected void extend(ServerConnector target) {
074
075        // nothing to do
076    }
077
078    /**
079     * Executes the history action according to the history state.<p>
080     */
081    private void executeHistoryAction() {
082
083        CmsHistoryState state = getState();
084        if (state.isHistoryBack()) {
085            History.back();
086        } else if (state.isHistoryForward()) {
087            History.forward();
088        }
089    }
090}