/*
 * ------------------------------------------------------------------------
 *
 *  Copyright (C) 2003 - 2013
 *  University of Konstanz, Germany and
 *  KNIME GmbH, Konstanz, Germany
 *  Website: http://www.knime.org; Email: contact@knime.org
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  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>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME GMBH herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * --------------------------------------------------------------------- *
 *
 */
package org.knime.knip.base.node;

import net.imglib2.type.numeric.RealType;

import org.knime.knip.base.data.img.ImgPlusValue;
import org.knime.knip.base.node.dialog.DialogComponentDimSelection;
import org.knime.knip.base.node.nodesettings.SettingsModelDimSelection;

/**
 * {@link ImgPlusToImgPlusNodeDialog} for {@link ImgPlusToImgPlusNodeModel} providing
 * {@link DialogComponentDimSelection}
 *
 * @author <a href="mailto:dietzc85@googlemail.com">Christian Dietz</a>
 * @author <a href="mailto:horn_martin@gmx.de">Martin Horn</a>
 *
 * @param <T>
 */
public abstract class ImgPlusToImgPlusNodeDialog<T extends RealType<T>> extends ValueToCellNodeDialog<ImgPlusValue<T>> {

    /**
     * {@link SettingsModelDimSelection} to store dimension selection
     */
    protected SettingsModelDimSelection m_dimSelectionModel;

    /**
     * Dialog for {@link ImgPlusToImgPlusNodeModel} which provides a {@link DialogComponentDimSelection}
     *
     * @param minDims Minimum number of selected dimensions in {@link DialogComponentDimSelection}
     * @param maxDims Maximum number of selected dimensions in {@link DialogComponentDimSelection}#
     * @param axes default selected axes
     */
    public ImgPlusToImgPlusNodeDialog(final int minDims, final int maxDims, final String... axes) {
        super(true);
        m_dimSelectionModel = ImgPlusToImgPlusNodeModel.createDimSelectionModel(axes);

        addDialogComponents();
        addDialogComponent("Options", "Dimension Selection", new DialogComponentDimSelection(m_dimSelectionModel, "",
                minDims, maxDims));

        buildDialog();
    }

    /**
     * Dialog for {@link ImgPlusToImgPlusNodeModel} which provides a {@link DialogComponentDimSelection}
     *
     * Deprecation: SettingsModel shouldn't be passed.
     *
     * @param model SettingsModel for the dimension selection (deprecated)
     * @param minDims Minimum number of selected dimensions in {@link DialogComponentDimSelection}
     * @param maxDims Maximum number of selected dimensions in {@link DialogComponentDimSelection}
     */
    @Deprecated
    public ImgPlusToImgPlusNodeDialog(final SettingsModelDimSelection model, final int minDims, final int maxDims) {
        super(true);
        m_dimSelectionModel = model;

        addDialogComponents();
        addDialogComponent("Options", "Dimension Selection", new DialogComponentDimSelection(m_dimSelectionModel, "",
                minDims, maxDims));

        buildDialog();
    }

    /**
     * This method can be called after everything is initialized
     */
    protected void initDialog() {
        // nothing to do here
    }

}