All Downloads are FREE. Search and download functionalities are using the official Maven repository.

fr.ird.observe.client.util.comment.JComment Maven / Gradle / Ivy

package fr.ird.observe.client.util.comment;

/*-
 * #%L
 * ObServe Toolkit :: Common Client
 * %%
 * Copyright (C) 2008 - 2017 IRD, Ultreia.io
 * %%
 * This program 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.
 * 
 * This program 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 this program.  If not, see
 * .
 * #L%
 */

import fr.ird.observe.dto.WithComment;
import java.awt.BorderLayout;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.LayoutManager;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.JToolBar;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuiton.jaxx.runtime.JAXXBinding;
import org.nuiton.jaxx.runtime.JAXXContext;
import org.nuiton.jaxx.runtime.JAXXObject;
import org.nuiton.jaxx.runtime.JAXXObjectDescriptor;
import org.nuiton.jaxx.runtime.JAXXUtil;
import org.nuiton.jaxx.runtime.binding.DefaultJAXXBinding;
import org.nuiton.jaxx.runtime.binding.SimpleJAXXObjectBinding;
import org.nuiton.jaxx.runtime.context.DefaultJAXXContext;
import org.nuiton.jaxx.runtime.swing.SwingUtil;
import static org.nuiton.i18n.I18n.t;
import static org.nuiton.jaxx.runtime.swing.SwingUtil.getStringValue;

public class JComment extends JPanel implements JAXXObject {

    /*-----------------------------------------------------------------------*/
    /*---------------- Constants for all javaBean properties ----------------*/
    /*-----------------------------------------------------------------------*/

    public static final String PROPERTY_MODEL = "model";
    public static final String PROPERTY_TITLE = "title";

    /*-----------------------------------------------------------------------*/
    /*------------------ Constants for all public bindings ------------------*/
    /*-----------------------------------------------------------------------*/

    public static final String BINDING_COMMENT2_TEXT = "comment2.text";
    public static final String BINDING_TITLE_LABEL_TEXT = "titleLabel.text";

    /*-----------------------------------------------------------------------*/
    /*------------------------- Other static fields -------------------------*/
    /*-----------------------------------------------------------------------*/

    private static final String $jaxxObjectDescriptor = "H4sIAAAAAAAAANVYW28TRxQem9jBjgnXUqAVhJBCIsoaBwoVIEoSJ2DXuYiYi8hDOt4dOwPjnWV2Fjuy4KEPfesf6ENf+1LxH1CfKvWlr/yHSvyEntm1d+1kbW9apLSWvLJnz3znO2fOZWZ+/QslbIG+5KKmmQ6V3NSe42ZTE44paZ1oxbmnT1crz4ku88TWBbUkF8j7xOIovoHGDH/clkjbKAFS1kPKKqRsGym7wOsWN4nZBXS7hNK23GbE3iJESjTdd7Ju29l1X/J203JEW1co6zBdf/yQex8j+Z/iCDUtoD8GZl/eA0Bg9UgJxakh0bHSc/wKZxk2a0BOULMGBh1SYwsM2/YKrpOX6A0aLaGkhQWASXTlH7nHhXOhmpZEB6eKa9gk7KpEl6tCo8LQeMUm4hXRdEYBQXMkZZrO63X1p7jg/bAsFyIpUaLODcIkOrtjtiG59oTKrd0TJJWMSHRE2aYpezXP3kBktK1Ook+VUFOzG/BeK67rgjOm+CrBlC9/sC0/K9EnPRPKpCnnBMFK7pgvntE5c+rmA4INIsDzPVNcbwRUOv7Jqf9n1OOU/y7tWlLCFWV/L4o7qMQ+86VT1Kxyf/xc78v0VLHMOZvHAhbiRK8N3niv6owgNpELHTcd75kx70iICCU5KdGYK+kNQZBe7BekkBRakBRBfMY2UEI4MCzRhf75qFLqIUh5yXShfzIpNa7g92/fiF8aH953Mug8kJsYNqurWEA4W4JbsIBUcTvspY8K1uwytm5voJRNGFQat5JcGsx8vS0J7IHFUTcw3bB/gO0tQEuMvn/328nv/jyA4ksozTg2lrCSL6CU3AL/bnFmNK1v7rnkMo2D8DwC3wMSHapwAUG2hqkpCWR5oooZLAdKcgu/dEgwkKoCrMQV5o81wZGXBjvS5/129cPvP//4xbuOM2NgxlSUmYFDE89QkpqMmsQtSO1aE1qAxiybOAYPCklYaUGquHSCt51Pmvuc3eWoGAT0psnlPOP6CwhhiUakcMADSvyWa4/6dUdhjhXLuFIhhsrK4bCjVS7qWEIIjLcmDSO7vJzdhs/k61DsTPFpHkuyRvUXJALn8U0vxFbNJa479iDW4wq3DN5fNGBBPi52ei+4KQjWxkNVEgZBZlaceoWISKAQ5UnPyxLNtnYGXYMaNSJtrUZt6IOQDNQETyy58ppRt1+DsiplTLWKZ0TwNisoaQa1LYa31eCTLWKuOIwFqRHC+WgAb0cingiPOkha5aM80bnAgBLkaBqISiK6k1Sik0rYS6c1bjnWoqneGz5YNIefWPKh89yBZ4na8qOt5jzBJvSKCp/nzeGrOerYpKBzs8tGrOvEggLm7yvK25aqumdbIf0Z8h32DlAJXqv613buAmfKlXM9Ex4VlrGJa0RoNdXMQGJ6srMaJbxNxKOC1gMwOROeuId3zBruuTHYMliOJIXc12DoiP2CWiHIlipi6p0S2xsk6gM3QodBjUh0uqqSvizwKyJszL4l27YfV31bSBp6EuWmt3TjulrvCm9eEV54pFzI3gYTSrBnwzCIZxxUmm6dUNEAi9AqQJNTq+mvvvd6DUoDEUDq7q7y0OlJXjysq+cj1XgLK+XNG5v5wv1CeX1zba5cXny4Erb0ivAo9dT+L8iOANkb+8r05h6Y3twT00yrxEFdP5r3ItMsra7c38xdjUg0yUBr7uqeqB5qLan9Vl+utyJzzS8uFJbnSteGsUy4G7z9JZkb6kqXZG5/Wc5GYzn7H19wj+W1/WV5PRrL68N625HuI/NjShoSnWqZpDHhnXSnoX+X1WF4eiasQwcnemtIZ46rfQwc2iWaaQGmdzHwGDOHKBXL6qphesbbLbh4Sh9MEbwBu5HYV2Gq/cuBYbpVC5dwXilTq+xSONe5y/Aaq9Z95tZk2IZhx8E8gsa2tZlW4MFQB3bdNUTwYc9WYExdPKj9NnX/9Zh4ZoeJ+mDrgjuMCKYlYffOYRuBxu8YcLSdqFATtue1u7uAY+qZjoC4KwpBMjYVjnd8KJ6afGEAwul/jfB5lACguntX0w/jfCQWNwYgXASEvwGEBnsBmhUAAA==";
    private static final Log log = LogFactory.getLog(JComment.class);
    private static final long serialVersionUID = 1L;

    /*-----------------------------------------------------------------------*/
    /*--------------------------- Internal states ---------------------------*/
    /*-----------------------------------------------------------------------*/

    protected List $activeBindings = new ArrayList();
    protected Map $bindingSources = new HashMap();
    protected final Map $bindings = new TreeMap();
    protected Map $objectMap = new HashMap();
    protected Map $previousValues = new HashMap();
    protected final JAXXContext delegateContext = new DefaultJAXXContext();

    /*-----------------------------------------------------------------------*/
    /*------------------------ Protected components  ------------------------*/
    /*-----------------------------------------------------------------------*/

    protected JPanel columnHeader;
    protected JScrollPane comment;
    protected JTextArea comment2;
    protected JLabel infoLabel;
    protected WithComment model;
    protected JButton resetComment;
    protected String title;
    protected JLabel titleLabel;

    /*-----------------------------------------------------------------------*/
    /*------------------------- Private components  -------------------------*/
    /*-----------------------------------------------------------------------*/

    private JComment $JPanel0;
    private JPanel $JPanel1;
    private JToolBar $JToolBar0;

    /*-----------------------------------------------------------------------*/
    /*---------------------------- Constructors  ----------------------------*/
    /*-----------------------------------------------------------------------*/

    public JComment(LayoutManager param0, boolean param1) {
        super(param0 ,param1);
        $initialize();
    }

    public JComment(JAXXContext parentContext, LayoutManager param1, boolean param2) {
        super(param1 ,param2);
        JAXXUtil.initContext(this, parentContext);
        $initialize();
    }

    public JComment(LayoutManager param0) {
        super(param0);
        $initialize();
    }

    public JComment(JAXXContext parentContext, LayoutManager param1) {
        super(param1);
        JAXXUtil.initContext(this, parentContext);
        $initialize();
    }

    public JComment() {
        $initialize();
    }

    public JComment(JAXXContext parentContext) {
        JAXXUtil.initContext(this, parentContext);
        $initialize();
    }

    public JComment(boolean param0) {
        super(param0);
        $initialize();
    }

    public JComment(JAXXContext parentContext, boolean param1) {
        super(param1);
        JAXXUtil.initContext(this, parentContext);
        $initialize();
    }

    /*-----------------------------------------------------------------------*/
    /*--------------------------- Statics methods ---------------------------*/
    /*-----------------------------------------------------------------------*/

    public static JAXXObjectDescriptor $getJAXXObjectDescriptor() {
        return JAXXUtil.decodeCompressedJAXXObjectDescriptor($jaxxObjectDescriptor);
    }

    /*-----------------------------------------------------------------------*/
    /*---------------------- JAXXObject implementation ----------------------*/
    /*-----------------------------------------------------------------------*/

    @Override
    public void applyDataBinding(String $binding) {
        if ($bindings.containsKey($binding)) {
            getDataBinding($binding).applyDataBinding();
        }
        processDataBinding($binding);
    }

    @Override
    public void firePropertyChange(String propertyName, Object oldValue, Object newValue) {
        super.firePropertyChange(propertyName, oldValue, newValue);
    }

    @Override
    public Map get$objectMap() {
        return $objectMap;
    }

    @Override
    public JAXXBinding getDataBinding(String bindingId) {
        return $bindings.get(bindingId);
    }

    @Override
    public JAXXBinding[] getDataBindings() {
        return $bindings.values().toArray(new JAXXBinding[$bindings.size()]);
    }

    @Override
    public Object getObjectById(String id) {
        return $objectMap.get(id);
    }

    @Override
    public void processDataBinding(String $binding, boolean $force) {
        if (!$force && $activeBindings.contains($binding)) { 
            return;
        }
        $activeBindings.add($binding);
        try {
            if ($bindings.containsKey($binding)) {
                getDataBinding($binding).processDataBinding();
            }
        } finally {
            $activeBindings.remove($binding);
        }
    }

    @Override
    public void processDataBinding(String $binding) {
        processDataBinding($binding, false);
    }

    @Override
    public void registerDataBinding(JAXXBinding binding) {
        $bindings.put(binding.getId(), binding);
    }

    @Override
    public void removeDataBinding(String $binding) {
        if ($bindings.containsKey($binding)) {
            getDataBinding($binding).removeDataBinding();
        }
    }

    /*-----------------------------------------------------------------------*/
    /*--------------------- JAXXContext implementation  ---------------------*/
    /*-----------------------------------------------------------------------*/

    @Override
    public  T getContextValue(Class clazz) {
        return delegateContext.getContextValue(clazz, null);
    }

    @Override
    public  T getContextValue(Class clazz, String name) {
        return delegateContext.getContextValue(clazz, name);
    }

    @Override
    public JAXXContext getDelegateContext() {
        return delegateContext;
    }

    @Override
    public  O getParentContainer(Class clazz) {
        return SwingUtil.getParentContainer(this, clazz);
    }

    @Override
    public  O getParentContainer(Object source, Class clazz) {
        return SwingUtil.getParentContainer(source, clazz);
    }

    @Override
    public  void removeContextValue(Class clazz) {
        delegateContext.removeContextValue(clazz, null);
    }

    @Override
    public  void removeContextValue(Class clazz, String name) {
        delegateContext.removeContextValue(clazz, name);
    }

    @Override
    public  void setContextValue(T o) {
        delegateContext.setContextValue(o, null);
    }

    @Override
    public  void setContextValue(T o, String name) {
        delegateContext.setContextValue(o, name);
    }

    /*-----------------------------------------------------------------------*/
    /*---------------------------- Event methods ----------------------------*/
    /*-----------------------------------------------------------------------*/

    public void doActionPerformed__on__resetComment(ActionEvent event) {
        if (log.isDebugEnabled()) {
            log.debug(event);
        }
        model.setComment(null);
    }

    public void doFocusGained__on__comment(FocusEvent event) {
        if (log.isDebugEnabled()) {
            log.debug(event);
        }
        comment2.requestFocus();
    }

    public void doKeyReleased__on__comment2(KeyEvent event) {
        if (log.isDebugEnabled()) {
            log.debug(event);
        }
        if (!comment2.getText().isEmpty() || model.getComment() != null) { model.setComment(comment2.getText().isEmpty() ? null : comment2.getText()); }
    }

    /*-----------------------------------------------------------------------*/
    /*----------------------- Public acessor methods  -----------------------*/
    /*-----------------------------------------------------------------------*/

    public JPanel getColumnHeader() {
        return columnHeader;
    }

    public JScrollPane getComment() {
        return comment;
    }

    public JTextArea getComment2() {
        return comment2;
    }

    public JLabel getInfoLabel() {
        return infoLabel;
    }

    public WithComment getModel() {
        return model;
    }

    public JButton getResetComment() {
        return resetComment;
    }

    public String getTitle() {
        return title;
    }

    public JLabel getTitleLabel() {
        return titleLabel;
    }

    /*-----------------------------------------------------------------------*/
    /*----------------------- Public mutator methods  -----------------------*/
    /*-----------------------------------------------------------------------*/

    public void setModel(WithComment model) {
        WithComment oldValue = this.model;
        this.model = model;
        firePropertyChange(PROPERTY_MODEL, oldValue, model);
    }

    public void setTitle(String title) {
        String oldValue = this.title;
        this.title = title;
        firePropertyChange(PROPERTY_TITLE, oldValue, title);
    }

    /*-----------------------------------------------------------------------*/
    /*--------------------- Protected acessors methods  ---------------------*/
    /*-----------------------------------------------------------------------*/

    protected JPanel get$JPanel1() {
        return $JPanel1;
    }

    protected JToolBar get$JToolBar0() {
        return $JToolBar0;
    }

    /*-----------------------------------------------------------------------*/
    /*--------------------- Components creation methods ---------------------*/
    /*-----------------------------------------------------------------------*/

    protected void addChildrenToColumnHeader() {
        columnHeader.add($JPanel1, BorderLayout.WEST);
        columnHeader.add($JToolBar0, BorderLayout.EAST);
    }

    protected void addChildrenToComment() {
        comment.getViewport().add(comment2);
    }

    protected void createColumnHeader() {
        $objectMap.put("columnHeader", columnHeader = new JPanel());
        
        columnHeader.setName("columnHeader");
        columnHeader.setLayout(new BorderLayout());
    }

    protected void createComment() {
        $objectMap.put("comment", comment = new JScrollPane());
        
        comment.setName("comment");
        comment.addFocusListener(JAXXUtil.getEventListener(FocusListener.class, "focusGained", this, "doFocusGained__on__comment"));
    }

    protected void createComment2() {
        $objectMap.put("comment2", comment2 = new JTextArea());
        
        comment2.setName("comment2");
        comment2.setColumns(15);
        comment2.setLineWrap(true);
        comment2.setWrapStyleWord(true);
        comment2.setRows(5);
        comment2.addKeyListener(JAXXUtil.getEventListener(KeyListener.class, "keyReleased", this, "doKeyReleased__on__comment2"));
    }

    protected void createInfoLabel() {
        $objectMap.put("infoLabel", infoLabel = new JLabel());
        
        infoLabel.setName("infoLabel");
        infoLabel.setToolTipText(t("observe.action.comment.tip"));
    }

    protected void createModel() {
        $objectMap.put("model", model = null);
    }

    protected void createResetComment() {
        $objectMap.put("resetComment", resetComment = new JButton());
        
        resetComment.setName("resetComment");
        resetComment.setFocusTraversalKeysEnabled(false);
        resetComment.setOpaque(false);
        resetComment.setFocusable(false);
        resetComment.setToolTipText(t("observe.action.resetComment.tip"));
        resetComment.addActionListener(JAXXUtil.getEventListener(ActionListener.class, "actionPerformed", this, "doActionPerformed__on__resetComment"));
    }

    protected void createTitle() {
        $objectMap.put("title", title = t("observe.common.comment"));
    }

    protected void createTitleLabel() {
        $objectMap.put("titleLabel", titleLabel = new JLabel());
        
        titleLabel.setName("titleLabel");
    }

    /*-----------------------------------------------------------------------*/
    /*------------------------ Internal jaxx methods ------------------------*/
    /*-----------------------------------------------------------------------*/

    protected void $initialize() {
        if (log.isDebugEnabled()) {
            log.debug(this);
        }
        $JPanel0 = this;
        $initialize_01_createComponents();
        $initialize_02_registerDataBindings();
        $initialize_03_finalizeCreateComponents();
        $initialize_04_applyDataBindings();
        $initialize_05_setProperties();
        $initialize_06_finalizeInitialize();
    }

    protected void $initialize_01_createComponents() {
        if (log.isDebugEnabled()) {
            log.debug(this);
        }
        $objectMap.put("$JPanel0", $JPanel0);
        createModel();
        createTitle();
        createComment();
        createComment2();
        createColumnHeader();
        // inline creation of $JPanel1
        $objectMap.put("$JPanel1", $JPanel1 = new JPanel());
        
        $JPanel1.setName("$JPanel1");
        $JPanel1.setLayout(new BorderLayout(3, 3));
        createTitleLabel();
        createInfoLabel();
        // inline creation of $JToolBar0
        $objectMap.put("$JToolBar0", $JToolBar0 = new JToolBar());
        
        $JToolBar0.setName("$JToolBar0");
        $JToolBar0.setBorderPainted(false);
        $JToolBar0.setOpaque(false);
        $JToolBar0.setFloatable(false);
        createResetComment();
        // inline creation of $JPanel0
        setName("$JPanel0");
        setLayout(new BorderLayout());
    }

    protected void $initialize_02_registerDataBindings() {
        if (log.isDebugEnabled()) {
            log.debug(this);
        }
        // register 2 data bindings
        registerDataBinding(new DefaultJAXXBinding(this, BINDING_COMMENT2_TEXT, true, true) {
        
            @Override
            public void applyDataBinding() {
                addPropertyChangeListener("model", this);
                if (getModel() != null) {
                    getModel().addPropertyChangeListener("comment", this);
                }
            }
        
            @Override
            public void processDataBinding() {
                if (getModel() != null) {
                    SwingUtil.setText(comment2, getStringValue(getModel().getComment()));
                }
            }
        
            @Override
            public void removeDataBinding() {
                removePropertyChangeListener("model", this);
                if (getModel() != null) {
                    getModel().removePropertyChangeListener("comment", this);
                }
            }
        });
        registerDataBinding(new SimpleJAXXObjectBinding(this, BINDING_TITLE_LABEL_TEXT, true ,"title") {
        
            @Override
            public void processDataBinding() {
                titleLabel.setText(t(getTitle()));
            }
        });
    }

    protected void $initialize_03_finalizeCreateComponents() {
        if (log.isDebugEnabled()) {
            log.debug(this);
        }
        // inline complete setup of $JPanel0
        add(comment, BorderLayout.CENTER);
        addChildrenToComment();
        addChildrenToColumnHeader();
        // inline complete setup of $JPanel1
        $JPanel1.add(titleLabel, BorderLayout.WEST);
        $JPanel1.add(infoLabel, BorderLayout.CENTER);
        // inline complete setup of $JToolBar0
        $JToolBar0.add(resetComment);
    }

    protected void $initialize_04_applyDataBindings() {
        if (log.isDebugEnabled()) {
            log.debug(this);
        }
        
        // apply 2 data bindings
        JAXXUtil.applyDataBinding(this, $bindings.keySet());
    }

    protected void $initialize_05_setProperties() {
        if (log.isDebugEnabled()) {
            log.debug(this);
        }
        
        // apply 6 property setters
        comment.setColumnHeaderView(columnHeader);
        infoLabel.setIcon(SwingUtil.getUIManagerActionIcon("information"));
        resetComment.setIcon(SwingUtil.getUIManagerActionIcon("combobox-reset"));
    }

    protected void $initialize_06_finalizeInitialize() {
        if (log.isDebugEnabled()) {
            log.debug(this);
        }
    }

}