MultipleTCBTracker.java

/*******************************************************************************
 * Copyright (c) 2004, 2012 BREDEX GmbH.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     BREDEX GmbH - initial API and implementation and/or initial documentation
 *******************************************************************************/
package org.eclipse.jubula.client.ui.rcp.controllers;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.jubula.client.ui.rcp.i18n.Messages;
import org.eclipse.jubula.client.ui.rcp.sourceprovider.ActiveProjectSourceProvider;
import org.eclipse.jubula.client.ui.rcp.views.TestCaseBrowser;

/**
 * @author BREDEX GmbH
 */
public class MultipleTCBTracker {
    /**
     * singleton instance
     */
    private static MultipleTCBTracker instance = null;

    /**
     * the list of open test case browsers
     */
    private List<TestCaseBrowser> m_tcb = 
            new ArrayList<TestCaseBrowser>();

    /**
     * the main test case browser
     */
    private TestCaseBrowser m_mainTCB = null;
    
    /**
     * the source provider
     */
    private ActiveProjectSourceProvider m_provider = null;
    
    /**
     * private Constructor
     */
    private MultipleTCBTracker() {
        // empty
    }

    /**
     * get single instance
     * 
     * @return single instance of ImportFileBP
     */
    public static MultipleTCBTracker getInstance() {
        if (instance == null) {
            instance = new MultipleTCBTracker();
        }
        return instance;
    }

    /**
     * Add a test case browser to this tracker.
     * @param testCaseBrowser The test case browser to add.
     */
    public void addTCB(TestCaseBrowser testCaseBrowser) {
        if (testCaseBrowser != null) {
            m_tcb.add(testCaseBrowser);
            setMainTCB(getOpenTCBs().get(0));
            fireStateChanged();
        }
    }

    /**
     * Remove a test case browser from this tracker.
     * @param testCaseBrowser The test case browser to remove.
     */
    public void removeTCB(TestCaseBrowser testCaseBrowser) {
        m_tcb.remove(testCaseBrowser);
        setMainTCB(
                getOpenTCBs().size() > 0 ? getOpenTCBs().get(0) : null);
        fireStateChanged();
    }

    /**
     * @return the currently open instances of the TCB view
     */
    public List<TestCaseBrowser> getOpenTCBs() {
        List<TestCaseBrowser> tcbs = new ArrayList<TestCaseBrowser>();
        for (TestCaseBrowser tcb : m_tcb) {
            tcbs.add(tcb);
        }
        return tcbs;
    }

    /**
     * @return the currently main TCB or <code>null</code> if there is none
     */
    public TestCaseBrowser getMainTCB() {
        if (m_mainTCB == null) {
            m_mainTCB = getOpenTCBs().size() > 0 ? getOpenTCBs().get(0) : null;
        }
        return m_mainTCB;
    }

    /**
     * @param mainTCB
     *            the mainTCB to set; may be <code>null</code>.
     */
    public void setMainTCB(TestCaseBrowser mainTCB) {
        TestCaseBrowser oldMainTCB = m_mainTCB;
        TestCaseBrowser newMainTCB = mainTCB;

        m_mainTCB = mainTCB;
        
        if (newMainTCB == null) {
            return;
        }

        final String tcbTitle = Messages.TestCaseBrowser;
        final String mainTcbTitle = Messages.TestCaseBrowserMainPrefix
                + tcbTitle;
        
        // reset old name
        if (oldMainTCB != null) {
            oldMainTCB.setViewTitle(tcbTitle);
        }
        
        // set new TCB name
        final int tcbCount = getOpenTCBs().size();
        if (tcbCount == 1) {
            newMainTCB.setViewTitle(tcbTitle);
        } else if (tcbCount > 1) {
            newMainTCB.setViewTitle(mainTcbTitle);
        }
    }
    
    /**
     * fire data changed events
     */
    private void fireStateChanged() {
        if (m_provider != null) {
            m_provider.handleProjectLoaded();
        }
    }
    
    /**
     * @param provider the provider to set
     */
    public void setProvider(ActiveProjectSourceProvider provider) {
        m_provider = provider;
    }

}