javafx/javafx2.project/src/org/netbeans/modules/javafx2/project/ui/RuntimeComboBox.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.netbeans.modules.javafx2.project.ui;

import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemListener;
import java.awt.event.KeyEvent;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.ComboBoxEditor;
import javax.swing.ComboBoxModel;
import javax.swing.DefaultListCellRenderer;
import javax.swing.JComboBox;
import javax.swing.JList;
import javax.swing.JSeparator;
import javax.swing.SwingUtilities;
import javax.swing.event.ListDataEvent;
import javax.swing.event.ListDataListener;
import javax.swing.event.PopupMenuListener;
import org.openide.util.NbBundle;

/**
 *
 * @author Petr Somol, Jarda Bachorik
 */
public class RuntimeComboBox extends javax.swing.JPanel {

    private static final String noneSelectionMessage = NbBundle.getMessage(RuntimeComboBox.class, "MSG_runtime_none"); //NOI18N
    private static final String otherSelectionMessage = NbBundle.getMessage(RuntimeComboBox.class, "MSG_runtime_other"); //NOI18N
    private static final String SEPARATOR = "-----";
    
    /**
     * Creates new form RuntimeComboBox
     */
    public RuntimeComboBox() {
        initComponents();
        combo.setRenderer(new DefaultListCellRenderer(){
            private JSeparator separator;

            {
                separator = new JSeparator(JSeparator.HORIZONTAL);
            }

            @Override
            public Component getListCellRendererComponent(JList list, Object value,
                    int index, boolean isSelected, boolean cellHasFocus) {
                if (SEPARATOR.equals(value)) {
                    return separator;
                }
                
                String s = ""; //NOI18N
                if (value != null) {
                    if (value instanceof Action) {
                        s = (String)((Action)value).getValue(Action.NAME);
                    } else {
                        s = value.toString();
                    }
                } else {
                    s = noneSelectionMessage;
                }
                return super.getListCellRendererComponent(list, s, index, isSelected, cellHasFocus);
            }
        });
        combo.setModel(new RuntimeListModel());
    }

    /**
     * This method is called from within the constructor to initialize the form.
     * WARNING: Do NOT modify this code. The content of this method is always
     * regenerated by the Form Editor.
     */
    @SuppressWarnings("unchecked")
    // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
    private void initComponents() {

        combo = new javax.swing.JComboBox();

        combo.setModel(new javax.swing.DefaultComboBoxModel(new String[] { "Item 1", "Item 2", "Item 3", "Item 4" }));

        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);
        this.setLayout(layout);
        layout.setHorizontalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addComponent(combo, 0, 188, Short.MAX_VALUE)
        );
        layout.setVerticalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addComponent(combo, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
        );
    }// </editor-fold>//GEN-END:initComponents
    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JComboBox combo;
    // End of variables declaration//GEN-END:variables

    //<editor-fold defaultstate="collapsed" desc="Delegating to JComboBox">
    // ### Start ### Delegating to JComboBox
    public void showPopup() {
        combo.showPopup();
    }
    
    public void setSelectedItem(Object anObject) {
        combo.setSelectedItem(anObject);
    }
    
    public void setSelectedIndex(int anIndex) {
        combo.setSelectedIndex(anIndex);
    }
    
    public void setPrototypeDisplayValue(Object prototypeDisplayValue) {
        combo.setPrototypeDisplayValue(prototypeDisplayValue);
    }
    
    public void setPopupVisible(boolean v) {
        combo.setPopupVisible(v);
    }
    
    public void setMaximumRowCount(int count) {
        combo.setMaximumRowCount(count);
    }
    
    public void setLightWeightPopupEnabled(boolean aFlag) {
        combo.setLightWeightPopupEnabled(aFlag);
    }
    
    public void setKeySelectionManager(JComboBox.KeySelectionManager aManager) {
        combo.setKeySelectionManager(aManager);
    }
    
    @Override
    public void setEnabled(boolean b) {
        combo.setEnabled(b);
    }
    
    public void setEditor(ComboBoxEditor anEditor) {
        combo.setEditor(anEditor);
    }
    
    public void setEditable(boolean aFlag) {
        combo.setEditable(aFlag);
    }
    
    public boolean selectWithKeyChar(char keyChar) {
        return combo.selectWithKeyChar(keyChar);
    }
    
    public void removePopupMenuListener(PopupMenuListener l) {
        combo.removePopupMenuListener(l);
    }
    
    public void removeItemListener(ItemListener aListener) {
        combo.removeItemListener(aListener);
    }
    
    public void removeActionListener(ActionListener l) {
        combo.removeActionListener(l);
    }
    
    @Override
    public void processKeyEvent(KeyEvent e) {
        combo.processKeyEvent(e);
    }
    
    public boolean isPopupVisible() {
        return combo.isPopupVisible();
    }
    
    public boolean isLightWeightPopupEnabled() {
        return combo.isLightWeightPopupEnabled();
    }
    
    public boolean isEditable() {
        return combo.isEditable();
    }
    
    public void hidePopup() {
        combo.hidePopup();
    }
    
    public Object[] getSelectedObjects() {
        return combo.getSelectedObjects();
    }
    
    public Object getSelectedItem() {
        return combo.getSelectedItem();
    }
    
    public int getSelectedIndex() {
        return combo.getSelectedIndex();
    }
    
    public Object getPrototypeDisplayValue() {
        return combo.getPrototypeDisplayValue();
    }
    
    public PopupMenuListener[] getPopupMenuListeners() {
        return combo.getPopupMenuListeners();
    }
    
    public int getMaximumRowCount() {
        return combo.getMaximumRowCount();
    }
    
    public JComboBox.KeySelectionManager getKeySelectionManager() {
        return combo.getKeySelectionManager();
    }
    
    public ItemListener[] getItemListeners() {
        return combo.getItemListeners();
    }
    
    public int getItemCount() {
        return combo.getItemCount();
    }
    
    public Object getItemAt(int index) {
        return combo.getItemAt(index);
    }
    
    public void firePopupMenuWillBecomeVisible() {
        combo.firePopupMenuWillBecomeVisible();
    }
    
    public void firePopupMenuWillBecomeInvisible() {
        combo.firePopupMenuWillBecomeInvisible();
    }
    
    public void firePopupMenuCanceled() {
        combo.firePopupMenuCanceled();
    }
    
    public void configureEditor(ComboBoxEditor anEditor, Object anItem) {
        combo.configureEditor(anEditor, anItem);
    }
    
    public void addPopupMenuListener(PopupMenuListener l) {
        combo.addPopupMenuListener(l);
    }
    
    public void addItemListener(ItemListener aListener) {
        combo.addItemListener(aListener);
    }
    
    public void addActionListener(ActionListener l) {
        combo.addActionListener(l);
    }
    
    public void actionPerformed(ActionEvent e) {
        combo.actionPerformed(e);
    }
    
    // ### End ### Delegating to JComboBox
    //</editor-fold>

    public <T> void setModel(RuntimeListModel<T> model) {
        combo.setModel(model);
    }
    
    @SuppressWarnings("unchecked")
    public <T> RuntimeListModel<T> getModel() {
        return (RuntimeListModel<T>)combo.getModel();
    }
    
    public Action getGrowAction() {
        return getModel().getGrowAction();
    }
    
    public void setGrowAction(Action growAction) {
        getModel().setGrowAction(growAction);
    }

    final public static class RuntimeListModel<T> implements ComboBoxModel {

        final private Set<ListDataListener> listeners = new CopyOnWriteArraySet<ListDataListener>();
        final private List<T> predefinedList = new ArrayList<T>();
        final private List<T> userList = new ArrayList<T>();
        
        private T selected = null;
        private Action growAction;

        RuntimeListModel() {
            this.growAction = new AbstractAction(otherSelectionMessage) {
                @Override
                public void actionPerformed(ActionEvent e) {
                }
            };
        }
        
        void setGrowAction(Action ga) {
            this.growAction = ga;
            fireDataChanged();
        }
        
        Action getGrowAction() {
            return this.growAction;
        }
        
        @Override
        public void setSelectedItem(final Object anItem) {
            if (anItem != null) {
                if (anItem.equals(SEPARATOR)) return;
                if (anItem instanceof Action) {
                    SwingUtilities.invokeLater(new Runnable() {
                        @Override
                        public void run() {
                            ((Action)anItem).actionPerformed(new ActionEvent(this, 0, "grow")); //NOI18N
                        }
                    });
                    
                } else {
                    selected = (T)anItem;
                }
            }
        }

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

        @Override
        public int getSize() {
            return getActionPos() + 1;
        }

        @Override
        public Object getElementAt(int index) {
            int sep = getSepPos();            
            if (index < sep) {
                int siz = predefinedList.isEmpty() ? 0 : predefinedList.size();
                if(index < siz) {
                    return predefinedList.get(index);
                } else {
                    return userList.get(index - siz);
                }
            }
            if (index == sep)  return SEPARATOR;
            if (index == getActionPos()) return growAction;
            throw new IndexOutOfBoundsException();
        }

        @Override
        public void addListDataListener(ListDataListener l) {
            listeners.add(l);
        }

        @Override
        public void removeListDataListener(ListDataListener l) {
            listeners.remove(l);
        }

        final public List<T> getPredefined() {
            return Collections.unmodifiableList(predefinedList);
        }
        
        final public List<T> getUserDefined() {
            return Collections.unmodifiableList(userList);
        }
                
        private void fireDataAdded(int start, int stop) {
            if (stop <= start) return;
            for(ListDataListener l : listeners) {
                l.intervalAdded(new ListDataEvent(this, ListDataEvent.INTERVAL_ADDED, start, stop));
            }
        }
        
        private void fireDataRemoved(int start, int stop) {
            for(ListDataListener l : listeners) {
                l.intervalRemoved(new ListDataEvent(this, ListDataEvent.INTERVAL_REMOVED, start, stop));
            }
        }
        
        private void fireDataChanged() {
            int stop = getSize() - 1;
            for(ListDataListener l : listeners) {
                l.contentsChanged(new ListDataEvent(this, ListDataEvent.CONTENTS_CHANGED, 0, stop));
            }
        }
        
        final public void setPredefined(T ... predefined) {
            int stop;
            if(!predefinedList.isEmpty()) {
                stop = predefinedList.size();
                predefinedList.clear();
                fireDataRemoved(0, stop);
            }
            predefinedList.addAll(Arrays.asList(predefined));
            stop = predefinedList.size();
            if (selected == null && !predefinedList.isEmpty()) selected = predefinedList.get(0);
            fireDataAdded(0, stop);
        }
        
        final public void setUserDefined(T ... user) {
            int stop;
            int start = predefinedList.isEmpty() ? 0 : predefinedList.size();
            if(!userList.isEmpty()) {
                stop = userList.size();
                userList.clear();
                fireDataRemoved(start, start + stop);
            }
            userList.addAll(Arrays.asList(user));
            stop = userList.size();
            if (selected == null && !userList.isEmpty()) selected = userList.get(0);
            fireDataAdded(start, start + stop);
        }
        
        final public void addPredefined(T ... predefined) {
            int stop1 = predefinedList.isEmpty() ? 0 : predefinedList.size();
            predefinedList.addAll(Arrays.asList(predefined));
            int stop2 = predefinedList.isEmpty() ? 0 : predefinedList.size();
            if (selected == null && !predefinedList.isEmpty()) selected = predefinedList.get(0);
            fireDataAdded(stop1, stop2);
        }
        
        final public void addUserDefined(T ... userdefined)  {
            int start = predefinedList.isEmpty() ? 0 : predefinedList.size();
            int stop1 = userList.isEmpty() ? 0 : userList.size();
            userList.addAll(Arrays.asList(userdefined));
            int stop2 = userList.isEmpty() ? 0 : userList.size();
            if (selected == null && !userList.isEmpty()) selected = userList.get(0);
            fireDataAdded(start + stop1, start + stop2);
        }
        
        private int getUserListStartPos() {
            return predefinedList.isEmpty() ? 0 : predefinedList.size();
        }
        
        private int getActionPos() {
            return getSepPos() + 1;
        }
        
        private int getSepPos() {
            if (predefinedList.isEmpty() && userList.isEmpty()) return -1;
            if (predefinedList.isEmpty()) return userList.size();
            if (userList.isEmpty()) return predefinedList.size();
            return predefinedList.size() + userList.size();
        }
        
    }
}