basecomponenttag.java

GridSphere 门户 提供一个基于 portlet 的高级开放源代码门户。GridSphere 是在欧盟提供基金的 GridLab 项目下开发的

/*
 * @author <a href="mailto:[e-mail]">Jason Novotny</a>
 * @version $Id: BaseComponentTag.java 4883 2006-06-26 23:52:13Z novotny $
 */
package org.gridsphere.provider.portletui.tags;

import org.gridsphere.portlet.impl.SportletProperties;
import org.gridsphere.provider.portletui.beans.BaseComponentBean;

import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.Tag;
import java.util.Locale;
import java.util.ResourceBundle;

/**
 * The abstract <code>BaseComponentTag</code> is used by all UI tags to provide CSS support and general
 * name, value attributes
 */
public abstract class BaseComponentTag extends BaseBeanTag {

    protected String name = null;
    protected String value = null;
    protected String key = null;
    protected boolean readonly = false;
    protected boolean disabled = false;
    protected String cssStyle = null;
    protected String cssClass = null;
    protected Locale locale = null;
    protected String id = null;

    /**
     * Sets the id of the bean  (not to be confused with beanId)
     *
     * @param id the id of the bean
     */
    public void setId(String id) {
        this.id = id;
    }

    /**
     * Gets the id of the bean
     *
     * @return id of the bean
     */
    public String getId() {
        return this.id;
    }

    /**
     * Sets the name of the bean
     *
     * @param name the name of the bean
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Gets the name of the bean
     *
     * @return name of the bean
     */
    public String getName() {
        return this.name;
    }

    /**
     * Sets the tag value
     *
     * @param value the tag value
     */
    public void setValue(String value) {
        this.value = value;
    }

    /**
     * Returns the tag value
     *
     * @return the tag value
     */
    public String getValue() {
        return value;
    }

    /**
     * Return the key used to identify the value in the properties file
     *
     * @return the key
     */
    public String getKey() {
        return key;
    }

    /**
     * Sets the key used to identify the value in the properties file
     *
     * @param key the property key
     */
    public void setKey(String key) {
        this.key = key;
    }

    /**
     * Returns true if bean is in disabled state
     *
     * @return the tag state
     */
    public boolean isDisabled() {
        return disabled;
    }

    /**
     * Sets the disabled attribute of the bean to be in the 'flag' state.
     *
     * @param flag is true if this tag/bean is disabled
     */
    public void setDisabled(boolean flag) {
        this.disabled = flag;
    }

    /**
     * Returns disabled String if bean is disabled
     *
     * @return a String depending if bean is disabled
     */
    protected String checkDisabled() {
        if (disabled) {
            return " disabled='disabled' ";
        } else {
            return "";
        }
    }

    /**
     * Sets the bean to read-only
     *
     * @param flag is true if bean is read-only, false otherwise
     */
    public void setReadonly(boolean flag) {
        this.readonly = flag;
    }

    /**
     * Returns the read-only status of the bean
     *
     * @return read-only status of the bean
     */
    public boolean isReadonly() {
        return readonly;
    }

    /**
     * Returns a String to use in markup if the bean is read-only
     *
     * @return a String to use in markup if the bean is read-only
     */
    protected String checkReadonly() {
        if (readonly) {
            return " readonly='readonly' ";
        } else {
            return "";
        }
    }

    /**
     * Returns the CSS style name of the beans
     *
     * @return the name of the css style
     */
    public String getCssStyle() {
        return cssStyle;
    }

    /**
     * Sets the CSS style of the beans
     *
     * @param style css style name to set for the beans
     */
    public void setCssStyle(String style) {
        this.cssStyle = style;
    }

    /**
     * Returns the CSS class name of the beans
     *
     * @return the name of the css class
     */
    public String getCssClass() {
        return cssClass;
    }

    /**
     * Sets the CSS class of the beans
     *
     * @param cssClass the class name to set for the beans
     */
    public void setCssClass(String cssClass) {
        this.cssClass = cssClass;
    }

    public void addCssClass(String cssClass) {
        if (this.cssClass == null) this.cssClass = "";
        if (cssClass != null) this.cssClass += " " + cssClass;
    }

    /**
     * Sets the base component properties of the bean
     *
     * @param componentBean a ui bean
     */
    protected void setBaseComponentBean(BaseComponentBean componentBean) {
        componentBean.setBeanId(beanId);
        if (id != null) componentBean.setId(id);
        componentBean.setLocale(getLocale());
        componentBean.addParam(SportletProperties.COMPONENT_ID, (String) pageContext.findAttribute(SportletProperties.COMPONENT_ID));
        componentBean.addParam(SportletProperties.GP_COMPONENT_ID, (String) pageContext.findAttribute(SportletProperties.GP_COMPONENT_ID));
        if (cssStyle != null) componentBean.setCssStyle(cssStyle);
        if (cssClass != null) componentBean.setCssClass(cssStyle);
        componentBean.setDisabled(disabled);
        componentBean.setReadOnly(readonly);
        if (name != null) componentBean.setName(name);
        if (value != null) componentBean.setValue(value);

        componentBean.setReadOnly(readonly);
        RenderResponse res = (RenderResponse) pageContext.getAttribute("renderResponse");
        componentBean.setRenderResponse(res);
        RenderRequest req = (RenderRequest) pageContext.getAttribute("renderRequest");
        componentBean.setRenderRequest(req);
    }

    /**
     * Updates the base component bean properties
     *
     * @param componentBean a ui bean
     */
    protected void updateBaseComponentBean(BaseComponentBean componentBean) {
        componentBean.setLocale(getLocale());
        if (id != null) componentBean.setId(id);
        componentBean.addParam(SportletProperties.COMPONENT_ID, (String) pageContext.findAttribute(SportletProperties.COMPONENT_ID));
        componentBean.addParam(SportletProperties.GP_COMPONENT_ID, (String) pageContext.findAttribute(SportletProperties.GP_COMPONENT_ID));
        if ((cssClass != null) && componentBean.getCssClass() == null) {
            componentBean.setCssClass(cssClass);
        }
        if ((cssStyle != null) && componentBean.getCssStyle() == null) {
            componentBean.setCssStyle(cssStyle);
        }
        if ((name != null) && (componentBean.getName() == null)) {
            componentBean.setName(name);
        }
        if ((value != null) && (componentBean.getValue() == null)) {
            componentBean.setValue(value);
        }
        RenderResponse res = (RenderResponse) pageContext.getAttribute("renderResponse");
        componentBean.setRenderResponse(res);
        RenderRequest req = (RenderRequest) pageContext.getAttribute("renderRequest");
        componentBean.setRenderRequest(req);
    }

    protected String getLocalizedText(String key) {
        return getLocalizedText(key, "Portlet");
    }

    protected Locale getLocale() {
        Locale locale = Locale.ENGLISH;
        RenderRequest renderReq = (RenderRequest) pageContext.getAttribute(SportletProperties.RENDER_REQUEST, PageContext.REQUEST_SCOPE);
        locale = renderReq.getLocale();
        return locale;
    }

    protected String getLocalizedText(String key, String base) {
        Locale locale = getLocale();
        try {
            ResourceBundle bundle = ResourceBundle.getBundle(base, locale);
            return bundle.getString(key);
        } catch (Exception e) {
            try {
                ResourceBundle bundle = ResourceBundle.getBundle(base, Locale.ENGLISH);
                return bundle.getString(key);
            } catch (Exception ex) {
                return key;
            }
        }
    }

    public int doStartTag() throws JspException {
        Tag parent = getParent();
        if (parent instanceof PanelTag) {
            PanelTag panelTag = (PanelTag) parent;

            int numCols = panelTag.getNumCols();

            int thiscol = panelTag.getColumnCounter();
            try {
                JspWriter out = pageContext.getOut();
                if ((thiscol % numCols) == 0) {
                    out.println("<tr>");
                }
                // Attribute 'width' replaced by 'style="width:"' for XHTML 1.0 Strict compliance                
                out.println("<td style=\"width:" + "100%" + "\">");
            } catch (Exception e) {
                throw new JspException(e.getMessage());
            }
        }
        return EVAL_BODY_INCLUDE;
    }

    public void release() {
        name = null;
        value = null;
        key = null;
        readonly = false;
        disabled = false;
        cssStyle = null;
        cssClass = null;
        locale = null;
        id = null;
    }

    public int doEndTag() throws JspException {
        Tag parent = getParent();
        if (parent instanceof PanelTag) {
            PanelTag panelTag = (PanelTag) parent;

            int numCols = panelTag.getNumCols();
            int thiscol = panelTag.getColumnCounter();
            thiscol++;
            panelTag.setColumnCounter(thiscol);
            try {
                JspWriter out = pageContext.getOut();
                out.println("</td>");
                if ((thiscol % numCols) == 0) {
                    out.println("</tr>");
                }
            } catch (Exception e) {
                throw new JspException(e.getMessage());
            }
        }
        return super.doEndTag();
    }

    /*
    public void updatePageEndBuffer(StringBuffer buffer) {
        RenderRequest req = (RenderRequest)pageContext.getAttribute(SportletProperties.RENDER_REQUEST, PageContext.REQUEST_SCOPE);
        StringBuffer pagebuffer = (StringBuffer)req.getAttribute(SportletProperties.PAGE_BUFFER);
        if (pagebuffer == null) pagebuffer = new StringBuffer();
        pagebuffer.append(buffer);
        req.setAttribute(SportletProperties.PAGE_BUFFER, pagebuffer);
    }
    */
}