client.history.SeriesPanelHistory.java Source code

Introduction

Here is the source code for client.history.SeriesPanelHistory.java

Source

/*
 * WBI Indicator Explorer
 *
 * Copyright 2015 Sebastian Nogara <snogaraleal@gmail.com>
 *
 * This file is part of WBI.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package client.history;

import com.google.gwt.event.logical.shared.SelectionEvent;
import com.google.gwt.event.logical.shared.SelectionHandler;
import com.google.gwt.event.shared.HandlerRegistration;

import client.managers.history.HistoryManager;
import client.managers.history.HistoryState;
import client.ui.coordinators.TabCoordinator;

/**
 * {@link HistoryManager.Listener} in charge of updating a
 * {@link TabCoordinator} according to the tab name specified in the
 * current {@link HistoryState}.
 */
public class SeriesPanelHistory extends HistoryManager.BaseHistory implements SelectionHandler<Integer> {

    /**
     * Currently attached {@code TabCoordinator}.
     */
    private TabCoordinator<?> coordinator;

    /**
     * {@code HandlerRegistration} obtained from registering a
     * {@code SelectionHandler} in the {@code TabLayoutPanel} underlying the
     * attached {@code TabCoordinator}.
     */
    private HandlerRegistration handlerRegistration;

    public SeriesPanelHistory() {
    }

    /**
     * Attach a {@link TabCoordinator}.
     *
     * @param coordinator Coordinator to attach.
     */
    public void connect(TabCoordinator<?> coordinator) {
        assert this.coordinator == null;

        this.coordinator = coordinator;
        this.handlerRegistration = coordinator.getPanel().addSelectionHandler(this);

        HistoryManager.get().addListener(this);
    }

    /**
     * Detach the currently attached {@link TabCoordinator}.
     */
    public void disconnect() {
        assert this.coordinator != null;

        this.handlerRegistration.removeHandler();
        this.coordinator = null;

        HistoryManager.get().removeListener(this);
    }

    /**
     * Handle a {@code HistoryState} change.
     */
    @Override
    public void onChange(HistoryState state) {
        /*
         * Switch to the tab specified in the current {@code HistoryState}.
         */
        coordinator.selectTab(state.getSeriesTabName());
    }

    /**
     * Handle tab selection.
     */
    @Override
    public void onSelection(SelectionEvent<Integer> event) {
        String tabName = coordinator.getTabName(event.getSelectedItem());

        if (tabName != null) {
            HistoryState state = historyManager.getCurrentState();

            /*
             * Update the current {@code HistoryState} with the name of the
             * selected tab.
             */
            state.setSeriesTabName(tabName);
            historyManager.setState(state);
        }
    }
}