ChooseTestCasePage.java

/*******************************************************************************
 * Copyright (c) 2004, 2010 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.wizards.refactor.pages;

import java.util.Set;

import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.wizard.WizardPage;
import org.eclipse.jubula.client.core.model.INodePO;
import org.eclipse.jubula.client.core.model.ISpecTestCasePO;
import org.eclipse.jubula.client.ui.constants.ContextHelpIds;
import org.eclipse.jubula.client.ui.rcp.i18n.Messages;
import org.eclipse.jubula.client.ui.rcp.widgets.TestCaseTreeComposite;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.PlatformUI;

/**
 * @author Markus Tiede
 * @created Jul 25, 2011
 */
public class ChooseTestCasePage extends WizardPage {

    /** The help context ID for this page. */
    private String m_contextHelpId;

    /**
     * <code>m_parentTestCase</code>
     */
    private INodePO m_parentTestCase;

    /**
     * <code>m_parentTestCases</code>
     */
    private Set<INodePO> m_setOfParentTestCases;
    
    /**
     * <code>m_choosenTestCase</code>
     */
    private ISpecTestCasePO m_choosenTestCase = null;

    /**
     * The default context help ID is
     * {@link ContextHelpIds#REFACTOR_REPLACE_CHOOSE_TEST_CASE_WIZARD_PAGE}.
     * @param pageId
     *            the page id
     * @param parentTestCase
     *            the parent test case
     */
    public ChooseTestCasePage(INodePO parentTestCase, String pageId) {
        super(pageId, Messages.ReplaceTCRWizard_choosePage_title, null);
        m_parentTestCase = parentTestCase;
        setPageComplete(false);
        m_contextHelpId =
                ContextHelpIds.REFACTOR_REPLACE_CHOOSE_TEST_CASE_WIZARD_PAGE;
    }
    
    /**
     * @param pageId
     *            the page id
     * @param parentTestCases
     *            the parent test cases
     */
    public ChooseTestCasePage(Set<INodePO> parentTestCases, String pageId) {
        super(pageId, Messages.ReplaceTCRWizard_choosePage_title, null);
        m_setOfParentTestCases = parentTestCases;
        setPageComplete(false);
    }

    /**
     * Override the default context help ID.
     * @param contextHelpId The help context ID for this wizard page.
     * @see #ChooseTestCasePage(INodePO, String)
     */
    public void setContextHelpId(String contextHelpId) {
        m_contextHelpId = contextHelpId;
    }

    /**
     * {@inheritDoc}
     */
    public void createControl(Composite parent) {
        final TestCaseTreeComposite tctc;
        if (m_parentTestCase != null) {
            tctc = new TestCaseTreeComposite(parent,
                    SWT.SINGLE, m_parentTestCase);
        } else {
            tctc = new TestCaseTreeComposite(parent,
                    SWT.SINGLE, m_setOfParentTestCases);
        }
        tctc.getTreeViewer().addSelectionChangedListener(
                new ISelectionChangedListener() {
                    public void selectionChanged(SelectionChangedEvent event) {
                        boolean pageComplete = false;
                        ISpecTestCasePO specTC = null;
                        if (tctc.hasValidSelection()) {
                            IStructuredSelection selection = 
                                (IStructuredSelection)event.getSelection();
                            pageComplete = true;
                            specTC = (ISpecTestCasePO)selection
                                    .getFirstElement();
                            if (specTC == null) {
                                pageComplete = false;
                            }
                        }
                        setChoosenTestCase(specTC);
                        setPageComplete(pageComplete);
                    }
                });
        setControl(tctc);
    }
    
    /**
     * {@inheritDoc}
     */
    public void performHelp() {
        PlatformUI.getWorkbench().getHelpSystem().displayHelp(
            m_contextHelpId);
    }

    /**
     * @param choosenTestCase the choosenTestCase to set
     */
    private void setChoosenTestCase(ISpecTestCasePO choosenTestCase) {
        m_choosenTestCase = choosenTestCase;
    }

    /**
     * @return the choosenTestCase
     */
    public ISpecTestCasePO getChoosenTestCase() {
        return m_choosenTestCase;
    }
}