JodaBeanSwingUI.java

/*
 *  Copyright 2001-2013 Stephen Colebourne
 *
 *  Licensed 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.joda.beans.ui.swing;

import java.util.Map;

import javax.swing.JPanel;

import org.joda.beans.Bean;
import org.joda.beans.MetaBean;
import org.joda.beans.ui.form.DefaultUIComponentFactory;
import org.joda.beans.ui.form.MetaUIComponent;
import org.joda.beans.ui.form.MetaUIFactory;
import org.joda.beans.ui.form.MetaUIForm;
import org.joda.beans.ui.form.UIComponentFactory;
import org.joda.beans.ui.form.UIForm;
import org.joda.beans.ui.swing.type.EnumSwingUIComponent;
import org.joda.beans.ui.swing.type.StringSwingUIComponent;

/**
 * Entry point factory class capable of creating a Swing UI for a bean.
 */
public class JodaBeanSwingUI {

    /**
     * Creates a form for the specified bean.
     * <p>
     * The bean is examined for meta-data and a form created.
     * 
     * @param bean  the bean to examine, not null
     * @return the created form panel, not null
     */
    public JPanel createForm(final Bean bean) {
        UIForm<JPanel> form = createForm(bean.metaBean());
        form.updateUI(bean);
        return form.getForm();
    }

    /**
     * Creates a form for the specified meta-bean.
     * <p>
     * The bean is examined for meta-data and a form created.
     * 
     * @param metaBean  the meta-bean to examine, not null
     * @return the created form panel, not null
     */
    public UIForm<JPanel> createForm(final MetaBean metaBean) {
        MetaUIForm metaForm = createMetaForm(metaBean);
        selectSwingComponents(metaForm);
        UIForm<JPanel> form = createSwingForm(metaForm);
        return form;
    }

    protected MetaUIForm createMetaForm(MetaBean metaBean) {
        return new MetaUIFactory().createForm(metaBean);
    }

    protected void selectSwingComponents(MetaUIForm form) {
        Map<Class<?>, UIComponentFactory> factories = SwingUISettings.INSTANCE.getFactories();
        for (MetaUIComponent comp : form.getComponents()) {
            UIComponentFactory factory = factories.get(comp.getMetaProperty().propertyType());
            if (factory == null) {
                if (Enum.class.isAssignableFrom(comp.getMetaProperty().propertyType())) {
                    factory = DefaultUIComponentFactory.of(EnumSwingUIComponent.class);
                } else if (SwingUISettings.INSTANCE.getStringConvert().isConvertible(comp.getMetaProperty().propertyType())) {
                    factory = DefaultUIComponentFactory.of(StringSwingUIComponent.class);
                }
            }
            comp.setComponentFactory(factory);
        }
    }

    protected SwingUIForm createSwingForm(MetaUIForm form) {
        return new SwingUIForm(form);
    }

}