package org.vaadin.smartgwt.server;
import org.vaadin.smartgwt.server.types.ImageStyle;
import org.vaadin.smartgwt.server.util.EnumUtil;
/*
* Smart GWT (GWT for SmartClient)
* Copyright 2008 and beyond, Isomorphic Software, Inc.
*
* Smart GWT is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation. Smart GWT is also
* available under typical commercial license terms - see
* http://smartclient.com/license
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
/**
* The Img widget class implements a simple widget that displays a single image.
*/
@com.vaadin.ui.ClientWidget(org.vaadin.smartgwt.client.VImg.class)
public class Img extends StatefulCanvas {
public Img() {
scClassName = "Img";
}
public Img(String src) {
setSrc(src);
scClassName = "Img";
}
public Img(String src, int width, int height) {
setSrc(src);
setWidth(width);
setHeight(height);
scClassName = "Img";
}
/**
* If specified this property will be included as the <code>alt</code> text for the image HMTL element.
*
* @param altText altText Default value is null
* @see com.smartgwt.client.docs.Accessibility Accessibility overview and related methods
*/
public void setAltText(String altText) {
setAttribute("altText", altText, true);
}
/**
* If specified this property will be included as the <code>alt</code> text for the image HMTL element.
*
*
* @return String
* @see com.smartgwt.client.docs.Accessibility Accessibility overview and related methods
*/
public String getAltText() {
return getAttributeAsString("altText");
}
/**
* Explicit size for the image, for {@link com.smartgwt.client.widgets.Img#getImageType imageType} settings that would
* normally use the image's natural size (applies to {@link com.smartgwt.client.widgets.Img#getImageType imageType}
* "center" and "normal" only).
*
* @param imageHeight imageHeight Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setImageHeight(Integer imageHeight) throws IllegalStateException {
setAttribute("imageHeight", imageHeight, false);
}
/**
* Explicit size for the image, for {@link com.smartgwt.client.widgets.Img#getImageType imageType} settings that would
* normally use the image's natural size (applies to {@link com.smartgwt.client.widgets.Img#getImageType imageType}
* "center" and "normal" only).
*
*
* @return Integer
*/
public Integer getImageHeight() {
return getAttributeAsInt("imageHeight");
}
/**
* Indicates whether the image should be tiled/cropped, stretched, or centered when the size of this widget does
* not match the size of the image. CENTER shows the image in it's natural size, but can't do so while the
* transparency fix is active for IE. The transparency fix can be manually disabled by setting {@link
* com.smartgwt.client.widgets.Img#getUsePNGFix usePNGFix} to false. See ImageStyle for further details.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Change the style of image rendering.
*
* @param imageType new style of image rendering. Default value is Img.STRETCH
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setImageType(ImageStyle imageType) {
setAttribute("imageType", imageType.getValue(), true);
}
/**
* Indicates whether the image should be tiled/cropped, stretched, or centered when the size of this widget does
* not match the size of the image. CENTER shows the image in it's natural size, but can't do so while the
* transparency fix is active for IE. The transparency fix can be manually disabled by setting {@link
* com.smartgwt.client.widgets.Img#getUsePNGFix usePNGFix} to false. See ImageStyle for further details.
*
*
* @return ImageStyle
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public ImageStyle getImageType() {
return EnumUtil.getEnum(ImageStyle.values(), getAttribute("imageType"));
}
/**
* Explicit size for the image, for {@link com.smartgwt.client.widgets.Img#getImageType imageType} settings that would
* normally use the image's natural size (applies to {@link com.smartgwt.client.widgets.Img#getImageType imageType}
* "center" and "normal" only).
*
* @param imageWidth imageWidth Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setImageWidth(Integer imageWidth) throws IllegalStateException {
setAttribute("imageWidth", imageWidth, false);
}
/**
* Explicit size for the image, for {@link com.smartgwt.client.widgets.Img#getImageType imageType} settings that would
* normally use the image's natural size (applies to {@link com.smartgwt.client.widgets.Img#getImageType imageType}
* "center" and "normal" only).
*
*
* @return Integer
*/
public Integer getImageWidth() {
return getAttributeAsInt("imageWidth");
}
/**
* The value of this attribute is specified as the value of the 'name' attribute in the resulting HTML. <p> Note: this
* attribute is ignored if the imageType is set to "tile"
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param name name Default value is "main"
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setName(String name) throws IllegalStateException {
setAttribute("name", name, false);
}
/**
* Determines whether any specified {@link com.smartgwt.client.widgets.StatefulCanvas#getTitle title} will be displayed
* for this component.<br> Applies to Image-based components only, where the title will be rendered out in a label floating
* over the component
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param showTitle showTitle Default value is false
*/
public void setShowTitle(Boolean showTitle) {
setAttribute("showTitle", showTitle, true);
}
/**
* Determines whether any specified {@link com.smartgwt.client.widgets.StatefulCanvas#getTitle title} will be displayed
* for this component.<br> Applies to Image-based components only, where the title will be rendered out in a label floating
* over the component
*
*
* @return Boolean
*/
public Boolean getShowTitle() {
return getAttributeAsBoolean("showTitle");
}
/**
* Convenience for setting height and width to the same value, at init time only
*
* @param size size Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setSize(Integer size) throws IllegalStateException {
setAttribute("size", size, false);
}
/**
* Convenience for setting height and width to the same value, at init time only
*
*
* @return Integer
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public Integer getSize() {
return getAttributeAsInt("size");
}
/**
* The base filename for the image. <P> If <code>img.state</code> is set, it's value will be appended to the URL before the
* file extension. <P> For example, given an <code>src</code> of "findIcon.gif" and a state of "Disabled", the resulting
* image name would be "findIcon_Disabled.gif". Compound states such as "Selected", "Focused" and "Over" or "Down" will
* have an intervening underscore, resulting in, for example, <code>"findIcon_Selected_Down.gif"</code>.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Changes the URL of this image and redraws it. <P> Does nothing if the src has not changed - if <code>src</code> has not changed but other state has changed such that the image needs updating, call {@link com.smartgwt.client.widgets.Img#resetSrc Img.resetSrc} instead.
*
* @param src new URL for the image. Default value is "blank.gif"
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setSrc(String src) {
setAttribute("src", src, true);
}
/**
* The base filename for the image. <P> If <code>img.state</code> is set, it's value will be appended to the URL before the
* file extension. <P> For example, given an <code>src</code> of "findIcon.gif" and a state of "Disabled", the resulting
* image name would be "findIcon_Disabled.gif". Compound states such as "Selected", "Focused" and "Over" or "Down" will
* have an intervening underscore, resulting in, for example, <code>"findIcon_Selected_Down.gif"</code>.
*
*
* @return String
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public String getSrc() {
return getAttributeAsString("src");
}
/**
* If false, never apply the png fix needed in Internet Explorer to make png transparency work correctly.
*
* @param usePNGFix usePNGFix Default value is true
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setUsePNGFix(Boolean usePNGFix) throws IllegalStateException {
setAttribute("usePNGFix", usePNGFix, false);
}
/**
* If false, never apply the png fix needed in Internet Explorer to make png transparency work correctly.
*
*
* @return Boolean
*/
public Boolean getUsePNGFix() {
return getAttributeAsBoolean("usePNGFix");
}
}