com.alee.laf.combobox.WebComboBoxModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
The newest version!
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.laf.combobox;

import com.alee.laf.list.WebListModel;
import com.alee.utils.CollectionUtils;

import javax.swing.*;
import java.util.ArrayList;
import java.util.Collection;

/**
 * Custom {@link JComboBox} model with generic element type.
 * Unlike {@link DefaultComboBoxModel} it will not reuse any of the provided arrays or {@link Collection}s.
 * Model should have its own data enclosed in itself in the first place, if you want to have control over it - override the model itself.
 * Also this model is based on {@link WebListModel} and overrides its methods to properly handle {@link #selected} element.
 *
 * @param  element type
 * @author Mikle Garin
 */
public class WebComboBoxModel extends WebListModel implements MutableComboBoxModel
{
    /**
     * Currently selected element.
     */
    @SuppressWarnings ( "NonSerializableFieldInSerializableClass" )
    protected T selected;

    /**
     * Constructs empty {@link WebComboBoxModel}.
     */
    public WebComboBoxModel ()
    {
        this ( new ArrayList ( 0 ) );
    }

    /**
     * Constructs new {@link WebComboBoxModel}.
     *
     * @param elements combobox elements
     */
    public WebComboBoxModel ( final T... elements )
    {
        this ( CollectionUtils.asList ( elements ) );
    }

    /**
     * Constructs new {@link WebComboBoxModel}.
     *
     * @param elements combobox elements
     */
    public WebComboBoxModel ( final Collection elements )
    {
        super ( elements );
        this.selected = getSize () > 0 ? getElementAt ( 0 ) : null;
    }

    @Override
    public void addElement ( final Object element )
    {
        add ( ( T ) element );
    }

    @Override
    public void insertElementAt ( final Object element, final int index )
    {
        add ( index, ( T ) element );
    }

    @Override
    public void removeElement ( final Object element )
    {
        remove ( ( T ) element );
    }

    @Override
    public void removeElementAt ( final int index )
    {
        remove ( index );
    }

    @Override
    public T getSelectedItem ()
    {
        return selected;
    }

    @Override
    public void setSelectedItem ( final Object element )
    {
        if ( selected != null && !selected.equals ( element ) || selected == null && element != null )
        {
            selected = ( T ) element;
            fireContentsChanged ( this, -1, -1 );
        }
    }

    @Override
    public T get ( final int index )
    {
        return index >= 0 && index < delegate.size () ? super.get ( index ) : null;
    }

    @Override
    public void addAll ( final int index, final Collection elements )
    {
        super.addAll ( index, elements );
        if ( size () == 1 && selected == null && CollectionUtils.notEmpty ( elements ) )
        {
            setSelectedItem ( elements.iterator ().next () );
        }
    }

    @Override
    public T set ( final int index, final T element )
    {
        final int selectedIndex = indexOf ( selected );
        if ( selectedIndex == index )
        {
            setSelectedItem ( element );
        }
        return super.set ( index, element );
    }

    @Override
    public void removeInterval ( final int start, final int end )
    {
        final int selectedIndex = indexOf ( selected );
        if ( start <= selectedIndex && selectedIndex <= end )
        {
            final int index = end < delegate.size () - 1 ? end + 1 : start > 0 ? start - 1 : -1;
            setSelectedItem ( index != -1 ? get ( index ) : null );
        }
        super.removeInterval ( start, end );
    }
}