• Home
• com.viaoa
• oa-web
• 3.5.59
• source code
• OAList.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.viaoa.jsp.OAList Maven / Gradle / Ivy

/*  Copyright 1999 Vince Via [email protected]
    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 com.viaoa.jsp;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.viaoa.hub.Hub;
import com.viaoa.object.OAObject;
import com.viaoa.util.*;

/*
 * Used with an HTML 
 or 
 to replace the 
 with hub objects.
 * 
 * @author vvia
 */
public class OAList implements OAJspComponent, OAJspRequirementsInterface {
    private static final long serialVersionUID = 1L;

    protected Hub hub;

    // Important Note:  this could be a composite (ex: OAButtonList uses OAPopupList uses OAList)
    //    and this "id" would be different then "getId()" ... see OAButtonList constructor
    protected String id;
    
    
    protected OAForm form;
    protected boolean bEnabled = true;
    protected boolean bVisible = true;
    protected boolean bAjaxSubmit=true;
    protected boolean bSubmit=false;
    protected String forwardUrl;
    protected String nullDescription = "";
    private boolean bShowNullDescriptionFirst;  // false=bottom of list
    protected boolean bRequired;
    protected String name;

    protected String format;
//    protected int lineWidth, maxRows, minLineWidth;
    
    protected String propertyPath;
    protected String visiblePropertyPath;
    protected String headingPropertyPath;
    protected int columns;
    
    protected int rows;
    protected int lastRow;
    
    protected String toolTip;
    protected String toolTipHtmlTemplate;
    protected OATemplate templateToolTip;
    private boolean bHadToolTip;
    
    protected String htmlTemplate;
    private OATemplate template;
    private HashMap hmChildren = new HashMap();
    
    protected HashMap hmHeading;
    
    // css styles
    protected String width;
    protected String maxHeight; // ex:  200px,  12em
    
    public OAList(String id, Hub hub, String propertyPath) {
        this(id, hub, propertyPath, 0, 0);
    }
    public OAList(Hub hub, String propertyPath) {
        this(null, hub, propertyPath, 0, 0);
    }
    public OAList(String id, Hub hub, String propertyPath, int cols, int rows) {
        this.id = id;
        this.hub = hub;
        setPropertyPath(propertyPath);
        this.columns = cols;
        this.rows = rows;
    }
    public OAList(Hub hub, String propertyPath, int cols, int rows) {
        this.hub = hub;
        setPropertyPath(propertyPath);
        this.columns = cols;
        this.rows = rows;
    }
    public OAList(String id, Hub hub, String propertyPath, String width, String height) {
        this.id = id;
        this.hub = hub;
        setPropertyPath(propertyPath);
        this.width = width;
        this.maxHeight = height;
    }
    public OAList(Hub hub, String propertyPath, String width, String height) {
        this.hub = hub;
        setPropertyPath(propertyPath);
        this.width = width;
        this.maxHeight = height;
    }

    /**
     * set the heading to use, beginning at a specific row.
     */
    public void addHeading(int row, String heading) {
        if (hmHeading == null) hmHeading = new HashMap<>();
        hmHeading.put(row, heading);
    }
    
    /**
     * Set the css style for width, ex: "100%"
     */
    public void setWidth(String width) {
        this.width = width;
    }
    public String getWidth() {
        return this.width;
    }

    /**
     * Set the css style for height, ex: "12em"
     */
    public void setHeight(String height) {
        this.maxHeight = height;
    }
    public String getHeight() {
        return this.maxHeight;
    }

    
    public int getColumns() {
        return columns;
    }
    public void setColumns(int x) {
        this.columns = x;
    }

    /**
     * how many rows to display.
     */
    public int getRows() {
        return rows;
    }
    public void setRows(int x) {
        this.rows = x;
    }

    
    public Hub getHub() {
        return hub;
    }
            
    
    public void setForwardUrl(String forwardUrl) {
        this.forwardUrl = forwardUrl;
    }
    public String getForwardUrl() {
        return this.forwardUrl;
    }
    
    @Override
    public boolean isChanged() {
        return false;
    }

    @Override
    public String getId() {
        return id;
    }
    @Override
    public void setId(String id) {
        this.id = id;
    }

    public String getPropertyPath() {
        return propertyPath;
    }
    public void setPropertyPath(String propertyPath) {
        this.propertyPath = propertyPath;
    }

    public String getHeadingPropertyPath() {
        return headingPropertyPath;
    }
    public void setHeadingPropertyPath(String propertyPath) {
        this.headingPropertyPath = propertyPath;
    }
    
    /** used when displaying error message for this textfield */
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    
    @Override
    public void reset() {
        // TODO Auto-generated method stub
    }

    @Override
    public void setForm(OAForm form) {
        this.form = form;
        for (Map.Entry e : hmChildren.entrySet()) {
            e.getValue().setForm(form);
        }
    }
    @Override
    public OAForm getForm() {
        return this.form;
    }

    private boolean bDefaultFormat=true;
    public void setFormat(String fmt) {
        this.format = fmt;
        bDefaultFormat = false;
    }
    public String getFormat() {
        if (format == null && bDefaultFormat && hub != null) {
            bDefaultFormat = false;
            OAPropertyPath pp = new OAPropertyPath(hub.getObjectClass(), propertyPath);
            if (pp != null) format = pp.getFormat();
        }
        return format;
    }
    
    
    @Override
    public boolean _beforeFormSubmitted() {
        return true;
    }

    private String submitUpdateScript;
    

    @Override
    public boolean _onFormSubmitted(HttpServletRequest req, HttpServletResponse resp, HashMap hmNameValue) {
        boolean bWasSubmitted = _myOnSubmit(req, resp, hmNameValue);
        return bWasSubmitted;
    }
    
    protected boolean _myOnSubmit(HttpServletRequest req, HttpServletResponse resp, HashMap hmNameValue) {
        // Enumeration enumx = req.getParameterNames();
        
        String s = req.getParameter("oacommand");
        if (s == null && hmNameValue != null) {
            String[] ss = hmNameValue.get("oacommand");
            if (ss != null && ss.length > 0) s = ss[0];
        }
        boolean bWasSubmitted = (id != null && (id.equalsIgnoreCase(s) || getId().equalsIgnoreCase(s)));
        
        
        String name = null;
        String[] values = null;

        for (Map.Entry ex : hmNameValue.entrySet()) {
            name = (String) ex.getKey();
            if (!name.equalsIgnoreCase("oalist"+id)) continue;
            values = ex.getValue();
            break;
        }

        if (values == null || values.length == 0 || OAString.isEmpty(values[0])) {
            return false;        
        }

        int row = OAConv.toInt(values[0]);
        if (row == lastRow) return bWasSubmitted; // not changed
        
        
        Object obj = hub.getAt(row);
        if (hub != null) hub.setAO(obj);

        
        submitUpdateScript = "";
        submitUpdateScript += "$('#"+id+" li').removeClass('oaSelected');";

        if (hub.getPos() >= 0) {
            submitUpdateScript += "$('#oalist"+id+"').val('"+hub.getPos()+"');";
            //was: s = " li:nth-child("+(hub.getPos()+1)+")";
        }
        else {
            submitUpdateScript += "$('#oalist"+id+"').val('');";
            //was: s = " li:nth-child("+(hub.getSize()+1)+")";
        }
        // use attr selector
        s = " li[oarow=\\'"+hub.getPos()+"\\']";
        submitUpdateScript += "$('#"+id+s+"').addClass('oaSelected');";

        // see if tooltip needs to be updated
        
        
        return bWasSubmitted; // true if this caused the form submit
    }

    @Override
    public String _onSubmit(String forwardUrl) {
        return onSubmit(forwardUrl);
    }
    
    @Override
    public String onSubmit(String forwardUrl) {
        return forwardUrl;
    }
    
    @Override
    public String _afterFormSubmitted(String forwardUrl) {
        return afterFormSubmitted(forwardUrl);
    }
    @Override
    public String afterFormSubmitted(String forwardUrl) {
        return forwardUrl;
    }

    public void setAjaxSubmit(boolean b) {
        bAjaxSubmit = b;
        if (b) setSubmit(false);
    }
    public boolean getAjaxSubmit() {
        return bAjaxSubmit;
    }
    public void setSubmit(boolean b) {
        if (b) setAjaxSubmit(false);
        bSubmit = b;
    }
    public boolean getSubmit() {
        return bSubmit;
    }
    
    @Override
    public String getScript() {
        lastAjaxSent = null;
        submitUpdateScript = null;
        bHadToolTip = false;
        StringBuilder sb = new StringBuilder(1024);
    
        sb.append("$('form').prepend(\"\");\n");

        
        sb.append("function oaList"+id+"Click() {\n");
        sb.append("    var v = $(this).attr('oarow');\n");
        
        sb.append("    if (v == null) return;\n");
        sb.append("    $('#oalist"+id+"').val(v);\n");
        sb.append("    $('#oacommand').val('" + id + "');\n");
        
        
        String s = getOnLineClickJs();
        if (s != null) {
            sb.append("    "+s);
        }
        
        if (getAjaxSubmit() && OAString.isEmpty(forwardUrl)) {
            sb.append("    ajaxSubmit();\n");
        }
        else {
            sb.append("    $('form').submit();\n");
            sb.append("    $('#oacommand').val('');\n");
        }
        sb.append("}\n");
        
        s = getScript2();
        if (s != null) sb.append(s);
        
        s = getAjaxScript();
        if (s != null) sb.append(s);
        
        s = getScript3();
        if (s != null) sb.append(s);
        
        if (isRequired()) {
            sb.append("$('#" + id + "').addClass('oaRequired');\n");
            sb.append("$('#" + id + "').attr('required', true);\n");
        }
        sb.append("$('#" + id + "').blur(function() {$(this).removeClass('oaError');}); \n");

        if (getSubmit() || getAjaxSubmit()) {
            sb.append("$('#" + id + "').addClass('oaSubmit');\n");
        }
        
        
        if (OAString.isNotEmpty(maxHeight)) {
            sb.append("$('#"+id+"').css(\"max-height\", \""+maxHeight+"\");\n");
        }
        else if (rows > 0) {
            int x = (int) (rows * 1.25);
            x += 3;
            sb.append("$('#"+id+" > li').css(\"line-height\", \"1.1em\");\n");
            sb.append("$('#"+id+"').css(\"max-height\", \""+x+"em\");\n");
        }

        
        if (width != null) {
            sb.append("$('#"+id+"').css(\"width\", \""+width+"\");\n");
            sb.append("$('#"+id+"').css(\"max-width\", \""+width+"\");\n");
        }
        else if (columns > 0) {
            int x = (int) (columns * .75);
            sb.append("$('#"+id+"').css(\"width\", \""+(x+2)+"em\");\n");
            sb.append("$('#"+id+"').css(\"max-width\", \""+(x+3)+"em\");\n");
        }
        
        if (OAString.isNotEmpty(width)) {
            sb.append("$('#"+id+"').css(\"width\", \""+width+"\");\n");
            sb.append("$('#"+id+"').css(\"max-width\", \""+width+"\");\n");
        }
        else if (columns > 0) {
            int x = (int) (columns * .75);
            sb.append("$('#"+id+"').css(\"width\", \""+(x+2)+"em\");\n");
            sb.append("$('#"+id+"').css(\"max-width\", \""+(x+3)+"em\");\n");
        }

        String js = sb.toString();
        return js;
    }
    
    protected String getScript2() {
        return null;
    }
    protected String getScript3() {
        return null;
    }
    

    @Override
    public String getVerifyScript() {
        StringBuilder sb = new StringBuilder(1024);

        if (isRequired()) {
            sb.append("if ($('#oalist" + id + "').val() == '') { requires.push('" + (name != null ? name : id) + "'); $('#" + id
                    + "').addClass('oaError');}\n");
        }

        if (sb.length() == 0) return null;
        return sb.toString();
    }

    private String lastAjaxSent;
    
    @Override
    public String getAjaxScript() {

        if (submitUpdateScript != null) {
            String s = submitUpdateScript;
            submitUpdateScript = null;
            lastAjaxSent = null;
            lastRow = hub.getPos();
            return s;
        }
        StringBuilder sb = new StringBuilder(2048);
        
        
        String ppHeading = getHeadingPropertyPath();
        String lastHeading = null;

        if (getShowNullDescriptionFirst()) {
            String s = getHtml(null, -1);
            if (s != null) {
                if (s.length() == 0) s += " ";
                sb.append("");
                sb.append(s);
                sb.append("
");
            }
        }
        
        for (int pos=0; ;pos++) {
            Object obj = hub.getAt(pos);
            if (obj == null) break;

            boolean b = false;
            
            String heading = null;
            if (OAString.isNotEmpty(ppHeading) && obj instanceof OAObject) {
                heading = ((OAObject) obj).getPropertyAsString(ppHeading, getFormat());
                if (OAString.isNotEmpty(heading) && !OAString.isEqual(heading, lastHeading)) {
                    sb.append("
"+heading+"
");
                    lastHeading = heading;
                }
            }
            if (hmHeading != null) {
                heading = hmHeading.get(pos);
                if (heading != null) {
                    sb.append("
"+heading+"
");
                }
            }
            
            sb.append("");
            String s = getHtml(obj, pos);
            if (s != null) sb.append(s);
            sb.append("");
        }
        //if (bInOptGroup) sb.append("");

        if (!getShowNullDescriptionFirst()) {
            String s = getHtml(null, -1);
            if (s != null) {
                if (s.length() == 0) s += " ";
                sb.append("");
                sb.append(s);
                sb.append("");
            }
        }
        
        String strListing = sb.toString();
        //strListing = Util.convert(strListing, "\\", "\\\\");
        //strListing = Util.convert(strListing, "'", "\\'");
        
        
        sb = new StringBuilder(strListing.length() + 2048);
        
        sb.append("$('#"+id+"').addClass('oaList');\n");
        if (OAString.isNotEmpty(ppHeading) || (hmHeading != null && hmHeading.size() > 0)) {
            sb.append("$('#"+id+"').addClass('oaIndent');\n");
        }

        strListing = OAJspUtil.createJsString(strListing, '\"');
        sb.append("$('#"+id+"').html(\""+strListing+"\");\n");
        
        sb.append("$('#"+id+" li').addClass('oaTextNoWrap');\n");
        
        
        if (getEnabled()) {
            sb.append("$('#"+id+" li[oarow]').click(oaList"+id+"Click);\n");
        }

        int posx = lastRow = hub.getPos();
        if (posx < 0) {
            sb.append("$('#oalist"+id+"').val('');\n"); // set back to blank
        }        
        else sb.append("    $('#oalist"+id+"').val('"+posx+"');\n");

        // tooltip for each row
        if (OAString.isNotEmpty(getToolTipHtmlTemplate())) {        
            for (int pos=0; ;pos++) {
                Object obj = hub.getAt(pos);
                if (obj == null) break;
                if (!(obj instanceof OAObject)) continue;
                
                String tt = getProcessedToolTip((OAObject) obj);
                if (OAString.isNotEmpty(tt)) {
                    tt = OAString.convertToHtml(tt);
                    sb.append("$('#"+id+" li[oarow=\\'"+pos+"\\']').tooltip();\n");
                    sb.append("$('#"+id+" li[oarow=\\'"+pos+"\\']').data('bs.tooltip').options.title = '"+tt+"';\n");
                    sb.append("$('#"+id+" li[oarow=\\'"+pos+"\\']').data('bs.tooltip').options.placement = 'right';\n");
                }
            }
        }


        // tooltip
        String prefix = null;
        String tt = getToolTip();
        if (OAString.isNotEmpty(tt)) {
            tt = OAString.convertToHtml(tt);
            if (!bHadToolTip) {
                bHadToolTip = true;
                prefix = "$('#"+id+"').tooltip();\n";
            }
            
            sb.append("$('#"+id+"').data('bs.tooltip').options.title = '"+tt+"';\n");
            sb.append("$('#"+id+"').data('bs.tooltip').options.placement = 'top';\n");
        }
        else {
            if (bHadToolTip) {
                sb.append("$('#"+id+"').tooltip('destroy');\n");
                bHadToolTip = false;
            }
        }

        String js = sb.toString();
        
        if (lastAjaxSent != null && lastAjaxSent.equals(js)) js = null;
        else lastAjaxSent = js;

        if (prefix != null) {
            js = prefix + OAString.notNull(js);
        }

        return js;
    }

    protected String getOnLineClickJs() {
        return null;
    }

    @Override
    public void setEnabled(boolean b) {
        lastAjaxSent = null;  
        this.bEnabled = b;
    }
    @Override
    public boolean getEnabled() {
        return bEnabled && hub != null;
    }


    @Override
    public void setVisible(boolean b) {
        lastAjaxSent = null;  
        this.bVisible = b;
    }
    @Override
    public boolean getVisible() {
        return this.bVisible;
    }

    public String getNullDescription() {
        return nullDescription;
    }
    public void setNullDescription(String s) {
        nullDescription = s;
    }
    
    
    public String getHtml(Object obj, int pos) {
        if (obj == null || pos < 0) {
            return getNullDescription();
        }

        String value;
        if (obj instanceof OAObject) {
            value = ((OAObject) obj).getPropertyAsString(getPropertyPath(), getFormat());

            String temp = getTemplateHtml(obj, pos);
            if (temp != null) {
                value = temp;
            }
        }
        else value = obj.toString();
        
        return value;
    }

    
    public void setMaxHeight(String val) {
        this.maxHeight = val;
    }
    public String getMaxHeigth() {
        return this.maxHeight;
    }

    public boolean isRequired() {
        return bRequired;
    }
    public boolean getRequired() {
        return bRequired;
    }
    public void setRequired(boolean required) {
        this.bRequired = required;
    }

    public void setToolTip(String tooltip) {
        this.toolTip = tooltip;
        templateToolTip = null;
    }
    public String getToolTip() {
        return this.toolTip;
    }
    public void setToolTipHtmlTemplate(String tooltip) {
        this.toolTipHtmlTemplate = tooltip;
        templateToolTip = null;
    }
    public String getToolTipHtmlTemplate() {
        return this.toolTipHtmlTemplate;
    }
    public String getProcessedToolTip(OAObject obj) {
        if (OAString.isEmpty(toolTipHtmlTemplate)) return toolTipHtmlTemplate;
        if (templateToolTip == null) {
            templateToolTip = new OATemplate();
            templateToolTip.setTemplate(getToolTipHtmlTemplate());
        }
        String s = templateToolTip.process(obj, hub, null);
        return s;
    }
    
    public String[] getRequiredJsNames() {
        ArrayList al = new ArrayList<>();

        al.add(OAJspDelegate.JS_jquery);
        al.add(OAJspDelegate.JS_jquery_ui);
        
        if (OAString.isNotEmpty(getToolTip())) {
            al.add(OAJspDelegate.JS_bootstrap);
        }

        String[] ss = new String[al.size()];
        return al.toArray(ss);
    }

    @Override
    public String[] getRequiredCssNames() {
        ArrayList al = new ArrayList<>();

        if (OAString.isNotEmpty(getToolTip())) {
            al.add(OAJspDelegate.CSS_bootstrap);
        }

        String[] ss = new String[al.size()];
        return al.toArray(ss);
    }

    @Override
    public String getEditorHtml(OAObject obj) {
        return null;
    }
    @Override
    public String getRenderHtml(OAObject obj) {
        return null;
    }
    
    @Override
    public void _beforeOnSubmit() {
    }


//qqqqqqqqqqqqqqqqqqqqqqqqq
    
    public void add(OAJspComponent comp) {
        if (comp != null) {
            hmChildren.put(comp.getId(), comp);
            comp.setForm(form);
        }
    }
    
    
    /**
     * @see #getTemplate()
     */
    public void setHtmlTemplate(String htmlTemplate) {
        this.htmlTemplate = htmlTemplate;
    }
    public String getHtmlTemplate() {
        return this.htmlTemplate;
    }
   

    /**
     * The following values are set and available:
     * $OAPOS, $OACOL, $OAROW
     * @see OATemplate
     */
    public OATemplate getTemplate() {
        if (template != null) return template;
        if (OAString.isEmpty(getHtmlTemplate())) return null;
        
        template = new OATemplate() {
            @Override
            protected String getValue(OAObject obj, String propertyName, int width, String fmt, OAProperties props, boolean bUseFormat) {
                String s;
                OAJspComponent comp = hmChildren.get(propertyName);
                if (comp == null) {
                    s = super.getValue(obj, propertyName, width, fmt, props, bUseFormat);
                }
                else {
                    s = comp.getRenderHtml(obj);
                }
                s = getTemplateValue(obj, propertyName, width, fmt, props, s);
                return s;
            }
            @Override
            protected String getOutputText(String s) {
                return s;
            }
        };
        template.setTemplate(getHtmlTemplate());
        
        return template;
    }
    public void setTemplate(OATemplate temp) {
        this.template = temp;
    }
    
    /*
     * Callback from {@link #getTemplate(Object, int, int, int)}
     */
    public String getTemplateValue(OAObject obj, String propertyName, int width, String fmt, OAProperties props, String defaultValue) {
        return defaultValue;
    }
    
    /**
     * This will use the OATemplate to create the html template for a single object.  
     */
    public String getTemplateHtml(Object objx, int pos) {
        if (!(objx instanceof OAObject)) return null;
        OAObject obj = (OAObject) objx;
        
        if (getTemplate() == null) return null;
        
        template.setProperty("OAPOS", ""+pos);
        template.setProperty("OACOL", ""+(1));
        template.setProperty("OAROW", ""+(pos+1));
        
        String s = template.process(obj);
        
        return s;
    }
    
    /*
    public String getHtmlPropertyPath(Object obj, int pos, int row, int col) {
        String result = null;
        String pp = getPropertyPath();
        if (!OAString.isEmpty(pp)) {
            if (obj != null) {
                result = ((OAObject)obj).getPropertyAsString(pp);
            }
        }
        return result;
    }
    */

    public void setShowNullDescriptionFirst(boolean b) {
        this.bShowNullDescriptionFirst = b;
    }
    public boolean getShowNullDescriptionFirst() {
        return bShowNullDescriptionFirst;
    }
}