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

Go to download
/*  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 com.viaoa.hub.Hub;
import com.viaoa.object.OAObject;
import com.viaoa.util.OAString;


/**
 * Controls an html img "src" attribute, to use an image using the ImageSerlvet
 * 
 * Example:  if image is in object Employee.ImageStore.bytes
 * OAImage(hubEmployee, Employee.P_EmpImageStore);
 * 
 * this will change the <img src=".."> to use the "/servlet/img" url
 * 
 * Note: to make responsive, set the max-height: 100%
 * 
 * @author vvia
 */
public class OAServletImage extends OAHtmlElement {
    private static final long serialVersionUID = 1L;

    protected String propertyPath;
    protected String bytePropertyName="bytes"; // name of property that has the bytes
    protected int maxWidthServlet, maxHeightServlet;

    /**
     * @param propertyPath path to the object that stores the image
     */
    public OAServletImage(String id, Hub hub, String propertyPath) {
        this(id, hub, propertyPath, 0, 0);
    }
    public OAServletImage(String id, Hub hub, String propertyPath, int maxWidth, int maxHeight) {
        super(id, hub);
        setPropertyPath(propertyPath);
        this.maxWidthServlet = maxWidth;
        this.maxHeightServlet = maxHeight;
    }
    
    public String getPropertyPath() {
        return propertyPath;
    }
    public void setPropertyPath(String propertyPath) {
        this.propertyPath = propertyPath;
    }

    // default is "bytes"
    public void setBytePropertyName(String propName) {
        this.bytePropertyName = propName;
    }
    public String getBytePropertyName() {
        return this.bytePropertyName;
    }
    
    
    private String lastAjaxSent;
    @Override
    public String getScript() {
        lastAjaxSent = null;
        return super.getScript();
    }
    
    
    public String getHtmlSource(Object obj) {
        String src = _getHtmlSource(obj);
        if (src == null) src = "";
        src = getSource(obj, src);
        return src;
    }
    private String _getHtmlSource(Object objx) {
        if (!(objx instanceof OAObject)) return null;
        OAObject obj = (OAObject) objx;
        
        Object value = OAString.isEmpty(propertyPath) ? obj : obj.getProperty(propertyPath);
        String className;

        if (value instanceof Hub) {
            Hub h = (Hub) value;
            value = h.getAO();
            if (value == null) value = h.getAt(0);
        }
        if (value == null) return null;
        
        if (!(value instanceof OAObject)) return null;
        className = value.getClass().getName();
        Object idValue = ((OAObject) value).getProperty("id");
        
        String src = String.format("/servlet/img?c=%s&id=%s&p=%s", className, idValue+"", getBytePropertyName());
        if (maxHeightServlet > 0) src = String.format("%s&mh=%d", src, maxHeightServlet);
        if (maxWidthServlet > 0) src = String.format("%s&mw=%d", src, maxWidthServlet);

        if (value instanceof OAObject) {
            value = ((OAObject) value).getProperty(getBytePropertyName());
            if (value instanceof byte[]) {
                int len = ((byte[]) value).length;
                if (len > 0) src = String.format("%s&len=%d", src, len); // 20171014 make it unique so that imageServlet can create an ETAG for the browser to cache
            }
        }
        
        return src;
    }

    
    private String defaultImageFileName;
    public void setDefaultImageFileName(String fname) {
        this.defaultImageFileName = fname;
    }
    public String getDefaultImageFileName() {
        return this.defaultImageFileName;
    }
    
    @Override
    public String getAjaxScript() {
        String s = super.getAjaxScript();
        StringBuilder sb = new StringBuilder(1024);
        if (s != null) sb.append(s);

        String src = null;
        OAObject obj = null;

        if (hub != null) src = getHtmlSource(hub.getAO());

        if (src == null) src = "";
        if (src.length() == 0) {
            src = getDefaultImageFileName();
            if (src == null) src = "";
        }
        
        if (src.length() == 0) {
            sb.append("$('#"+id+"').addClass('oaMissingImage');\n");
        }
        else {
            sb.append(convertSource(src)+"\n");
            sb.append("$('#"+id+"').removeClass('oaMissingImage');\n");
        }
        if (OAString.isNotEmpty(width)) {
            sb.append("$('#"+id+"').removeAttr('width');\n");
        }
        
        if (OAString.isNotEmpty(height)) {
            sb.append("$('#"+id+"').removeAttr('height');\n");
        }
        
        String js = sb.toString();

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

        return js;
    }

    protected String convertSource(String src) {
        return "$('#"+id+"').attr('src', '"+src+"');";
    }
    
    
    /**
     * Called to get the image source.
     * @param defaultSource default value that will be for the image src used for ImageServlet
     * @return
     */
    public String getSource(Object object, String defaultSource) {
        return defaultSource;
    }
    
    @Override
    public String getRenderHtml(OAObject obj) {
        String s = "";
        return s;
    }
    
}