com.anrisoftware.prefdialog.miscswing.comboboxhistory.HistoryComboBoxModelFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of prefdialog-misc-swing Show documentation

Miscellaneous swing components.

The newest version!

/*
 * Copyright 2013-2016 Erwin Müller 
 *
 * This file is part of prefdialog-misc-swing.
 *
 * prefdialog-misc-swing 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 3 of the License, or (at your
 * option) any later version.
 *
 * prefdialog-misc-swing 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 Lesser General Public License
 * along with prefdialog-misc-swing. If not, see .
 */
package com.anrisoftware.prefdialog.miscswing.comboboxhistory;

import java.util.Collection;

import javax.swing.MutableComboBoxModel;

/**
 * Factory to decorate a model as the history combo box model.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface HistoryComboBoxModelFactory {

    /**
     * Decorate a model as the history combo box model.
     *
     * @param model
     *            the parent {@link MutableComboBoxModel}.
     *
     * @param defaultItems
     *            {@link Collection} of default items for the model. The default
     *            items can not be removed.
     *
     * @return the {@link HistoryComboBoxModel}
     */
    @SuppressWarnings("rawtypes")
    HistoryComboBoxModel create(MutableComboBoxModel model,
            Collection defaultItems);
}