/**
 * DialogItem -- An item for a dialog that can have many separate elements.
 * 
 * Copyright (C) 2009-2025, by Joseph A. Huwaldt. All rights reserved.
 * 
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place -
 * Suite 330, Boston, MA 02111-1307, USA. Or visit: http://www.gnu.org/licenses/lgpl.html
 */
package geomss.ui;

import static java.util.Objects.requireNonNull;
import javax.measure.unit.Unit;

/**
 * A container for for items to display in a dialog.
 * 
 * <p> Modified by: Joseph A. Huwaldt </p>
 * 
 * @author Joseph A. Huwaldt, Date: May 5, 2009
 * @version February 22, 2025
 */
public class DialogItem implements Cloneable {

    private String _prefixStr;
    private Object _element;
    private String _suffixStr = null;
    private Unit[] _unitList = null;
    private boolean _fileLoad = true;
    private String _fileExtension = null;

    /**
     * Construct a new and empty DialogItem.
     */
    public DialogItem() {
    }

    /**
     * Construct a new DialogItem with the specified elements.
     *
     * @param prefix The prefix for the dialog to display.
     * @param element The the item to display in the dialog.
     */
    public DialogItem(String prefix, Object element) {
        _prefixStr = requireNonNull(prefix);
        _element = requireNonNull(element);
    }

    /**
     * Construct a new DialogItem with the specified elements.
     *
     * @param prefix The prefix for the item displayed.
     * @param element The item to display in the dialog.
     * @param suffix The suffix for the item displayed.
     */
    public DialogItem(String prefix, Object element, String suffix) {
        _prefixStr = requireNonNull(prefix);
        _element = requireNonNull(element);
        _suffixStr = requireNonNull(suffix);
    }

    /**
     * Construct a new DialogItem with the specified elements.
     *
     * @param prefix The prefix for the item displayed.
     * @param element The item to display in the dialog.
     * @param unitList The list of units to display with the item.
     */
    public DialogItem(String prefix, Object element, Unit[] unitList) {
        _prefixStr = requireNonNull(prefix);
        _element = requireNonNull(element);
        _unitList = requireNonNull(unitList);
    }

    /**
     * Return the prefix String.
     * 
     * @return the prefix
     */
    public String getPrefix() {
        return _prefixStr;
    }

    /**
     * Set the prefix String.
     *
     * @param prefix the prefix to display with the item.
     */
    public void setPrefix(String prefix) {
        _prefixStr = requireNonNull(prefix);
    }

    /**
     * Return the element to be edited.
     *
     * @return the element or item
     */
    public Object getElement() {
        return _element;
    }

    /**
     * Set the element to be edited.
     *
     * @param element the item to display in the dialog.
     */
    public void setElement(Object element) {
        _element = requireNonNull(element);
    }

    /**
     * Return the suffix String.
     *
     * @return the suffix
     */
    public String getSuffix() {
        return _suffixStr;
    }

    /**
     * Set the suffix string.
     *
     * @param suffix the suffix to place after the item in the dialog.
     */
    public void setSuffix(String suffix) {
        _suffixStr = requireNonNull(suffix);
    }

    /**
     * Return the array of units.
     *
     * @return the array of units displayed with the item in the dialog.
     */
    public Unit[] getUnitList() {
        return _unitList;
    }

    /**
     * Set the array of units.
     *
     * @param units the array of units to display with the item.
     */
    public void setUnitList(Unit[] units) {
        _unitList = requireNonNull(units);
    }

    /**
     * Set the file load/save option (if the element is of type File).
     *
     * @param load Set to <code>true</code> to use a "load file" dialog and
     *             <code>false</code> to use a "save file" dialog.
     */
    public void setLoadFile(boolean load) {
        _fileLoad = load;
    }

    /**
     * Returns the load/save option (true to use a load file dialog and false to use a
     * save file dialog).
     * 
     * @return The value true to use a load file dialog and false to use a
     * save file dialog.
     */
    public boolean isLoadFile() {
        return _fileLoad;
    }

    /**
     * Set the file extension to enforce when selecting a file for saving.
     *
     * @param extension The file extension to enforce when selecting a file for saving.
     */
    public void setFileExtension(String extension) {
        _fileExtension = extension;
    }

    /**
     * Returns the file extension requested for saving a file (or null if none has been
     * set).
     * 
     * @return The file extension requested for saving a file or null if none has been set.
     */
    public String getFileExtension() {
        return _fileExtension;
    }

    /**
     * Returns a shallow copy of this DialogItem instance.
     *
     * @return a clone of this DialogItem instance
     */
    @Override
    @SuppressWarnings("CloneDeclaresCloneNotSupported")
    public Object clone() {
        DialogItem result = null;

        try {
            // Make a shallow copy.
            result = (DialogItem)super.clone();

        } catch (Exception e) {
            // Shouldn't happen if this object implements Cloneable.
            e.printStackTrace();
        }

        return result;
    }
}