nextapp.echo2.webcontainer.propertyrender.FillImageRender Maven / Gradle / Ivy
Show all versions of ibis-echo2 Show documentation
/*
* 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.propertyrender;
import nextapp.echo2.app.FillImage;
import nextapp.echo2.app.Component;
import nextapp.echo2.webcontainer.RenderContext;
import nextapp.echo2.webcontainer.image.ImageRenderSupport;
import nextapp.echo2.webcontainer.image.ImageTools;
import nextapp.echo2.webrender.ClientProperties;
import nextapp.echo2.webrender.output.CssStyle;
/**
* Utility class for rendering nextapp.echo2.FillImage
* properties to CSS.
*/
public class FillImageRender {
/**
* A flag indicating that the 'fixed' property of the FillImage
* should be ignored.
*/
public static final int FLAG_DISABLE_FIXED_MODE = 0x1;
/**
* A flag indicating that the Internet Explorer 6.0 PNG AlphaImageLoader
* filter should be enabled for Internet Explorer clients that might
* "benefit" from it. Enabling this flag can however have serious
* unacceptable side-effects for Internet Explorer clients:
* If the flag is enabled, Images will be SCALED to span
* the entire region. IE will ignore any positioning/repeat information
* if this flag is enabled. Further, the browser may in fact not allow
* the user to click on any content within the region.
* Use of this flag is thus strongly discouraged in most all situations.
*
* This flag has no effect for clients other than Internet Explorer 6.0.
*/
public static final int FLAG_ENABLE_IE_PNG_ALPHA_FILTER = 0x2;
/**
* Renders a FillImage to a CSS style.
*
* @param cssStyle the CSS style to be updated
* @param rc the relevant RenderContext
* @param irs a ComponentSynchronizePeer providing
* ImageRenderSupport
* @param component the relevant Component
* @param imageId the image id of the background image
* @param fillImage the FillImage property value
* @param flags optional image rendering flags (see FLAG_XXX
* constants)
*/
public static void renderToStyle(CssStyle cssStyle, RenderContext rc, ImageRenderSupport irs,
Component component, String imageId, FillImage fillImage, int flags) {
if (fillImage == null) {
return;
}
String imageUri = ImageTools.getUri(rc, irs, component, imageId);
if ((flags & FLAG_ENABLE_IE_PNG_ALPHA_FILTER) != 0 && rc.getContainerInstance().getClientProperties().getBoolean(
ClientProperties.PROPRIETARY_IE_PNG_ALPHA_FILTER_REQUIRED)) {
cssStyle.setAttribute("background-image", "none");
cssStyle.setAttribute("filter",
"progid:DXImageTransform.Microsoft.AlphaImageLoader(src='" + imageUri + "', sizingMethod='scale')");
} else {
cssStyle.setAttribute("background-image", "url(" + imageUri + ")");
}
if (rc.getContainerInstance().getClientProperties().getBoolean(
ClientProperties.QUIRK_CSS_BACKGROUND_ATTACHMENT_USE_FIXED)) {
cssStyle.setAttribute("background-attachment", "fixed");
}
switch (fillImage.getRepeat()) {
case FillImage.NO_REPEAT:
cssStyle.setAttribute("background-repeat", "no-repeat");
break;
case FillImage.REPEAT_HORIZONTAL:
cssStyle.setAttribute("background-repeat", "repeat-x");
break;
case FillImage.REPEAT_VERTICAL:
cssStyle.setAttribute("background-repeat", "repeat-y");
break;
default:
cssStyle.setAttribute("background-repeat", "repeat");
}
if (fillImage.getHorizontalOffset() != null || fillImage.getVerticalOffset() != null) {
StringBuffer positionText = new StringBuffer();
if (fillImage.getHorizontalOffset() == null) {
positionText.append("0px");
} else {
positionText.append(ExtentRender.renderCssAttributeValue(fillImage.getHorizontalOffset()));
}
positionText.append(" " );
if (fillImage.getVerticalOffset() == null) {
positionText.append("0px");
} else {
positionText.append(ExtentRender.renderCssAttributeValue(fillImage.getVerticalOffset()));
}
cssStyle.setAttribute("background-position", positionText.toString());
}
}
/** Non-instantiable class. */
private FillImageRender() { }
}