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 StretchImg widget class implements a widget type that displays a list of multiple images that make up a single
* image.
*/
public class StretchImg extends StatefulCanvas {
// public static StretchImg getOrCreateRef(JavaScriptObject jsObj) {
// if(jsObj == null) return null;
// BaseWidget obj = BaseWidget.getRef(jsObj);
// if(obj != null) {
// return (StretchImg) obj;
// } else {
// return new StretchImg(jsObj);
// }
// }
public StretchImg(){
scClassName = "StretchImg";
}
// public StretchImg(JavaScriptObject jsObj){
// super(jsObj);
// }
// protected native JavaScriptObject create()/*-{
// var config = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
// var scClassName = this.@com.smartgwt.client.widgets.BaseWidget::scClassName;
// var widget = $wnd.isc[scClassName].create(config);
// this.@com.smartgwt.client.widgets.BaseWidget::doInit()();
// return widget;
// }-*/;
// ********************* Properties / Attributes ***********************
/**
* If the default items are used, capSize is the size in pixels of the first and last images in this stretchImg.
*
* @param capSize capSize Default value is 2
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setCapSize(int capSize) {
setAttribute("capSize", capSize, true);
}
/**
* If the default items are used, capSize is the size in pixels of the first and last images in this stretchImg.
*
*
* @return int
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public int getCapSize() {
return getAttributeAsInt("capSize");
}
/**
* Suffix used the 'grip' image if {@link com.smartgwt.client.widgets.StretchImg#getShowGrip showGrip} is true.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param gripImgSuffix gripImgSuffix Default value is "grip"
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setGripImgSuffix(String gripImgSuffix) throws IllegalStateException {
setAttribute("gripImgSuffix", gripImgSuffix, false);
}
/**
* Suffix used the 'grip' image if {@link com.smartgwt.client.widgets.StretchImg#getShowGrip showGrip} is true.
*
*
* @return String
*/
public String getGripImgSuffix() {
return getAttributeAsString("gripImgSuffix");
}
/**
* Base URL for the image if {@link com.smartgwt.client.widgets.StretchImg#getVertical vertical} is false and {@link
* com.smartgwt.client.widgets.StretchImg#getSrc src} is unset.
*
* @param hSrc hSrc Default value is null
* @see com.smartgwt.client.widgets.StretchImg#setSrc
* @see com.smartgwt.client.widgets.StretchImg#setVSrc
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setHSrc(String hSrc) {
setAttribute("hSrc", hSrc, true);
}
/**
* Base URL for the image if {@link com.smartgwt.client.widgets.StretchImg#getVertical vertical} is false and {@link
* com.smartgwt.client.widgets.StretchImg#getSrc src} is unset.
*
*
* @return String
* @see com.smartgwt.client.widgets.StretchImg#getSrc
* @see com.smartgwt.client.widgets.StretchImg#getVSrc
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public String getHSrc() {
return getAttributeAsString("hSrc");
}
/**
* 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. See ImageStyle for details.
*
* @param imageType imageType 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. See ImageStyle for details.
*
*
* @return ImageStyle
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public ImageStyle getImageType() {
return EnumUtil.getEnum(ImageStyle.values(), getAttribute("imageType"));
}
/**
* If specified this css class will be applied to the individual item images within this StretchImg. May be overridden by
* specifying item-specific base styles to each object in the {@link com.smartgwt.client.widgets.StretchImg#getItems items
* array}. This base style will have standard stateful suffixes appended to indicate the state of this component (as
* described in {@link com.smartgwt.client.widgets.StatefulCanvas#getBaseStyle baseStyle}).
*
* @param itemBaseStyle itemBaseStyle Default value is null
*/
public void setItemBaseStyle(String itemBaseStyle) {
setAttribute("itemBaseStyle", itemBaseStyle, true);
}
/**
* If specified this css class will be applied to the individual item images within this StretchImg. May be overridden by
* specifying item-specific base styles to each object in the {@link com.smartgwt.client.widgets.StretchImg#getItems items
* array}. This base style will have standard stateful suffixes appended to indicate the state of this component (as
* described in {@link com.smartgwt.client.widgets.StatefulCanvas#getBaseStyle baseStyle}).
*
*
* @return String
*/
public String getItemBaseStyle() {
return getAttributeAsString("itemBaseStyle");
}
/**
* If {@link com.smartgwt.client.widgets.StretchImg#getShowGrip showGrip} is true, this property determines whether to show
* the 'Down' state on the grip image when the user mousedown's on this widget. Has no effect if {@link
* com.smartgwt.client.widgets.StatefulCanvas#getShowDown showDown} is false.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param showDownGrip showDownGrip Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setShowDownGrip(Boolean showDownGrip) throws IllegalStateException {
setAttribute("showDownGrip", showDownGrip, false);
}
/**
* If {@link com.smartgwt.client.widgets.StretchImg#getShowGrip showGrip} is true, this property determines whether to show
* the 'Down' state on the grip image when the user mousedown's on this widget. Has no effect if {@link
* com.smartgwt.client.widgets.StatefulCanvas#getShowDown showDown} is false.
*
*
* @return Boolean
*/
public Boolean getShowDownGrip() {
return getAttributeAsBoolean("showDownGrip");
}
/**
* Should we show a "grip" image floating above the center of this widget?
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param showGrip showGrip Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setShowGrip(Boolean showGrip) throws IllegalStateException {
setAttribute("showGrip", showGrip, false);
}
/**
* Should we show a "grip" image floating above the center of this widget?
*
*
* @return Boolean
*/
public Boolean getShowGrip() {
return getAttributeAsBoolean("showGrip");
}
/**
* If {@link com.smartgwt.client.widgets.StretchImg#getShowGrip showGrip} is true, this property determines whether to show
* the 'Over' state on the grip image when the user rolls over on this widget. Has no effect if {@link
* com.smartgwt.client.widgets.StatefulCanvas#getShowRollOver showRollOver} is false.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param showRollOverGrip showRollOverGrip Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setShowRollOverGrip(Boolean showRollOverGrip) throws IllegalStateException {
setAttribute("showRollOverGrip", showRollOverGrip, false);
}
/**
* If {@link com.smartgwt.client.widgets.StretchImg#getShowGrip showGrip} is true, this property determines whether to show
* the 'Over' state on the grip image when the user rolls over on this widget. Has no effect if {@link
* com.smartgwt.client.widgets.StatefulCanvas#getShowRollOver showRollOver} is false.
*
*
* @return Boolean
*/
public Boolean getShowRollOverGrip() {
return getAttributeAsBoolean("showRollOverGrip");
}
/**
* 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");
}
/**
* The base URL for the image. <P> As with {@link com.smartgwt.client.widgets.Img#getSrc src}, the {@link
* com.smartgwt.client.types.State} of the component is added to this URL. Then, the image segment name as specified by
* {@link com.smartgwt.client.widgets.StretchImg#getItems items} is added. <P> For example, for a stretchImg in "Over"
* state with a <code>src</code> of "button.png" and a segment name of "stretch", the resulting URL would be
* "button_Over_stretch.png".
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Changes the base {@link com.smartgwt.client.widgets.StretchImg#getSrc src} for this stretchImg, redrawing if necessary.
*
* @param src new URL for the image. Default value is null
* @see com.smartgwt.client.widgets.StretchImg#setHSrc
* @see com.smartgwt.client.widgets.StretchImg#setVSrc
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setSrc(String src) {
setAttribute("src", src, true);
}
/**
* The base URL for the image. <P> As with {@link com.smartgwt.client.widgets.Img#getSrc src}, the {@link
* com.smartgwt.client.types.State} of the component is added to this URL. Then, the image segment name as specified by
* {@link com.smartgwt.client.widgets.StretchImg#getItems items} is added. <P> For example, for a stretchImg in "Over"
* state with a <code>src</code> of "button.png" and a segment name of "stretch", the resulting URL would be
* "button_Over_stretch.png".
*
*
* @return String
* @see com.smartgwt.client.widgets.StretchImg#getHSrc
* @see com.smartgwt.client.widgets.StretchImg#getVSrc
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public String getSrc() {
return getAttributeAsString("src");
}
/**
* Indicates whether the list of images is drawn vertically from top to bottom (true), or horizontally from left to right
* (false).
*
* @param vertical vertical Default value is true
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setVertical(Boolean vertical) {
setAttribute("vertical", vertical, true);
}
/**
* Indicates whether the list of images is drawn vertically from top to bottom (true), or horizontally from left to right
* (false).
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public Boolean getVertical() {
return getAttributeAsBoolean("vertical");
}
/**
* Base URL for the image if {@link com.smartgwt.client.widgets.StretchImg#getVertical vertical} is true and {@link
* com.smartgwt.client.widgets.StretchImg#getSrc src} is unset.
*
* @param vSrc vSrc Default value is null
* @see com.smartgwt.client.widgets.StretchImg#setSrc
* @see com.smartgwt.client.widgets.StretchImg#setVSrc
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setVSrc(String vSrc) {
setAttribute("vSrc", vSrc, true);
}
/**
* Base URL for the image if {@link com.smartgwt.client.widgets.StretchImg#getVertical vertical} is true and {@link
* com.smartgwt.client.widgets.StretchImg#getSrc src} is unset.
*
*
* @return String
* @see com.smartgwt.client.widgets.StretchImg#getSrc
* @see com.smartgwt.client.widgets.StretchImg#getVSrc
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public String getVSrc() {
return getAttributeAsString("vSrc");
}
// ********************* Methods ***********************
// /**
// * Set the specified image's state to newState and update the displayed image given by whichPart, or set the state for all
// * images to newState and update the displayed images if whichPart is not provided.
// * @param newState name for the new state ("off", "down", etc)
// */
// public native void setState(String newState) /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// self.setState(newState);
// }-*/;
//
// /**
// * Set the specified image's state to newState and update the displayed image given by whichPart, or set the state for all
// * images to newState and update the displayed images if whichPart is not provided.
// * @param newState name for the new state ("off", "down", etc)
// * @param whichPart name of the piece to set ("start", "stretch" or "end") if not specified, sets them all
// * @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
// */
// public native void setState(String newState, String whichPart) /*-{
// var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
// self.setState(newState, whichPart);
// }-*/;
//
// // ********************* Static Methods ***********************
// /**
// * Class level method to set the default properties of this class. If set, then all subsequent instances of this
// * class will automatically have the default properties that were set when this method was called. This is a powerful
// * feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default
// * properties of this class. Can also be used for skinning / styling purposes.
// * <P>
// * <b>Note:</b> This method is intended for setting default attributes only and will effect all instances of the
// * underlying class (including those automatically generated in JavaScript).
// * This method should not be used to apply standard EventHandlers or override methods for
// * a class - use a custom subclass instead.
// *
// * @param stretchImgProperties properties that should be used as new defaults when instances of this class are created
// */
// public static native void setDefaultProperties(StretchImg stretchImgProperties) /*-{
// var properties = $wnd.isc.addProperties({},stretchImgProperties.@com.smartgwt.client.widgets.BaseWidget::getConfig()());
// delete properties.ID;
// $wnd.isc.StretchImg.addProperties(properties);
// }-*/;
// ***********************************************************
}