Application: gvSIG desktop » Library: org.gvsig.tools

package org.gvsig.tools.dynform.spi.dynform;

import java.awt.BorderLayout;

import java.awt.Color;

import java.awt.Component;

import java.awt.Dimension;

import java.awt.Toolkit;

import java.awt.event.MouseAdapter;

import java.awt.event.MouseEvent;

import java.io.OutputStream;

import java.nio.charset.StandardCharsets;

import java.text.NumberFormat;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Objects;

import java.util.Set;

import javax.swing.Action;

import javax.swing.BorderFactory;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JViewport;

import javax.swing.SwingUtilities;

import org.apache.commons.io.IOUtils;

import org.apache.commons.text.StringEscapeUtils;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.CoercionException;

import org.gvsig.tools.dataTypes.DataType;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.dispose.DisposeUtils;

import org.gvsig.tools.dynform.DynFormDefinition;

import org.gvsig.tools.dynform.DynFormFieldDefinition;

import org.gvsig.tools.dynform.JDynForm;

import org.gvsig.tools.dynform.JDynFormField;

import org.gvsig.tools.dynform.spi.DynFormSPIManager;

import org.gvsig.tools.dynform.spi.dynformfield.AbstractJDynFormFieldWithValueList;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.Tags;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.identitymanagement.SimpleIdentity;

import org.gvsig.tools.resourcesstorage.ResourcesStorage;

import org.gvsig.tools.script.Script;

import org.gvsig.tools.script.ScriptManager;

import org.gvsig.tools.swing.api.ToolsSwingUtils;

import org.gvsig.tools.util.PropertiesSupportHelper;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

@SuppressWarnings("UseSpecificCatch")

public abstract class AbstractJDynForm implements JDynForm {

    protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractJDynForm.class);

    private final DynFormSPIManager manager;

    private final DynFormDefinition definition;

    private final JDynFormFactory factory;

    private DynFormContext context;

    private int formWidth = -1;

    private int formHeight = -1;

    private int layoutMode = USE_PLAIN;

    private JLabel jlabel_messages = null;

    private boolean readOnly = true;

    private Set listeners = null;

    private boolean useScrollBars = true;

    private final Map<String, List<Action>> customActions;

    protected JComponent contents = null;

    protected DynObject values = null;

    protected boolean border;

    private final PropertiesSupportHelper propertiesHelper = new PropertiesSupportHelper();

    private Script script;

    private boolean script_initialized = false;

    @SuppressWarnings("OverridableMethodCallInConstructor")

    public AbstractJDynForm(

            DynFormSPIManager manager,

            JDynFormFactory factory,

            DynFormDefinition definition,

            DynFormContext context

    ) {

        this.manager = manager;

        this.factory = factory;

        this.definition = definition;

        this.context = context;

        this.listeners = new HashSet();

        this.customActions = new HashMap();

        if (definition != null) {

            this.loadDefaultValuesFromTags(definition.getTags());

            SimpleIdentity user = ToolsLocator.getIdentityManager().getCurrentIdentity();

            if( !user.canWrite(this, definition.getName()) ) {

                this.readOnly = true;

            }

        }

    }

    @Override

    public Script getScript() {

        if( script_initialized ) {

            return script;

        }

        ResourcesStorage resources = null;

        try {

            resources = this.context.getResourcesStorage();

            if( resources==null ) {

                this.script = null;

                this.script_initialized = true;

                return null;

            }

            ResourcesStorage.Resource res = resources.getResource("jfrms");

            if( res == null || !res.exists() ) {

                this.script = null;

                this.script_initialized = true;

                return null;

            }

            String source = IOUtils.toString(res.asInputStream());

            if( StringUtils.isEmpty(source) ) {

                this.script = null;

                this.script_initialized = true;

                return null;

            }

            ScriptManager scriptManager = this.context.getScriptManager();

            if( scriptManager==null ) {

                this.script = null;

                this.script_initialized = true;

                return null;

            }

            this.script = scriptManager.createScript(this.definition.getName(), source, null);

            this.script_initialized = true;

            return script;

        } catch (Exception ex) {

            LOGGER.warn("Can't load resource jfrms.", ex);

            this.script = null;

            this.script_initialized = true;

            return null;

        } finally {

            DisposeUtils.disposeQuietly(resources);

        }

    }

    public boolean isScriptReadOnly() {

        ResourcesStorage resources = null;

        ResourcesStorage.Resource res = null;

        try {

            resources = this.context.getResourcesStorage();

            if( resources==null ) {

                return true;

            }

            res = resources.getResource("jfrms");

            if( res == null ) {

                return true;

            }

            return res.isReadOnly();

        } catch (Exception ex) {

            LOGGER.warn("Can't check if script resource jfrms is read-only.", ex);

            return true;

        } finally {

            IOUtils.closeQuietly(res);

            DisposeUtils.disposeQuietly(resources);

        }

    }

    @Override

    public void putScript(String source) {

        ResourcesStorage resources = null;

        ResourcesStorage.Resource res = null;

        OutputStream os = null;

        try {

            ScriptManager scriptManager = this.context.getScriptManager();

            if( scriptManager==null ) {

                throw new RuntimeException("Can't get the scripting manager.");

            }

            this.script = scriptManager.createScript(this.definition.getName(), source, null);

            this.script_initialized = true;

            resources = this.context.getResourcesStorage();

            if( resources==null ) {

                throw new RuntimeException("Can't get the resources storage.");

            }

            res = resources.getResource("jfrms");

            if( res == null ) {

                throw new RuntimeException("Can't get the resource of this form.");

            }

            if( res.isReadOnly() ) {

                throw new RuntimeException("Can't modify the resource, is read-only.");

            }

            os = res.asOutputStream();

            IOUtils.write(source, os, StandardCharsets.UTF_8);

        } catch (Exception ex) {

            LOGGER.warn("Can't save resource jfrms.", ex);

        } finally {

            IOUtils.closeQuietly(os);

            IOUtils.closeQuietly(res);

            DisposeUtils.disposeQuietly(resources);

        }

    }

    @Override

    public void callUserEvent(String name, Object...args) {

        Script theScript = this.getScript();

        if( theScript==null ) {

            return;

        }

        try {

            theScript.invokeFunction(name, args);

        } catch(NoSuchMethodException ex) {

            // Do nothing

        } catch(Exception ex) {

            LOGGER.warn("Error calling form event '"+name+"'.", ex);

        }

    }

    @Override

    public Object callUserFunction(String function, Object...args) throws Exception {

        Script theScript = this.getScript();

        if( theScript==null ) {

            throw new RuntimeException("Can't exists user code associated to this form.");

        }

        return theScript.invokeFunction(function, args);

    } 

    public static int getLayoutFromTags(Tags tags) {

        String layoutMode = (String) tags.get(

                DynFormSPIManager.TAG_DYNFORM_LAYOUTMODE, 

                DataTypes.STRING, 

                DynFormSPIManager.TAG_DYNFORM_LAYOUTMODE_VALUE_PLAIN

        );

        if (!StringUtils.isEmpty(layoutMode)) {

            if (layoutMode.equalsIgnoreCase("0")

                    || layoutMode.equalsIgnoreCase(DynFormSPIManager.TAG_DYNFORM_LAYOUTMODE_VALUE_PLAIN)) {

                return JDynForm.USE_PLAIN;

            } else if (layoutMode.equalsIgnoreCase("1")

                    || layoutMode.equalsIgnoreCase(DynFormSPIManager.TAG_DYNFORM_LAYOUTMODE_VALUE_TABS)) {

                return JDynForm.USE_TABS;

            } else if (layoutMode.equalsIgnoreCase("2")

                    || layoutMode.equalsIgnoreCase(DynFormSPIManager.TAG_DYNFORM_LAYOUTMODE_VALUE_SEPARATORS)) {

                return JDynForm.USE_SEPARATORS;

            }

        }

        return JDynForm.USE_PLAIN;

    }

    public void loadDefaultValuesFromTags(Tags tags) {

        this.setLayoutMode(getLayoutFromTags(tags));

        try {

            String s = tags.getString(DynFormSPIManager.TAG_DYNFORM_WIDTH);

            this.formWidth = NumberFormat.getInstance().parse(s).intValue();

            if( StringUtils.endsWithAny(s, "ch","char","cols","columns") ) {

                this.formWidth = ToolsSwingUtils.cols2px(this.formWidth);

            }

        } catch (Exception ex) {

        }

        try {

            String s = tags.getString(DynFormSPIManager.TAG_DYNFORM_HEIGHT);

            this.formHeight = NumberFormat.getInstance().parse(s).intValue();

            if( StringUtils.endsWithAny(s, "ch","char","rows","lines") ) {

                this.formHeight = ToolsSwingUtils.rows2px(this.formHeight);

            }

        } catch (Exception ex) {

        }

        try {

            this.border = tags.getBoolean(DynFormSPIManager.TAG_DYNFORM_BORDER);

        } catch (CoercionException ex) {

        }

        try {

            this.useScrollBars = tags.getBoolean(DynFormSPIManager.TAG_DYNFORM_USESCROLLBARS);

        } catch (CoercionException ex) {

        }

        try {

            this.readOnly = tags.getBoolean(DynFormSPIManager.TAG_DYNFORM_READONLY);

        } catch (CoercionException ex) {

        }

    }

    public DynFormSPIManager getServiceManager() {

        return this.manager;

    }

    @Override

    public JComponent asJComponent() {

        if (this.contents == null) {

            this.initComponents();

        }

        return this.contents;

    }

    protected void initComponents() {

        if (this.contents == null) {

            this.contents = addScrollsAndMessageBar(this.getFieldsContainer());

            if (this.values != null) {

                this.setValues(values);

            }

            if (this.border) {

                this.contents.setBorder(BorderFactory.createLineBorder(Color.GRAY));

            }

            message();

        }

    }

    protected boolean isContentsInitialized() {

        return this.contents != null;

    }

    @Override

    public void addListener(JDynFormListener listener) {

        this.listeners.add(listener);

    }

    @Override

    public void removeListener(JDynFormListener listener) {

        this.listeners.remove(listener);

    }

    public JLabel getMessagesJLabel() {

        if (this.jlabel_messages == null) {

            this.jlabel_messages = new JLabel();

            this.jlabel_messages.addMouseListener(new MouseAdapter() {

                @Override

                public void mouseClicked(MouseEvent evt) {

                    int count = evt.getClickCount();

                    if (count == 2) {

                        JOptionPane.showMessageDialog(contents, jlabel_messages.getText(), "Status", JOptionPane.INFORMATION_MESSAGE);

                    }

                }

            });

        }

        return this.jlabel_messages;

    }

    @Override

    public void setShowMessageStatus(boolean showMessageStatus) {

        this.getMessagesJLabel().setVisible(showMessageStatus);

    }

    @Override

    public boolean isShowMessageStatus() {

        return this.getMessagesJLabel().isVisible();

    }

    @Override

    public void message() {

        this.getMessagesJLabel().setText(" ");

    }

    @Override

    public void message(String msg) {

        this.getMessagesJLabel().setText(msg);

        fireMessageEvent(msg);

    }

    protected void fireMessageEvent(String message) {

        Iterator it = this.listeners.iterator();

        while (it.hasNext()) {

            JDynFormListener listener = (JDynFormListener) it.next();

            try {

                listener.message(message);

            } catch (Exception ex) {

                LOGGER.info("Error calling listener " + listener.toString()

                        + "(" + listener.getClass().getName() + ") from "

                        + this.toString() + "(" + this.getClass().getName()

                        + ").", ex);

            }

        }

    }

    protected void fireFieldChangeEvent(JDynFormField field) {

        Iterator it = this.listeners.iterator();

        while (it.hasNext()) {

            JDynFormListener listener = (JDynFormListener) it.next();

            try {

                listener.fieldChanged(field);

            } catch (Exception ex) {

                LOGGER.info("Error calling listener " + listener.toString()

                        + "(" + listener.getClass().getName() + ") from "

                        + this.toString() + "(" + this.getClass().getName()

                        + ").", ex);

            }

        }

    }

    protected JPanel addScrollsAndMessageBar(JComponent formPanel) {

        formPanel.setBorder(BorderFactory.createEmptyBorder(4, 4, 4, 4));

        JScrollPane scroll = new JScrollPane(formPanel);

        scroll.getVerticalScrollBar().setBlockIncrement(30);

        scroll.getVerticalScrollBar().setUnitIncrement(10);

        Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();

        Dimension size = formPanel.getPreferredSize();

        if( this.formHeight<100 ) {

            if( size.height>screenSize.height-100 ) {

                this.formHeight = screenSize.height-150;

            } else {

                this.formHeight = size.height;

            }

        }

        if( this.formWidth<100 ) {

            if( size.width>800 ) {

                this.formWidth = 800;

            } else {

                this.formWidth = size.width;

            }

        }

        if (useScrollBars) {

            int scrollBarWidth = scroll.getVerticalScrollBar().getPreferredSize().width;

            scroll.setPreferredSize(new Dimension(formWidth+4, formHeight+4));

//            formPanel.setPreferredSize(new Dimension(formWidth-scrollBarWidth, formHeight));

        } else {

            scroll.setPreferredSize(new Dimension(formWidth, formHeight));

        }

        scroll.setBorder(BorderFactory.createEmptyBorder());

        JPanel jpanel = new JPanel();

        jpanel.setLayout(new BorderLayout());

        jpanel.add(scroll, BorderLayout.CENTER);

        jpanel.add(getMessagesJLabel(), BorderLayout.PAGE_END);

        return jpanel;

    }

    @Override

    public int getLayoutMode() {

        return this.layoutMode;

    }

    @Override

    public void setLayoutMode(int layoutMode) {

        if (layoutMode < 0 || layoutMode > USE_SEPARATORS) {

            throw new IllegalArgumentException("layoutMode (" + layoutMode + ") out of range. Valid values are 0 .. " + USE_SEPARATORS + ".");

        }

        this.layoutMode = layoutMode;

    }

    @Override

    public boolean isReadOnly() {

        return readOnly;

    }

    @Override

    public void setReadOnly(boolean readOnly) {

        this.readOnly = readOnly;

    }

    @Override

    public int getFormWidth() {

        if (this.contents == null) {

            return this.formWidth;

        } else {

            JViewport port = ((JScrollPane) this.asJComponent()).getViewport();

            Component comp = (Component) port.getView();

            return comp.getWidth();

        }

    }

    @Override

    public int getFormHeight() {

        if (this.contents == null) {

            return this.formHeight;

        } else {

            JViewport port = ((JScrollPane) this.asJComponent()).getViewport();

            Component comp = (Component) port.getView();

            return comp.getHeight();

        }

    }

    @Override

    public void setFormSize(int width, int height) {

        this.formHeight = height;

        this.formWidth = width;

        if (this.contents != null) {

            this.asJComponent().setPreferredSize(new Dimension(width, height));

        }

    }

    public void configurePopupMenu(JDynFormField jfield) {

        DynFormFieldDefinition fieldDefinition = jfield.getDefinition();

        List<Action> customActions = getCustomActionsForDataType(fieldDefinition.getDataType());

        if (customActions != null && !customActions.isEmpty()) {

            for (Action customAction : customActions) {

                if (customAction != null) {

                    jfield.addActionToPopupMenu((String) customAction.getValue(Action.NAME), customAction);

                } else {

                    jfield.addSeparatorToPopupMenu();

                }

            }

        }

        this.getServiceManager().configurePopupMenu(jfield);

    }

    protected List<Action> getCustomActionsForDataType(DataType dataType) {

        return (List<Action>) customActions.get(dataType.getName());

    }

    @Override

    public void addActionToPopupMenu(DataType tipo, String name, Action action) {

        List<Action> acts = this.getCustomActionsForDataType(tipo);

        action.putValue(Action.NAME, name);

        if (acts == null) {

            List<Action> aux = new ArrayList<>();

            aux.add(action);

            customActions.put(tipo.getName(), aux);

        } else {

            acts.add(action);

        }

    }

    @Override

    public void addSeparatorToPopupMenu(DataType tipo) {

        List<Action> acts = this.getCustomActionsForDataType(tipo);

        if (acts == null) {

            List<Action> aux = new ArrayList<>();

            aux.add(null);

            customActions.put(tipo.getName(), aux);

        } else {

            acts.add(null);

        }

    }

    @Override

    public DynFormDefinition getDefinition() {

        return this.definition;

    }

    @Override

    public boolean getUseScrollBars() {

        return useScrollBars;

    }

    @Override

    public void setUseScrollBars(boolean usesScrolls) {

        this.useScrollBars = usesScrolls;

    }

    public void setBorder(boolean border) {

        this.border = border;

        if (this.isContentsInitialized() && border) {

            this.asJComponent().setBorder(BorderFactory.createLineBorder(Color.GRAY));

        }

    }

    @Override

    public JDynFormField getField(String fieldName) {

        return null;

    }

    @Override

    public final JDynFormField get(String key) {

        return this.getField(key);

    }

    @Override

    public Object getProperty(String key) {

        return this.propertiesHelper.getProperty(key);

    }

    @Override

    public void setProperty(String key, Object obj) {

        this.propertiesHelper.setProperty(key, obj);

    }

    @Override

    public Map<String, Object> getProperties() {

        return this.propertiesHelper.getProperties();

    }

    @Override

    public DynFormContext getContext() {

        return this.context;

    }

    @Override

    public void setContext(DynFormContext context) {

        this.context = context;

    }

    @Override

    public String toHtml() {

        I18nManager i18n = ToolsLocator.getI18nManager();

        List<String> groups = this.getDefinition().getGroups();

        StringBuilder builder = new StringBuilder();

        builder.append("<html>\n");

        builder.append("<body>\n");

        builder.append("<table style=\"border: none;\" cellspacing=\"2\" cellpadding=\"0\">\n");

        for (String group : groups) {

            String tablabel = group;

            if (StringUtils.isBlank(tablabel)) {

                tablabel = i18n.getTranslation("General");

            } else {

                tablabel = i18n.getTranslation(tablabel);            

            }

            builder.append("<tr>\n");

            builder.append("<td colspan=\"2\">\n<br/><i>");

            builder.append(StringEscapeUtils.escapeHtml3(tablabel));

            builder.append("</i>");

//            builder.append("<br/><hr/>\n");

            builder.append("</td>\n");

            builder.append("</tr>\n");            

            List<DynFormFieldDefinition> fields = this.getDefinition().getDefinitions(group);                

            for (DynFormFieldDefinition fieldDefinition : fields) {

                if( fieldDefinition.isHidden() ) {

                    continue;

                }

                JDynFormField jfield = this.getField(fieldDefinition.getName());

                if( jfield == null ) {

                    continue; // ??????

                }

                String value = jfield.toHTML();

                if( value == null ) {

                    if (fieldDefinition.isHidden() || fieldDefinition.getDataType().isContainer()) {

                        continue;

                    } 

                    if( jfield instanceof AbstractJDynFormFieldWithValueList ) {

                        value = ((AbstractJDynFormFieldWithValueList)jfield).getFromJComponent();

                    } else {

                        try {

                            value = Objects.toString(jfield.getValue(),"");

                        } catch(Exception e) {

                            value = "#ERROR#";

                        }

                    }

                    value = StringEscapeUtils.escapeHtml3(value);

                }

                builder.append("<tr>\n");

                if(  jfield.useEmptyLabel() ) {

                    builder.append("<td colspan=\"2\">\n");

                    builder.append(value);

                    builder.append("</td>\n");

                } else {

                    builder.append("<td valign=\"top\" nowrap style=\"white-space:nowrap;\">\n");

                    if( fieldDefinition.isMandatory() ) {

                        builder.append("<b>");

                        builder.append(StringEscapeUtils.escapeHtml3(fieldDefinition.getLabel()));

                        builder.append("</b>");

                    } else {

                        builder.append(StringEscapeUtils.escapeHtml3(fieldDefinition.getLabel()));

                    }

                    builder.append(": ");

                    builder.append("</td>\n");

                    builder.append("<td>\n");

                    builder.append(value);

                    builder.append("</td>\n");

                }

                builder.append("</tr>\n");

            }

        }

        builder.append("</table>\n");

        builder.append("</body>\n");

        builder.append("</html>\n");

        return builder.toString();

    }

}