nextapp.echo2.webcontainer.partialupdate.InsetsUpdate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
There is a newer version: 2.0.4
/* 
 * This file is part of the Echo Web Application Framework (hereinafter "Echo").
 * Copyright (C) 2002-2009 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

package nextapp.echo2.webcontainer.partialupdate;

import nextapp.echo2.app.Insets;
import nextapp.echo2.app.update.ServerComponentUpdate;
import nextapp.echo2.webcontainer.ContainerInstance;
import nextapp.echo2.webcontainer.PartialUpdateParticipant;
import nextapp.echo2.webcontainer.RenderContext;
import nextapp.echo2.webcontainer.propertyrender.InsetsRender;
import nextapp.echo2.webrender.servermessage.DomUpdate;

/**
 * A PartialUpdateParticipant to update a CSS property 
 * representing an inset property, e.g., 'padding' or 'margin'.
 */
public class InsetsUpdate
implements PartialUpdateParticipant {
    
    public static final String CSS_PADDING = "padding";
    public static final String CSS_MARGIN = "margin";
    
    private String componentPropertyName;
    private String cssAttributeName;
    private String idSuffix;
    
    /**
     * Creates a new InsetsUpdate.
     * 
     * @param componentPropertyName the name of the property of the component
     * @param idSuffix the suffix to append to the root client-side identifier
     *        of the component (should be null in typical case of no suffix)
     * @param cssAttributeName the name of the CSS attribute to update (see 
     *        CSS constants provided in this class)
     */
    public InsetsUpdate(String componentPropertyName, String idSuffix, String cssAttributeName) {
        super();
        this.componentPropertyName = componentPropertyName;
        this.idSuffix = idSuffix;
        this.cssAttributeName = cssAttributeName;
    }

    /**
     * @see nextapp.echo2.webcontainer.PartialUpdateParticipant#canRenderProperty(nextapp.echo2.webcontainer.RenderContext, 
     *      nextapp.echo2.app.update.ServerComponentUpdate)
     */
    public boolean canRenderProperty(RenderContext rc, ServerComponentUpdate update) {
        return true;
    }

    /**
     * @see nextapp.echo2.webcontainer.PartialUpdateParticipant#renderProperty(
     *      nextapp.echo2.webcontainer.RenderContext, nextapp.echo2.app.update.ServerComponentUpdate)
     */
    public void renderProperty(RenderContext rc, ServerComponentUpdate update) {
        Insets insets = (Insets) update.getParent().getRenderProperty(componentPropertyName);
        String elementId = idSuffix == null ? ContainerInstance.getElementId(update.getParent())
                : ContainerInstance.getElementId(update.getParent()) + idSuffix;
        if (insets == null) {
            DomUpdate.renderStyleUpdate(rc.getServerMessage(), elementId, cssAttributeName, "");
        } else {
            DomUpdate.renderStyleUpdate(rc.getServerMessage(), elementId, cssAttributeName, 
                    InsetsRender.renderCssAttributeValue(insets));
        }
    }
}