/*
* 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.
*/
package com.smartgwt.client.widgets;
import com.smartgwt.client.event.*;
import com.smartgwt.client.core.*;
import com.smartgwt.client.types.*;
import com.smartgwt.client.data.*;
import com.smartgwt.client.data.events.*;
import com.smartgwt.client.rpc.*;
import com.smartgwt.client.widgets.*;
import com.smartgwt.client.widgets.events.*;
import com.smartgwt.client.widgets.form.*;
import com.smartgwt.client.widgets.form.validator.*;
import com.smartgwt.client.widgets.form.fields.*;
import com.smartgwt.client.widgets.tile.*;
import com.smartgwt.client.widgets.tile.events.*;
import com.smartgwt.client.widgets.grid.*;
import com.smartgwt.client.widgets.grid.events.*;
import com.smartgwt.client.widgets.chart.*;
import com.smartgwt.client.widgets.layout.*;
import com.smartgwt.client.widgets.layout.events.*;
import com.smartgwt.client.widgets.menu.*;
import com.smartgwt.client.widgets.tab.*;
import com.smartgwt.client.widgets.toolbar.*;
import com.smartgwt.client.widgets.tree.*;
import com.smartgwt.client.widgets.tree.events.*;
import com.smartgwt.client.widgets.viewer.*;
import com.smartgwt.client.widgets.calendar.*;
import com.smartgwt.client.widgets.calendar.events.*;
import com.smartgwt.client.widgets.cube.*;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.HashMap;
import com.google.gwt.user.client.ui.Widget;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.user.client.Element;
import com.smartgwt.client.util.*;
import com.google.gwt.event.shared.*;
import com.google.gwt.event.shared.HasHandlers;
/**
* Canvas is the base abstraction for cross-browser DHTML drawing. All DHTML widgets inherit from the Canvas class.
*/
public class Canvas extends BaseWidget implements com.smartgwt.client.widgets.events.HasDropHandlers, com.smartgwt.client.widgets.events.HasResizedHandlers, com.smartgwt.client.widgets.events.HasClickHandlers, com.smartgwt.client.widgets.events.HasDoubleClickHandlers, com.smartgwt.client.widgets.events.HasDragMoveHandlers, com.smartgwt.client.widgets.events.HasDragRepositionMoveHandlers, com.smartgwt.client.widgets.events.HasDragRepositionStartHandlers, com.smartgwt.client.widgets.events.HasDragRepositionStopHandlers, com.smartgwt.client.widgets.events.HasDragResizeMoveHandlers, com.smartgwt.client.widgets.events.HasDragResizeStartHandlers, com.smartgwt.client.widgets.events.HasDragResizeStopHandlers, com.smartgwt.client.widgets.events.HasDragStartHandlers, com.smartgwt.client.widgets.events.HasDragStopHandlers, com.smartgwt.client.widgets.events.HasDropMoveHandlers, com.smartgwt.client.widgets.events.HasDropOutHandlers, com.smartgwt.client.widgets.events.HasDropOverHandlers, com.smartgwt.client.widgets.events.HasMouseDownHandlers, com.smartgwt.client.widgets.events.HasMouseUpHandlers, com.smartgwt.client.widgets.events.HasMouseMoveHandlers, com.smartgwt.client.widgets.events.HasMouseOutHandlers, com.smartgwt.client.widgets.events.HasMouseOverHandlers, com.smartgwt.client.widgets.events.HasMouseStillDownHandlers, com.smartgwt.client.widgets.events.HasMouseWheelHandlers, com.smartgwt.client.widgets.events.HasKeyPressHandlers, com.smartgwt.client.widgets.events.HasKeyDownHandlers, com.smartgwt.client.widgets.events.HasRightMouseDownHandlers, com.smartgwt.client.widgets.events.HasHoverHandlers, com.smartgwt.client.widgets.events.HasHoverHiddenHandlers, com.smartgwt.client.widgets.events.HasScrolledHandlers, com.smartgwt.client.widgets.events.HasMovedHandlers, com.smartgwt.client.widgets.events.HasParentMovedHandlers, com.smartgwt.client.widgets.events.HasFocusChangedHandlers, com.smartgwt.client.widgets.events.HasShowContextMenuHandlers, com.smartgwt.client.widgets.events.HasVisibilityChangedHandlers {
public static Canvas getOrCreateRef(JavaScriptObject jsObj) {
if(jsObj == null) return null;
BaseWidget obj = BaseWidget.getRef(jsObj);
if(obj != null) {
return (Canvas) obj;
} else {
return new Canvas(jsObj);
}
}
public Canvas(){
scClassName = "Canvas";
}
public Canvas(JavaScriptObject jsObj){
super(jsObj);
}
public Canvas(String id) {
super(id);
scClassName = "Canvas";
}
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 specified this governs the accessKey for the widget. This should be set to a character - when a user hits
* Alt+[accessKey], or in Mozilla Firefox 2.0 and above, Shift+Alt+[accessKey], focus will be given to the widget in
* question.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the accessKey for this canvas. <P> The accessKey can be set to any alphanumeric character (symbols not supported) Having set an accessKey, the canvas will be given focus when the user hits Alt+[accessKey], or in Mozilla Firefox 2.0 and above, Shift+Alt+[accessKey].
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param accessKey Character to use as an accessKey for this widget. Case Insensitive.. Default value is null
* @see com.smartgwt.client.docs.Focus Focus overview and related methods
*/
public void setAccessKey(String accessKey) {
setAttribute("accessKey", accessKey, true);
}
/**
* If specified this governs the accessKey for the widget. This should be set to a character - when a user hits
* Alt+[accessKey], or in Mozilla Firefox 2.0 and above, Shift+Alt+[accessKey], focus will be given to the widget in
* question.
*
*
* @return String
* @see com.smartgwt.client.docs.Focus Focus overview and related methods
*/
public String getAccessKey() {
return getAttributeAsString("accessKey");
}
/**
* Default acceleration effect to apply to all animations on this Canvas. Can be overridden by setting
* animationAcceleration for specific animations or by passing an acceleration function directly into the appropriate
* method.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateAcceleration animateAcceleration Default value is "smoothEnd"
*/
public void setAnimateAcceleration(AnimationAcceleration animateAcceleration) {
setAttribute("animateAcceleration", animateAcceleration == null ? null : animateAcceleration.getValue(), true);
}
/**
* Default acceleration effect to apply to all animations on this Canvas. Can be overridden by setting
* animationAcceleration for specific animations or by passing an acceleration function directly into the appropriate
* method.
*
*
* @return AnimationAcceleration
*/
public AnimationAcceleration getAnimateAcceleration() {
return EnumUtil.getEnum(AnimationAcceleration.values(), getAttribute("animateAcceleration"));
}
/**
* Default time for performing an animated fade. If unset, <code>this.animateTime</code> will be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateFadeTime animateFadeTime Default value is null
*/
public void setAnimateFadeTime(Integer animateFadeTime) {
setAttribute("animateFadeTime", animateFadeTime, true);
}
/**
* Default time for performing an animated fade. If unset, <code>this.animateTime</code> will be used by default instead
*
*
* @return Integer
*/
public Integer getAnimateFadeTime() {
return getAttributeAsInt("animateFadeTime");
}
/**
* Default acceleration function for performing an animated hide. If unset, <code>this.animateAcceleration</code> will be
* used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateHideAcceleration animateHideAcceleration Default value is null
*/
public void setAnimateHideAcceleration(AnimationAcceleration animateHideAcceleration) {
setAttribute("animateHideAcceleration", animateHideAcceleration == null ? null : animateHideAcceleration.getValue(), true);
}
/**
* Default acceleration function for performing an animated hide. If unset, <code>this.animateAcceleration</code> will be
* used by default instead
*
*
* @return AnimationAcceleration
*/
public AnimationAcceleration getAnimateHideAcceleration() {
return EnumUtil.getEnum(AnimationAcceleration.values(), getAttribute("animateHideAcceleration"));
}
/**
* Default time for performing an animated hide. If unset, <code>this.animateTime</code> will be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateHideTime animateHideTime Default value is null
*/
public void setAnimateHideTime(Integer animateHideTime) {
setAttribute("animateHideTime", animateHideTime, true);
}
/**
* Default time for performing an animated hide. If unset, <code>this.animateTime</code> will be used by default instead
*
*
* @return Integer
*/
public Integer getAnimateHideTime() {
return getAttributeAsInt("animateHideTime");
}
/**
* Default acceleration effect for performing an animated move. If unset, <code>this.animateAcceleration</code> will be
* used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateMoveAcceleration animateMoveAcceleration Default value is null
*/
public void setAnimateMoveAcceleration(AnimationAcceleration animateMoveAcceleration) {
setAttribute("animateMoveAcceleration", animateMoveAcceleration == null ? null : animateMoveAcceleration.getValue(), true);
}
/**
* Default acceleration effect for performing an animated move. If unset, <code>this.animateAcceleration</code> will be
* used by default instead
*
*
* @return AnimationAcceleration
*/
public AnimationAcceleration getAnimateMoveAcceleration() {
return EnumUtil.getEnum(AnimationAcceleration.values(), getAttribute("animateMoveAcceleration"));
}
/**
* Default time for performing an animated move. If unset, <code>this.animateTime</code> will be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateMoveTime animateMoveTime Default value is null
*/
public void setAnimateMoveTime(Integer animateMoveTime) {
setAttribute("animateMoveTime", animateMoveTime, true);
}
/**
* Default time for performing an animated move. If unset, <code>this.animateTime</code> will be used by default instead
*
*
* @return Integer
*/
public Integer getAnimateMoveTime() {
return getAttributeAsInt("animateMoveTime");
}
/**
* Default acceleration function for performing an animated move and resize. If unset,
* <code>this.animateAcceleration</code> will be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateRectAcceleration animateRectAcceleration Default value is null
*/
public void setAnimateRectAcceleration(AnimationAcceleration animateRectAcceleration) {
setAttribute("animateRectAcceleration", animateRectAcceleration == null ? null : animateRectAcceleration.getValue(), true);
}
/**
* Default acceleration function for performing an animated move and resize. If unset,
* <code>this.animateAcceleration</code> will be used by default instead
*
*
* @return AnimationAcceleration
*/
public AnimationAcceleration getAnimateRectAcceleration() {
return EnumUtil.getEnum(AnimationAcceleration.values(), getAttribute("animateRectAcceleration"));
}
/**
* Default time for performing an animated setRect. If unset, <code>this.animateTime</code> will be used by default
* instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateRectTime animateRectTime Default value is null
*/
public void setAnimateRectTime(Integer animateRectTime) {
setAttribute("animateRectTime", animateRectTime, true);
}
/**
* Default time for performing an animated setRect. If unset, <code>this.animateTime</code> will be used by default
* instead
*
*
* @return Integer
*/
public Integer getAnimateRectTime() {
return getAttributeAsInt("animateRectTime");
}
/**
* Default acceleration function for performing an animated resize. If unset, <code>this.animateAcceleration</code> will
* be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateResizeAcceleration animateResizeAcceleration Default value is null
*/
public void setAnimateResizeAcceleration(AnimationAcceleration animateResizeAcceleration) {
setAttribute("animateResizeAcceleration", animateResizeAcceleration == null ? null : animateResizeAcceleration.getValue(), true);
}
/**
* Default acceleration function for performing an animated resize. If unset, <code>this.animateAcceleration</code> will
* be used by default instead
*
*
* @return AnimationAcceleration
*/
public AnimationAcceleration getAnimateResizeAcceleration() {
return EnumUtil.getEnum(AnimationAcceleration.values(), getAttribute("animateResizeAcceleration"));
}
/**
* Default time for performing an animated resize. If unset, <code>this.animateTime</code> will be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateResizeTime animateResizeTime Default value is null
*/
public void setAnimateResizeTime(Integer animateResizeTime) {
setAttribute("animateResizeTime", animateResizeTime, true);
}
/**
* Default time for performing an animated resize. If unset, <code>this.animateTime</code> will be used by default instead
*
*
* @return Integer
*/
public Integer getAnimateResizeTime() {
return getAttributeAsInt("animateResizeTime");
}
/**
* Default acceleration function for performing an animated scroll. If unset, <code>this.animateAcceleration</code> will
* be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateScrollAcceleration animateScrollAcceleration Default value is null
*/
public void setAnimateScrollAcceleration(AnimationAcceleration animateScrollAcceleration) {
setAttribute("animateScrollAcceleration", animateScrollAcceleration == null ? null : animateScrollAcceleration.getValue(), true);
}
/**
* Default acceleration function for performing an animated scroll. If unset, <code>this.animateAcceleration</code> will
* be used by default instead
*
*
* @return AnimationAcceleration
*/
public AnimationAcceleration getAnimateScrollAcceleration() {
return EnumUtil.getEnum(AnimationAcceleration.values(), getAttribute("animateScrollAcceleration"));
}
/**
* Default time for performing an animated scroll. If unset, <code>this.animateTime</code> will be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateScrollTime animateScrollTime Default value is null
*/
public void setAnimateScrollTime(Integer animateScrollTime) {
setAttribute("animateScrollTime", animateScrollTime, true);
}
/**
* Default time for performing an animated scroll. If unset, <code>this.animateTime</code> will be used by default instead
*
*
* @return Integer
*/
public Integer getAnimateScrollTime() {
return getAttributeAsInt("animateScrollTime");
}
/**
* Default acceleration function for performing an animated show. If unset, <code>this.animateAcceleration</code> will be
* used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateShowAcceleration animateShowAcceleration Default value is null
*/
public void setAnimateShowAcceleration(AnimationAcceleration animateShowAcceleration) {
setAttribute("animateShowAcceleration", animateShowAcceleration == null ? null : animateShowAcceleration.getValue(), true);
}
/**
* Default acceleration function for performing an animated show. If unset, <code>this.animateAcceleration</code> will be
* used by default instead
*
*
* @return AnimationAcceleration
*/
public AnimationAcceleration getAnimateShowAcceleration() {
return EnumUtil.getEnum(AnimationAcceleration.values(), getAttribute("animateShowAcceleration"));
}
/**
* Default time for performing an animated show. If unset, <code>this.animateTime</code> will be used by default instead
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateShowTime animateShowTime Default value is null
*/
public void setAnimateShowTime(Integer animateShowTime) {
setAttribute("animateShowTime", animateShowTime, true);
}
/**
* Default time for performing an animated show. If unset, <code>this.animateTime</code> will be used by default instead
*
*
* @return Integer
*/
public Integer getAnimateShowTime() {
return getAttributeAsInt("animateShowTime");
}
/**
* Default total duration of animations. Can be overridden by setting animation times for specific animations, or by
* passing a <code>duration</code> parameter into the appropriate animate...() method.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param animateTime animateTime Default value is 300
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_animation_move" target="examples">Fly Onscreen Example</a>
*/
public void setAnimateTime(int animateTime) {
setAttribute("animateTime", animateTime, true);
}
/**
* Default total duration of animations. Can be overridden by setting animation times for specific animations, or by
* passing a <code>duration</code> parameter into the appropriate animate...() method.
*
*
* @return int
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_animation_move" target="examples">Fly Onscreen Example</a>
*/
public int getAnimateTime() {
return getAttributeAsInt("animateTime");
}
/**
* Default directory for app-specific images, relative to the Page-wide {@link com.smartgwt.client.util.Page#getAppImgDir
* appImgDir}.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param appImgDir appImgDir Default value is ""
* @see com.smartgwt.client.docs.Images Images overview and related methods
*/
public void setAppImgDir(String appImgDir) {
setAttribute("appImgDir", appImgDir, true);
}
/**
* Default directory for app-specific images, relative to the Page-wide {@link com.smartgwt.client.util.Page#getAppImgDir
* appImgDir}.
*
*
* @return String
* @see com.smartgwt.client.docs.Images Images overview and related methods
*/
public String getAppImgDir() {
return getAttributeAsString("appImgDir");
}
/**
* ARIA role of this component. Usually does not need to be manually set - see accessibility.
*
* @param ariaRole ariaRole Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setAriaRole(String ariaRole) throws IllegalStateException {
setAttribute("ariaRole", ariaRole, false);
}
/**
* ARIA role of this component. Usually does not need to be manually set - see accessibility.
*
*
* @return String
*/
public String getAriaRole() {
return getAttributeAsString("ariaRole");
}
/**
* If true, this canvas will draw itself immediately after it is created.
* <P>
* <b>Note</b> that you should turn this OFF for any canvases that are provided as children
* of other canvases, or they will draw initially, then be clear()ed and drawn again when
* added as children, causing a large performance penalty.
* <P>
* For example, the following code is incorrect and will cause extra draw()s:
* <P>
* <pre>
* isc.Layout.create({
* members : [
* isc.ListGrid.create()
* ]
* });
* </pre>
* It should instead be:
* <pre>
* isc.Layout.create({
* members : [
* isc.ListGrid.create(<b>{ autoDraw: false }</b>)
* ]
* });
* </pre>
* In order to avoid unwanted autoDrawing systematically, it is recommend that you call
* {@link com.smartgwt.client.util.isc#setAutoDraw isc.setAutoDraw(false)} immediately after Smart GWT is loaded
* and before any components are created, then set <code>autoDraw:true</code> or call
* draw() explicitly to draw components.
* <P>
* Otherwise, if the global setting for autoDraw remains <code>true</code>, you must set
* autoDraw:false, as shown above, on every component in your application that
* should not immediately draw: all Canvas children, Layout members, Window items, Tab
* panes, etc, however deeply nested. Forgetting to set autoDraw:false will result in one
* more clear()s - these are reported on the Results tab of the
* {@link com.smartgwt.client.docs.Debugging Developer Console}, and can be tracked to individual components by
* using the "clears" log category in the Developer Console.
*
* @param autoDraw autoDraw Default value is true
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.Drawing Drawing overview and related methods
*
*/
public void setAutoDraw(Boolean autoDraw) throws IllegalStateException {
setAttribute("autoDraw", autoDraw, false);
}
/**
* If true, this canvas will draw itself immediately after it is created.
* <P>
* <b>Note</b> that you should turn this OFF for any canvases that are provided as children
* of other canvases, or they will draw initially, then be clear()ed and drawn again when
* added as children, causing a large performance penalty.
* <P>
* For example, the following code is incorrect and will cause extra draw()s:
* <P>
* <pre>
* isc.Layout.create({
* members : [
* isc.ListGrid.create()
* ]
* });
* </pre>
* It should instead be:
* <pre>
* isc.Layout.create({
* members : [
* isc.ListGrid.create(<b>{ autoDraw: false }</b>)
* ]
* });
* </pre>
* In order to avoid unwanted autoDrawing systematically, it is recommend that you call
* {@link com.smartgwt.client.util.isc#setAutoDraw isc.setAutoDraw(false)} immediately after Smart GWT is loaded
* and before any components are created, then set <code>autoDraw:true</code> or call
* draw() explicitly to draw components.
* <P>
* Otherwise, if the global setting for autoDraw remains <code>true</code>, you must set
* autoDraw:false, as shown above, on every component in your application that
* should not immediately draw: all Canvas children, Layout members, Window items, Tab
* panes, etc, however deeply nested. Forgetting to set autoDraw:false will result in one
* more clear()s - these are reported on the Results tab of the
* {@link com.smartgwt.client.docs.Debugging Developer Console}, and can be tracked to individual components by
* using the "clears" log category in the Developer Console.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Drawing Drawing overview and related methods
*
*/
public Boolean getAutoDraw() {
return getAttributeAsBoolean("autoDraw");
}
/**
* If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param autoShowParent autoShowParent Default value is false
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setAutoShowParent(Boolean autoShowParent) {
setAttribute("autoShowParent", autoShowParent, true);
}
/**
* If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public Boolean getAutoShowParent() {
return getAttributeAsBoolean("autoShowParent");
}
/**
* The background color for this widget. It corresponds to the CSS background-color attribute. You can set this property to
* an RGB value (e.g. #22AAFF) or a named color (e.g. red) from a list of browser supported color names.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Sets the background color of this widget to newColor.
*
* @param backgroundColor new color to set the widget's background to. Default value is null
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setBackgroundColor(String backgroundColor) {
setAttribute("backgroundColor", backgroundColor, true);
}
/**
* The background color for this widget. It corresponds to the CSS background-color attribute. You can set this property to
* an RGB value (e.g. #22AAFF) or a named color (e.g. red) from a list of browser supported color names.
*
*
* @return String
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public String getBackgroundColor() {
return getAttributeAsString("backgroundColor");
}
/**
* URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Sets the background to an image file given by newImage. This URL should be given as a string relative to the image directory for the page (./images by default).
*
* @param backgroundImage new URL (local to Page image directory) for background image. Default value is null
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setBackgroundImage(String backgroundImage) {
setAttribute("backgroundImage", backgroundImage, true);
}
/**
* URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
*
*
* @return String
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public String getBackgroundImage() {
return getAttributeAsString("backgroundImage");
}
/**
* Specifies how the background image should be positioned on the widget. It corresponds to the CSS
* background-position attribute. If unset, no background-position attribute is specified if a background image is
* specified.
*
* @param backgroundPosition backgroundPosition Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setBackgroundPosition(String backgroundPosition) throws IllegalStateException {
setAttribute("backgroundPosition", backgroundPosition, false);
}
/**
* Specifies how the background image should be positioned on the widget. It corresponds to the CSS
* background-position attribute. If unset, no background-position attribute is specified if a background image is
* specified.
*
*
* @return String
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public String getBackgroundPosition() {
return getAttributeAsString("backgroundPosition");
}
/**
* Specifies how the background image should be tiled if this widget is larger than the image. It corresponds to the
* CSS background-repeat attribute. See BkgndRepeat type for details.
*
* @param backgroundRepeat backgroundRepeat Default value is Canvas.REPEAT
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setBackgroundRepeat(BkgndRepeat backgroundRepeat) throws IllegalStateException {
setAttribute("backgroundRepeat", backgroundRepeat == null ? null : backgroundRepeat.getValue(), false);
}
/**
* Specifies how the background image should be tiled if this widget is larger than the image. It corresponds to the
* CSS background-repeat attribute. See BkgndRepeat type for details.
*
*
* @return BkgndRepeat
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public BkgndRepeat getBackgroundRepeat() {
return EnumUtil.getEnum(BkgndRepeat.values(), getAttribute("backgroundRepeat"));
}
/**
* Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid
* blue"). <P> This property applies the same border to all four sides of this component. Different per-side borders can
* be set in a CSS style and applied via {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid blue"). <P> This property applies the same border to all four sides of this component. Different per-side borders can be set in a CSS style and applied via {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}.
*
* @param border new border to set to (eg: "2px solid black"). Default value is null
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setBorder(String border) {
setAttribute("border", border, true);
}
/**
* Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid
* blue"). <P> This property applies the same border to all four sides of this component. Different per-side borders can
* be set in a CSS style and applied via {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}.
*
*
* @return String
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public String getBorder() {
return getAttributeAsString("border");
}
/**
* Indicates that this object can receive dropped widgets (i.e. other widgets can be dropped on top of it).
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canAcceptDrop canAcceptDrop Default value is false
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_create" target="examples">Drag create Example</a>
*/
public void setCanAcceptDrop(Boolean canAcceptDrop) {
setAttribute("canAcceptDrop", canAcceptDrop, true);
}
/**
* Indicates that this object can receive dropped widgets (i.e. other widgets can be dropped on top of it).
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_create" target="examples">Drag create Example</a>
*/
public Boolean getCanAcceptDrop() {
return getAttributeAsBoolean("canAcceptDrop");
}
/**
* Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize).
* Normally canDragReposition or canDragResize would be used instead of this property. Note: this property may be
* manipulated by higher-level dragging semantics.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canDrag canDrag Default value is false
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_create" target="examples">Drag create Example</a>
*/
public void setCanDrag(Boolean canDrag) {
setAttribute("canDrag", canDrag, true);
}
/**
* Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize).
* Normally canDragReposition or canDragResize would be used instead of this property. Note: this property may be
* manipulated by higher-level dragging semantics.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_create" target="examples">Drag create Example</a>
*/
public Boolean getCanDrag() {
return getAttributeAsBoolean("canDrag");
}
/**
* Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canDragReposition canDragReposition Default value is false
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_effects" target="examples">Drag effects Example</a>
*/
public void setCanDragReposition(Boolean canDragReposition) {
setAttribute("canDragReposition", canDragReposition, true);
}
/**
* Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_effects" target="examples">Drag effects Example</a>
*/
public Boolean getCanDragReposition() {
return getAttributeAsBoolean("canDragReposition");
}
/**
* Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canDragResize canDragResize Default value is false
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_resize" target="examples">Drag resize Example</a>
*/
public void setCanDragResize(Boolean canDragResize) {
setAttribute("canDragResize", canDragResize, true);
}
/**
* Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_resize" target="examples">Drag resize Example</a>
*/
public Boolean getCanDragResize() {
return getAttributeAsBoolean("canDragResize");
}
/**
* If this Canvas is canAcceptDrop:true, when the user drags a droppable widget over an edge of the widget, should we
* scroll to show the rest of the widget's content? Returned from canvas.shouldDragScroll().
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canDragScroll canDragScroll Default value is true
* @see com.smartgwt.client.widgets.Canvas#shouldDragScroll
*/
public void setCanDragScroll(Boolean canDragScroll) {
setAttribute("canDragScroll", canDragScroll, true);
}
/**
* If this Canvas is canAcceptDrop:true, when the user drags a droppable widget over an edge of the widget, should we
* scroll to show the rest of the widget's content? Returned from canvas.shouldDragScroll().
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#shouldDragScroll
*/
public Boolean getCanDragScroll() {
return getAttributeAsBoolean("canDragScroll");
}
/**
* Indicates that this object can be dropped on top of other widgets. Only valid if canDrag or canDragReposition is
* true.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canDrop canDrop Default value is false
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_create" target="examples">Drag create Example</a>
*/
public void setCanDrop(Boolean canDrop) {
setAttribute("canDrop", canDrop, true);
}
/**
* Indicates that this object can be dropped on top of other widgets. Only valid if canDrag or canDragReposition is
* true.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_create" target="examples">Drag create Example</a>
*/
public Boolean getCanDrop() {
return getAttributeAsBoolean("canDrop");
}
/**
* When explicitly set to false, disallows drop before this member in the Layout.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canDropBefore canDropBefore Default value is null
* @see com.smartgwt.client.widgets.layout.Layout
* @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods
*/
public void setCanDropBefore(Boolean canDropBefore) {
setAttribute("canDropBefore", canDropBefore, true);
}
/**
* When explicitly set to false, disallows drop before this member in the Layout.
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.layout.Layout
* @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods
*/
public Boolean getCanDropBefore() {
return getAttributeAsBoolean("canDropBefore");
}
/**
* Can this widget be allowed to become the target of keyboard events? <P> If canFocus is unset (the default), only
* scrollable widgets with visible scrollbars are focusable, to allow for keyboard scrolling. <P> A widget normally
* receives focus by being clicked on or tabbed to.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Change whether a widget can accept keyboard focus.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canFocus whether the widget should now accept focus. Default value is null
* @see com.smartgwt.client.docs.Focus Focus overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_focus_tabbing" target="examples">Focus & Tabbing Example</a>
*/
public void setCanFocus(Boolean canFocus) {
setAttribute("canFocus", canFocus, true);
}
/**
* Can this widget be allowed to become the target of keyboard events? <P> If canFocus is unset (the default), only
* scrollable widgets with visible scrollbars are focusable, to allow for keyboard scrolling. <P> A widget normally
* receives focus by being clicked on or tabbed to.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Focus Focus overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_focus_tabbing" target="examples">Focus & Tabbing Example</a>
*/
public Boolean getCanFocus() {
return getAttributeAsBoolean("canFocus");
}
/**
* Will this Canvas fire hover events when the user hovers over it, or one of its children?
*
* @param canHover canHover Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
* @see com.smartgwt.client.widgets.events.HoverEvent
*/
public void setCanHover(Boolean canHover) {
setAttribute("canHover", canHover, true);
}
/**
* Will this Canvas fire hover events when the user hovers over it, or one of its children?
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getShowHover
* @see com.smartgwt.client.widgets.events.HoverEvent
*/
public Boolean getCanHover() {
return getAttributeAsBoolean("canHover");
}
/**
* Whether native drag selection of contained text is allowed within this Canvas. <P> Note that setting this property to
* <code>false</code> will not avoid text selection which is initiated outside this Canvas from continuing into this
* Canvas, even if text selection began in another Canvas.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param canSelectText canSelectText Default value is false
*/
public void setCanSelectText(Boolean canSelectText) {
setAttribute("canSelectText", canSelectText, true);
}
/**
* Whether native drag selection of contained text is allowed within this Canvas. <P> Note that setting this property to
* <code>false</code> will not avoid text selection which is initiated outside this Canvas from continuing into this
* Canvas, even if text selection began in another Canvas.
*
*
* @return Boolean
*/
public Boolean getCanSelectText() {
return getAttributeAsBoolean("canSelectText");
}
/**
* If this canvas is being displayed in a {@link com.smartgwt.client.widgets.form.fields.CanvasItem}, this property will be
* set to point at the item. Otherwise this property will be null.
*
* @param canvasItem canvasItem Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setCanvasItem(CanvasItem canvasItem) throws IllegalStateException {
setAttribute("canvasItem", canvasItem.getJsObj(), false);
}
/**
* If this canvas is being displayed in a {@link com.smartgwt.client.widgets.form.fields.CanvasItem}, this property will be
* set to point at the item. Otherwise this property will be null.
*
*
* @return CanvasItem
*/
public CanvasItem getCanvasItem() {
return CanvasItem.getOrCreateRef(getAttributeAsJavaScriptObject("canvasItem"));
}
/**
* If true, causes this canvas's children to snap to its grid when resizing. This behavior can be overridden on a per-child
* basis by setting the {@link com.smartgwt.client.widgets.Canvas#getSnapToGrid snapToGrid} or {@link
* com.smartgwt.client.widgets.Canvas#getSnapResizeToGrid snapResizeToGrid} value on the child.
*
* @param childrenSnapResizeToGrid childrenSnapResizeToGrid Default value is null
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setChildrenSnapResizeToGrid(Boolean childrenSnapResizeToGrid) {
setAttribute("childrenSnapResizeToGrid", childrenSnapResizeToGrid, true);
}
/**
* If true, causes this canvas's children to snap to its grid when resizing. This behavior can be overridden on a per-child
* basis by setting the {@link com.smartgwt.client.widgets.Canvas#getSnapToGrid snapToGrid} or {@link
* com.smartgwt.client.widgets.Canvas#getSnapResizeToGrid snapResizeToGrid} value on the child.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public Boolean getChildrenSnapResizeToGrid() {
return getAttributeAsBoolean("childrenSnapResizeToGrid");
}
/**
* If true, causes this canvas's children to snap to its grid when dragging. This behavior can be overridden on a per-child
* basis by setting the {@link com.smartgwt.client.widgets.Canvas#getSnapToGrid snapToGrid} value on the child.
*
* @param childrenSnapToGrid childrenSnapToGrid Default value is null
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setChildrenSnapToGrid(Boolean childrenSnapToGrid) {
setAttribute("childrenSnapToGrid", childrenSnapToGrid, true);
}
/**
* If true, causes this canvas's children to snap to its grid when dragging. This behavior can be overridden on a per-child
* basis by setting the {@link com.smartgwt.client.widgets.Canvas#getSnapToGrid snapToGrid} value on the child.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public Boolean getChildrenSnapToGrid() {
return getAttributeAsBoolean("childrenSnapToGrid");
}
/**
* The contents of a canvas or label widget. Any HTML string is acceptable.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Changes the contents of a widget to newContents, an HTML string. <P> When {@link com.smartgwt.client.widgets.Canvas#getDynamicContents dynamicContents} is set, <code>setContents()</code> can also be called with no arguments to cause contents to be re-evaluated.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param contents an HTML string to be set as the contents of this widget. Default value is " "
* @see com.smartgwt.client.widgets.Canvas#setDynamicContents
*/
public void setContents(String contents) {
setAttribute("contents", contents, true);
}
/**
* The contents of a canvas or label widget. Any HTML string is acceptable.
*
*
* @return Returns the contents of a Canvas. The contents are an HTML string.
* @see com.smartgwt.client.widgets.Canvas#getDynamicContents
*/
public String getContents() {
return getAttributeAsString("contents");
}
/**
* Context menu to show for this object, an instance of the Menu widget. <P> Note: if {@link
* com.smartgwt.client.widgets.Canvas#destroy Canvas.destroy} is called on a canvas, any specified context menu is not
* automatically destroyed as well. This is in contrast to {@link com.smartgwt.client.widgets.menu.MenuButton}s which
* automatically destroy their specified {@link com.smartgwt.client.widgets.menu.MenuButton#getMenu menu} by default. The
* behavior is intentional as context menus are commonly reused across components.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param contextMenu contextMenu Default value is null
* @see com.smartgwt.client.widgets.events.ShowContextMenuEvent
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_contextmenu" target="examples">Context menus Example</a>
*/
public void setContextMenu(Menu contextMenu) {
setAttribute("contextMenu", contextMenu == null ? null : contextMenu.getOrCreateJsObj(), true);
}
/**
* Context menu to show for this object, an instance of the Menu widget. <P> Note: if {@link
* com.smartgwt.client.widgets.Canvas#destroy Canvas.destroy} is called on a canvas, any specified context menu is not
* automatically destroyed as well. This is in contrast to {@link com.smartgwt.client.widgets.menu.MenuButton}s which
* automatically destroy their specified {@link com.smartgwt.client.widgets.menu.MenuButton#getMenu menu} by default. The
* behavior is intentional as context menus are commonly reused across components.
*
*
* @return Menu
* @see com.smartgwt.client.widgets.events.ShowContextMenuEvent
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_contextmenu" target="examples">Context menus Example</a>
*/
public Menu getContextMenu() {
return Menu.getOrCreateRef(getAttributeAsJavaScriptObject("contextMenu"));
}
/**
* Specifies the cursor image to display when the mouse pointer is over this widget. It corresponds to the CSS cursor
* attribute. See Cursor type for different cursors.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Sets the cursor for this widget to cursor. See the cursor property for possible values.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param cursor new cursor. Default value is Canvas.DEFAULT
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_create" target="examples">Drag create Example</a>
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_cursors" target="examples">Cursors Example</a>
*/
public void setCursor(Cursor cursor) {
setAttribute("cursor", cursor == null ? null : cursor.getValue(), true);
}
/**
* Specifies the cursor image to display when the mouse pointer is over this widget. It corresponds to the CSS cursor
* attribute. See Cursor type for different cursors.
*
*
* @return Cursor
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_create" target="examples">Drag create Example</a>
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_cursors" target="examples">Cursors Example</a>
*/
public Cursor getCursor() {
return EnumUtil.getEnum(Cursor.values(), getAttribute("cursor"));
}
/**
* A dataPath may be specified on any canvas. This provides a straightforward way to display or
* edit complex nested data.
* <P>
* For components which support displaying or editing data values, (such as {@link
* com.smartgwt.client.widgets.form.DynamicForm} or
* {@link com.smartgwt.client.widgets.grid.ListGrid} components), the dataPath may be set to specify how the components
* data is
* accessed. In this case the dataPath essentially specifies a nested object to edit - typically
* a path to a field value within a dataSource record. Note that a ValuesManager will be required
* to handle connecting the dataBoundcomponent to the appropriate sub object. This may be explicitly
* specified on the component, or a parent of the component, or automatically generated
* if a DataSource is specified on either the component or a parent thereof.
* <P>
* To provide a simple example - if a complex object existed with the following format:
* <pre>
* { companyName:"Some Company",
* address:{ street:"123 Main Street", city:"New York", state:"NY" }
* }
* </pre>
* a developer could specify a DynamicForm instance with 'dataPath' set to "address" to edit
* the nested address object:
* <pre>
* isc.ValuesManager.create({
* ID:'vm',
* values: { companyName:"Some Company",
* address:{ street:"123 Main Street", city:"New York", state:"NY" }
* }
* });
*
* isc.DynamicForm.create({
* valuesManager:"vm",
* dataPath:"address",
* items:[{name:"street"}, {name:"city"}, {name:"state"}]
* });
* </pre>
* If a component is specified with a <code>dataPath</code> attribute but does not have an
* explicitly specified valuesManager, it will check its parent element chain for a specified
* valuesManager and automatically bind to that. This simplifies binding multiple components used
* to view or edit a nested data structure as the valuesManager needs only be defined once at a
* reasonably high level component. Here's an example of this approach:
* <pre>
* isc.ValuesManager.create({
* ID:'vm',
* values: { companyName:"Some Company",
* address:{ street:"123 Main Street", city:"New York", state:"NY" }
* }
* });
*
* isc.Layout.create({
* valuesManager:"vm",
* members:[
* isc.DynamicForm.create({
* dataPath:"/",
* items:[{name:"companyName"}]
* }),
* isc.DynamicForm.create({
* dataPath:"address",
* items:[{name:"street"}, {name:"city"}, {name:"state"}]
* })
* ]
* });
* </pre>
* Note that in this case the valuesManager is specified on a Layout, which has no 'values'
* management behavior of its own, but contains items with a specified dataPath which do. In this
* example you'd see 2 forms allowing editing of the nested data structure.
* <P>
* dataPaths from multiple nested components may also be combined. For example:
* <pre>
* isc.ValuesManager.create({
* ID:'vm',
* values: { companyName:"Some Company",
* address:{ street:"123 Main Street", city:"New York", state:"NY" }
* parentCompany:{
* companyName:"Some Corporation",
* address:{ street:"1 High Street", city:"New York", state:"NY" }
* }
* }
* });
*
* isc.Layout.create({
* valuesManager:"vm",
* members:[
* isc.DynamicForm.create({
* dataPath:"/",
* items:[{name:"companyName"}]
* }),
* isc.DynamicForm.create({
* dataPath:"address",
* items:[{name:"street"}, {name:"city"}, {name:"state"}]
* }),
* isc.Layout.create({
* dataPath:"parentCompany",
* members:[
* isc.DynamicForm.create({
* dataPath:"/",
* items:[{name:"companyName", type:"staticText"}]
* }),
* isc.DetailViewer.create({
* dataPath:"address",
* fields:[{name:"street", name:"city", name:"state"}]
* })
* ]
* })
* ]
* });
* </pre>
* In this example the detailViewer will display data from the <code>parentCompany.address</code>
* object within the base record.
* <P>
* Note that if a component has a specified dataSource and shows child components with a
* specified dataPath, there is no need to explicitly declare a valuesManager at all. If a component
* with a dataPath has a dataSource, or an ancestor with a dataSource specified, it will, a
* valuesManager will automatically be generated on the higher level component (and be available as
* <code>component.valuesManager</code>).
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Setter for the {@link com.smartgwt.client.widgets.Canvas#getDataPath dataPath} attribute. This method may be called directly at runtime to set the dataPath on a component, and will also be re-run automatically whenever a canvas' parentElement changes due to a call to addChild(). This method handles automatically binding the component to the appropriate valuesManager if necessary.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dataPath new dataPath. Default value is null
*/
public void setDataPath(String dataPath) {
setAttribute("dataPath", dataPath, true);
}
/**
* A dataPath may be specified on any canvas. This provides a straightforward way to display or
* edit complex nested data.
* <P>
* For components which support displaying or editing data values, (such as {@link
* com.smartgwt.client.widgets.form.DynamicForm} or
* {@link com.smartgwt.client.widgets.grid.ListGrid} components), the dataPath may be set to specify how the components
* data is
* accessed. In this case the dataPath essentially specifies a nested object to edit - typically
* a path to a field value within a dataSource record. Note that a ValuesManager will be required
* to handle connecting the dataBoundcomponent to the appropriate sub object. This may be explicitly
* specified on the component, or a parent of the component, or automatically generated
* if a DataSource is specified on either the component or a parent thereof.
* <P>
* To provide a simple example - if a complex object existed with the following format:
* <pre>
* { companyName:"Some Company",
* address:{ street:"123 Main Street", city:"New York", state:"NY" }
* }
* </pre>
* a developer could specify a DynamicForm instance with 'dataPath' set to "address" to edit
* the nested address object:
* <pre>
* isc.ValuesManager.create({
* ID:'vm',
* values: { companyName:"Some Company",
* address:{ street:"123 Main Street", city:"New York", state:"NY" }
* }
* });
*
* isc.DynamicForm.create({
* valuesManager:"vm",
* dataPath:"address",
* items:[{name:"street"}, {name:"city"}, {name:"state"}]
* });
* </pre>
* If a component is specified with a <code>dataPath</code> attribute but does not have an
* explicitly specified valuesManager, it will check its parent element chain for a specified
* valuesManager and automatically bind to that. This simplifies binding multiple components used
* to view or edit a nested data structure as the valuesManager needs only be defined once at a
* reasonably high level component. Here's an example of this approach:
* <pre>
* isc.ValuesManager.create({
* ID:'vm',
* values: { companyName:"Some Company",
* address:{ street:"123 Main Street", city:"New York", state:"NY" }
* }
* });
*
* isc.Layout.create({
* valuesManager:"vm",
* members:[
* isc.DynamicForm.create({
* dataPath:"/",
* items:[{name:"companyName"}]
* }),
* isc.DynamicForm.create({
* dataPath:"address",
* items:[{name:"street"}, {name:"city"}, {name:"state"}]
* })
* ]
* });
* </pre>
* Note that in this case the valuesManager is specified on a Layout, which has no 'values'
* management behavior of its own, but contains items with a specified dataPath which do. In this
* example you'd see 2 forms allowing editing of the nested data structure.
* <P>
* dataPaths from multiple nested components may also be combined. For example:
* <pre>
* isc.ValuesManager.create({
* ID:'vm',
* values: { companyName:"Some Company",
* address:{ street:"123 Main Street", city:"New York", state:"NY" }
* parentCompany:{
* companyName:"Some Corporation",
* address:{ street:"1 High Street", city:"New York", state:"NY" }
* }
* }
* });
*
* isc.Layout.create({
* valuesManager:"vm",
* members:[
* isc.DynamicForm.create({
* dataPath:"/",
* items:[{name:"companyName"}]
* }),
* isc.DynamicForm.create({
* dataPath:"address",
* items:[{name:"street"}, {name:"city"}, {name:"state"}]
* }),
* isc.Layout.create({
* dataPath:"parentCompany",
* members:[
* isc.DynamicForm.create({
* dataPath:"/",
* items:[{name:"companyName", type:"staticText"}]
* }),
* isc.DetailViewer.create({
* dataPath:"address",
* fields:[{name:"street", name:"city", name:"state"}]
* })
* ]
* })
* ]
* });
* </pre>
* In this example the detailViewer will display data from the <code>parentCompany.address</code>
* object within the base record.
* <P>
* Note that if a component has a specified dataSource and shows child components with a
* specified dataPath, there is no need to explicitly declare a valuesManager at all. If a component
* with a dataPath has a dataSource, or an ancestor with a dataSource specified, it will, a
* valuesManager will automatically be generated on the higher level component (and be available as
* <code>component.valuesManager</code>).
*
*
* @return String
*/
public String getDataPath() {
return getAttributeAsString("dataPath");
}
/**
* For custom components, establishes a default height for the component. <P> For a component that should potentially be
* sized automatically by a Layout, set this property rather than {@link com.smartgwt.client.widgets.Canvas#getHeight
* height} directly, because Layouts regard a height setting as an explicit size that shouldn't be changed.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param defaultHeight defaultHeight Default value is 100
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setDefaultHeight(int defaultHeight) {
setAttribute("defaultHeight", defaultHeight, true);
}
/**
* For custom components, establishes a default height for the component. <P> For a component that should potentially be
* sized automatically by a Layout, set this property rather than {@link com.smartgwt.client.widgets.Canvas#getHeight
* height} directly, because Layouts regard a height setting as an explicit size that shouldn't be changed.
*
*
* @return int
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public int getDefaultHeight() {
return getAttributeAsInt("defaultHeight");
}
/**
* For custom components, establishes a default width for the component. <P> For a component that should potentially be
* sized automatically by a Layout, set this property rather than {@link com.smartgwt.client.widgets.Canvas#getWidth width}
* directly, because Layouts regard a width setting as an explicit size that shouldn't be changed.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param defaultWidth defaultWidth Default value is 100
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setDefaultWidth(int defaultWidth) {
setAttribute("defaultWidth", defaultWidth, true);
}
/**
* For custom components, establishes a default width for the component. <P> For a component that should potentially be
* sized automatically by a Layout, set this property rather than {@link com.smartgwt.client.widgets.Canvas#getWidth width}
* directly, because Layouts regard a width setting as an explicit size that shouldn't be changed.
*
*
* @return int
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public int getDefaultWidth() {
return getAttributeAsInt("defaultWidth");
}
/**
* If this property is set to <code>true</code>, the {@link com.smartgwt.client.widgets.Canvas#destroy destroy()} method
* has been called on this canvas. This implies the canvas is no longer valid. Its ID has been removed from global scope,
* and calling standard canvas APIs on it is likely to result in errors.
*
* <b>Note :</b> This method should be called only after the widget has been rendered.
*
* @return Boolean
* @throws IllegalStateException if widget has not yet been rendered.
* @see com.smartgwt.client.widgets.Canvas#destroy
*/
public Boolean getDestroyed() throws IllegalStateException {
errorIfNotCreated("destroyed");
return getAttributeAsBoolean("destroyed");
}
/**
* This property is set to true when the {@link com.smartgwt.client.widgets.Canvas#destroy Canvas.destroy} method is called
* on a widget. If this property is true, but {@link com.smartgwt.client.widgets.Canvas#getDestroyed destroyed} is not,
* this indicates the canvas is in the process of being destroyed.
*
* <b>Note :</b> This method should be called only after the widget has been rendered.
*
* @return Boolean
* @throws IllegalStateException if widget has not yet been rendered.
* @see com.smartgwt.client.widgets.Canvas#destroy
*/
public Boolean getDestroying() throws IllegalStateException {
errorIfNotCreated("destroying");
return getAttributeAsBoolean("destroying");
}
/**
* Specifies the cursor image to display when the mouse pointer is over this widget if this widget is disabled. It
* corresponds to the CSS cursor attribute. See Cursor type for different cursors.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param disabledCursor disabledCursor Default value is Canvas.DEFAULT
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
*/
public void setDisabledCursor(Cursor disabledCursor) {
setAttribute("disabledCursor", disabledCursor == null ? null : disabledCursor.getValue(), true);
}
/**
* Specifies the cursor image to display when the mouse pointer is over this widget if this widget is disabled. It
* corresponds to the CSS cursor attribute. See Cursor type for different cursors.
*
*
* @return Cursor
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
*/
public Cursor getDisabledCursor() {
return EnumUtil.getEnum(Cursor.values(), getAttribute("disabledCursor"));
}
/**
* Amount of time (in msec) between which two clicks are considered a single click
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param doubleClickDelay doubleClickDelay Default value is 250
*/
public void setDoubleClickDelay(int doubleClickDelay) {
setAttribute("doubleClickDelay", doubleClickDelay, true);
}
/**
* Amount of time (in msec) between which two clicks are considered a single click
*
*
* @return int
*/
public int getDoubleClickDelay() {
return getAttributeAsInt("doubleClickDelay");
}
/**
* Visual appearance to show when the object is being dragged. May be overridden for dragResize or dragReposition events
* via {@link com.smartgwt.client.widgets.Canvas#getDragResizeAppearance dragResizeAppearance} and {@link
* com.smartgwt.client.widgets.Canvas#getDragRepositionAppearance dragRepositionAppearance}.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragAppearance dragAppearance Default value is EventHandler.OUTLINE
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setDragAppearance(DragAppearance dragAppearance) {
setAttribute("dragAppearance", dragAppearance == null ? null : dragAppearance.getValue(), true);
}
/**
* Visual appearance to show when the object is being dragged. May be overridden for dragResize or dragReposition events
* via {@link com.smartgwt.client.widgets.Canvas#getDragResizeAppearance dragResizeAppearance} and {@link
* com.smartgwt.client.widgets.Canvas#getDragRepositionAppearance dragRepositionAppearance}.
*
*
* @return DragAppearance
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public DragAppearance getDragAppearance() {
return EnumUtil.getEnum(DragAppearance.values(), getAttribute("dragAppearance"));
}
/**
* This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection
* with the rectangle of the dragMoveTarget.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragIntersectStyle dragIntersectStyle Default value is "mouse"
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setDragIntersectStyle(DragIntersectStyle dragIntersectStyle) {
setAttribute("dragIntersectStyle", dragIntersectStyle == null ? null : dragIntersectStyle.getValue(), true);
}
/**
* This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection
* with the rectangle of the dragMoveTarget.
*
*
* @return DragIntersectStyle
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public DragIntersectStyle getDragIntersectStyle() {
return EnumUtil.getEnum(DragIntersectStyle.values(), getAttribute("dragIntersectStyle"));
}
/**
* If this widget has dragAppearance <code>"target"</code>, this value specifies the opacity to render the target while it
* is being dragged. A null value implies we do not modify the opacity.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragOpacity dragOpacity Default value is null
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_effects" target="examples">Drag effects Example</a>
*/
public void setDragOpacity(Integer dragOpacity) {
setAttribute("dragOpacity", dragOpacity, true);
}
/**
* If this widget has dragAppearance <code>"target"</code>, this value specifies the opacity to render the target while it
* is being dragged. A null value implies we do not modify the opacity.
*
*
* @return Integer
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_effects" target="examples">Drag effects Example</a>
*/
public Integer getDragOpacity() {
return getAttributeAsInt("dragOpacity");
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getCanDragReposition canDragReposition} is true, this attributes specifies
* the visual appearance to show during drag reposition. If unset {@link
* com.smartgwt.client.widgets.Canvas#getDragAppearance dragAppearance} will be used.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragRepositionAppearance dragRepositionAppearance Default value is null
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setDragRepositionAppearance(DragAppearance dragRepositionAppearance) {
setAttribute("dragRepositionAppearance", dragRepositionAppearance == null ? null : dragRepositionAppearance.getValue(), true);
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getCanDragReposition canDragReposition} is true, this attributes specifies
* the visual appearance to show during drag reposition. If unset {@link
* com.smartgwt.client.widgets.Canvas#getDragAppearance dragAppearance} will be used.
*
*
* @return DragAppearance
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public DragAppearance getDragRepositionAppearance() {
return EnumUtil.getEnum(DragAppearance.values(), getAttribute("dragRepositionAppearance"));
}
/**
* Cursor to switch to if the mouse is over a widget that is drag repositionable.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragRepositionCursor dragRepositionCursor Default value is Canvas.MOVE
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setDragRepositionCursor(Cursor dragRepositionCursor) {
setAttribute("dragRepositionCursor", dragRepositionCursor == null ? null : dragRepositionCursor.getValue(), true);
}
/**
* Cursor to switch to if the mouse is over a widget that is drag repositionable.
*
*
* @return Cursor
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public Cursor getDragRepositionCursor() {
return EnumUtil.getEnum(Cursor.values(), getAttribute("dragRepositionCursor"));
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getCanDragResize canDragResize} is true, this attributes specifies the
* visual appearance to show during drag resize. If unset {@link com.smartgwt.client.widgets.Canvas#getDragAppearance
* dragAppearance} will be used.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragResizeAppearance dragResizeAppearance Default value is null
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setDragResizeAppearance(DragAppearance dragResizeAppearance) {
setAttribute("dragResizeAppearance", dragResizeAppearance == null ? null : dragResizeAppearance.getValue(), true);
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getCanDragResize canDragResize} is true, this attributes specifies the
* visual appearance to show during drag resize. If unset {@link com.smartgwt.client.widgets.Canvas#getDragAppearance
* dragAppearance} will be used.
*
*
* @return DragAppearance
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public DragAppearance getDragResizeAppearance() {
return EnumUtil.getEnum(DragAppearance.values(), getAttribute("dragResizeAppearance"));
}
/**
* If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the
* drag-scroll threshold before scrolling begins.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragScrollDelay dragScrollDelay Default value is 100
*/
public void setDragScrollDelay(int dragScrollDelay) {
setAttribute("dragScrollDelay", dragScrollDelay, true);
}
/**
* If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the
* drag-scroll threshold before scrolling begins.
*
*
* @return int
*/
public int getDragScrollDelay() {
return getAttributeAsInt("dragScrollDelay");
}
/**
* Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragStartDistance dragStartDistance Default value is 5
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setDragStartDistance(int dragStartDistance) {
setAttribute("dragStartDistance", dragStartDistance, true);
}
/**
* Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
*
*
* @return int
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public int getDragStartDistance() {
return getAttributeAsInt("dragStartDistance");
}
/**
* The "type" of thing given as a string that can be dragged from this widget. If specified, this will be matched up
* with the dropTypes of droppable widgets as detailed in the dropTypes property.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragType dragType Default value is null
* @see com.smartgwt.client.widgets.Canvas#setDropTypes
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setDragType(String dragType) {
setAttribute("dragType", dragType, true);
}
/**
* The "type" of thing given as a string that can be dragged from this widget. If specified, this will be matched up
* with the dropTypes of droppable widgets as detailed in the dropTypes property.
*
*
* @return String
* @see com.smartgwt.client.widgets.Canvas#getDropTypes
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public String getDragType() {
return getAttributeAsString("dragType");
}
/**
* Dynamic contents allows the contents string to be treated as a simple, but powerful
* template. When this attribute is set to true, expressions of the form \${arbitrary JS
* here} are replaced by the result of the evaluation of the JS code inside the curly
* brackets. This evaluation happens at draw time. If you want to trigger a re-evaluation
* of the expressions in the contents string you can call markForRedraw() on the canvas.
* <p>
* You can use this feature to build some simple custom components. For example, let's say
* you want to show the value of a Slider in a Canvas somewhere on the screen. You can do
* this by observing the valueChanged() method on the slider and calling setContents() on
* your canvas with the new string or you can set the contents of the canvas to something
* like:
* <p><code>
* "The slider value is \${sliderInstance.getValue()}."
* </code><p>
* Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider
* and call canvas.markForRedraw() in that observation. This approach is cleaner than
* setContents() when the Canvas is aggregating several values or dynamic expressions.
* Like so:
* <p>
* <pre>
* Slider.create({
* ID: "mySlider"
* });
*
* Canvas.create({
* ID: "myCanvas",
* dynamicContents: true,
* contents: "The slider value is \${mySlider.getValue()}."
* });
*
* myCanvas.observe(mySlider, "valueChanged",
* "observer.markForRedraw()");
* </pre>
* You can embed an arbitrary number of dynamic expressions in the contents string. The
* search and replace is optimized for speed.
* <p>
* If an error occurs during the evaluation of one of the expressions, a warning is logged
* to the ISC Developer Console and the error string is embedded in place of the expected
* value in the Canvas.
* <p>
* The value of a function is its return value. The value of any variable is the same as
* that returned by its toString() representation.
* <p>
* Inside the evaluation contentext, <code>this</code> points to the canvas instance that
* has the dynamicContents string as its contents - in other words the canvas instance on
* which the template is declared.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dynamicContents dynamicContents Default value is false
* @see com.smartgwt.client.widgets.Canvas#setContents
* @see com.smartgwt.client.widgets.Canvas#setDynamicContentsVars
*
*/
public void setDynamicContents(Boolean dynamicContents) {
setAttribute("dynamicContents", dynamicContents, true);
}
/**
* Dynamic contents allows the contents string to be treated as a simple, but powerful
* template. When this attribute is set to true, expressions of the form \${arbitrary JS
* here} are replaced by the result of the evaluation of the JS code inside the curly
* brackets. This evaluation happens at draw time. If you want to trigger a re-evaluation
* of the expressions in the contents string you can call markForRedraw() on the canvas.
* <p>
* You can use this feature to build some simple custom components. For example, let's say
* you want to show the value of a Slider in a Canvas somewhere on the screen. You can do
* this by observing the valueChanged() method on the slider and calling setContents() on
* your canvas with the new string or you can set the contents of the canvas to something
* like:
* <p><code>
* "The slider value is \${sliderInstance.getValue()}."
* </code><p>
* Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider
* and call canvas.markForRedraw() in that observation. This approach is cleaner than
* setContents() when the Canvas is aggregating several values or dynamic expressions.
* Like so:
* <p>
* <pre>
* Slider.create({
* ID: "mySlider"
* });
*
* Canvas.create({
* ID: "myCanvas",
* dynamicContents: true,
* contents: "The slider value is \${mySlider.getValue()}."
* });
*
* myCanvas.observe(mySlider, "valueChanged",
* "observer.markForRedraw()");
* </pre>
* You can embed an arbitrary number of dynamic expressions in the contents string. The
* search and replace is optimized for speed.
* <p>
* If an error occurs during the evaluation of one of the expressions, a warning is logged
* to the ISC Developer Console and the error string is embedded in place of the expected
* value in the Canvas.
* <p>
* The value of a function is its return value. The value of any variable is the same as
* that returned by its toString() representation.
* <p>
* Inside the evaluation contentext, <code>this</code> points to the canvas instance that
* has the dynamicContents string as its contents - in other words the canvas instance on
* which the template is declared.
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getContents
* @see com.smartgwt.client.widgets.Canvas#getDynamicContentsVars
*
*/
public Boolean getDynamicContents() {
return getAttributeAsBoolean("dynamicContents");
}
/**
* Background color for the EdgedCanvas created to decorate this component. This can be used to provide an underlying
* "tint" color for translucent edge media
*
* @param edgeBackgroundColor edgeBackgroundColor Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setEdgeBackgroundColor(String edgeBackgroundColor) throws IllegalStateException {
setAttribute("edgeBackgroundColor", edgeBackgroundColor, false);
}
/**
* Background color for the EdgedCanvas created to decorate this component. This can be used to provide an underlying
* "tint" color for translucent edge media
*
*
* @return String
*/
public String getEdgeBackgroundColor() {
return getAttributeAsString("edgeBackgroundColor");
}
/**
* Background color for the center section only. Can be used as a surrogate background color for the decorated Canvas, if
* the Canvas is set to partially overlap the edges and hence can't show a background color itself without occluding media.
*
* @param edgeCenterBackgroundColor edgeCenterBackgroundColor Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setEdgeCenterBackgroundColor(String edgeCenterBackgroundColor) throws IllegalStateException {
setAttribute("edgeCenterBackgroundColor", edgeCenterBackgroundColor, false);
}
/**
* Background color for the center section only. Can be used as a surrogate background color for the decorated Canvas, if
* the Canvas is set to partially overlap the edges and hence can't show a background color itself without occluding media.
*
*
* @return String
*/
public String getEdgeCenterBackgroundColor() {
return getAttributeAsString("edgeCenterBackgroundColor");
}
/**
* Base name of images for edges. Extensions for each corner or edge piece will be added to this image URL, before the
* extension. For example, with the default base name of "edge.gif", the top-left corner image will be "edge_TL.gif". <P>
* The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".
*
* @param edgeImage edgeImage Default value is "[SKIN]edge.gif"
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a>
*/
public void setEdgeImage(String edgeImage) throws IllegalStateException {
setAttribute("edgeImage", edgeImage, false);
}
/**
* Base name of images for edges. Extensions for each corner or edge piece will be added to this image URL, before the
* extension. For example, with the default base name of "edge.gif", the top-left corner image will be "edge_TL.gif". <P>
* The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".
*
*
* @return String
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a>
*/
public String getEdgeImage() {
return getAttributeAsString("edgeImage");
}
/**
* How far into the edge of an object do we consider the "edge" for drag resize purposes?
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param edgeMarginSize edgeMarginSize Default value is 5
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_resize" target="examples">Drag resize Example</a>
*/
public void setEdgeMarginSize(int edgeMarginSize) {
setAttribute("edgeMarginSize", edgeMarginSize, true);
}
/**
* How far into the edge of an object do we consider the "edge" for drag resize purposes?
*
*
* @return int
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_resize" target="examples">Drag resize Example</a>
*/
public int getEdgeMarginSize() {
return getAttributeAsInt("edgeMarginSize");
}
/**
* Amount the contained Canvas should be offset. Defaults to edgeSize; set to less than edgeSize to allow the contained
* Canvas to overlap the edge and corner media.
*
* @param edgeOffset edgeOffset Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_corners" target="examples">Corners Example</a>
*/
public void setEdgeOffset(Integer edgeOffset) throws IllegalStateException {
setAttribute("edgeOffset", edgeOffset, false);
}
/**
* Amount the contained Canvas should be offset. Defaults to edgeSize; set to less than edgeSize to allow the contained
* Canvas to overlap the edge and corner media.
*
*
* @return Integer
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_corners" target="examples">Corners Example</a>
*/
public Integer getEdgeOffset() {
return getAttributeAsInt("edgeOffset");
}
/**
* Opacity of the edges. Defaults to matching this.opacity. if {@link com.smartgwt.client.widgets.Canvas#setOpacity
* Canvas.setOpacity} is called on a Canvas where edgeOpacity is set, edgeOpacity will be considered a percentage of the
* parent's opacity (so 50% opaque parent plus edgeOpacity 50 means 25% opaque edges)
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the {@link com.smartgwt.client.widgets.Canvas#getEdgeOpacity edgeOpacity} and mark the canvas for redraw
*
* @param edgeOpacity new edge-opacity level. Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a>
*/
public void setEdgeOpacity(Integer edgeOpacity) throws IllegalStateException {
setAttribute("edgeOpacity", edgeOpacity, false);
}
/**
* Opacity of the edges. Defaults to matching this.opacity. if {@link com.smartgwt.client.widgets.Canvas#setOpacity
* Canvas.setOpacity} is called on a Canvas where edgeOpacity is set, edgeOpacity will be considered a percentage of the
* parent's opacity (so 50% opaque parent plus edgeOpacity 50 means 25% opaque edges)
*
*
* @return Integer
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a>
*/
public Integer getEdgeOpacity() {
return getAttributeAsInt("edgeOpacity");
}
/**
* Whether to show media in the center section, that is, behind the decorated Canvas.
*
* @param edgeShowCenter edgeShowCenter Default value is false
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_corners" target="examples">Corners Example</a>
*/
public void setEdgeShowCenter(Boolean edgeShowCenter) throws IllegalStateException {
setAttribute("edgeShowCenter", edgeShowCenter, false);
}
/**
* Whether to show media in the center section, that is, behind the decorated Canvas.
*
*
* @return Boolean
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_corners" target="examples">Corners Example</a>
*/
public Boolean getEdgeShowCenter() {
return getAttributeAsBoolean("edgeShowCenter");
}
/**
* Size in pixels for corners and edges
*
* @param edgeSize edgeSize Default value is 10
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a>
*/
public void setEdgeSize(int edgeSize) throws IllegalStateException {
setAttribute("edgeSize", edgeSize, false);
}
/**
* Size in pixels for corners and edges
*
*
* @return int
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a>
*/
public int getEdgeSize() {
return getAttributeAsInt("edgeSize");
}
/**
* When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a
* Layout.
*
* @param extraSpace extraSpace Default value is 0
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.layout.LayoutSpacer
* @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods
*/
public void setExtraSpace(int extraSpace) throws IllegalStateException {
setAttribute("extraSpace", extraSpace, false);
}
/**
* When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a
* Layout.
*
*
* @return int
* @see com.smartgwt.client.widgets.layout.LayoutSpacer
* @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods
*/
public int getExtraSpace() {
return getAttributeAsInt("extraSpace");
}
/**
* If <code>this.showHover</code> is true, this property can be used to customize the alignment of content in the hover
* canvas.
*
* @param hoverAlign hoverAlign Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
*/
public void setHoverAlign(Alignment hoverAlign) {
setAttribute("hoverAlign", hoverAlign == null ? null : hoverAlign.getValue(), true);
}
/**
* If <code>this.showHover</code> is true, this property can be used to customize the alignment of content in the hover
* canvas.
*
*
* @return Alignment
* @see com.smartgwt.client.widgets.Canvas#getShowHover
*/
public Alignment getHoverAlign() {
return EnumUtil.getEnum(Alignment.values(), getAttribute("hoverAlign"));
}
/**
* If <code>this.showHover</code> is true and {@link com.smartgwt.client.widgets.Canvas#getHoverComponent
* Canvas.getHoverComponent} is implemented, should the hoverCanvas returned from it be automatically destroyed when it is
* hidden? <P> The default of null indicates that the component <b>will</b> be automatically destroyed. Set to false to
* prevent this.
*
* @param hoverAutoDestroy hoverAutoDestroy Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
*/
public void setHoverAutoDestroy(Boolean hoverAutoDestroy) {
setAttribute("hoverAutoDestroy", hoverAutoDestroy, true);
}
/**
* If <code>this.showHover</code> is true and {@link com.smartgwt.client.widgets.Canvas#getHoverComponent
* Canvas.getHoverComponent} is implemented, should the hoverCanvas returned from it be automatically destroyed when it is
* hidden? <P> The default of null indicates that the component <b>will</b> be automatically destroyed. Set to false to
* prevent this.
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getShowHover
*/
public Boolean getHoverAutoDestroy() {
return getAttributeAsBoolean("hoverAutoDestroy");
}
/**
* If <code>this.canHover</code> is true, how long should the mouse be kept over this widget before the hover event is
* fired
*
* @param hoverDelay hoverDelay Default value is 300
* @see com.smartgwt.client.widgets.Canvas#setCanHover
* @see com.smartgwt.client.widgets.events.HoverEvent
*/
public void setHoverDelay(int hoverDelay) {
setAttribute("hoverDelay", hoverDelay, true);
}
/**
* If <code>this.canHover</code> is true, how long should the mouse be kept over this widget before the hover event is
* fired
*
*
* @return int
* @see com.smartgwt.client.widgets.Canvas#getCanHover
* @see com.smartgwt.client.widgets.events.HoverEvent
*/
public int getHoverDelay() {
return getAttributeAsInt("hoverDelay");
}
/**
* If <code>this.showHover</code> is true, this property can be used to customize the height of the hover canvas shown.
*
* @param hoverHeight hoverHeight Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
*/
public void setHoverHeight(Integer hoverHeight) {
setAttribute("hoverHeight", hoverHeight, true);
}
/**
* If <code>this.showHover</code> is true, this property can be used to customize the height of the hover canvas shown.
*
*
* @return Integer
* @see com.smartgwt.client.widgets.Canvas#getShowHover
*/
public Integer getHoverHeight() {
return getAttributeAsInt("hoverHeight");
}
/**
* If <code>this.showHover</code> is true, should this widget's hover canvas be moved with the mouse while visible?
*
* @param hoverMoveWithMouse hoverMoveWithMouse Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
*/
public void setHoverMoveWithMouse(Boolean hoverMoveWithMouse) {
setAttribute("hoverMoveWithMouse", hoverMoveWithMouse, true);
}
/**
* If <code>this.showHover</code> is true, should this widget's hover canvas be moved with the mouse while visible?
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getShowHover
*/
public Boolean getHoverMoveWithMouse() {
return getAttributeAsBoolean("hoverMoveWithMouse");
}
/**
* If <code>this.showHover</code> is true, should the hover canvas be shown with opacity other than 100?
*
* @param hoverOpacity hoverOpacity Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a>
*/
public void setHoverOpacity(Integer hoverOpacity) {
setAttribute("hoverOpacity", hoverOpacity, true);
}
/**
* If <code>this.showHover</code> is true, should the hover canvas be shown with opacity other than 100?
*
*
* @return Integer
* @see com.smartgwt.client.widgets.Canvas#getShowHover
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a>
*/
public Integer getHoverOpacity() {
return getAttributeAsInt("hoverOpacity");
}
/**
* If <code>this.showHover</code> is true, this property can be used to specify the css style to apply to the hover canvas.
*
* @param hoverStyle hoverStyle Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a>
*/
public void setHoverStyle(String hoverStyle) {
setAttribute("hoverStyle", hoverStyle, true);
}
/**
* If <code>this.showHover</code> is true, this property can be used to specify the css style to apply to the hover canvas.
*
*
* @return String
* @see com.smartgwt.client.widgets.Canvas#getShowHover
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a>
*/
public String getHoverStyle() {
return getAttributeAsString("hoverStyle");
}
/**
* If <code>this.showHover</code> is true, this property can be used to customize the vertical alignment of content in the
* hover canvas.
*
* @param hoverVAlign hoverVAlign Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
*/
public void setHoverVAlign(VerticalAlignment hoverVAlign) {
setAttribute("hoverVAlign", hoverVAlign == null ? null : hoverVAlign.getValue(), true);
}
/**
* If <code>this.showHover</code> is true, this property can be used to customize the vertical alignment of content in the
* hover canvas.
*
*
* @return VerticalAlignment
* @see com.smartgwt.client.widgets.Canvas#getShowHover
*/
public VerticalAlignment getHoverVAlign() {
return EnumUtil.getEnum(VerticalAlignment.values(), getAttribute("hoverVAlign"));
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getShowHover this.showHover} is true, this property can be used to
* customize the width of the hover canvas shown.
*
* @param hoverWidth hoverWidth Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a>
*/
public void setHoverWidth(Integer hoverWidth) {
setAttribute("hoverWidth", hoverWidth, true);
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getShowHover this.showHover} is true, this property can be used to
* customize the width of the hover canvas shown.
*
*
* @return Integer
* @see com.smartgwt.client.widgets.Canvas#getShowHover
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a>
*/
public Integer getHoverWidth() {
return getAttributeAsInt("hoverWidth");
}
/**
* If <code>this.showHover</code> is true, this property can be used to customize the whether content in the hover canvas
* is displayed in a single line, or wraps.
*
* @param hoverWrap hoverWrap Default value is null
* @see com.smartgwt.client.widgets.Canvas#setShowHover
*/
public void setHoverWrap(Boolean hoverWrap) {
setAttribute("hoverWrap", hoverWrap, true);
}
/**
* If <code>this.showHover</code> is true, this property can be used to customize the whether content in the hover canvas
* is displayed in a single line, or wraps.
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getShowHover
*/
public Boolean getHoverWrap() {
return getAttributeAsBoolean("hoverWrap");
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getHtmlElement htmlElement} is specified, this attribute specifies the
* position where the canvas should be inserted relative to the <code>htmlElement</code> in the DOM.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Setter for the {@link com.smartgwt.client.widgets.Canvas#getHtmlPosition htmlPosition}.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param htmlPosition New htmlPosition for this canvas. Default value is "afterBegin"
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public void setHtmlPosition(DrawPosition htmlPosition) {
setAttribute("htmlPosition", htmlPosition == null ? null : htmlPosition.getValue(), true);
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getHtmlElement htmlElement} is specified, this attribute specifies the
* position where the canvas should be inserted relative to the <code>htmlElement</code> in the DOM.
*
*
* @return DrawPosition
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public DrawPosition getHtmlPosition() {
return EnumUtil.getEnum(DrawPosition.values(), getAttribute("htmlPosition"));
}
/**
* Strategy to use when locating children in this canvas from an autoTest locator string.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param locateChildrenBy locateChildrenBy Default value is null
*/
public void setLocateChildrenBy(LocatorStrategy locateChildrenBy) {
setAttribute("locateChildrenBy", locateChildrenBy == null ? null : locateChildrenBy.getValue(), true);
}
/**
* Strategy to use when locating children in this canvas from an autoTest locator string.
*
*
* @return LocatorStrategy
*/
public LocatorStrategy getLocateChildrenBy() {
return EnumUtil.getEnum(LocatorStrategy.values(), getAttribute("locateChildrenBy"));
}
/**
* {@link com.smartgwt.client.types.LocatorTypeStrategy} to use when finding children within this canvas.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param locateChildrenType locateChildrenType Default value is null
*/
public void setLocateChildrenType(LocatorTypeStrategy locateChildrenType) {
setAttribute("locateChildrenType", locateChildrenType == null ? null : locateChildrenType.getValue(), true);
}
/**
* {@link com.smartgwt.client.types.LocatorTypeStrategy} to use when finding children within this canvas.
*
*
* @return LocatorTypeStrategy
*/
public LocatorTypeStrategy getLocateChildrenType() {
return EnumUtil.getEnum(LocatorTypeStrategy.values(), getAttribute("locateChildrenType"));
}
/**
* Strategy to use when locating peers of this canvas from an autoTest locator string.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param locatePeersBy locatePeersBy Default value is null
*/
public void setLocatePeersBy(LocatorStrategy locatePeersBy) {
setAttribute("locatePeersBy", locatePeersBy == null ? null : locatePeersBy.getValue(), true);
}
/**
* Strategy to use when locating peers of this canvas from an autoTest locator string.
*
*
* @return LocatorStrategy
*/
public LocatorStrategy getLocatePeersBy() {
return EnumUtil.getEnum(LocatorStrategy.values(), getAttribute("locatePeersBy"));
}
/**
* {@link com.smartgwt.client.types.LocatorTypeStrategy} to use when finding peers of this canvas.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param locatePeersType locatePeersType Default value is null
*/
public void setLocatePeersType(LocatorTypeStrategy locatePeersType) {
setAttribute("locatePeersType", locatePeersType == null ? null : locatePeersType.getValue(), true);
}
/**
* {@link com.smartgwt.client.types.LocatorTypeStrategy} to use when finding peers of this canvas.
*
*
* @return LocatorTypeStrategy
*/
public LocatorTypeStrategy getLocatePeersType() {
return EnumUtil.getEnum(LocatorTypeStrategy.values(), getAttribute("locatePeersType"));
}
/**
* Set the CSS Margin, in pixels, for this component. Margin provides blank space outside of the border. <P> This property
* sets the same thickness of margin on every side. Differing per-side margins can be set in a CSS style and applied via
* {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}. <P> Note that the specified size of the widget will
* be the size <b>including</b> the margin thickness on each side.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the CSS Margin, in pixels, for this component. Margin provides blank space outside of the border. <P> This property sets the same thickness of margin on every side. Differing per-side margins can be set in a CSS style and applied via {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}. <P> Note that the specified size of the widget will be the size <b>including</b> the margin thickness on each side.
*
* @param margin new margin in pixels. Default value is null
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setMargin(Integer margin) {
setAttribute("margin", margin, true);
}
/**
* Set the CSS Margin, in pixels, for this component. Margin provides blank space outside of the border. <P> This property
* sets the same thickness of margin on every side. Differing per-side margins can be set in a CSS style and applied via
* {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}. <P> Note that the specified size of the widget will
* be the size <b>including</b> the margin thickness on each side.
*
*
* @return Integer
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public Integer getMargin() {
return getAttributeAsInt("margin");
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getHtmlElement htmlElement} is specified, should this canvas initially be
* drawn at the same dimensions as the htmlElement?<br> Note: setting this property will not force the canvas to resize if
* the element subsequently resizes (for example due to page reflow).
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param matchElement matchElement Default value is null
*/
public void setMatchElement(Boolean matchElement) {
setAttribute("matchElement", matchElement, true);
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getHtmlElement htmlElement} is specified, should this canvas initially be
* drawn at the same dimensions as the htmlElement?<br> Note: setting this property will not force the canvas to resize if
* the element subsequently resizes (for example due to page reflow).
*
*
* @return Boolean
*/
public Boolean getMatchElement() {
return getAttributeAsBoolean("matchElement");
}
/**
* Maximum height that this Canvas can be resized to.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param maxHeight maxHeight Default value is 10000
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setMaxHeight(int maxHeight) {
setAttribute("maxHeight", maxHeight, true);
}
/**
* Maximum height that this Canvas can be resized to.
*
*
* @return int
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public int getMaxHeight() {
return getAttributeAsInt("maxHeight");
}
/**
* Maximum width that this Canvas can be resized to.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param maxWidth maxWidth Default value is 10000
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setMaxWidth(int maxWidth) {
setAttribute("maxWidth", maxWidth, true);
}
/**
* Maximum width that this Canvas can be resized to.
*
*
* @return int
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public int getMaxWidth() {
return getAttributeAsInt("maxWidth");
}
/**
* Default class used to construct menus created by this component, including context menus.
*
* @param menuConstructor menuConstructor Default value is "Menu"
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.events.ShowContextMenuEvent
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
*/
public void setMenuConstructor(String menuConstructor) throws IllegalStateException {
setAttribute("menuConstructor", menuConstructor, false);
}
/**
* Default class used to construct menus created by this component, including context menus.
*
*
* @return String
* @see com.smartgwt.client.widgets.events.ShowContextMenuEvent
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
*/
public String getMenuConstructor() {
return getAttributeAsString("menuConstructor");
}
/**
* Minimum height that this Canvas can be resized to. <P> Note that a Canvas with overflow:"visible" has an implicit
* minimize size based on it's contents.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param minHeight minHeight Default value is 10
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setMinHeight(int minHeight) {
setAttribute("minHeight", minHeight, true);
}
/**
* Minimum height that this Canvas can be resized to. <P> Note that a Canvas with overflow:"visible" has an implicit
* minimize size based on it's contents.
*
*
* @return int
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public int getMinHeight() {
return getAttributeAsInt("minHeight");
}
/**
* Minimum width that this Canvas can be resized to. <P> Note that a Canvas with overflow:"visible" has an implicit
* minimize size based on it's contents.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param minWidth minWidth Default value is 10
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setMinWidth(int minWidth) {
setAttribute("minWidth", minWidth, true);
}
/**
* Minimum width that this Canvas can be resized to. <P> Note that a Canvas with overflow:"visible" has an implicit
* minimize size based on it's contents.
*
*
* @return int
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public int getMinWidth() {
return getAttributeAsInt("minWidth");
}
/**
* Amount of time (in msec) between 'mouseStillDown' events for this object
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param mouseStillDownDelay mouseStillDownDelay Default value is 100
*/
public void setMouseStillDownDelay(int mouseStillDownDelay) {
setAttribute("mouseStillDownDelay", mouseStillDownDelay, true);
}
/**
* Amount of time (in msec) between 'mouseStillDown' events for this object
*
*
* @return int
*/
public int getMouseStillDownDelay() {
return getAttributeAsInt("mouseStillDownDelay");
}
/**
* Amount of time (in msec) before mouseStillDown events start to be fired for this object.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param mouseStillDownInitialDelay mouseStillDownInitialDelay Default value is 400
*/
public void setMouseStillDownInitialDelay(int mouseStillDownInitialDelay) {
setAttribute("mouseStillDownInitialDelay", mouseStillDownInitialDelay, true);
}
/**
* Amount of time (in msec) before mouseStillDown events start to be fired for this object.
*
*
* @return int
*/
public int getMouseStillDownInitialDelay() {
return getAttributeAsInt("mouseStillDownInitialDelay");
}
/**
* If true, this canvas will receive all mouse-clicks as single click events rather than doubleClicks.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param noDoubleClicks noDoubleClicks Default value is null
*/
public void setNoDoubleClicks(Boolean noDoubleClicks) {
setAttribute("noDoubleClicks", noDoubleClicks, true);
}
/**
* If true, this canvas will receive all mouse-clicks as single click events rather than doubleClicks.
*
*
* @return Boolean
*/
public Boolean getNoDoubleClicks() {
return getAttributeAsBoolean("noDoubleClicks");
}
/**
* Renders the widget to be partly transparent. A widget's opacity property may be set to any number between 0
* (transparent) to 100 (opaque). Null means don't specify opacity directly, 100 is fully opaque. Note that heavy use of
* opacity may slow down your browser. See canvas.setOpacity() for details.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Sets the opacity for the widget to the newOpacity value. This newOpacity value must be within the range of 0 (transparent) to 100 (opaque). <br> In Internet Explorer, any other filter effects will be wiped out.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param opacity new opacity level. Default value is null
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
*/
public void setOpacity(Integer opacity) {
setAttribute("opacity", opacity, true);
}
/**
* Renders the widget to be partly transparent. A widget's opacity property may be set to any number between 0
* (transparent) to 100 (opaque). Null means don't specify opacity directly, 100 is fully opaque. Note that heavy use of
* opacity may slow down your browser. See canvas.setOpacity() for details.
*
*
* @return Integer
* @see com.smartgwt.client.docs.Cues Cues overview and related methods
*/
public Integer getOpacity() {
return getAttributeAsInt("opacity");
}
/**
* Controls what happens when the drawn size of the content of a Canvas is either greater or smaller than the specified
* size of the Canvas. Similar to the CSS property overflow, but consistent across browsers. See Overflow type for
* details.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Update the {@link com.smartgwt.client.widgets.Canvas#getOverflow overflow} of a Canvas after it has been created.
*
* @param overflow New overflow value.. Default value is Canvas.VISIBLE
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setOverflow(Overflow overflow) {
setAttribute("overflow", overflow == null ? null : overflow.getValue(), true);
}
/**
* Controls what happens when the drawn size of the content of a Canvas is either greater or smaller than the specified
* size of the Canvas. Similar to the CSS property overflow, but consistent across browsers. See Overflow type for
* details.
*
*
* @return Overflow
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public Overflow getOverflow() {
return EnumUtil.getEnum(Overflow.values(), getAttribute("overflow"));
}
/**
* Set the CSS padding of this component, in pixels. Padding provides space between the border and the component's
* contents. <P> This property sets the same thickness of padding on every side. Differing per-side padding can be set in
* a CSS style and applied via {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}. <P> Note that CSS padding
* does not affect the placement of {@link com.smartgwt.client.widgets.Canvas#getChildren children}. To provide a blank
* area around children, either use {@link com.smartgwt.client.widgets.Canvas#getMargin CSS margins} or use a {@link
* com.smartgwt.client.widgets.layout.Layout} as the parent instead, and use properties such as {@link
* com.smartgwt.client.widgets.layout.Layout#getLayoutMargin layoutMargin} to create blank space.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the CSS padding of this component, in pixels. Padding provides space between the border and the component's contents. <P> This property sets the same thickness of padding on every side. Differing per-side padding can be set in a CSS style and applied via {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}. <P>
*
* @param padding new padding in pixels. Default value is null
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setPadding(Integer padding) {
setAttribute("padding", padding, true);
}
/**
* Set the CSS padding of this component, in pixels. Padding provides space between the border and the component's
* contents. <P> This property sets the same thickness of padding on every side. Differing per-side padding can be set in
* a CSS style and applied via {@link com.smartgwt.client.widgets.Canvas#getStyleName styleName}. <P> Note that CSS padding
* does not affect the placement of {@link com.smartgwt.client.widgets.Canvas#getChildren children}. To provide a blank
* area around children, either use {@link com.smartgwt.client.widgets.Canvas#getMargin CSS margins} or use a {@link
* com.smartgwt.client.widgets.layout.Layout} as the parent instead, and use properties such as {@link
* com.smartgwt.client.widgets.layout.Layout#getLayoutMargin layoutMargin} to create blank space.
*
*
* @return Integer
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public Integer getPadding() {
return getAttributeAsInt("padding");
}
/**
* Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a
* specified {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo}. <P> Only affects widgets with a a specified
* {@link com.smartgwt.client.widgets.Canvas#getPercentSource percentSource}, or widgets that have {@link
* com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} set and are peers of some {@link
* com.smartgwt.client.widgets.Canvas#getMasterElement other canvas}. <P> Determines whether the coordinates used for
* sizing (for percentage sized widgets) and positioning (if <code>snapTo</code> is set) should be relative to the visible
* size or the viewport size of the percentSource or masterElement widget.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param percentBox percentBox Default value is "visible"
* @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 setPercentBox(PercentBoxModel percentBox) throws IllegalStateException {
setAttribute("percentBox", percentBox == null ? null : percentBox.getValue(), false);
}
/**
* Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a
* specified {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo}. <P> Only affects widgets with a a specified
* {@link com.smartgwt.client.widgets.Canvas#getPercentSource percentSource}, or widgets that have {@link
* com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} set and are peers of some {@link
* com.smartgwt.client.widgets.Canvas#getMasterElement other canvas}. <P> Determines whether the coordinates used for
* sizing (for percentage sized widgets) and positioning (if <code>snapTo</code> is set) should be relative to the visible
* size or the viewport size of the percentSource or masterElement widget.
*
*
* @return PercentBoxModel
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public PercentBoxModel getPercentBox() {
return EnumUtil.getEnum(PercentBoxModel.values(), getAttribute("percentBox"));
}
/**
* Absolute or relative, corresponding to the "absolute" (with respect to parent) or
* "relative" (with respect to document flow) values for the CSS position attribute.
* <P>
* Setting <code>position:"relative"</code> enables Smart GWT components to be embedded
* directly into the native HTML flow of a page, causing the component to be rendered
* within an existing DOM structure.
* This attribute should only be set to <code>"relative"</code> on a top level component
* (a component with no {@link com.smartgwt.client.widgets.Canvas#getParentElement parentElement}).
* <P>
* There are 2 ways to embed relatively positioned canvases in the DOM - by default the
* component will be written out inline when it gets {@link com.smartgwt.client.widgets.Canvas#draw drawn()n}. For example
* to embed a canvas in an HTML table you could use this code:
* <pre>
* <table>
* <tr>
* <td>
* <script>
* isc.Canvas.create({autoDraw:true, backgroundColor:"red", position:"relative"});
* </script>
* <td>
* </tr>
* </table>
* </pre>
* Alternatively you can make use of the {@link com.smartgwt.client.widgets.Canvas#getHtmlElement htmlElement} attribute.
* <P>
* Relative positioning is intended as a short-term integration scenario while incrementally
* upgrading existing applications.
* Note that relative positioning is not used to manage layout within Smart GWT components -
* instead the {@link com.smartgwt.client.widgets.layout.Layout} class would typically be used.
* For best consistency and flexibility across browsers, all Smart GWT layout managers
* use absolute positioning.
* <P>
* For canvases with a specified {@link com.smartgwt.client.widgets.Canvas#getHtmlElement htmlElement}, this attribute
* defaults to
* <code>"relative"</code>. In all other cases the default value will be
* <code>"absolute"</code>.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param position position Default value is null
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*
*/
public void setPosition(Positioning position) {
setAttribute("position", position == null ? null : position.getValue(), true);
}
/**
* Absolute or relative, corresponding to the "absolute" (with respect to parent) or
* "relative" (with respect to document flow) values for the CSS position attribute.
* <P>
* Setting <code>position:"relative"</code> enables Smart GWT components to be embedded
* directly into the native HTML flow of a page, causing the component to be rendered
* within an existing DOM structure.
* This attribute should only be set to <code>"relative"</code> on a top level component
* (a component with no {@link com.smartgwt.client.widgets.Canvas#getParentElement parentElement}).
* <P>
* There are 2 ways to embed relatively positioned canvases in the DOM - by default the
* component will be written out inline when it gets {@link com.smartgwt.client.widgets.Canvas#draw drawn()n}. For example
* to embed a canvas in an HTML table you could use this code:
* <pre>
* <table>
* <tr>
* <td>
* <script>
* isc.Canvas.create({autoDraw:true, backgroundColor:"red", position:"relative"});
* </script>
* <td>
* </tr>
* </table>
* </pre>
* Alternatively you can make use of the {@link com.smartgwt.client.widgets.Canvas#getHtmlElement htmlElement} attribute.
* <P>
* Relative positioning is intended as a short-term integration scenario while incrementally
* upgrading existing applications.
* Note that relative positioning is not used to manage layout within Smart GWT components -
* instead the {@link com.smartgwt.client.widgets.layout.Layout} class would typically be used.
* For best consistency and flexibility across browsers, all Smart GWT layout managers
* use absolute positioning.
* <P>
* For canvases with a specified {@link com.smartgwt.client.widgets.Canvas#getHtmlElement htmlElement}, this attribute
* defaults to
* <code>"relative"</code>. In all other cases the default value will be
* <code>"absolute"</code>.
*
*
* @return Positioning
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*
*/
public Positioning getPosition() {
return EnumUtil.getEnum(Positioning.values(), getAttribute("position"));
}
/**
* Prompt displayed in hover canvas if {@link com.smartgwt.client.widgets.Canvas#getShowHover showHover} is true.
*
* @param prompt prompt Default value is null
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a>
*/
public void setPrompt(String prompt) {
setAttribute("prompt", prompt, true);
}
/**
* Prompt displayed in hover canvas if {@link com.smartgwt.client.widgets.Canvas#getShowHover showHover} is true.
*
*
* @return String
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_interaction_hovers" target="examples">Hovers / Tooltips Example</a>
*/
public String getPrompt() {
return getAttributeAsString("prompt");
}
/**
* Should this element be redrawn in response to a resize? <P> Should be set to true for components whose {@link
* com.smartgwt.client.widgets.Canvas#getInnerHTML inner HTML} will not automatically reflow to fit the component's new
* size.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param redrawOnResize redrawOnResize Default value is true
* @see com.smartgwt.client.docs.Drawing Drawing overview and related methods
*/
public void setRedrawOnResize(Boolean redrawOnResize) {
setAttribute("redrawOnResize", redrawOnResize, true);
}
/**
* Should this element be redrawn in response to a resize? <P> Should be set to true for components whose {@link
* com.smartgwt.client.widgets.Canvas#getInnerHTML inner HTML} will not automatically reflow to fit the component's new
* size.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Drawing Drawing overview and related methods
*/
public Boolean getRedrawOnResize() {
return getAttributeAsBoolean("redrawOnResize");
}
/**
* When this Canvas is included as a member in a Layout, and {@link com.smartgwt.client.widgets.Canvas#getShowResizeBar
* showResizeBar} is set to <code>true</code> so that a resizeBar is created, <code>resizeBarTarget:"next"</code> can be
* set to indicate that the resizeBar should resize the next member of the layout rather than this one. For resizeBars
* that support hiding their target member when clicked on, <code>resizeBarTarget:"next"</code> also means that the next
* member will be the one hidden. <P> This is typically used to create a 3-way split pane, where left and right-hand
* sections can be resized or hidden to allow a center section to expand. <P> <b>NOTE:</b> as with any Layout, to ensure
* all available space is used, one or more members must maintain a flexible size (eg 75%, or *). In a two pane Layout
* with a normal resize bar, to fill all space after a user resizes, the member on the <b>right</b> should have flexible
* size. With resizeBarTarget:"next", the member on the <b>left</b> should have flexible size.
*
* @param resizeBarTarget resizeBarTarget Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.widgets.Canvas#setShowResizeBar
* @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods
*/
public void setResizeBarTarget(String resizeBarTarget) throws IllegalStateException {
setAttribute("resizeBarTarget", resizeBarTarget, false);
}
/**
* When this Canvas is included as a member in a Layout, and {@link com.smartgwt.client.widgets.Canvas#getShowResizeBar
* showResizeBar} is set to <code>true</code> so that a resizeBar is created, <code>resizeBarTarget:"next"</code> can be
* set to indicate that the resizeBar should resize the next member of the layout rather than this one. For resizeBars
* that support hiding their target member when clicked on, <code>resizeBarTarget:"next"</code> also means that the next
* member will be the one hidden. <P> This is typically used to create a 3-way split pane, where left and right-hand
* sections can be resized or hidden to allow a center section to expand. <P> <b>NOTE:</b> as with any Layout, to ensure
* all available space is used, one or more members must maintain a flexible size (eg 75%, or *). In a two pane Layout
* with a normal resize bar, to fill all space after a user resizes, the member on the <b>right</b> should have flexible
* size. With resizeBarTarget:"next", the member on the <b>left</b> should have flexible size.
*
*
* @return String
* @see com.smartgwt.client.widgets.Canvas#getShowResizeBar
* @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods
*/
public String getResizeBarTarget() {
return getAttributeAsString("resizeBarTarget");
}
/**
* How thick should we make the scrollbars for this canvas.<br> NOTE: has no effect if showCustomScrollbars is false.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param scrollbarSize scrollbarSize Default value is 16
* @see com.smartgwt.client.widgets.Canvas#getScrollbarSize
* @see com.smartgwt.client.docs.Scrolling Scrolling overview and related methods
*/
public void setScrollbarSize(int scrollbarSize) {
setAttribute("scrollbarSize", scrollbarSize, true);
}
/**
* How thick should we make the scrollbars for this canvas.<br> NOTE: has no effect if showCustomScrollbars is false.
*
*
* @return Returns the thickness of this widget's scrollbars.<br> For canvases showing custom scrollbars this is determined from
* <code>this.scrollbarSize</code>
* @see com.smartgwt.client.widgets.Canvas#getScrollbarSize
* @see com.smartgwt.client.docs.Scrolling Scrolling overview and related methods
*/
public int getScrollbarSize() {
return getAttributeAsInt("scrollbarSize");
}
/**
* Depth of the shadow, or the virtual height above the page of the widget throwing the shadow. <P> This is a single
* parameter that can be used to control both <code>shadowSoftness</code> and <code>shadowOffset</code>.
*
* @param shadowDepth shadowDepth Default value is 4
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setShadowDepth(int shadowDepth) throws IllegalStateException {
setAttribute("shadowDepth", shadowDepth, false);
}
/**
* Depth of the shadow, or the virtual height above the page of the widget throwing the shadow. <P> This is a single
* parameter that can be used to control both <code>shadowSoftness</code> and <code>shadowOffset</code>.
*
*
* @return int
*/
public int getShadowDepth() {
return getAttributeAsInt("shadowDepth");
}
/**
* Base name of the series of images for the sides, corners, and center of the shadow. <P> The actual image names fetched
* for the dropShadow combine the segment name and the <code>shadowDepth</code> setting. For example, given "ds.png" as
* the base name, a depth of 4, and the top-left segment of the shadow, we'd use "ds4_TL.png". <P> The names for segments
* are the same as those given for controlling resizable edges; see {@link com.smartgwt.client.widgets.Canvas#getResizeFrom
* resizeFrom}. The center segment has the name "center". The center segment is the only segment that doesn't include the
* depth in the URL, so the final image name for the center given a baseName of "ds.png" would be just "ds_center.png".
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param shadowImage shadowImage Default value is "[SKIN]ds.png"
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setShadowImage(String shadowImage) throws IllegalStateException {
setAttribute("shadowImage", shadowImage, false);
}
/**
* Base name of the series of images for the sides, corners, and center of the shadow. <P> The actual image names fetched
* for the dropShadow combine the segment name and the <code>shadowDepth</code> setting. For example, given "ds.png" as
* the base name, a depth of 4, and the top-left segment of the shadow, we'd use "ds4_TL.png". <P> The names for segments
* are the same as those given for controlling resizable edges; see {@link com.smartgwt.client.widgets.Canvas#getResizeFrom
* resizeFrom}. The center segment has the name "center". The center segment is the only segment that doesn't include the
* depth in the URL, so the final image name for the center given a baseName of "ds.png" would be just "ds_center.png".
*
*
* @return String
*/
public String getShadowImage() {
return getAttributeAsString("shadowImage");
}
/**
* Whether this canvas should be included in a printable view. <P> Default is to: <ul> <li> omit all peers (edges generated
* by showEdges:true, etc) <li> omit anything considered a "control", such as a button or menu (see {@link
* com.smartgwt.client.util.PrintProperties#getOmitControls omitControls}) <li> include everything else not marked
* shouldPrint:false </ul>
*
* @param shouldPrint shouldPrint Default value is null
* @see com.smartgwt.client.docs.Printing Printing overview and related methods
*/
public void setShouldPrint(Boolean shouldPrint) {
setAttribute("shouldPrint", shouldPrint, true);
}
/**
* Whether this canvas should be included in a printable view. <P> Default is to: <ul> <li> omit all peers (edges generated
* by showEdges:true, etc) <li> omit anything considered a "control", such as a button or menu (see {@link
* com.smartgwt.client.util.PrintProperties#getOmitControls omitControls}) <li> include everything else not marked
* shouldPrint:false </ul>
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Printing Printing overview and related methods
*/
public Boolean getShouldPrint() {
return getAttributeAsBoolean("shouldPrint");
}
/**
* Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
* <P>
* Smart GWT-based scrollbars are skinnable, giving you complete control over look and
* feel. Smart GWT-based scrollbars also enable some interactions not possible with
* native scrollbars, such as {@link com.smartgwt.client.widgets.grid.ListGrid#getFixedRecordHeights variable height
* records}
* in grids in combination with {@link com.smartgwt.client.widgets.grid.ListGrid#getDataPageSize data paging}.
* <P>
* Native browser scrollbars are slightly faster simply because there are less Smart GWT
* components that need to be created, drawn and updated. Each visible Smart GWT-based
* scrollbar on the screen has roughly the impact of two StretchImgButtons.
* <P>
* Smart GWT is always aware of the size of the scrollbar, regardless of whether native
* or custom scrollbars are used, and regardless of what operating system and/or operating
* system "theme" or "skin" is in use. This means Smart GWT will correctly report the
* {@link com.smartgwt.client.widgets.Canvas#getViewportHeight viewport size}, that is, the interior area of the
* widget excluding space taken by scrollbars, which is key for exactly filling a component
* with content without creating unnecessary scrolling.
* <P>
* The <code>showCustomScrollbars</code> setting is typically overridden in load_skin.js in
* order to change the default for all Smart GWT components at once.
* This may be achieved via the static {@link com.smartgwt.client.widgets.Canvas#setShowCustomScrollbars
* Canvas.setShowCustomScrollbars} method or
* via a simple addProperties block, like so:
* <pre>
* isc.Canvas.addProperties({ showCustomScrollbars:false });
* </pre>
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param showCustomScrollbars showCustomScrollbars Default value is true
* @see com.smartgwt.client.docs.Scrolling Scrolling overview and related methods
*/
public void setShowCustomScrollbars(Boolean showCustomScrollbars) {
setAttribute("showCustomScrollbars", showCustomScrollbars, true);
}
/**
* Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
* <P>
* Smart GWT-based scrollbars are skinnable, giving you complete control over look and
* feel. Smart GWT-based scrollbars also enable some interactions not possible with
* native scrollbars, such as {@link com.smartgwt.client.widgets.grid.ListGrid#getFixedRecordHeights variable height
* records}
* in grids in combination with {@link com.smartgwt.client.widgets.grid.ListGrid#getDataPageSize data paging}.
* <P>
* Native browser scrollbars are slightly faster simply because there are less Smart GWT
* components that need to be created, drawn and updated. Each visible Smart GWT-based
* scrollbar on the screen has roughly the impact of two StretchImgButtons.
* <P>
* Smart GWT is always aware of the size of the scrollbar, regardless of whether native
* or custom scrollbars are used, and regardless of what operating system and/or operating
* system "theme" or "skin" is in use. This means Smart GWT will correctly report the
* {@link com.smartgwt.client.widgets.Canvas#getViewportHeight viewport size}, that is, the interior area of the
* widget excluding space taken by scrollbars, which is key for exactly filling a component
* with content without creating unnecessary scrolling.
* <P>
* The <code>showCustomScrollbars</code> setting is typically overridden in load_skin.js in
* order to change the default for all Smart GWT components at once.
* This may be achieved via the static {@link com.smartgwt.client.widgets.Canvas#setShowCustomScrollbars
* Canvas.setShowCustomScrollbars} method or
* via a simple addProperties block, like so:
* <pre>
* isc.Canvas.addProperties({ showCustomScrollbars:false });
* </pre>
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Scrolling Scrolling overview and related methods
*/
public Boolean getShowCustomScrollbars() {
return getAttributeAsBoolean("showCustomScrollbars");
}
/**
* When this widget is dragged, if its dragAppearance is <code>"target"</code>, should we show a shadow behind the canvas
* during the drag.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param showDragShadow showDragShadow Default value is null
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_effects" target="examples">Drag effects Example</a>
*/
public void setShowDragShadow(Boolean showDragShadow) {
setAttribute("showDragShadow", showDragShadow, true);
}
/**
* When this widget is dragged, if its dragAppearance is <code>"target"</code>, should we show a shadow behind the canvas
* during the drag.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_dd_effects" target="examples">Drag effects Example</a>
*/
public Boolean getShowDragShadow() {
return getAttributeAsBoolean("showDragShadow");
}
/**
* Whether an {@link com.smartgwt.client.widgets.EdgedCanvas} should be used to show image-based edges around this
* component.
*
* @param showEdges showEdges Default value is false
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a>
*/
public void setShowEdges(Boolean showEdges) throws IllegalStateException {
setAttribute("showEdges", showEdges, false);
}
/**
* Whether an {@link com.smartgwt.client.widgets.EdgedCanvas} should be used to show image-based edges around this
* component.
*
*
* @return Boolean
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_edges" target="examples">Edges Example</a>
*/
public Boolean getShowEdges() {
return getAttributeAsBoolean("showEdges");
}
/**
* If <code>this.canHover</code> is true, should we show the global hover canvas by default when the user hovers over this
* canvas?
*
* @param showHover showHover Default value is true
* @see com.smartgwt.client.widgets.Canvas#getHoverHTML
*/
public void setShowHover(Boolean showHover) {
setAttribute("showHover", showHover, true);
}
/**
* If <code>this.canHover</code> is true, should we show the global hover canvas by default when the user hovers over this
* canvas?
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getHoverHTML
*/
public Boolean getShowHover() {
return getAttributeAsBoolean("showHover");
}
/**
* When set to true, shows a widget hovering at the mouse point instead of the builtin hover label. Override {@link
* com.smartgwt.client.widgets.Canvas#getHoverComponent getHoverComponent} to provide the Canvas to show as the
* hoverComponent.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param showHoverComponents showHoverComponents Default value is false
*/
public void setShowHoverComponents(Boolean showHoverComponents) {
setAttribute("showHoverComponents", showHoverComponents, true);
}
/**
* When set to true, shows a widget hovering at the mouse point instead of the builtin hover label. Override {@link
* com.smartgwt.client.widgets.Canvas#getHoverComponent getHoverComponent} to provide the Canvas to show as the
* hoverComponent.
*
*
* @return Boolean
*/
public Boolean getShowHoverComponents() {
return getAttributeAsBoolean("showHoverComponents");
}
/**
* When this Canvas is included as a member in a {@link com.smartgwt.client.widgets.layout.Layout}, whether a resizeBar
* should be shown after this member in the layout, to allow it to be resized. <p> Whether a resizeBar is actually shown
* also depends on the {@link com.smartgwt.client.widgets.layout.Layout#getDefaultResizeBars defaultResizeBars} attribute
* of the layout, and whether this Canvas is the last layout member. <p> By default the resize bar acts on the Canvas that
* it is declared on. If you want the resize bar to instead act on the next member of the Layout (e.g. to collapse down or
* to the right), set {@link com.smartgwt.client.widgets.Canvas#getResizeBarTarget resizeBarTarget} as well.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* When this Canvas is included as a member in a {@link com.smartgwt.client.widgets.layout.Layout}, dynamically updates whether a resizeBar should be shown after this member in the layout, to allow it to be resized. <p> Whether a resizeBar is actually shown also depends on the {@link com.smartgwt.client.widgets.layout.Layout#getDefaultResizeBars defaultResizeBars} attribute of the layout, and whether this Canvas is the last layout member.
*
* @param showResizeBar setting for this.showResizeBar. Default value is false
* @see com.smartgwt.client.widgets.Canvas#setResizeBarTarget
* @see com.smartgwt.client.widgets.layout.Layout#setDefaultResizeBars
* @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#layout_nesting" target="examples">Nesting Example</a>
*/
public void setShowResizeBar(Boolean showResizeBar) {
setAttribute("showResizeBar", showResizeBar, true);
}
/**
* When this Canvas is included as a member in a {@link com.smartgwt.client.widgets.layout.Layout}, whether a resizeBar
* should be shown after this member in the layout, to allow it to be resized. <p> Whether a resizeBar is actually shown
* also depends on the {@link com.smartgwt.client.widgets.layout.Layout#getDefaultResizeBars defaultResizeBars} attribute
* of the layout, and whether this Canvas is the last layout member. <p> By default the resize bar acts on the Canvas that
* it is declared on. If you want the resize bar to instead act on the next member of the Layout (e.g. to collapse down or
* to the right), set {@link com.smartgwt.client.widgets.Canvas#getResizeBarTarget resizeBarTarget} as well.
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getResizeBarTarget
* @see com.smartgwt.client.widgets.layout.Layout#getDefaultResizeBars
* @see com.smartgwt.client.docs.LayoutMember LayoutMember overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#layout_nesting" target="examples">Nesting Example</a>
*/
public Boolean getShowResizeBar() {
return getAttributeAsBoolean("showResizeBar");
}
/**
* Whether to show a drop shadow for this Canvas
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Method to update {@link com.smartgwt.client.widgets.Canvas#getShowShadow showShadow}.
*
* @param showShadow true if the shadow should be visible false if not. Default value is false
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_shadows" target="examples">Shadows Example</a>
*/
public void setShowShadow(Boolean showShadow) throws IllegalStateException {
setAttribute("showShadow", showShadow, false);
}
/**
* Whether to show a drop shadow for this Canvas
*
*
* @return Boolean
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_shadows" target="examples">Shadows Example</a>
*/
public Boolean getShowShadow() {
return getAttributeAsBoolean("showShadow");
}
/**
* Default directory for skin images (those defined by the class), relative to the Page-wide {@link
* com.smartgwt.client.util.Page#getSkinDir skinDir}.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param skinImgDir skinImgDir Default value is "images/"
* @see com.smartgwt.client.docs.Images Images overview and related methods
*/
public void setSkinImgDir(String skinImgDir) {
setAttribute("skinImgDir", skinImgDir, true);
}
/**
* Default directory for skin images (those defined by the class), relative to the Page-wide {@link
* com.smartgwt.client.util.Page#getSkinDir skinDir}.
*
*
* @return String
* @see com.smartgwt.client.docs.Images Images overview and related methods
*/
public String getSkinImgDir() {
return getAttributeAsString("skinImgDir");
}
/**
* Describes which axes to apply snap-to-grid to. Valid values are Canvas.HORIZONTAL, Canvas.VERTICAL and Canvas.BOTH
*
* @param snapAxis snapAxis Default value is Canvas.BOTH
* @see com.smartgwt.client.widgets.Canvas#setSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setSnapAxis(String snapAxis) {
setAttribute("snapAxis", snapAxis, true);
}
/**
* Describes which axes to apply snap-to-grid to. Valid values are Canvas.HORIZONTAL, Canvas.VERTICAL and Canvas.BOTH
*
*
* @return String
* @see com.smartgwt.client.widgets.Canvas#getSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public String getSnapAxis() {
return getAttributeAsString("snapAxis");
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} is defined to this widget, this property can be used to
* define which edge of this widget should be snapped to an edge of the master or parent element. <P> If unspecified the,
* default snapTo behavior is set up to align the "snapTo" edge of this widget with the snapTo edge of the master or
* parent.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the snapEdge property of this canvas, and handle repositioning.
*
* @param snapEdge new snapEdge value. Default value is null
* @see com.smartgwt.client.widgets.Canvas#setSnapTo
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setSnapEdge(String snapEdge) {
setAttribute("snapEdge", snapEdge, true);
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} is defined to this widget, this property can be used to
* define which edge of this widget should be snapped to an edge of the master or parent element. <P> If unspecified the,
* default snapTo behavior is set up to align the "snapTo" edge of this widget with the snapTo edge of the master or
* parent.
*
*
* @return Return the snapEdge value of this object
* @see com.smartgwt.client.widgets.Canvas#getSnapTo
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public String getSnapEdge() {
return getAttributeAsString("snapEdge");
}
/**
* The horizontal snap direction. Set this value to Canvas.BEFORE to snap to the nearest gridpoint to the left; set it to
* Canvas.AFTER to snap to the nearest gridpoint to the right; and set it to Canvas.NEAREST to snap to the nearest
* gridpoint in either direction.
*
* @param snapHDirection snapHDirection Default value is Canvas.AFTER
* @see com.smartgwt.client.widgets.Canvas#setSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setSnapHDirection(String snapHDirection) {
setAttribute("snapHDirection", snapHDirection, true);
}
/**
* The horizontal snap direction. Set this value to Canvas.BEFORE to snap to the nearest gridpoint to the left; set it to
* Canvas.AFTER to snap to the nearest gridpoint to the right; and set it to Canvas.NEAREST to snap to the nearest
* gridpoint in either direction.
*
*
* @return String
* @see com.smartgwt.client.widgets.Canvas#getSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public String getSnapHDirection() {
return getAttributeAsString("snapHDirection");
}
/**
* The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
*
* @param snapHGap snapHGap Default value is 20
* @see com.smartgwt.client.widgets.Canvas#setSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setSnapHGap(int snapHGap) {
setAttribute("snapHGap", snapHGap, true);
}
/**
* The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
*
*
* @return int
* @see com.smartgwt.client.widgets.Canvas#getSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public int getSnapHGap() {
return getAttributeAsInt("snapHGap");
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} is defined for this widget, this property can be used to
* specify an offset in px or percentage for the left coordinate of this widget. <P> For example if <code>snapTo</code> is
* specified as <code>"L"</code> and <code>snapOffsetLeft</code> is set to 6, this widget will be rendered 6px inside the
* left edge of its parent or master element. Alternatively if <code>snapTo</code> was set to <code>"R"</code>, a
* <code>snapOffsetLeft</code> value of -6 would cause the component to be rendered 6px inside the right edge of its
* parent or masterElement.
*
* @param snapOffsetLeft snapOffsetLeft Default value is null
* @see com.smartgwt.client.widgets.Canvas#setSnapTo
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setSnapOffsetLeft(Integer snapOffsetLeft) {
setAttribute("snapOffsetLeft", snapOffsetLeft, true);
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} is defined for this widget, this property can be used to
* specify an offset in px or percentage for the left coordinate of this widget. <P> For example if <code>snapTo</code> is
* specified as <code>"L"</code> and <code>snapOffsetLeft</code> is set to 6, this widget will be rendered 6px inside the
* left edge of its parent or master element. Alternatively if <code>snapTo</code> was set to <code>"R"</code>, a
* <code>snapOffsetLeft</code> value of -6 would cause the component to be rendered 6px inside the right edge of its
* parent or masterElement.
*
*
* @return Integer
* @see com.smartgwt.client.widgets.Canvas#getSnapTo
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public Integer getSnapOffsetLeft() {
return getAttributeAsInt("snapOffsetLeft");
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} is defined for this widget, this property can be used to
* specify an offset in px or percentage for the top coordinate of this widget. <P> For example if <code>snapTo</code> is
* specified as <code>"T"</code> and <code>snapOffsetTop</code> is set to 6, this widget will be rendered 6px below the
* top edge of its parent or master element. . Alternatively if <code>snapTo</code> was set to <code>"B"</code>, a
* <code>snapOffsetTop</code> value of -6 would cause the component to be rendered 6px inside the bottom edge of its
* parent or masterElement.
*
* @param snapOffsetTop snapOffsetTop Default value is null
* @see com.smartgwt.client.widgets.Canvas#setSnapTo
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setSnapOffsetTop(Integer snapOffsetTop) {
setAttribute("snapOffsetTop", snapOffsetTop, true);
}
/**
* If {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} is defined for this widget, this property can be used to
* specify an offset in px or percentage for the top coordinate of this widget. <P> For example if <code>snapTo</code> is
* specified as <code>"T"</code> and <code>snapOffsetTop</code> is set to 6, this widget will be rendered 6px below the
* top edge of its parent or master element. . Alternatively if <code>snapTo</code> was set to <code>"B"</code>, a
* <code>snapOffsetTop</code> value of -6 would cause the component to be rendered 6px inside the bottom edge of its
* parent or masterElement.
*
*
* @return Integer
* @see com.smartgwt.client.widgets.Canvas#getSnapTo
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public Integer getSnapOffsetTop() {
return getAttributeAsInt("snapOffsetTop");
}
/**
* When this canvas is dropped onto an object supporting snap-to-grid, should it snap to the grid (true, the default) or
* just drop wherever the mouse is (false).
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param snapOnDrop snapOnDrop Default value is true
* @see com.smartgwt.client.widgets.Canvas#setSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#shouldSnapOnDrop
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setSnapOnDrop(Boolean snapOnDrop) {
setAttribute("snapOnDrop", snapOnDrop, true);
}
/**
* When this canvas is dropped onto an object supporting snap-to-grid, should it snap to the grid (true, the default) or
* just drop wherever the mouse is (false).
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#shouldSnapOnDrop
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public Boolean getSnapOnDrop() {
return getAttributeAsBoolean("snapOnDrop");
}
/**
* Causes this canvas to snap to its parent's grid when resizing. Note that this value defaults to the Canvas's {@link
* com.smartgwt.client.widgets.Canvas#getSnapToGrid snapToGrid} value if undefined.
*
* @param snapResizeToGrid snapResizeToGrid Default value is null
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setSnapResizeToGrid(Boolean snapResizeToGrid) {
setAttribute("snapResizeToGrid", snapResizeToGrid, true);
}
/**
* Causes this canvas to snap to its parent's grid when resizing. Note that this value defaults to the Canvas's {@link
* com.smartgwt.client.widgets.Canvas#getSnapToGrid snapToGrid} value if undefined.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public Boolean getSnapResizeToGrid() {
return getAttributeAsBoolean("snapResizeToGrid");
}
/**
* Position this widget such that it is aligned with ("snapped to") an edge of its {@link
* com.smartgwt.client.widgets.Canvas#getMasterElement masterElement} (if specified), or its {@link
* com.smartgwt.client.widgets.Canvas#getParentElement parentElement}. <P> Note that this property also impacts the sizing
* of this widget. If this widgets size is specified as a percent value, and has no explicit {@link
* com.smartgwt.client.widgets.Canvas#getPercentSource percentSource}, sizing will be calculated based on the size of the
* masterElement when snapTo is set. <P> Possible values: BR, BL, TR, TL, R, L, B, T, C where B=Bottom, T=Top, L=Left,
* R=right and C=center <P> Standard snapTo behavior will attach the outer edge of the widget to the parent or master
* element - for example setting <code>snapTo</code> to <code>"B"</code> would align the bottom edge of this component with
* the bottom edge of the master or parent element (and center this component horizontally over its master or parent
* element). {@link com.smartgwt.client.widgets.Canvas#getSnapEdge snapEdge} can be specified to change this behavior
* allowing the developer to, for example, align the top edge of this component with the bottom edge of its masterElement.
* <P> {@link com.smartgwt.client.widgets.Canvas#getSnapOffsetLeft snapOffsetLeft} and {@link
* com.smartgwt.client.widgets.Canvas#getSnapOffsetTop snapOffsetTop} may also be specified to offset the element from
* exact snapTo alignment.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Set the snapTo property of this canvas, and handle repositioning.
*
* @param snapTo new snapTo value. Default value is null
* @see com.smartgwt.client.widgets.Canvas#setSnapEdge
* @see com.smartgwt.client.widgets.Canvas#setPercentBox
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public void setSnapTo(String snapTo) {
setAttribute("snapTo", snapTo, true);
}
/**
* Position this widget such that it is aligned with ("snapped to") an edge of its {@link
* com.smartgwt.client.widgets.Canvas#getMasterElement masterElement} (if specified), or its {@link
* com.smartgwt.client.widgets.Canvas#getParentElement parentElement}. <P> Note that this property also impacts the sizing
* of this widget. If this widgets size is specified as a percent value, and has no explicit {@link
* com.smartgwt.client.widgets.Canvas#getPercentSource percentSource}, sizing will be calculated based on the size of the
* masterElement when snapTo is set. <P> Possible values: BR, BL, TR, TL, R, L, B, T, C where B=Bottom, T=Top, L=Left,
* R=right and C=center <P> Standard snapTo behavior will attach the outer edge of the widget to the parent or master
* element - for example setting <code>snapTo</code> to <code>"B"</code> would align the bottom edge of this component with
* the bottom edge of the master or parent element (and center this component horizontally over its master or parent
* element). {@link com.smartgwt.client.widgets.Canvas#getSnapEdge snapEdge} can be specified to change this behavior
* allowing the developer to, for example, align the top edge of this component with the bottom edge of its masterElement.
* <P> {@link com.smartgwt.client.widgets.Canvas#getSnapOffsetLeft snapOffsetLeft} and {@link
* com.smartgwt.client.widgets.Canvas#getSnapOffsetTop snapOffsetTop} may also be specified to offset the element from
* exact snapTo alignment.
*
*
* @return Return the snapTo value of this object
* @see com.smartgwt.client.widgets.Canvas#getSnapEdge
* @see com.smartgwt.client.widgets.Canvas#getPercentBox
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public String getSnapTo() {
return getAttributeAsString("snapTo");
}
/**
* Causes this canvas to snap to its parent's grid when dragging.
*
* @param snapToGrid snapToGrid Default value is null
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setSnapToGrid(Boolean snapToGrid) {
setAttribute("snapToGrid", snapToGrid, true);
}
/**
* Causes this canvas to snap to its parent's grid when dragging.
*
*
* @return Boolean
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public Boolean getSnapToGrid() {
return getAttributeAsBoolean("snapToGrid");
}
/**
* The vertical snap direction. Set this value to Canvas.BEFORE to snap to the nearest gridpoint above; set it to
* Canvas.AFTER to snap to the nearest gridpoint below; and set it to Canvas.NEAREST to snap to the nearest gridpoint in
* either direction.
*
* @param snapVDirection snapVDirection Default value is Canvas.AFTER
* @see com.smartgwt.client.widgets.Canvas#setSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setSnapVDirection(String snapVDirection) {
setAttribute("snapVDirection", snapVDirection, true);
}
/**
* The vertical snap direction. Set this value to Canvas.BEFORE to snap to the nearest gridpoint above; set it to
* Canvas.AFTER to snap to the nearest gridpoint below; and set it to Canvas.NEAREST to snap to the nearest gridpoint in
* either direction.
*
*
* @return String
* @see com.smartgwt.client.widgets.Canvas#getSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public String getSnapVDirection() {
return getAttributeAsString("snapVDirection");
}
/**
* The vertical grid size to use, in pixels, when snap-to-grid is enabled.
*
* @param snapVGap snapVGap Default value is 20
* @see com.smartgwt.client.widgets.Canvas#setSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#setChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public void setSnapVGap(int snapVGap) {
setAttribute("snapVGap", snapVGap, true);
}
/**
* The vertical grid size to use, in pixels, when snap-to-grid is enabled.
*
*
* @return int
* @see com.smartgwt.client.widgets.Canvas#getSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getSnapResizeToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapToGrid
* @see com.smartgwt.client.widgets.Canvas#getChildrenSnapResizeToGrid
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public int getSnapVGap() {
return getAttributeAsInt("snapVGap");
}
/**
* The CSS class applied to this widget as a whole.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Sets the CSS class for this widget
*
* @param styleName new CSS style name. Default value is "normal"
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_css" target="examples">CSS styles Example</a>
*/
public void setStyleName(String styleName) {
setAttribute("styleName", styleName, true);
}
/**
* The CSS class applied to this widget as a whole.
*
*
* @return String
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#effects_lf_css" target="examples">CSS styles Example</a>
*/
public String getStyleName() {
return getAttributeAsString("styleName");
}
/**
* If specified this governs the tabIndex of the widget in the page's tab order. Note that by default Smart GWT
* auto-assigns tab-indices, ensuring focusable widgets are reachable by tabbing in the order in which they are drawn on
* the page. <code>canvas.tabIndex</code> cannot be set to greater than {@link
* com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR TAB_INDEX_FLOOR} - as we reserve the values above this range for
* auto-assigned tab-indices.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Assign an explicit tabIndex to this widget.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param tabIndex New tabIndex for this widget. Must be less than {@link
* com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR TAB_INDEX_FLOOR} to avoid interfering with auto-assigned
* tab indices on the page.. Default value is null
* @see com.smartgwt.client.docs.Focus Focus overview and related methods
*/
public void setTabIndex(Integer tabIndex) {
setAttribute("tabIndex", tabIndex, true);
}
/**
* If specified this governs the tabIndex of the widget in the page's tab order. Note that by default Smart GWT
* auto-assigns tab-indices, ensuring focusable widgets are reachable by tabbing in the order in which they are drawn on
* the page. <code>canvas.tabIndex</code> cannot be set to greater than {@link
* com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR TAB_INDEX_FLOOR} - as we reserve the values above this range for
* auto-assigned tab-indices.
*
*
* @return Integer
* @see com.smartgwt.client.docs.Focus Focus overview and related methods
*/
public Integer getTabIndex() {
return getAttributeAsInt("tabIndex");
}
/**
* Configures where the Opacity filter is used for IE6-8. <P> With the default of null, opacity filters are used unless
* {@link com.smartgwt.client.widgets.Canvas#neverUseFilters neverUseFilters} has been set. When set explicitly to true,
* opacity filters are used even if <code>neverUseFilters</code> is true. <P> See {@link
* com.smartgwt.client.docs.IEFilters} for background.
*
* @param useOpacityFilter useOpacityFilter Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
* @see com.smartgwt.client.docs.IEFilters IEFilters overview and related methods
*/
public void setUseOpacityFilter(Boolean useOpacityFilter) throws IllegalStateException {
setAttribute("useOpacityFilter", useOpacityFilter, false);
}
/**
* Configures where the Opacity filter is used for IE6-8. <P> With the default of null, opacity filters are used unless
* {@link com.smartgwt.client.widgets.Canvas#neverUseFilters neverUseFilters} has been set. When set explicitly to true,
* opacity filters are used even if <code>neverUseFilters</code> is true. <P> See {@link
* com.smartgwt.client.docs.IEFilters} for background.
*
*
* @return Boolean
* @see com.smartgwt.client.docs.IEFilters IEFilters overview and related methods
*/
public Boolean getUseOpacityFilter() {
return getAttributeAsBoolean("useOpacityFilter");
}
/**
* {@link com.smartgwt.client.widgets.form.ValuesManager} for managing values displayed in this component. If specified at
* initialization time, this component will be added to the valuesManager via {@link
* com.smartgwt.client.widgets.form.ValuesManager#addMember ValuesManager.addMember}. <P> ValuesManagers allow different
* fields of a single object to be displayed or edited across multiple UI components. Given a single values object, a
* valuesManager will handle determining the appropriate field values for its member components and displaying them /
* responding to edits if the components support this. <P> Data may be derived simply from the specified fieldNames within
* the member components, or for complex nested data structures can be specified by both component and field-level {@link
* com.smartgwt.client.widgets.Canvas#getDataPath dataPath}. <P> Note that components may be automatically bound to an
* existing valuesManager attached to a parent component if dataPath is specified. See {@link
* com.smartgwt.client.widgets.Canvas#getDataPath dataPath} for more information. Also note that if a databound component
* has a specified dataSource and dataPath but no specified valuesManager object one will be automatically generated as
* part of the databinding process
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Setter for the {@link com.smartgwt.client.widgets.Canvas#getValuesManager valuesManager} attribute. This method may be called directly at runtime to set the ValuesManager for a component; it has the same effect as calling {@link com.smartgwt.client.widgets.form.ValuesManager#addMember ValuesManager.addMember}, passing in this DataBoundComponent.
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param valuesManager new dataPath. Default value is null
*/
public void setValuesManager(ValuesManager valuesManager) {
setAttribute("valuesManager", valuesManager == null ? null : valuesManager.getOrCreateJsObj(), true);
}
/**
* {@link com.smartgwt.client.widgets.form.ValuesManager} for managing values displayed in this component. If specified at
* initialization time, this component will be added to the valuesManager via {@link
* com.smartgwt.client.widgets.form.ValuesManager#addMember ValuesManager.addMember}. <P> ValuesManagers allow different
* fields of a single object to be displayed or edited across multiple UI components. Given a single values object, a
* valuesManager will handle determining the appropriate field values for its member components and displaying them /
* responding to edits if the components support this. <P> Data may be derived simply from the specified fieldNames within
* the member components, or for complex nested data structures can be specified by both component and field-level {@link
* com.smartgwt.client.widgets.Canvas#getDataPath dataPath}. <P> Note that components may be automatically bound to an
* existing valuesManager attached to a parent component if dataPath is specified. See {@link
* com.smartgwt.client.widgets.Canvas#getDataPath dataPath} for more information. Also note that if a databound component
* has a specified dataSource and dataPath but no specified valuesManager object one will be automatically generated as
* part of the databinding process
*
*
* @return ValuesManager
*/
public ValuesManager getValuesManager() {
return ValuesManager.getOrCreateRef(getAttributeAsJavaScriptObject("valuesManager"));
}
/**
* Controls widget visibility when the widget is initialized. See Visibility type for details.
*
* <br><br>If this method is called after the component has been drawn/initialized:
* Sets this widget's visibility to "inherit", so that it becomes visible if all it's parents are visible or it has no parents. <P> If the widget has not yet been drawn (and doesn't have a parent or master), this method calls the draw method as well.
*
* @param visibility visibility Default value is Canvas.INHERIT
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public void setVisibility(Visibility visibility) {
setAttribute("visibility", visibility == null ? null : visibility.getValue(), true);
}
/**
* Controls widget visibility when the widget is initialized. See Visibility type for details.
*
*
* @return Returns true if the widget is visible, taking all parents into account, so that a widget which is not hidden might still
* report itself as not visible if it is within a hidden parent. <P> NOTE: Undrawn widgets will report themselves as
* visible if they would be visible if drawn.
* @see com.smartgwt.client.docs.Appearance Appearance overview and related methods
*/
public Visibility getVisibility() {
return EnumUtil.getEnum(Visibility.values(), getAttribute("visibility"));
}
// ********************* Methods ***********************
/**
* Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if name
* argument is provided, and draw the child if this widget has been drawn already. <P> If newChild has a parent it will be
* removed from it. If it has a master, it will be detached from it if the master is a child of a different parent. If
* newChild has peers, they'll be added to this widget as children as well.
* @param newChild new child canvas to add
*
* @return the new child, or null if it couldn't be added
* @see com.smartgwt.client.docs.Containment Containment overview and related methods
*/
public native Canvas addChild(Canvas newChild) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var ret = self.addChild(newChild.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
if(ret == null || ret === undefined) return null;
var retVal = @com.smartgwt.client.widgets.BaseWidget::getRef(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
if(retVal == null) {
retVal = @com.smartgwt.client.widgets.Canvas::new(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
}
return retVal;
}-*/;
/**
* Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if name
* argument is provided, and draw the child if this widget has been drawn already. <P> If newChild has a parent it will be
* removed from it. If it has a master, it will be detached from it if the master is a child of a different parent. If
* newChild has peers, they'll be added to this widget as children as well.
* @param newChild new child canvas to add
* @param name name to assign to child (eg: this[name] == child)
* @param autoDraw if false, child will not automatically be drawn (only for advanced use)
*
* @return the new child, or null if it couldn't be added
* @see com.smartgwt.client.docs.Containment Containment overview and related methods
*/
public native Canvas addChild(Canvas newChild, String name, boolean autoDraw) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var ret = self.addChild(newChild.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()(), name, autoDraw);
if(ret == null || ret === undefined) return null;
var retVal = @com.smartgwt.client.widgets.BaseWidget::getRef(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
if(retVal == null) {
retVal = @com.smartgwt.client.widgets.Canvas::new(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
}
return retVal;
}-*/;
/**
* Adds newPeer as a peer of this widget (also making it a child of this widget's parent, if any), set up a named
* object reference (i.e., this[name]) to the new widget if name is provided, and draw the peer if this widget has
* been drawn already.<br> The widget to be added as a peer will be removed from its old master and/or parent, if any,
* and it will be added as a child to the parent of this canvas (if any)
* @param newPeer new peer widget to add
*
* @return the new peer, or null if it couldn't be added
* @see com.smartgwt.client.docs.Containment Containment overview and related methods
*/
public native Canvas addPeer(Canvas newPeer) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var ret = self.addPeer(newPeer.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
if(ret == null || ret === undefined) return null;
var retVal = @com.smartgwt.client.widgets.BaseWidget::getRef(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
if(retVal == null) {
retVal = @com.smartgwt.client.widgets.Canvas::new(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
}
return retVal;
}-*/;
/**
* Adds newPeer as a peer of this widget (also making it a child of this widget's parent, if any), set up a named
* object reference (i.e., this[name]) to the new widget if name is provided, and draw the peer if this widget has
* been drawn already.<br> The widget to be added as a peer will be removed from its old master and/or parent, if any,
* and it will be added as a child to the parent of this canvas (if any)
* @param newPeer new peer widget to add
* @param name name to assign to peer (eg: this[peer] == child)
* @param autoDraw if true, peer will not automatically be drawn (only for advanced use)
* @param preDraw if true, when draw is called on the master widget, the peer will be drawn before the
* master
*
* @return the new peer, or null if it couldn't be added
* @see com.smartgwt.client.docs.Containment Containment overview and related methods
*/
public native Canvas addPeer(Canvas newPeer, String name, boolean autoDraw, boolean preDraw) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var ret = self.addPeer(newPeer.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()(), name, autoDraw, preDraw);
if(ret == null || ret === undefined) return null;
var retVal = @com.smartgwt.client.widgets.BaseWidget::getRef(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
if(retVal == null) {
retVal = @com.smartgwt.client.widgets.Canvas::new(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
}
return retVal;
}-*/;
/**
* This method tells a component to adjust for size changes made to content by external code. <P> This is for very advanced
* use in which the contents of a Canvas are being directly updated by Ajax techniques, which is required for integration
* with some third-party libraries. Calling this method is required because browsers do not provide consistent events by
* which Smart GWT can be notified of external content changes. <P> Only contents supplied to a widget via {@link
* com.smartgwt.client.widgets.Canvas#getContents contents} or via an override of {@link
* com.smartgwt.client.widgets.Canvas#getInnerHTML Canvas.getInnerHTML} should be manipulated directly. Contents
* automatically generated by Smart GWT components (such as the basic structure of a Button) should never be manipulated:
* these structures are considered internal, differ by platform, and will change without notice.
* @param immediate By default the adjustment will occur on a small delay for performance reasons. Pass in this parameter to force
* immediate adjustment.
*/
public native void adjustForContent(boolean immediate) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.adjustForContent(immediate);
}-*/;
/**
* If this canvas has keyboard focus, blur it. After this method, the canvas will no longer appear focused and will stop
* receiving keyboard events.
*/
public native void blur() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.blur();
}-*/;
/**
* Puts this widget at the top of the stacking order, so it appears in front of all other widgets in the same parent.
*/
public native void bringToFront() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.bringToFront();
}-*/;
/**
* Remove all visual representation of a Canvas, including all child or member Canvases, or managed top-level components
* such as the ListGrid drop location indicator. <P> This is more expensive than hide(), because in order to become visible
* again, the Canvas must be draw()n again. Generally, application code has no reason to call clear() unless it is
* attempting to do advanced memory management. If you want to temporarily hide a Canvas, use hide() and show(), and if
* you want to permanently destroy a Canvas, use {@link com.smartgwt.client.widgets.Canvas#destroy Canvas.destroy}. <P> You
* would only use clear() if you were managing a very large pool of components and you wanted to reclaim some of the memory
* used by components that had not been used in a while, while still being able to just draw() them to make them active and
* visible again. <P> Note: a clear() will happen as part of moving a Canvas to a different parent. See {@link
* com.smartgwt.client.widgets.Canvas#addChild Canvas.addChild}.
*/
public native void clear() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.clear();
}-*/;
/**
* Add a click handler.
* <p>
* Executed when the left mouse is clicked (pressed and then released) on this widget. No default implementation.
*
* @param handler the click handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addClickHandler(com.smartgwt.client.widgets.events.ClickHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.ClickEvent.getType()) == 0) setupClickEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.ClickEvent.getType());
}
private native void setupClickEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({click:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.ClickEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.click = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.ClickEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Determines whether a clickmask is showing
*/
public native void clickMaskUp() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.clickMaskUp();
}-*/;
/**
* Determines whether a clickmask is showing
* @param ID optional ID of specific clickMask to check. If not passed, checks for the click mask associated
* with this widget only.
* @see com.smartgwt.client.widgets.Canvas#showClickMask
*/
public native void clickMaskUp(String ID) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.clickMaskUp(ID);
}-*/;
/**
* Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment
* hierarchy); and false otherwise.
* @param canvas the canvas to be tested
*
* @return true if specified element is a descendant of this canvas; false otherwise
* @see com.smartgwt.client.docs.Containment Containment overview and related methods
*/
public native Boolean contains(Canvas canvas) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.contains(canvas.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment
* hierarchy); and false otherwise.
* @param canvas the canvas to be tested
* @param testSelf If passed this method will return true if the the canvas parameter is a pointer to this
* widget.
*
* @return true if specified element is a descendant of this canvas; false otherwise
* @see com.smartgwt.client.docs.Containment Containment overview and related methods
*/
public native Boolean contains(Canvas canvas, boolean testSelf) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.contains(canvas.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()(), testSelf);
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Return true if the last event's mouse coordinates are within the bounds of this component. NOTE: Z-ordering is not
* considered for the purposes of this test. If the coordinate you're testing is occluded by other component, but the X,Y
* coordinates are still within the bounds of that component, this method will return true.
*
* @return true if the event occurred within the bounds of this component
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native Boolean containsEvent() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.containsEvent();
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Returns true if the keyboard focus is in this Canvas or any child of this Canvas.
*
* @return whether this Canvas contains the keyboard focus
* @see com.smartgwt.client.docs.Focus Focus overview and related methods
*/
public native Boolean containsFocus() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.containsFocus();
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Return whether or not this object contains the specified global (x,y) coordinates. <P> Will return false if any
* parentElement does not contain the specified point, (EG: you're hovering over an element's absolute location, but it is
* scrolled out of view in a parent element)
* @param x GLOBAL x-coordinate
* @param y GLOBAL y-coordinate
*
* @return true if this object contains the specified point; false otherwise
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native Boolean containsPoint(int x, int y) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.containsPoint(x, y);
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Return whether or not this object contains the specified global (x,y) coordinates. <P> Will return false if any
* parentElement does not contain the specified point, (EG: you're hovering over an element's absolute location, but it is
* scrolled out of view in a parent element)
* @param x GLOBAL x-coordinate
* @param y GLOBAL y-coordinate
* @param withinViewport point lies specifically within our viewport (drawn area excluding margins
* and scrollbars if present)
*
* @return true if this object contains the specified point; false otherwise
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native Boolean containsPoint(int x, int y, boolean withinViewport) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.containsPoint(x, y, withinViewport);
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Disables this widget and any children and peers of this widget.
*/
public native void disable() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.disable();
}-*/;
/**
* Add a doubleClick handler.
* <p>
* Executed when the left mouse button is clicked twice in rapid succession (within {@link
* com.smartgwt.client.widgets.Canvas#getDoubleClickDelay doubleClickDelay} by default) in this object.
*
* @param handler the doubleClick handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDoubleClickHandler(com.smartgwt.client.widgets.events.DoubleClickHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DoubleClickEvent.getType()) == 0) setupDoubleClickEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DoubleClickEvent.getType());
}
private native void setupDoubleClickEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({doubleClick:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DoubleClickEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.doubleClick = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DoubleClickEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragMove handler.
* <p>
* Executed every time the mouse moves while dragging this canvas.
*
* @param handler the dragMove handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragMoveHandler(com.smartgwt.client.widgets.events.DragMoveHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragMoveEvent.getType()) == 0) setupDragMoveEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragMoveEvent.getType());
}
private native void setupDragMoveEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragMove:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragMove = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragRepositionMove handler.
* <p>
* Executed every time the mouse moves while drag-repositioning. If this method does not Call {@link com.smartgwt.client.widgets.events.DragRepositionMoveEvent#cancel()} from within {@link DragRepositionMoveHandler#onDragRepositionMove}, the {@link
* com.smartgwt.client.widgets.Canvas#getDragTarget dragTarget} (or outline if {@link
* com.smartgwt.client.widgets.Canvas#getDragAppearance dragAppearance} is set to "outline") will automatically be moved as
* appropriate whenever the mouse moves.
*
* @param handler the dragRepositionMove handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragRepositionMoveHandler(com.smartgwt.client.widgets.events.DragRepositionMoveHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragRepositionMoveEvent.getType()) == 0) setupDragRepositionMoveEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragRepositionMoveEvent.getType());
}
private native void setupDragRepositionMoveEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragRepositionMove:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragRepositionMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragRepositionMove = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragRepositionMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragRepositionStart handler.
* <p>
* Executed when dragging first starts. No default implementation. Create this handler to set things up for the drag
* reposition.
*
* @param handler the dragRepositionStart handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragRepositionStartHandler(com.smartgwt.client.widgets.events.DragRepositionStartHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragRepositionStartEvent.getType()) == 0) setupDragRepositionStartEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragRepositionStartEvent.getType());
}
private native void setupDragRepositionStartEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragRepositionStart:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragRepositionStartEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragRepositionStart = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragRepositionStartEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragRepositionStop handler.
* <p>
* Executed when the mouse button is released at the end of the drag. Your widget can use this opportunity to fire custom
* code based upon where the mouse button was released, etc. <p> Returning true from this handler will cause the {@link
* com.smartgwt.client.widgets.Canvas#getDragTarget dragTarget} (or outline if {@link
* com.smartgwt.client.widgets.Canvas#getDragAppearance dragAppearance} is set to "outline") to be left in its current
* location. Returning false from this handler will cause it to snap back to its original location.
*
* @param handler the dragRepositionStop handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragRepositionStopHandler(com.smartgwt.client.widgets.events.DragRepositionStopHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragRepositionStopEvent.getType()) == 0) setupDragRepositionStopEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragRepositionStopEvent.getType());
}
private native void setupDragRepositionStopEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragRepositionStop:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragRepositionStopEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragRepositionStop = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragRepositionStopEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragResizeMove handler.
* <p>
* Executed every time the mouse moves while drag-resizing. If this method does not Call {@link com.smartgwt.client.widgets.events.DragResizeMoveEvent#cancel()} from within {@link DragResizeMoveHandler#onDragResizeMove}, the {@link
* com.smartgwt.client.widgets.Canvas#getDragTarget dragTarget} (or outline if {@link
* com.smartgwt.client.widgets.Canvas#getDragAppearance dragAppearance} is set to "outline") will automatically be moved as
* appropriate whenever the mouse moves.
*
* @param handler the dragResizeMove handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragResizeMoveHandler(com.smartgwt.client.widgets.events.DragResizeMoveHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragResizeMoveEvent.getType()) == 0) setupDragResizeMoveEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragResizeMoveEvent.getType());
}
private native void setupDragResizeMoveEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragResizeMove:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragResizeMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragResizeMove = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragResizeMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragResizeStart handler.
* <p>
* Executed when resize dragging first starts. No default implementation. Create this handler to set things up for the
* drag resize.
*
* @param handler the dragResizeStart handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragResizeStartHandler(com.smartgwt.client.widgets.events.DragResizeStartHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragResizeStartEvent.getType()) == 0) setupDragResizeStartEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragResizeStartEvent.getType());
}
private native void setupDragResizeStartEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragResizeStart:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragResizeStartEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragResizeStart = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragResizeStartEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragResizeStop handler.
* <p>
* Executed when the mouse button is released at the end of the drag resize. Your widget can use this opportunity to fire
* custom code based upon where the mouse button was released, etc. <p> Returning true from this handler will cause the
* {@link com.smartgwt.client.widgets.Canvas#getDragTarget dragTarget} (or outline if {@link
* com.smartgwt.client.widgets.Canvas#getDragAppearance dragAppearance} is set to "outline") to be left at its current
* size. Returning false from this handler will cause it to snap back to its original location size
*
* @param handler the dragResizeStop handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragResizeStopHandler(com.smartgwt.client.widgets.events.DragResizeStopHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragResizeStopEvent.getType()) == 0) setupDragResizeStopEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragResizeStopEvent.getType());
}
private native void setupDragResizeStopEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragResizeStop:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragResizeStopEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragResizeStop = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragResizeStopEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragStart handler.
* <p>
* Executed when dragging first starts. Your widget can use this opportunity to set things up for the drag, such as setting
* the drag tracker. Returning false from this event handler will cancel the drag action entirely. <p> A drag action is
* considered to be begin when the mouse has moved {@link com.smartgwt.client.widgets.Canvas#getDragStartDistance
* dragStartDistance} with the left mouse down.
*
* @param handler the dragStart handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragStartHandler(com.smartgwt.client.widgets.events.DragStartHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragStartEvent.getType()) == 0) setupDragStartEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragStartEvent.getType());
}
private native void setupDragStartEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragStart:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragStartEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragStart = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragStartEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dragStop handler.
* <p>
* Executed when the mouse button is released at the end of the drag. Your widget can use this opportunity to fire code
* based on the last location of the drag or reset any visual state that was sent.
*
* @param handler the dragStop handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDragStopHandler(com.smartgwt.client.widgets.events.DragStopHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DragStopEvent.getType()) == 0) setupDragStopEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DragStopEvent.getType());
}
private native void setupDragStopEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dragStop:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragStopEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dragStop = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DragStopEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dropMove handler.
* <p>
* Executed whenever the compatible dragged object is moved over this drop target. You can use this to show a custom visual
* indication of where the drop would occur within the widget.
*
* @param handler the dropMove handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDropMoveHandler(com.smartgwt.client.widgets.events.DropMoveHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DropMoveEvent.getType()) == 0) setupDropMoveEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DropMoveEvent.getType());
}
private native void setupDropMoveEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dropMove:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DropMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dropMove = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DropMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dropOut handler.
* <p>
* Executed when the dragged object is moved out of the rectangle of this drop target. If you have set a visual indication
* in dropOver or dropMove, you should reset it to its normal state in dropOut.
*
* @param handler the dropOut handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDropOutHandler(com.smartgwt.client.widgets.events.DropOutHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DropOutEvent.getType()) == 0) setupDropOutEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DropOutEvent.getType());
}
private native void setupDropOutEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dropOut:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DropOutEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dropOut = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DropOutEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a dropOver handler.
* <p>
* Executed when the compatible dragged object is first moved over this drop target. Your implementation can use this to
* show a custom visual indication that the object can be dropped here.
*
* @param handler the dropOver handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDropOverHandler(com.smartgwt.client.widgets.events.DropOverHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DropOverEvent.getType()) == 0) setupDropOverEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DropOverEvent.getType());
}
private native void setupDropOverEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({dropOver:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DropOverEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.dropOver = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DropOverEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Enables this widget and any children / peers of this widget.
*/
public native void enable() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.enable();
}-*/;
/**
* If this canvas can accept focus, give it keyboard focus. After this method, the canvas will appear focused and will
* receive keyboard events.
*/
public native void focus() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.focus();
}-*/;
/**
* Add a focusChanged handler.
* <p>
* Notification function fired when this widget receives or loses keyboard focus.
*
* @param handler the focusChanged handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addFocusChangedHandler(com.smartgwt.client.widgets.events.FocusChangedHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.FocusChangedEvent.getType()) == 0) setupFocusChangedEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.FocusChangedEvent.getType());
}
private native void setupFocusChangedEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({focusChanged:$entry(function(){
var param = {"hasFocus" : arguments[0]};
var event = @com.smartgwt.client.widgets.events.FocusChangedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
})
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.focusChanged = $entry(function(){
var param = {"hasFocus" : arguments[0]};
var event = @com.smartgwt.client.widgets.events.FocusChangedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
});
}
}-*/;
/**
* Return the bottom coordinate of this object as rendered, relative to its enclosing context, in pixels.
*
* @return bottom coordinate
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getBottom() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getBottom();
}-*/;
/**
* Returns a fully qualified String for this canvas. This is calculated by combining the canvas' specified {@link
* com.smartgwt.client.widgets.Canvas#getDataPath dataPath} with the <code>dataPath</code> of any parent canvases up to
* whichever canvas has a specified {@link com.smartgwt.client.widgets.Canvas#getValuesManager valuesManager} specified to
* actually manage values from this component.
*
* @return fully qualified dataPath for this component
*/
public native String getFullDataPath() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getFullDataPath();
}-*/;
/**
* If <code>this.showHover</code> is true, when the user holds the mouse over this Canvas for long enough to trigger a
* hover event, a hover canvas is shown by default. This method returns the contents of that hover canvas. Default
* implementation returns <code>this.prompt</code> - override for custom hover HTML. Note that returning <code>null</code>
* or an empty string will suppress the hover canvas altogether.
*/
public native void getHoverHTML() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.getHoverHTML();
}-*/;
/**
* Get an offset to be used when calculating snap positioning. Returns 0 by default.
*
* @return The offset to use when snapping
* @see com.smartgwt.client.widgets.Canvas#getHSnapPosition
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getHSnapOrigin() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getHSnapOrigin();
}-*/;
/**
* Get an offset to be used when calculating snap positioning. Returns 0 by default.
* @param snapChild the child that is being snapped
*
* @return The offset to use when snapping
* @see com.smartgwt.client.widgets.Canvas#getHSnapPosition
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getHSnapOrigin(Canvas snapChild) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getHSnapOrigin(snapChild.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
}-*/;
/**
* Override this method to provide a custom snap-to grid. Note that you do not need to do this if your grid is regular
* (ie, grid points are every x pixels); regular grids should be defined using {@link
* com.smartgwt.client.widgets.Canvas#getSnapHGap snapHGap} and {@link com.smartgwt.client.widgets.Canvas#getSnapVGap
* snapVGap}. You should only override this method if you want to provide support for a grid of irregularly-placed points
* @param coordinate x-coordinate of the drag event relative to the inside of this widget
*
* @return The horizontal coordinate to snap to
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public native int getHSnapPosition(int coordinate) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getHSnapPosition(coordinate);
}-*/;
/**
* Override this method to provide a custom snap-to grid. Note that you do not need to do this if your grid is regular
* (ie, grid points are every x pixels); regular grids should be defined using {@link
* com.smartgwt.client.widgets.Canvas#getSnapHGap snapHGap} and {@link com.smartgwt.client.widgets.Canvas#getSnapVGap
* snapVGap}. You should only override this method if you want to provide support for a grid of irregularly-placed points
* @param coordinate x-coordinate of the drag event relative to the inside of this widget
* @param direction "before" or "after" denoting whether the returned coordinate should match the left or right edge of the current
* square. If unset {@link com.smartgwt.client.widgets.Canvas#getSnapHDirection snapHDirection} will be used by default
*
* @return The horizontal coordinate to snap to
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public native int getHSnapPosition(int coordinate, String direction) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getHSnapPosition(coordinate, direction);
}-*/;
/**
* Returns the amount of space available for interior content (or relatively positioned child widget(s)) without
* introducing clipping, scrolling or overflow.<br> This is the space within the viewport of the widget (not including
* padding, and excluding margins, borders or scrollbars) rendered at its specified size.
*
* @return inner height of the widget in pixels
* @see com.smartgwt.client.widgets.Canvas#getInnerContentWidth
* @see com.smartgwt.client.widgets.Canvas#getInnerHeight
* @see com.smartgwt.client.widgets.Canvas#getInnerWidth
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getInnerContentHeight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getInnerContentHeight();
}-*/;
/**
* Returns the amount of space available for interior content (or relatively positioned child widget(s)) without
* introducing clipping, scrolling or overflow.<br> This is the space within the viewport of the widget (not including
* padding, and excluding margins, borders or scrollbars) rendered at its specified size.
*
* @return inner height of the widget in pixels
* @see com.smartgwt.client.widgets.Canvas#getInnerContentHeight
* @see com.smartgwt.client.widgets.Canvas#getInnerHeight
* @see com.smartgwt.client.widgets.Canvas#getInnerWidth
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getInnerContentWidth() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getInnerContentWidth();
}-*/;
/**
* Returns the amount of space available for (an) absolutely positioned child widget(s) or absolutely positioned HTML
* content, without introducing clipping, scrolling or overflow. <P> This is the space within the viewport of the widget
* (including padding, but excluding margins, borders or scrollbars) rendered at its specified size.
*
* @return inner height of the widget in pixels
* @see com.smartgwt.client.widgets.Canvas#getInnerWidth
* @see com.smartgwt.client.widgets.Canvas#getInnerContentHeight
* @see com.smartgwt.client.widgets.Canvas#getInnerContentWidth
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getInnerHeight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getInnerHeight();
}-*/;
/**
* Returns the amount of space available for absolutely positioned child widget(s) or absolutely positioned HTML content,
* without introducing clipping, scrolling or overflow. <P> This is the space within the viewport of the widget (including
* padding, but excluding margins, borders or scrollbars) rendered at its specified size.
*
* @return inner width of the widget in pixels
* @see com.smartgwt.client.widgets.Canvas#getInnerHeight
* @see com.smartgwt.client.widgets.Canvas#getInnerContentHeight
* @see com.smartgwt.client.widgets.Canvas#getInnerContentWidth
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getInnerWidth() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getInnerWidth();
}-*/;
/**
* Return the X-coordinate of the last event relative to the left edge of the content of this Canvas.<br><br> NOTE: To get
* a coordinate relative to the <b>viewport</b> of this Canvas, subtract this.getScrollLeft()
*
* @return
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getOffsetX() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getOffsetX();
}-*/;
/**
* Return the Y-coordinate of the last event, relative to the top edge of the content of this Canvas.<br><br> NOTE: To get
* a coordinate relative to the <b>viewport</b> of this Canvas, subtract this.getScrollTop()
*
* @return
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getOffsetY() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getOffsetY();
}-*/;
/**
* Return the page-relative bottom coordinate of this object, in pixels.
*
* @return GLOBAL bottom coordinate
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getPageBottom() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getPageBottom();
}-*/;
/**
* Returns the page-relative left coordinate of the widget on the page, in pixels.
*
* @return global left coordinate
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getPageLeft() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getPageLeft();
}-*/;
/**
* Return the page-relative right coordinate of this object, in pixels.
*
* @return GLOBAL right coordinate
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getPageRight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getPageRight();
}-*/;
/**
* Returns the page-relative top coordinate of the widget on the page, in pixels
*
* @return GLOBAL top coordinate
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getPageTop() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getPageTop();
}-*/;
/**
* Return the right coordinate of this object as rendered, relative to its enclosing context, in pixels.
*
* @return right coordinate
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getRight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getRight();
}-*/;
/**
* Returns the scrollable height of the widget's contents, including children, ignoring clipping.
*
* @return height of the element that can scroll
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getScrollHeight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getScrollHeight();
}-*/;
/**
* Get the number of pixels this Canvas is scrolled from its left edge.
*
* @return scrollLeft
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getScrollLeft() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getScrollLeft();
}-*/;
/**
* Get the number of pixels this Canvas is scrolled from its top edge.
*
* @return scrollTop
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getScrollTop() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getScrollTop();
}-*/;
/**
* Returns the scrollable width of the widget's contents, including children, ignoring clipping.
*
* @return the scrollable width of the widget's contents
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getScrollWidth() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getScrollWidth();
}-*/;
/**
* Returns the height of the viewport onto the scrollable content.
*
* @return height of the viewport, in pixels
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getViewportHeight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getViewportHeight();
}-*/;
/**
* Returns the width of the viewport onto the scrollable content.
*
* @return width of the viewport, in pixels
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getViewportWidth() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getViewportWidth();
}-*/;
/**
* Return the visible height of the Canvas.
*
* @return visible height in pixels
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getVisibleHeight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getVisibleHeight();
}-*/;
/**
* Return the visible width of the Canvas.
*
* @return visible width in pixels
* @see com.smartgwt.client.docs.Sizing Sizing overview and related methods
*/
public native int getVisibleWidth() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getVisibleWidth();
}-*/;
/**
* Get an offset to be used when calculating snap positioning. Returns 0 by default.
*
* @return The offset to use when snapping
* @see com.smartgwt.client.widgets.Canvas#getVSnapPosition
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getVSnapOrigin() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getVSnapOrigin();
}-*/;
/**
* Get an offset to be used when calculating snap positioning. Returns 0 by default.
* @param snapChild the child that is being snapped
*
* @return The offset to use when snapping
* @see com.smartgwt.client.widgets.Canvas#getVSnapPosition
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native int getVSnapOrigin(Canvas snapChild) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getVSnapOrigin(snapChild.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
}-*/;
/**
* Override this method to provide a custom snap-to grid. Note that you do not need to do this if your grid is regular
* (ie, grid points are every x pixels) - regular grids should be defined using {@link
* com.smartgwt.client.widgets.Canvas#getSnapHGap snapHGap} and {@link com.smartgwt.client.widgets.Canvas#getSnapVGap
* snapVGap}. You should only override this method if you want to provide support for a grid of irregularly-placed points
* @param coordinate y-coordinate of the drag event relative to the inside of this widget
*
* @return The vertical coordinate to snap to
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public native int getVSnapPosition(int coordinate) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getVSnapPosition(coordinate);
}-*/;
/**
* Override this method to provide a custom snap-to grid. Note that you do not need to do this if your grid is regular
* (ie, grid points are every x pixels) - regular grids should be defined using {@link
* com.smartgwt.client.widgets.Canvas#getSnapHGap snapHGap} and {@link com.smartgwt.client.widgets.Canvas#getSnapVGap
* snapVGap}. You should only override this method if you want to provide support for a grid of irregularly-placed points
* @param coordinate y-coordinate of the drag event relative to the inside of this widget
* @param direction "before" or "after" denoting whether the returned coordinate should match the top or bottom edge of the current
* square. If unset {@link com.smartgwt.client.widgets.Canvas#getSnapHDirection snapHDirection} will be used by default
*
* @return The vertical coordinate to snap to
* @see com.smartgwt.client.docs.Dragdrop Dragdrop overview and related methods
*/
public native int getVSnapPosition(int coordinate, String direction) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getVSnapPosition(coordinate, direction);
}-*/;
/**
* Handler fired on a delay when the user hovers the mouse over this hover-target. Default implementation will fire
* <code>this.hover()</code> (if defined), and handle showing the hover canvas if <code>this.showHover</code> is true.
*/
public native void handleHover() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.handleHover();
}-*/;
/**
* Sets the widget's CSS visibility attribute to "hidden".
*/
public native void hide() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.hide();
}-*/;
/**
* Hides the click mask associated with this canvas.
*/
public native void hideClickMask() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.hideClickMask();
}-*/;
/**
* Hides the click mask associated with this canvas.
* @param ID optional ID of specific clickMask to hide. If not passed, defaults to hiding the click mask
* associated with this widget only.
* @see com.smartgwt.client.widgets.Canvas#showClickMask
*/
public native void hideClickMask(String ID) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.hideClickMask(ID);
}-*/;
/**
* The default implementation of this method hides the contextMenu currently being shown for this component (which occurs
* when the mouse button that toggles the context menu is released). Override if you want some other behavior.
*/
public native void hideContextMenu() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.hideContextMenu();
}-*/;
/**
* Add a hover handler.
* <p>
* If <code>canHover</code> is true for this widget, the <code>hover</code> string method will be fired when the user
* hovers over this canvas. If this method returns false, it will suppress the default behavior of showing a hover canvas
* if <code>this.showHover</code> is true.
*
* @param handler the hover handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addHoverHandler(com.smartgwt.client.widgets.events.HoverHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.HoverEvent.getType()) == 0) setupHoverEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.HoverEvent.getType());
}
private native void setupHoverEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({hover:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.HoverEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.hover = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.HoverEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a hoverHidden handler.
* <p>
* If {@link com.smartgwt.client.widgets.Canvas#getShowHover showHover} is true for this canvas, this notification method
* will be fired whenever the hover shown in response to {@link com.smartgwt.client.widgets.Canvas#handleHover
* handleHover()} is hidden. This method may be observed or overridden.
*
* @param handler the hoverHidden handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addHoverHiddenHandler(com.smartgwt.client.widgets.events.HoverHiddenHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.HoverHiddenEvent.getType()) == 0) setupHoverHiddenEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.HoverHiddenEvent.getType());
}
private native void setupHoverHiddenEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({hoverHidden:$entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.HoverHiddenEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
})
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.hoverHidden = $entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.HoverHiddenEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
});
}
}-*/;
/**
* Returns true if the rectangles of this widget and the specified widget overlap.
* @param other other canvas to test for intersection
*
* @return true if this canvas intersects other; false otherwise
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native Boolean intersects(Canvas other) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.intersects(other.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Returns whether a canvas is waiting to be redrawn. Will return true if {@link
* com.smartgwt.client.widgets.Canvas#markForRedraw Canvas.markForRedraw} has been called, but this canvas has not yet been
* redrawn.
*
* @return true is this canvas needs to be redrawn; false otherwise
* @see com.smartgwt.client.docs.Drawing Drawing overview and related methods
*/
public native Boolean isDirty() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.isDirty();
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Is this canvas disabled? Note that the disabled state is inherited - this method will return true if this widget, or any
* of its ancestors are marked disabled.
*
* @return true if the widget or any widget above it in the containment hierarchy are disabled.
* @see com.smartgwt.client.docs.Enable Enable overview and related methods
*/
public native Boolean isDisabled() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.isDisabled();
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Returns the boolean true, if the widget has been completely drawn, and false otherwise.
*
* @return true if drawn, false if not drawn
* @see com.smartgwt.client.docs.Drawing Drawing overview and related methods
*/
public native Boolean isDrawn() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.isDrawn();
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Add a keyDown handler.
* <p>
* Executed when a key is pressed on a focusable widget ({@link com.smartgwt.client.widgets.Canvas#getCanFocus canFocus}:
* true). <P> Use {@link com.smartgwt.client.util.EventHandler#getKey EventHandler.getKey} to find out the String of the
* key that was pressed, and use {@link com.smartgwt.client.util.EventHandler#shiftKeyDown EventHandler.shiftKeyDown} and
* related functions to determine whether modifier keys were down.
*
* @param handler the keyDown handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addKeyDownHandler(com.smartgwt.client.widgets.events.KeyDownHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.KeyDownEvent.getType()) == 0) setupKeyDownEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.KeyDownEvent.getType());
}
private native void setupKeyDownEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({keyDown:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.KeyDownEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.keyDown = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.KeyDownEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a keyPress handler.
* <p>
* Executed when a key is pressed and released on a focusable widget ({@link com.smartgwt.client.widgets.Canvas#getCanFocus
* canFocus}: true). <P> Use {@link com.smartgwt.client.util.EventHandler#getKey EventHandler.getKey} to find out the
* String of the key that was pressed, and use {@link com.smartgwt.client.util.EventHandler#shiftKeyDown
* EventHandler.shiftKeyDown} and related functions to determine whether modifier keys were down.
*
* @param handler the keyPress handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addKeyPressHandler(com.smartgwt.client.widgets.events.KeyPressHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.KeyPressEvent.getType()) == 0) setupKeyPressEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.KeyPressEvent.getType());
}
private native void setupKeyPressEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({keyPress:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.KeyPressEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.keyPress = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.KeyPressEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Executed when a key is released on a focusable widget ({@link com.smartgwt.client.widgets.Canvas#getCanFocus canFocus}:
* true). <P> Use {@link com.smartgwt.client.util.EventHandler#getKey EventHandler.getKey} to find out the String of the
* key that was pressed, and use {@link com.smartgwt.client.util.EventHandler#shiftKeyDown EventHandler.shiftKeyDown} and
* related functions to determine whether modifier keys were down.
*
* @return false to prevent this event from bubbling to this widget's parent, true or undefined to bubble.
* @see com.smartgwt.client.widgets.Canvas#getCanFocus
*/
public native Boolean keyUp() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.keyUp();
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* <code>layoutChildren()</code> is where a Canvas should implement a sizing policy for it's Canvas children. Since
* <code>layoutChildren</code> calls parentResized() on its children, {@link
* com.smartgwt.client.widgets.Canvas#parentResized Canvas.parentResized} is a good place for a child to implement a layout
* policy that can be used within any parent. <P> Recommended practice for a Canvas that manages Canvas children is to
* create those children without any initial coordinate or size settings and do all sizing when layoutChildren() is called.
* <P> layoutChildren() is always called at least once before children are drawn, and is called automatically whenever the
* viewport size changes (which includes both resizing and introduction/removal of scrolling). layoutChildren() can also
* be manually invoked in any other component-specific situation which changes the layout. <P> NOTE: layoutChildren() may
* be called before draw() if a widget is resized before draw(), so be sure to avoid errors such as assuming that any
* children you automatically create have already been created. <P> NOTE: auto-sizing: layoutChildren() is also called once
* during the initial draw(), before children are drawn, with a "reason" of "initial draw". During this invocation of
* layoutChildren() it is legal to directly draw children (call child.draw()), which is otherwise never allowed. This
* allows a Canvas to implement an auto-sizing layout policy by drawing some children before deciding on the sizes of
* remaining children, which is far more efficient than drawing all children and resizing some of them after they are
* drawn.
* @param reason reason why layoutChildren() is being called, passed when framework code invokes layoutChildren()
*/
public native void layoutChildren(String reason) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.layoutChildren(reason);
}-*/;
/**
* Generates the HTML for a standard link element
* @param href URL for the link to point to
*
* @return HTML for the link
*/
public native String linkHTML(String href) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.linkHTML(href);
}-*/;
/**
* Generates the HTML for a standard link element
* @param href URL for the link to point to
* @param text Text to for the link (defaults to the href)
* @param target Target window for the link (defaults to opening in a new, unnamed window)
* @param ID optional ID for the link element to be written out
* @param tabIndex optional tabIndex for the link
* @param accessKey optional accessKey for the link
*
* @return HTML for the link
*/
public native String linkHTML(String href, String text, String target, String ID, int tabIndex, String accessKey) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.linkHTML(href, text, target, ID, tabIndex, accessKey);
}-*/;
/**
* {@link com.smartgwt.client.widgets.Canvas#destroy destroy()} this canvas on a timeout. This method should be used
* instead of calling <code>canvas.destroy()</code> directly unless there's a reason a the canvas needs to be destroyed
* synchronously. By using a timeout, this method ensures the <code>destroy()</code> will occur after the current thread of
* execution completes. This allows you to easily mark canvases for destruction while they're handling events, which must
* complete before the canvas can be destroyed.
*/
public native void markForDestroy() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.markForDestroy();
}-*/;
/**
* Marks the widget as "dirty" so that it will be added to a queue for redraw. Redraw of dirty components is handled by a
* looping timer and will after a very short delay (typically less than 100ms). In most cases it is recommended that
* developers use <code>markForRedraw()</code> instead of calling {@link com.smartgwt.client.widgets.Canvas#redraw
* Canvas.redraw} directly. Since this method queues the redraw, multiple calls to markForRedraw() within a single thread
* of execution will only lead to a single DOM manipulation which greatly improves application performance.
*/
public native void markForRedraw() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.markForRedraw();
}-*/;
/**
* Marks the widget as "dirty" so that it will be added to a queue for redraw. Redraw of dirty components is handled by a
* looping timer and will after a very short delay (typically less than 100ms). In most cases it is recommended that
* developers use <code>markForRedraw()</code> instead of calling {@link com.smartgwt.client.widgets.Canvas#redraw
* Canvas.redraw} directly. Since this method queues the redraw, multiple calls to markForRedraw() within a single thread
* of execution will only lead to a single DOM manipulation which greatly improves application performance.
* @param reason reason for performing the redraw
* @see com.smartgwt.client.docs.Drawing Drawing overview and related methods
*/
public native void markForRedraw(String reason) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.markForRedraw(reason);
}-*/;
/**
* Add a mouseDown handler.
* <p>
* Executed when the left mouse down is pressed on this widget. No default implementation.
*
* @param handler the mouseDown handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addMouseDownHandler(com.smartgwt.client.widgets.events.MouseDownHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.MouseDownEvent.getType()) == 0) setupMouseDownEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.MouseDownEvent.getType());
}
private native void setupMouseDownEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({mouseDown:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseDownEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.mouseDown = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseDownEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a mouseMove handler.
* <p>
* Executed when the mouse moves within this widget. No default implementation.
*
* @param handler the mouseMove handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addMouseMoveHandler(com.smartgwt.client.widgets.events.MouseMoveHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.MouseMoveEvent.getType()) == 0) setupMouseMoveEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.MouseMoveEvent.getType());
}
private native void setupMouseMoveEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({mouseMove:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.mouseMove = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseMoveEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a mouseOut handler.
* <p>
* Executed when the mouse leaves this widget. No default implementation.
*
* @param handler the mouseOut handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addMouseOutHandler(com.smartgwt.client.widgets.events.MouseOutHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.MouseOutEvent.getType()) == 0) setupMouseOutEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.MouseOutEvent.getType());
}
private native void setupMouseOutEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({mouseOut:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseOutEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.mouseOut = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseOutEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a mouseOver handler.
* <p>
* Executed when mouse enters this widget. No default implementation.
*
* @param handler the mouseOver handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addMouseOverHandler(com.smartgwt.client.widgets.events.MouseOverHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.MouseOverEvent.getType()) == 0) setupMouseOverEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.MouseOverEvent.getType());
}
private native void setupMouseOverEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({mouseOver:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseOverEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.mouseOver = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseOverEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a mouseStillDown handler.
* <p>
* Executed repeatedly (every {@link com.smartgwt.client.widgets.Canvas#getMouseStillDownDelay mouseStillDownDelay} by
* default) when the system is idle - i.e. not busy running other scripts - and the left mouse button is held down after
* having been pressed in the object. This event is not native to JavaScript, but is provided by the ISC system. <p> Note:
* The event handling system waits {@link com.smartgwt.client.widgets.Canvas#getMouseStillDownInitialDelay
* mouseStillDownInitialDelay} before calling mouseStillDown for the first time on the widget. Subsequently the method is
* called every {@link com.smartgwt.client.widgets.Canvas#getMouseStillDownDelay mouseStillDownDelay}. Both attributes are
* configurable per widget instance. <p> This method is called only when the left mouse is held down.
*
* @param handler the mouseStillDown handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addMouseStillDownHandler(com.smartgwt.client.widgets.events.MouseStillDownHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.MouseStillDownEvent.getType()) == 0) setupMouseStillDownEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.MouseStillDownEvent.getType());
}
private native void setupMouseStillDownEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({mouseStillDown:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseStillDownEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.mouseStillDown = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseStillDownEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a mouseUp handler.
* <p>
* Executed when the left mouse is released on this widget. No default implementation.
*
* @param handler the mouseUp handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addMouseUpHandler(com.smartgwt.client.widgets.events.MouseUpHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.MouseUpEvent.getType()) == 0) setupMouseUpEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.MouseUpEvent.getType());
}
private native void setupMouseUpEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({mouseUp:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseUpEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.mouseUp = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseUpEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Add a mouseWheel handler.
* <p>
* Executed when the mouse wheel is actuated.
*
* @param handler the mouseWheel handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addMouseWheelHandler(com.smartgwt.client.widgets.events.MouseWheelHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.MouseWheelEvent.getType()) == 0) setupMouseWheelEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.MouseWheelEvent.getType());
}
private native void setupMouseWheelEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({mouseWheel:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseWheelEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.mouseWheel = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.MouseWheelEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Puts this widget just above the specified widget in the stacking order, so it appears in front of the specified widget
* if both widgets have the same parent.
* @param canvas canvas to move above
*/
public native void moveAbove(Canvas canvas) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.moveAbove(canvas.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
}-*/;
/**
* Puts this widget just below the specified widget in the stacking order, so it appears behind the specified widget if
* both widgets have the same parent.
* @param canvas canvas to move below
*/
public native void moveBelow(Canvas canvas) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.moveBelow(canvas.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
}-*/;
/**
* Moves the widget deltaX pixels to the right and deltaY pixels down. Pass negative numbers to move up and/or to
* the left.
* @param deltaX amount to move horizontally (may be negative)
* @param deltaY amount to move vertically (may be negative)
*
* @return whether the component actually moved
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
* @see <a href="http://www.smartclient.com/smartgwt/showcase/#basics_components_move" target="examples">Move Example</a>
*/
public native Boolean moveBy(int deltaX, int deltaY) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.moveBy(deltaX, deltaY);
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Add a moved handler.
* <p>
* Notification method fired when this component is explicitly moved. Note that a component's position on the screen may
* also changed due to an ancestor being moved. The {@link com.smartgwt.client.widgets.Canvas#addParentMovedHandler
* Canvas.parentMoved} method provides a notification entry point to catch that case as well.
*
* @param handler the moved handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addMovedHandler(com.smartgwt.client.widgets.events.MovedHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.MovedEvent.getType()) == 0) setupMovedEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.MovedEvent.getType());
}
private native void setupMovedEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({moved:$entry(function(){
var param = {"deltaX" : arguments[0], "deltaY" : arguments[1]};
var event = @com.smartgwt.client.widgets.events.MovedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
})
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.moved = $entry(function(){
var param = {"deltaX" : arguments[0], "deltaY" : arguments[1]};
var event = @com.smartgwt.client.widgets.events.MovedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
});
}
}-*/;
/**
* Add a parentMoved handler.
* <p>
* Notification method fire when an ancestor of this component's position changes.
*
* @param handler the parentMoved handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addParentMovedHandler(com.smartgwt.client.widgets.events.ParentMovedHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.ParentMovedEvent.getType()) == 0) setupParentMovedEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.ParentMovedEvent.getType());
}
private native void setupParentMovedEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({parentMoved:$entry(function(){
var param = {"parent" : arguments[0], "deltaX" : arguments[1], "deltaY" : arguments[2]};
var event = @com.smartgwt.client.widgets.events.ParentMovedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
})
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.parentMoved = $entry(function(){
var param = {"parent" : arguments[0], "deltaX" : arguments[1], "deltaY" : arguments[2]};
var event = @com.smartgwt.client.widgets.events.ParentMovedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
});
}
}-*/;
/**
* Redraws the widget immediately with its current property values. Generally, if you want a Canvas to redraw, call
* markForRedraw() - this will cause the Canvas to be redrawn when current processing ends, so that a series of
* modifications made to a Canvas will cause it to redraw only once. Only call redraw() directly if you need immediate
* responsiveness, for example you are redrawing in response to continuous mouse motion.
*/
public native void redraw() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.redraw();
}-*/;
/**
* Redraws the widget immediately with its current property values. Generally, if you want a Canvas to redraw, call
* markForRedraw() - this will cause the Canvas to be redrawn when current processing ends, so that a series of
* modifications made to a Canvas will cause it to redraw only once. Only call redraw() directly if you need immediate
* responsiveness, for example you are redrawing in response to continuous mouse motion.
* @param reason reason for performing the redraw
* @see com.smartgwt.client.docs.Drawing Drawing overview and related methods
*/
public native void redraw(String reason) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.redraw(reason);
}-*/;
/**
* Add a resized handler.
* <p>
* Observable method called whenever a Canvas changes size. Note that if this canvas is {@link
* com.smartgwt.client.widgets.Canvas#getOverflow overflow:"visible"}, and is waiting for a queued redraw (see {@link
* com.smartgwt.client.widgets.Canvas#isDirty Canvas.isDirty}), the value for {@link
* com.smartgwt.client.widgets.Canvas#getVisibleWidth Canvas.getVisibleWidth} and {@link
* com.smartgwt.client.widgets.Canvas#getVisibleHeight Canvas.getVisibleHeight} will be unreliable until
* <code>redraw()</code> fires.
*
* @param handler the resized handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addResizedHandler(com.smartgwt.client.widgets.events.ResizedHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.ResizedEvent.getType()) == 0) setupResizedEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.ResizedEvent.getType());
}
private native void setupResizedEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({resized:$entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.ResizedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
})
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.resized = $entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.ResizedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
});
}
}-*/;
/**
* Add a rightMouseDown handler.
* <p>
* Executed when the right mouse down is pressed on this widget. No default implementation.
*
* @param handler the rightMouseDown handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addRightMouseDownHandler(com.smartgwt.client.widgets.events.RightMouseDownHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.RightMouseDownEvent.getType()) == 0) setupRightMouseDownEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.RightMouseDownEvent.getType());
}
private native void setupRightMouseDownEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({rightMouseDown:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.RightMouseDownEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.rightMouseDown = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.RightMouseDownEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Scroll this widget by some pixel increment in either (or both) direction(s).
* @param dX Number of pixels to scroll horizontally
* @param dY Number of pixels to scroll vertically
*/
public native void scrollBy(int dX, int dY) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.scrollBy(dX, dY);
}-*/;
/**
* Add a scrolled handler.
* <p>
* Notification that this component has just scrolled. Use with observation. <P> Fires for both CSS and {@link
* com.smartgwt.client.widgets.Scrollbar "synthetic" scrollbars}.
*
* @param handler the scrolled handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addScrolledHandler(com.smartgwt.client.widgets.events.ScrolledHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.ScrolledEvent.getType()) == 0) setupScrolledEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.ScrolledEvent.getType());
}
private native void setupScrolledEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({scrolled:$entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.ScrolledEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
})
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.scrolled = $entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.ScrolledEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
});
}
}-*/;
/**
* Scrolls the content of the widget so that the origin (top-left corner) of the content is left pixels to the left and top
* pixels above the widget's top-left corner (but still clipped by the widget's dimensions). <p> This is guaranteed to be
* called whenever this Canvas is scrolled, whether scrolling is initiated programmatically, by custom scrollbars, or a by
* a native scrollbar.
*/
public native void scrollTo() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.scrollTo();
}-*/;
/**
* Scrolls the content of the widget so that the origin (top-left corner) of the content is left pixels to the left and top
* pixels above the widget's top-left corner (but still clipped by the widget's dimensions). <p> This is guaranteed to be
* called whenever this Canvas is scrolled, whether scrolling is initiated programmatically, by custom scrollbars, or a by
* a native scrollbar.
* @param left the left coordinate
* @param top the top coordinate
* @see com.smartgwt.client.docs.Scrolling Scrolling overview and related methods
*/
public native void scrollTo(int left, int top) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.scrollTo(left, top);
}-*/;
/**
* Vertically scrolls the content of the widget to the end of its content
*/
public native void scrollToBottom() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.scrollToBottom();
}-*/;
/**
* Horizontally scrolls the content of the widget to 0
*/
public native void scrollToLeft() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.scrollToLeft();
}-*/;
/**
* Horizontally scrolls the content of the widget to the end of its content
*/
public native void scrollToRight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.scrollToRight();
}-*/;
/**
* Vertically scrolls the content of the widget to 0
*/
public native void scrollToTop() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.scrollToTop();
}-*/;
/**
* Puts this widget at the bottom of the stacking order, so it appears behind all other widgets in the same parent.
*/
public native void sendToBack() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.sendToBack();
}-*/;
/**
* Resizes the widget vertically to position its bottom edge at the specified coordinate. <P> NOTE: if you're setting
* multiple coordinates, use setRect(), moveTo() or resizeTo() instead
* @param bottom new bottom coordinate
*/
public native void setBottom(int bottom) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.setBottom(bottom);
}-*/;
/**
* Set the URL of an image element by name. <p> The image element must have been created from HTML generated by calling
* <code>canvas.imgHTML()</code> on this particular Canvas.
* @param identifier name of the image to change, as originally passed to <code>imgHTML</code>
* @param URL URL for the image
*/
public native void setImage(String identifier, String URL) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.setImage(identifier, URL);
}-*/;
/**
* Set the URL of an image element by name. <p> The image element must have been created from HTML generated by calling
* <code>canvas.imgHTML()</code> on this particular Canvas.
* @param identifier name of the image to change, as originally passed to <code>imgHTML</code>
* @param URL URL for the image
* @param imgDir optional image directory, overrides the default for this Canvas
* @see com.smartgwt.client.docs.Images Images overview and related methods
*/
public native void setImage(String identifier, String URL, String imgDir) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.setImage(identifier, URL, imgDir);
}-*/;
/**
* Set the page-relative left coordinate of this widget.
* @param left new left coordinate in pixels
*/
public native void setPageLeft(int left) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.setPageLeft(left);
}-*/;
/**
* Set the page-relative top coordinate of this widget.
* @param top new top coordinate in pixels
*/
public native void setPageTop(int top) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.setPageTop(top);
}-*/;
/**
* Resizes the widget horizontally to position its right side at the specified coordinate. <P> NOTE: if you're setting
* multiple coordinates, use setRect(), moveTo() or resizeTo() instead
* @param right new right coordinate
*/
public native void setRight(int right) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.setRight(right);
}-*/;
/**
* If this widget is showing scrollbars, and a user drags close to the edge of the viewport, should we scroll the viewport
* in the appropriate direction? Returns this.canDragScroll by default.
*/
public native void shouldDragScroll() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.shouldDragScroll();
}-*/;
/**
* Sets this widget's visibility to "inherit", so that it becomes visible if all it's parents are visible or it has no
* parents. <P> If the widget has not yet been drawn (and doesn't have a parent or master), this method calls the draw
* method as well.
*/
public native void show() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.show();
}-*/;
/**
* Add a showContextMenu handler.
* <p>
* Executed when the right mouse button is clicked. The default implementation of this method auto-creates a {@link
* com.smartgwt.client.widgets.menu.Menu} from the {@link com.smartgwt.client.widgets.Canvas#getContextMenu contextMenu}
* property on this component and then calls {@link com.smartgwt.client.widgets.menu.Menu#showContextMenu
* Menu.showContextMenu} on it to show it. <p> If you want to show a standard context menu, you can simply define your Menu
* and set it as the contextMenu property on your component - you do not need to override this method. <p> If you want to
* do some other processing before showing a menu or do something else entirely, then you should override this method.
* Note that the return value from this method controls whether or not the native browser context menu is shown.
*
* @param handler the showContextMenu handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addShowContextMenuHandler(com.smartgwt.client.widgets.events.ShowContextMenuHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.ShowContextMenuEvent.getType()) == 0) setupShowContextMenuEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.ShowContextMenuEvent.getType());
}
private native void setupShowContextMenuEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({showContextMenu:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.ShowContextMenuEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.showContextMenu = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.ShowContextMenuEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
/**
* Show this widget next to another widget.
* @param otherWidget Canvas to show next to
*/
public native void showNextTo(Canvas otherWidget) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.showNextTo(otherWidget.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
}-*/;
/**
* Show this widget next to another widget.
* @param otherWidget Canvas to show next to
* @param side which side to show on, defaults to "right"
*/
public native void showNextTo(Canvas otherWidget, String side) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.showNextTo(otherWidget.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()(), side);
}-*/;
/**
* Recursively show the canvas and all it's parents so the canvas will be visible. <P> If the widget has not yet been
* drawn, this method calls the draw method as well.
*/
public native void showRecursively() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.showRecursively();
}-*/;
/**
* If this canvas is currently showing a hover (see {@link com.smartgwt.client.widgets.Canvas#handleHover
* Canvas.handleHover}), this method can be called to update the contents of the hover. Has no effect if the hover canvas
* is not showing for this widget.
*/
public native void updateHover() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.updateHover();
}-*/;
/**
* If this canvas is currently showing a hover (see {@link com.smartgwt.client.widgets.Canvas#handleHover
* Canvas.handleHover}), this method can be called to update the contents of the hover. Has no effect if the hover canvas
* is not showing for this widget.
* @param hoverHTML Option to specify new HTML for the hover. If not passed, the result of {@link
* com.smartgwt.client.widgets.Canvas#getHoverHTML this.getHoverHTML()} will be used instead. Note that if the hover HTML
* is empty the hover will be hidden.
*/
public native void updateHover(String hoverHTML) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.updateHover(hoverHTML);
}-*/;
/**
* Add a visibilityChanged handler.
* <p>
* Notification fired when this canvas becomes visible or hidden to the user. Note - this method is fired when the {@link
* com.smartgwt.client.widgets.Canvas#isVisible Canvas.isVisible} state of this component changes. It may be fired in
* response an explicit call to {@link com.smartgwt.client.widgets.Canvas#show Canvas.show} or {@link
* com.smartgwt.client.widgets.Canvas#hide Canvas.hide} or {@link com.smartgwt.client.widgets.Canvas#setVisibility
* Canvas.setVisibility}, or in response to a parent component being shown or hidden when this widgets {@link
* com.smartgwt.client.widgets.Canvas#getVisibility visibility} is set to "inherit". <P> Note that a call to {@link
* com.smartgwt.client.widgets.Canvas#show Canvas.show} or {@link com.smartgwt.client.widgets.Canvas#hide Canvas.hide} will
* not <b>always</b> fire this notification. If this widget has a hidden parent, show or hide would change this components
* {@link com.smartgwt.client.widgets.Canvas#getVisibility visibility} property, and may update the CSS visibility
* attribute of the drawn handle in the DOM, but would not actually hide or reveal the component to the user and as such
* the notification would not fire. <P> Note also that this notification will only be fired for components which have been
* {@link com.smartgwt.client.widgets.Canvas#draw drawn}.
*
* @param handler the visibilityChanged handler
* @return {@link HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addVisibilityChangedHandler(com.smartgwt.client.widgets.events.VisibilityChangedHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.VisibilityChangedEvent.getType()) == 0) setupVisibilityChangedEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.VisibilityChangedEvent.getType());
}
private native void setupVisibilityChangedEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({visibilityChanged:$entry(function(){
var param = {"isVisible" : arguments[0]};
var event = @com.smartgwt.client.widgets.events.VisibilityChangedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
})
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.visibilityChanged = $entry(function(){
var param = {"isVisible" : arguments[0]};
var event = @com.smartgwt.client.widgets.events.VisibilityChangedEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
});
}
}-*/;
// ********************* Static Methods ***********************
/**
* Retrieve a Canvas by it's global {@link com.smartgwt.client.widgets.Canvas#getID ID}.
* @param ID global ID of the Canvas
*
* @return the Canvas, or null if not found
*/
public static native Canvas getById(String ID) /*-{
var ret = $wnd.isc.Canvas.getById(ID);
if(ret == null || ret === undefined) return null;
var retVal = @com.smartgwt.client.widgets.BaseWidget::getRef(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
if(retVal == null) {
retVal = @com.smartgwt.client.widgets.Canvas::new(Lcom/google/gwt/core/client/JavaScriptObject;)(ret);
}
return retVal;
}-*/;
/**
* Changes the system-wide {@link com.smartgwt.client.widgets.Canvas#allowExternalFilters allowExternalFilters} setting.
* @param allExternalFilters new setting
*/
public static native void setAllowExternalFilters(boolean allExternalFilters) /*-{
$wnd.isc.Canvas.setAllowExternalFilters(allExternalFilters);
}-*/;
/**
* Changes the system-wide {@link com.smartgwt.client.widgets.Canvas#neverUseFilters neverUseFilters} setting.
* @param neverUseFilters new setting
*/
public static native void setNeverUseFilters(boolean neverUseFilters) /*-{
$wnd.isc.Canvas.setNeverUseFilters(neverUseFilters);
}-*/;
/**
* 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 canvasProperties properties that should be used as new defaults when instances of this class are created
*/
public static native void setDefaultProperties(Canvas canvasProperties) /*-{
var properties = $wnd.isc.addProperties({},canvasProperties.@com.smartgwt.client.widgets.BaseWidget::getConfig()());
delete properties.ID;
$wnd.isc.Canvas.addProperties(properties);
}-*/;
// ***********************************************************
protected native void onInit () /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self._jsOverrideCall = {};
self._fireDefaultMethod = {};
self.__parentResized = self.parentResized;
self.parentResized = $debox($entry(function() {
var jObj = this.__ref;
jObj.@com.smartgwt.client.widgets.Canvas::parentResized()();
}));
self.__willAcceptDrop = self.willAcceptDrop;
self.willAcceptDrop = $debox($entry(function() {
var jObj = this.__ref;
var retVal = jObj.@com.smartgwt.client.widgets.Canvas::willAcceptDrop()();
return retVal.@java.lang.Boolean::booleanValue()();
}));
self.__getPrintHTML = self.getPrintHTML;
self.getPrintHTML = function (printProperties, callback) {
self._jsOverrideCall.getPrintHTML = true;
var jObj = this.__ref;
var jPP = printProperties == null ? null :
@com.smartgwt.client.util.PrintProperties::getOrCreateRef(Lcom/google/gwt/core/client/JavaScriptObject;)(printProperties);
var ret;
ret = jObj.@com.smartgwt.client.widgets.Canvas::getPrintHTMLJSCB(Lcom/smartgwt/client/util/PrintProperties;Lcom/google/gwt/core/client/JavaScriptObject;)(jPP,callback);
if (self._fireDefaultMethod.getPrintHTML) {
ret = self.__getPrintHTML(printProperties,callback);
}
self._jsOverrideCall.getPrintHTML = null;
self._fireDefaultMethod.getPrintHTML = null;
return ret;
}
self.__getHoverComponent = self.getHoverComponent;
self.getHoverComponent = $entry(function() {
var jObj = this.__ref;
var componentJ = jObj.@com.smartgwt.client.widgets.Canvas::getHoverComponent()();
return componentJ == null ? null : componentJ.@com.smartgwt.client.widgets.Canvas::getOrCreateJsObj()();
});
}-*/;
/**
* Create a databound component corresponding to the passed jsObj.
*
* @param jsObj the javascript object
* @return the databound component
*/
private static native DataBoundComponent getOrCreateDBC(JavaScriptObject jsObj) /*-{
if(jsObj == null) return null;
var obj = jsObj.__ref;
if(obj == null || obj === undefined) {
if($wnd.isc.isA.ListGrid(jsObj)) return @com.smartgwt.client.widgets.grid.ListGrid::new(Lcom/google/gwt/core/client/JavaScriptObject;)(jsObj);
if($wnd.isc.isA.DynamicForm(jsObj)) return @com.smartgwt.client.widgets.form.DynamicForm::new(Lcom/google/gwt/core/client/JavaScriptObject;)(jsObj);
if($wnd.isc.isA.DetailViewer(jsObj)) return @com.smartgwt.client.widgets.viewer.DetailViewer::new(Lcom/google/gwt/core/client/JavaScriptObject;)(jsObj);
if($wnd.isc.isA.Calendar(jsObj)) return @com.smartgwt.client.widgets.calendar.Calendar::new(Lcom/google/gwt/core/client/JavaScriptObject;)(jsObj);
if($wnd.isc.isA.ColumnTree(jsObj)) return @com.smartgwt.client.widgets.grid.ColumnTree::new(Lcom/google/gwt/core/client/JavaScriptObject;)(jsObj);
if($wnd.isc.isA.TileGrid(jsObj)) return @com.smartgwt.client.widgets.tile.TileGrid::new(Lcom/google/gwt/core/client/JavaScriptObject;)(jsObj);
return @com.smartgwt.client.widgets.Canvas::new(Lcom/google/gwt/core/client/JavaScriptObject;)(jsObj);
} else {
return obj;
}
}-*/;
protected void onDetach() {
super.onDetach();
//when a SmartGWT widget is removed from a parent GWT widget container, make sure we carry out proper cleanup
clear();
}
protected void onAttach() {
super.onAttach();
//upon attach to a GWT container, draw the SmartGWT widget if it has not been previously drawn
if(!isDrawn()) {
draw();
}
}
/**
* Multiple styles are currently not supported. This method essentially calls {@link #setStyleName(String)}
*
* @param style the style name
* @see #setStyleName(String)
*/
public void addStyleName(String style) {
setStyleName(style);
com.google.gwt.core.client.GWT.log("addStyleName is not supported. Calling setStyleName instead", null);
}
public void setVisible(boolean visible) {
setVisibility(visible ? Visibility.INHERIT : Visibility.HIDDEN);
}
/**
* Size for this component's vertical dimension. <P> Can be a number of pixels, or a percentage like "50%". See
* documentation for {@link com.smartgwt.client.widgets.Canvas#getWidth width} for details on who percentage values
* are resolved actual size. <P> Note that if {@link com.smartgwt.client.widgets.Canvas#getOverflow overflow} is set
* to "visible", this size is a minimum, and the component may overflow to show all content and/or children. <P> If
* trying to establish a default height for a custom component, set {@link com.smartgwt.client.widgets.Canvas#getDefaultHeight
* defaultHeight} instead. Resizes the widget vertically to the specified height (moves the bottom side of the
* widget). The height parameter can be expressed as a percentage of viewport size or as the number of pixels. <P>
* NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
*
* @param height new height. Default value is null
*/
public void setHeight(int height) {
setAttribute("height", height, true);
}
/**
* Convenience method that sets the height to 100%.
*/
public void setHeight100() {
setHeight("100%");
}
/**
* Convenience method that sets the width to 100%.
*/
public void setWidth100() {
setWidth("100%");
}
public void setHeight(String height) {
setAttribute("height", height, true);
}
public Integer getHeight() {
return getAttributeAsInt("height");
}
public String getHeightAsString() {
return getAttribute("height");
}
/**
* Synonym for {@link #setPrompt(String)}
*
* @param title the title
*/
public void setTitle(String title) {
setPrompt(title);
}
/**
* Synonym for {@link #getPrompt()}
*
* @return the title
*/
public String getTitle() {
return getPrompt();
}
/**
* Synonym for {@link #setPrompt(String)}
*
* @param tooltip the tooltip
*/
public void setTooltip(String tooltip) {
setPrompt(tooltip);
}
/**
* Synonym for {@link #getPrompt()}
*
* @return the tooltip
*/
public String getTooltip() {
return getPrompt();
}
/**
* Size for this component's horizontal dimension. <P> Can be a number of pixels, or a percentage like "50%".
* Percentage sizes are resolved to pixel values as follows: <UL> <LI>If a canvas has a specified {@link
* com.smartgwt.client.widgets.Canvas#getPercentSource percentSource}, sizing will be a percentage of the size
* of that widget (see also {@link com.smartgwt.client.widgets.Canvas#getPercentBox percentBox}).</LI>
* <LI>Otherwise, if a canvas has a {@link com.smartgwt.client.widgets.Canvas#getMasterElement masterElement}, and
* {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} is set for the widget, sizing will be a percentage
* of the size of that widget (see also {@link com.smartgwt.client.widgets.Canvas#getPercentBox
* percentBox}).</LI> <LI>Otherwise if this is a child of some other canvas, percentages will be based on the
* inner size of the {@link com.smartgwt.client.widgets.Canvas#getParentElement parentElement}'s viewport.</LI>
* <LI>Otherwise, for top level widgets, sizing is calculated as a percentage of page size.</LI> </UL> <P> {@link
* com.smartgwt.client.widgets.layout.Layout} may specially interpret percentage sizes on their children, and also
* allow "*" as a size. <P> Note that if {@link com.smartgwt.client.widgets.Canvas#getOverflow overflow} is set to
* "visible", this size is a minimum, and the component may overflow to show all content and/or children. <P> If
* trying to establish a default width for a custom component, set {@link com.smartgwt.client.widgets.Canvas#getDefaultWidth
* defaultWidth} instead. Resizes the widget horizontally to the specified width (moves the right side of the
* widget). The width parameter can be expressed as a percentage of viewport size or as the number of pixels. <P>
* NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
*
* @param width new width. Default value is null
*/
public void setWidth(int width) {
setAttribute("width", width, true);
}
/**
* Size for this component's horizontal dimension. <P> Can be a number of pixels, or a percentage like "50%".
* Percentage sizes are resolved to pixel values as follows: <UL> <LI>If a canvas has a specified {@link
* com.smartgwt.client.widgets.Canvas#getPercentSource percentSource}, sizing will be a percentage of the size
* of that widget (see also {@link com.smartgwt.client.widgets.Canvas#getPercentBox percentBox}).</LI>
* <LI>Otherwise, if a canvas has a {@link com.smartgwt.client.widgets.Canvas#getMasterElement masterElement}, and
* {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo} is set for the widget, sizing will be a percentage
* of the size of that widget (see also {@link com.smartgwt.client.widgets.Canvas#getPercentBox
* percentBox}).</LI> <LI>Otherwise if this is a child of some other canvas, percentages will be based on the
* inner size of the {@link com.smartgwt.client.widgets.Canvas#getParentElement parentElement}'s viewport.</LI>
* <LI>Otherwise, for top level widgets, sizing is calculated as a percentage of page size.</LI> </UL> <P> {@link
* com.smartgwt.client.widgets.layout.Layout} may specially interpret percentage sizes on their children, and also
* allow "*" as a size. <P> Note that if {@link com.smartgwt.client.widgets.Canvas#getOverflow overflow} is set to
* "visible", this size is a minimum, and the component may overflow to show all content and/or children. <P> If
* trying to establish a default width for a custom component, set {@link com.smartgwt.client.widgets.Canvas#getDefaultWidth
* defaultWidth} instead. Resizes the widget horizontally to the specified width (moves the right side of the
* widget). The width parameter can be expressed as a percentage of viewport size or as the number of pixels. <P>
* NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
*
* @param width new width. Default value is null
*/
public void setWidth(String width) {
setAttribute("width", width, true);
}
public Integer getWidth() {
return getAttributeAsInt("width");
}
public String getWidthAsString() {
return getAttribute("width");
}
/**
* Number of pixels the left side of the widget is offset to the right from its default drawing context (either its
* parent's topleft corner, or the document flow, depending on the value of the {@link
* com.smartgwt.client.widgets.Canvas#getPosition position} property). <P> Can also be set as a percentage, specified as a
* String ending in '%', eg, "50%". In this case the top coordinate is considered as a percentage of the specified width
* of the {@link com.smartgwt.client.widgets.Canvas#getParentElement 'parent'}.
* Set the left coordinate of this object, relative to its enclosing context, in pixels. NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo() instead
*
* @param left new left coordinate. Default value is 0
*/
public void setLeft(int left) {
setAttribute("left", left, true);
}
/**
* Number of pixels the left side of the widget is offset to the right from its default drawing context (either its
* parent's topleft corner, or the document flow, depending on the value of the {@link
* com.smartgwt.client.widgets.Canvas#getPosition position} property). <P> Can also be set as a percentage, specified as a
* String ending in '%', eg, "50%". In this case the top coordinate is considered as a percentage of the specified width
* of the {@link com.smartgwt.client.widgets.Canvas#getParentElement 'parent'}.
*
*
* @return Return the left coordinate of this object, relative to its enclosing context, in pixels.
*/
public int getLeft() {
return getAttributeAsInt("left");
}
/**
* Number of pixels the left side of the widget is offset to the right from its default drawing context (either its
* parent's topleft corner, or the document flow, depending on the value of the {@link
* com.smartgwt.client.widgets.Canvas#getPosition position} property). <P> Can also be set as a percentage, specified as a
* String ending in '%', eg, "50%". In this case the top coordinate is considered as a percentage of the specified width
* of the {@link com.smartgwt.client.widgets.Canvas#getParentElement 'parent'}.
* Set the left coordinate of this object, relative to its enclosing context, in pixels. NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo() instead
*
* @param left new left coordinate. Default value is 0
*/
public void setLeft(String left) {
setAttribute("left", left, true);
}
/**
* Number of pixels the left side of the widget is offset to the right from its default drawing context (either its
* parent's topleft corner, or the document flow, depending on the value of the {@link
* com.smartgwt.client.widgets.Canvas#getPosition position} property). <P> Can also be set as a percentage, specified as a
* String ending in '%', eg, "50%". In this case the top coordinate is considered as a percentage of the specified width
* of the {@link com.smartgwt.client.widgets.Canvas#getParentElement 'parent'}.
*
*
* @return Return the left coordinate of this object, relative to its enclosing context, in pixels.
*/
public String getLeftAsString() {
return getAttributeAsString("left");
}
/**
* Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left
* corner, or the document flow, depending on the value of the {@link com.smartgwt.client.widgets.Canvas#getPosition
* position} property). <P> Can also be set as a percentage, specified as a String ending in '%', eg, "50%". In this case
* the top coordinate is considered as a percentage of the specified height of the {@link
* com.smartgwt.client.widgets.Canvas#getParentElement 'parent'}.
* Set the top coordinate of this object, relative to its enclosing context, in pixels. <P> NOTE: if you're setting multiple coordinates, use setRect() or moveTo() instead
*
* @param top new top coordinate. Default value is 0
*/
public void setTop(int top) {
setAttribute("top", top, true);
}
/**
* If a Canvas is dropped onto a {@link com.smartgwt.client.widgets.cube.CubeGrid}, and it has a {@link #setFacetId(String) facetId}
* property specified then the Cube treats this as adding that facetId at the drop location.
*
* @return the facet id
*/
public String getFacetId() {
return getAttribute("facetId");
}
/**
* If a Canvas is dropped onto a {@link com.smartgwt.client.widgets.cube.CubeGrid}, and it has a facetId property specified then
* the Cube treats this as adding that facetId at the drop location.
*
* @param facetId the facet id
*/
public void setFacetId(String facetId) {
setAttribute("facetId", facetId, true);
}
/**
* Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left
* corner, or the document flow, depending on the value of the {@link com.smartgwt.client.widgets.Canvas#getPosition
* position} property). <P> Can also be set as a percentage, specified as a String ending in '%', eg, "50%". In this case
* the top coordinate is considered as a percentage of the specified height of the {@link
* com.smartgwt.client.widgets.Canvas#getParentElement 'parent'}.
*
*
* @return Return the top coordinate of this object, relative to its enclosing context, in pixels.
*/
public int getTop() {
return getAttributeAsInt("top");
}
/**
* Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left
* corner, or the document flow, depending on the value of the {@link com.smartgwt.client.widgets.Canvas#getPosition
* position} property). <P> Can also be set as a percentage, specified as a String ending in '%', eg, "50%". In this case
* the top coordinate is considered as a percentage of the specified height of the {@link
* com.smartgwt.client.widgets.Canvas#getParentElement 'parent'}.
* Set the top coordinate of this object, relative to its enclosing context, in pixels. <P> NOTE: if you're setting multiple coordinates, use setRect() or moveTo() instead
*
* @param top new top coordinate. Default value is 0
*/
public void setTop(String top) {
setAttribute("top", top, true);
}
/**
* Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left
* corner, or the document flow, depending on the value of the {@link com.smartgwt.client.widgets.Canvas#getPosition
* position} property). <P> Can also be set as a percentage, specified as a String ending in '%', eg, "50%". In this case
* the top coordinate is considered as a percentage of the specified height of the {@link
* com.smartgwt.client.widgets.Canvas#getParentElement 'parent'}.
*
*
* @return Return the top coordinate of this object, relative to its enclosing context, in pixels.
*/
public String getTopAsString() {
return getAttributeAsString("top");
}
public void setAlign(Alignment align) {
setAttribute("align", align.getValue(), true);
}
public int getAbsoluteLeft() {
return getPageLeft();
}
public int getAbsoluteTop() {
return getPageTop();
}
/**
* Default animation effect to use if {@link Canvas#animateShow()} is called without an explicit effect parameter.
*
* @param animateShowEffect the animate show effect. Default is "wipe"
*/
public void setAnimateShowEffect(AnimationEffect animateShowEffect) {
setAttribute("animateShowEffect", animateShowEffect, true);
}
/**
* Default animation effect to use if {@link Canvas#animateShow()} is called without an explicit effect parameter.
*
* @return animation effect. Default value is "wipe"
*/
public AnimationEffect getAnimateShowEffect() {
return EnumUtil.getEnum(AnimationEffect.values(), getAttribute("animateShowEffect"));
}
/**
* If set to true, the widget will be disabled. A widget is only considered enabled if it is individually enabled and
* all parents above it in the containment hierarchy are enabled. This allows you to enable or disable all components
* of a complex nested widget by enabling or disabling the top-level parent only.
* set the disabled state of this object
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param disabled new disabled state of this object - pass <code>true</code> to disable the widget. Default value is false
*/
public void setDisabled(boolean disabled) {
setAttribute("disabled", disabled, true);
}
/**
* If set to true, the widget will be disabled. A widget is only considered enabled if it is individually enabled and
* all parents above it in the containment hierarchy are enabled. This allows you to enable or disable all components
* of a complex nested widget by enabling or disabling the top-level parent only.
*
*
* @return Is this canvas disabled? Note that the disabled state is inherited - this method will return true if this widget, or any
* of its ancestors are marked disabled.
*/
public boolean getDisabled() {
Boolean disabled = getAttributeAsBoolean("disabled");
return disabled == null ? false : disabled;
}
/**
* A different widget that should be actually dragged when dragging initiates on this
widget. One example of this is to have a child widget that drags its parent, as with a
drag box. Because the parent automatically repositions its children, setting the drag
target of the child to the parent and then dragging the child will result in both
widgets being moved.<br>
Valid dragTarget values are:<br>
- <code>null</code> (default) [this widget is its own drag target]<br>
- Pointer to another widget, or widget ID<br>
- <code>"parent"</code> drag target is this widget's
{@link com.smartgwt.client.widgets.Canvas#getParentElement parentElement}<br>
- <code>"top"</code> drag target is this widget's
{@link com.smartgwt.client.widgets.Canvas#getTopElement topElement}<br>
* <p><b>Note : </b> This is an advanced setting</p>
*
* @param dragTarget dragTarget Default value is null
*/
public void setDragTarget(Canvas dragTarget) {
setAttribute("dragTarget", dragTarget.getOrCreateJsObj(), true);
}
/**
* A different widget that should be actually dragged when dragging initiates on this
widget. One example of this is to have a child widget that drags its parent, as with a
drag box. Because the parent automatically repositions its children, setting the drag
target of the child to the parent and then dragging the child will result in both
widgets being moved.<br>
Valid dragTarget values are:<br>
- <code>null</code> (default) [this widget is its own drag target]<br>
- Pointer to another widget, or widget ID<br>
- <code>"parent"</code> drag target is this widget's
{@link com.smartgwt.client.widgets.Canvas#getParentElement parentElement}<br>
- <code>"top"</code> drag target is this widget's
{@link com.smartgwt.client.widgets.Canvas#getTopElement topElement}<br>
*
*
* @return Canvas
*
*/
public Canvas getDragTarget() {
return Canvas.getOrCreateRef(getAttributeAsJavaScriptObject("dragTarget"));
}
/**
* Returns true if the widget object being dragged can be dropped on this widget, and false otherwise. The default
* implementation of this method simply compares the {@link com.smartgwt.client.widgets.Canvas#getDragType dragType} of the
* <code>dragTarget</code> (the component being dragged from) with the list of {@link
* com.smartgwt.client.widgets.Canvas#getDropTypes dropTypes} on this Canvas. If the {@link
* com.smartgwt.client.widgets.Canvas#getDropTypes dropTypes} list contains the {@link
* com.smartgwt.client.widgets.Canvas#getDragType dragType} value, then this method returns true. Otherwise it returns
* false.
* <br><b>Note: This is an override point</b>
*
*
* @return true if the widget object being dragged can be dropped on this widget, false otherwise
*/
public native Boolean willAcceptDrop() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal = self.__willAcceptDrop();
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Fires when the interior size of the parent changes, including parent resize and scrollbar introduction or removal. <p>
* This method allows a child to implement a layout policy that can be used within any parent, such as a Resizer component
* that always snaps to the parent's bottom-right corner. The default implementation of this method applies a child's
* percent sizes, if any, or implements layout based on the {@link com.smartgwt.client.widgets.Canvas#getSnapTo snapTo}
* property.
* <br><p>Make sure you call super.parentResized() if you'd like the default behavior to apply.
*
* <br><b>Note: This is an override point</b>
*
*/
protected native void parentResized() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.__parentResized();
}-*/;
/**
* When {@link com.smartgwt.client.widgets.Canvas#getShowHoverComponents showHoverComponents} is true, this method is
* called to get the component to show as a hover for this Canvas. There is no default implementation of this method, so
* you need to override it with an implementation that returns a Canvas that suits your needs. <P> By default, components
* returned by <code>getHoverComponent()</code> will not be automatically destroyed when the hover is hidden. To enforce
* this, set {@link com.smartgwt.client.widgets.Canvas#getHoverAutoDestroy hoverAutoDestroy} to true on the returned
* component.
*
* <br><b>Note: this is an override point</b>
*
* @return the component to show as a hover
*/
public native Canvas getHoverComponent() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var hoverComponent = (self.__getHoverComponent == null) ? null : self.__getHoverComponent();
return hoverComponent == null ? null : hoverComponent.@com.smartgwt.client.widgets.Canvas::getOrCreateJsObj()();
}-*/;
/**
* Offset of the shadow. Defaults to half of <code>shadowDepth</code> if unset. <P> Because of the blurred edges, a
* shadow is larger than the originating component by 2xsoftness. An <code>shadowOffset</code> of 0 means that the
* shadow will extend around the originating component equally in all directions. <p><b>Note : </b> This is an
* advanced setting</p>
*
* @param shadowOffset shadowOffset Default value is null
*/
public void setShadowOffset(Integer shadowOffset) {
setAttribute("shadowOffset", shadowOffset, true);
}
/**
* Offset of the shadow. Defaults to half of <code>shadowDepth</code> if unset. <P> Because of the blurred edges, a
* shadow is larger than the originating component by 2xsoftness. An <code>shadowOffset</code> of 0 means that the
* shadow will extend around the originating component equally in all directions.
*
* @return Integer
*/
public Integer getShadowOffset() {
return getAttributeAsInt("shadowOffset");
}
/**
* Softness, or degree of blurring, of the shadow. <P> A shadow with <code>softness:x</code> is 2x pixels larger in
* each direction than the element throwing the shadow, and the media for each edge should be x pixels wide/tall.
* <P> Defaults to <code>shadowDepth</code> if unset. <p><b>Note : </b> This is an advanced setting</p>
*
* @param shadowSoftness shadowSoftness Default value is null
*/
public void setShadowSoftness(Integer shadowSoftness) {
setAttribute("shadowSoftness", shadowSoftness, true);
}
/**
* Softness, or degree of blurring, of the shadow. <P> A shadow with <code>softness:x</code> is 2x pixels larger in
* each direction than the element throwing the shadow, and the media for each edge should be x pixels wide/tall.
* <P> Defaults to <code>shadowDepth</code> if unset.
*
* @return Integer
*/
public Integer getShadowSoftness() {
return getAttributeAsInt("shadowSoftness");
}
/**
* Set the groupTitle.
*
* @param groupTitle the groupTitle
*/
public void setGroupTitle(String groupTitle) {
setAttribute("groupTitle", groupTitle, true);
}
/**
* Return the groupTitle.
*
* @return the groupTitle
*/
public String getGroupTitle() {
return getAttribute("groupTitle");
}
/**
* Set the isGroup.
*
* @param isGroup the isGroup
*/
public void setIsGroup(Boolean isGroup) {
setAttribute("isGroup", isGroup, true);
}
/**
* Return the isGroup.
*
* @return the isGroup
*/
public Boolean getIsGroup() {
return getAttributeAsBoolean("isGroup");
}
public void setSmoothFade(Boolean smoothFade) throws IllegalStateException {
setAttribute("smoothFade", smoothFade, false);
}
public void setKeepInParentRect(Boolean keepInParentRect) {
setAttribute("keepInParentRect", keepInParentRect, true);
}
public void setKeepInParentRect(Rectangle rectangle) {
setAttribute("keepInParentRect", rectangle.getAsJSArray(), true);
}
public void setPrefix(String prefix) {
setAttribute("prefix", prefix, true);
}
public String getPrefix() {
return getAttribute("prefix");
}
/**
* Allows resizing in certain edges or corners. The default value of null indicates that the widget is resizable from any corner
* or edge. To restrict resizing to only certain corners, set resizeFrom to an array of any of the values listed:<br>
*
* T top edge<br>
* B bottom edge<br>
* L left edge<br>
* R right edge<br>
* TL top-left corner<br>
* TR top-right corner<br>
* BL bottom-left corner<br>
* BR bottom-right corner<br><br>
* E.g. setting this property to a value of ["R","TR","BR"] would restrict resizing to the right edge, top-right corner and bottom-right corner only
*
* @param resizeFrom resizeFrom values
*/
public void setResizeFrom(String... resizeFrom) {
setAttribute("resizeFrom", resizeFrom, true);
}
/**
* When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the
breadth axis of
* the layout. Default is "left" for a VLayout, "top" for an HLayout.
*
* @param layoutAlign layoutAlign Default valaue is null
* @throws IllegalStateException this property cannot be changed after the component has been rendered
*/
public void setLayoutAlign(Alignment layoutAlign) throws IllegalStateException {
setAttribute("layoutAlign", layoutAlign.getValue(), false);
}
/**
* When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the
breadth axis of
* the layout. Default is "left" for a VLayout, "top" for an HLayout.
*
* @param layoutAlign layoutAlign Default valaue is null
* @throws IllegalStateException this property cannot be changed after the component has been rendered
*/
public void setLayoutAlign(VerticalAlignment layoutAlign) throws IllegalStateException {
setAttribute("layoutAlign", layoutAlign.getValue(), false);
}
/**
* The "type" of thing(s) that can be dropped on this widget specified as a string or an array of strings
* (indicating multiple types). Leave this with the value null to indicate that this widget can accept anything
* dropped on it from the page. <p><b>Note : </b> This is an advanced setting</p>
*
* @param dropTypes dropTypes Default value is Canvas.ANYTHING
*/
public void setDropTypes(String... dropTypes) {
setAttribute("dropTypes", dropTypes, true);
}
/*
public void setParentElement(Canvas parentElement) {
setAttribute("parentElement", parentElement.getOrCreateJsObj(), true);
}
*/
/**
* Moves the widget so that its top-left corner is at the specified coordinates. This method will also accept a
* single parameter as an object array with left and top given as properties.
*
* @param left x-coordinate to move to in LOCAL coordinates
* @param top y-coordinate to move to in LOCAL coordinates
* @return whether the component actually moved
*/
public native boolean moveTo(int left, int top) /*-{
var widget = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return widget.moveTo(left, top);
}-*/;
/**
* Resizes the widget, adding deltaX to its width and deltaY to its height (moves the right and/or bottom sides of
* the widget).
* @param deltaX amount to resize horizontally (may be negative)
* @param deltaY amount to resize vertically (may be negative)
*
* @return whether the component actually changed size
*/
public native Boolean resizeBy(int deltaX, int deltaY) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.resizeBy(deltaX, deltaY);
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Resizes the widget to the specified width and height (moves the right and/ or bottom sides of the widget). The
* width and height parameters can be expressed as a percentage of viewport size or as the number of pixels.
* @param width new width for canvas
* @param height new height for canvas
*
* @return whether the size actually changed
*/
public native Boolean resizeTo(String width, String height) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.resizeTo(width, height);
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Resizes the widget to the specified width and height (moves the right and/ or bottom sides of the widget). The
* width and height parameters can be expressed as a percentage of viewport size or as the number of pixels.
* @param width new width for canvas
* @param height new height for canvas
*
* @return whether the size actually changed
*/
public native Boolean resizeTo(int width, int height) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.resizeTo(width, height);
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Scroll this widget by some percentage of scroll size in either (or both) direction(s).
*
* @param dX Percentage to scroll horizontally.
* @param dY Percentage to scroll vertically.
*/
public native void scrollByPercent(int dX, int dY) /*-{
var widget = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return widget.scrollByPercent(dX, dY);
}-*/;
/**
* Scroll this widget to some position specified as a percentage of scroll size in either (or both) direction(s).
*
* @param left left Percentage position to scroll to
* @param top top Percentage position to scroll to
*/
public native void scrollToPercent(int left, int top) /*-{
var widget = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return widget.scrollToPercent(left, top);
}-*/;
/**
* Returns true if the widget is visible, taking all parents into account, so that a widget which is not hidden
* might still report itself as not visible if it is within a hidden parent. <P> NOTE: Undrawn widgets will
* report themselves as visible if they would be visible if drawn.
*
* @return true if the widget is visible, false otherwise
*/
public native boolean isVisible() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.isVisible();
}-*/;
/**
* Animate a reposition of this canvas from its current position to the specified position
*
* @param left new left position (or null for unchanged)
* @param top new top position (or null for unchanged)
*/
public native void animateMove(Integer left, Integer top) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var leftJS = left == null ? null : left.@java.lang.Integer::intValue()();
var topJS = top == null ? null : top.@java.lang.Integer::intValue()();
self.animateMove(leftJS, topJS);
}-*/;
/**
* Animate a reposition of this canvas from its current position to the specified position
*
* @param left new left position (or null for unchanged)
* @param top new top position (or null for unchanged)
* @param callback When the move completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
*/
public native void animateMove(Integer left, Integer top, AnimationCallback callback) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var leftJS = left == null ? null : left.@java.lang.Integer::intValue()();
var topJS = top == null ? null : top.@java.lang.Integer::intValue()();
self.animateMove(leftJS, topJS, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}));
}-*/;
/**
* Animate a reposition of this canvas from its current position to the specified position
*
* @param left new left position (or null for unchanged)
* @param top new top position (or null for unchanged)
* @param callback When the move completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
* @param duration Duration in ms of the animated move
*/
public native void animateMove(Integer left, Integer top, AnimationCallback callback, int duration) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var leftJS = left == null ? null : left.@java.lang.Integer::intValue()();
var topJS = top == null ? null : top.@java.lang.Integer::intValue()();
self.animateMove(leftJS, topJS, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}), duration);
}-*/;
/**
* Animate a reposition of this canvas from its current position to the specified position
*
* @param left new left position (or null for unchanged)
* @param top new top position (or null for unchanged)
* @param callback When the move completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
* @param duration Duration in ms of the animated move
* @param acceleration Optional acceleration effect to bias the ratios
*/
public native void animateMove(Integer left, Integer top, AnimationCallback callback, int duration, AnimationAcceleration acceleration) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var leftJS = left == null ? null : left.@java.lang.Integer::intValue()();
var topJS = top == null ? null : top.@java.lang.Integer::intValue()();
self.animateMove(leftJS, topJS, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}), duration, acceleration == null ? null : acceleration.@com.smartgwt.client.types.ValueEnum::getValue()());
}-*/;
/**
* Animate a scroll from the current scroll position to the specified position.
*
* @param scrollLeft desired final left scroll postion
* @param scrollTop desired final top scroll postion
*/
public native void animateScroll(int scrollLeft, int scrollTop) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateScroll(scrollLeft, scrollTop);
}-*/;
/**
* Animate a scroll from the current scroll position to the specified position.
*
* @param scrollLeft desired final left scroll postion
* @param scrollTop desired final top scroll postion
* @param callback When the scroll completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
*/
public native void animateScroll(int scrollLeft, int scrollTop, AnimationCallback callback) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateScroll(scrollLeft, scrollTop, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}));
}-*/;
/**
* Animate a scroll from the current scroll position to the specified position.
*
* @param scrollLeft desired final left scroll postion
* @param scrollTop desired final top scroll postion
* @param callback When the scroll completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
* @param duration Duration in ms of the animated scroll
*/
public native void animateScroll(int scrollLeft, int scrollTop, AnimationCallback callback, int duration) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateScroll(scrollLeft, scrollTop, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}), duration);
}-*/;
/**
* Animate a reposition / resize of this canvas from its current size and postion.
*
* @param left new left position (or null for unchanged)
* @param top new top position (or null for unchanged)
* @param width new width (or null for unchanged)
* @param height new height (or null for unchanged)
*/
public native void animateRect(Integer left, Integer top, Integer width, Integer height) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var leftJS = left == null ? null : left.@java.lang.Integer::intValue()();
var topJS = top == null ? null : top.@java.lang.Integer::intValue()();
var widthJS = width == null ? null : width.@java.lang.Integer::intValue()();
var heightJS = height == null ? null : height.@java.lang.Integer::intValue()();
self.animateRect(leftJS, topJS, widthJS, heightJS);
}-*/;
/**
* Animate a reposition / resize of this canvas from its current size and postion.
*
* @param left new left position (or null for unchanged)
* @param top new top position (or null for unchanged)
* @param width new width (or null for unchanged)
* @param height new height (or null for unchanged)
* @param callback When the setRect completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
*/
public native void animateRect(Integer left, Integer top, Integer width, Integer height, AnimationCallback callback) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var leftJS = left == null ? null : left.@java.lang.Integer::intValue()();
var topJS = top == null ? null : top.@java.lang.Integer::intValue()();
var widthJS = width == null ? null : width.@java.lang.Integer::intValue()();
var heightJS = height == null ? null : height.@java.lang.Integer::intValue()();
self.animateRect(leftJS, topJS, widthJS, heightJS, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}));
}-*/;
/**
* Animate a reposition / resize of this canvas from its current size and postion.
*
* @param left new left position (or null for unchanged)
* @param top new top position (or null for unchanged)
* @param width new width (or null for unchanged)
* @param height new height (or null for unchanged)
* @param callback When the setRect completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
* @param duration Duration in ms of the animated setRect
*/
public native void animateRect(Integer left, Integer top, Integer width, Integer height, AnimationCallback callback, int duration) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var leftJS = left == null ? null : left.@java.lang.Integer::intValue()();
var topJS = top == null ? null : top.@java.lang.Integer::intValue()();
var widthJS = width == null ? null : width.@java.lang.Integer::intValue()();
var heightJS = height == null ? null : height.@java.lang.Integer::intValue()();
self.animateRect(leftJS, topJS, widthJS, heightJS, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}), duration);
}-*/;
/**
* Animate a resize of this canvas from its current size to the specified size
*
* @param width new width (or null for unchanged)
* @param height new height (or null for unchanged)
*/
public native void animateResize(Integer width, Integer height) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var widthJS = width == null ? null : width.@java.lang.Integer::intValue()();
var heightJS = height == null ? null : height.@java.lang.Integer::intValue()();
self.animateResize(widthJS, heightJS);
}-*/;
/**
* Animate a resize of this canvas from its current size to the specified size
*
* @param width new width (or null for unchanged)
* @param height new height (or null for unchanged)
* @param callback When the resize completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
*/
public native void animateResize(Integer width, Integer height, AnimationCallback callback) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var widthJS = width == null ? null : width.@java.lang.Integer::intValue()();
var heightJS = height == null ? null : height.@java.lang.Integer::intValue()();
self.animateResize(widthJS, heightJS, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}));
}-*/;
/**
* Animate a resize of this canvas from its current size to the specified size
*
* @param width new width (or null for unchanged)
* @param height new height (or null for unchanged)
* @param callback When the resize completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
* @param duration Duration in ms of the animated resize
*/
public native void animateResize(Integer width, Integer height, AnimationCallback callback, int duration) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var widthJS = width == null ? null : width.@java.lang.Integer::intValue()();
var heightJS = height == null ? null : height.@java.lang.Integer::intValue()();
self.animateResize(widthJS, heightJS, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}), duration);
}-*/;
/**
* Animate a change in opacity from the widget's current opacity to the specified opacity.
*
* @param opacity desired final opacity
*/
public native void animateFade(int opacity) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateFade(opacity);
}-*/;
/**
* Animate a change in opacity from the widget's current opacity to the specified opacity.
*
* @param opacity desired final opacity
* @param callback When the fade completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
*/
public native void animateFade(int opacity, AnimationCallback callback) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateFade(opacity, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}));
}-*/;
/**
* Animate a change in opacity from the widget's current opacity to the specified opacity.
*
* @param opacity desired final opacity
* @param callback When the fade completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation
* @param duration Duration in ms of the animated fade
*/
public native void animateFade(int opacity, AnimationCallback callback, int duration) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateFade(opacity, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}), duration);
}-*/;
/**
* Hide a canvas by shrinking it vertically to zero height over a period of time. This method will not fire if the
* widget is already drawn and visible, or has overflow other than <code>"visible"</code> or <code>"hidden"</code>.
*
* @param effect How should the content of the window be hidden during the hide? If ommitted, default behavior can
* be configured via {@link com.smartgwt.client.widgets.Canvas#getAnimateHideEffect
* animateHideEffect}
*/
public native void animateHide(AnimationEffect effect) /*-{
var effectVal = effect.@com.smartgwt.client.types.AnimationEffect::getValue()();
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateHide(effectVal);
}-*/;
/**
* Hide a canvas by shrinking it vertically to zero height over a period of time. This method will not fire if the
* widget is already drawn and visible, or has overflow other than <code>"visible"</code> or <code>"hidden"</code>.
*
* @param effect How should the content of the window be hidden during the hide? If ommitted, default behavior
* can be configured via {@link com.smartgwt.client.widgets.Canvas#getAnimateHideEffect
* animateHideEffect}
* @param callback When the hide completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation.
*/
public native void animateHide(AnimationEffect effect, AnimationCallback callback) /*-{
var effectVal = effect.@com.smartgwt.client.types.AnimationEffect::getValue()();
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateHide(effectVal, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}));
}-*/;
/**
* Hide a canvas by shrinking it vertically to zero height over a period of time. This method will not fire if the
* widget is already drawn and visible, or has overflow other than <code>"visible"</code> or <code>"hidden"</code>.
*
* @param effect How should the content of the window be hidden during the hide? If ommitted, default behavior
* can be configured via {@link com.smartgwt.client.widgets.Canvas#getAnimateHideEffect
* animateHideEffect}
* @param callback When the hide completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation.
* @param duration Duration in ms of the animated hide. If unset, duration will be picked up from {@link
* com.smartgwt.client.widgets.Canvas#getAnimateHideTime animateHideTime}
*/
public native void animateHide(AnimationEffect effect, AnimationCallback callback, int duration) /*-{
var effectVal = effect.@com.smartgwt.client.types.AnimationEffect::getValue()();
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateHide(effectVal, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}), duration);
}-*/;
/**
* Show a canvas by growing it vertically to its fully drawn height over a period of time. This method will not fire
* if the widget is already drawn and visible, or has overflow other than <code>"visible"</code> or
* <code>"hidden"</code>.
*
* @param effect Animation effect to use when revealing the widget. If ommitted, default behavior can be
* configured via {@link com.smartgwt.client.widgets.Canvas#getAnimateShowEffect
* animateShowEffect}
*/
public native void animateShow(AnimationEffect effect) /*-{
var effectVal = effect.@com.smartgwt.client.types.AnimationEffect::getValue()();
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateShow(effectVal);
}-*/;
/**
* Show a canvas by growing it vertically to its fully drawn height over a period of time. This method will not fire
* if the widget is already drawn and visible, or has overflow other than <code>"visible"</code> or
* <code>"hidden"</code>.
*
* @param effect Animation effect to use when revealing the widget. If ommitted, default behavior can be
* configured via {@link com.smartgwt.client.widgets.Canvas#getAnimateShowEffect
* animateShowEffect}
* @param callback When the show completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation.
*/
public native void animateShow(AnimationEffect effect, AnimationCallback callback) /*-{
var effectVal = effect.@com.smartgwt.client.types.AnimationEffect::getValue()();
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateShow(effectVal, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}));
}-*/;
/**
* Show a canvas by growing it vertically to its fully drawn height over a period of time. This method will not fire
* if the widget is already drawn and visible, or has overflow other than <code>"visible"</code> or
* <code>"hidden"</code>.
*
* @param effect Animation effect to use when revealing the widget. If ommitted, default behavior can be
* configured via {@link com.smartgwt.client.widgets.Canvas#getAnimateShowEffect
* animateShowEffect}
* @param callback When the show completes this callback will be fired. Single
* 'earlyFinish' parameter will be passed if the animation was cut
* short by a call to finishAnimation.
* @param duration Duration in ms of the animated show. If unset, duration will be picked up from {@link
* com.smartgwt.client.widgets.Canvas#getAnimateShowTime animateShowTime}
*/
public native void animateShow(AnimationEffect effect, AnimationCallback callback, int duration) /*-{
var effectVal = effect.@com.smartgwt.client.types.AnimationEffect::getValue()();
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.animateShow(effectVal, $entry(function(earlyFinish) {
earlyFinish = earlyFinish === undefined ? false : earlyFinish;
if(callback != null) callback.@com.smartgwt.client.widgets.AnimationCallback::execute(Z)(earlyFinish);
}), duration);
}-*/;
/**
* Update the canvas shadow.
*/
public native void updateShadow() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.updateShadow();
}-*/;
/**
* Get the z-Index of this canvas.
*
* @return the zIndex
*/
public native int getZIndex() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getZIndex(true);
}-*/;
/**
* get the next zIndex for the next item to be drawn. see setZIndex() for notes
*
* @return the next zIndex
*/
public native int getNextZIndex() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getNextZIndex();
}-*/;
/**
* Set the z-Index of the canvas.
*
* @param newIndex the new zIndex to set to
*/
public native void setZIndex(int newIndex) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.setZIndex(newIndex);
}-*/;
public native Rectangle getPageRect() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var rect = self.getPageRect();
return @com.smartgwt.client.core.Rectangle::new(IIII)(rect[0], rect[1],rect[2],rect[3]);
}-*/;
/**
* Set all four coordinates, relative to the enclosing context, at once. <P> Moves the widget so that its top-left
* corner is at the specified top-left coordinates, then resizes it to the specified width and height.
*
* @param rectangle new coordinates
*/
public void setRect(Rectangle rectangle) {
setRect(rectangle.getLeft(), rectangle.getTop(), rectangle.getWidth(), rectangle.getHeight());
}
/**
* Set all four coordinates, relative to the enclosing context, at once. <P> Moves the widget so that its top-left
* corner is at the specified top-left coordinates, then resizes it to the specified width and height.
*
* @param left new left coordinate, Array of coordinates in
* parameter order, or Object with left, top, width,
* height properties. If an Array or Object is
* passed, the remaining parameters are ignored
* @param top new top coordinate
* @param width new width
* @param height new height
*/
public native void setRect(int left, int top, int width, int height) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.setRect(left, top, width, height);
}-*/;
/**
* Get all four coordinates, relative to the enclosing context, at one.
*
* @return the Rectangle
*/
public native Rectangle getRect() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var rect = self.getRect();
return @com.smartgwt.client.core.Rectangle::new(IIII)(rect[0], rect[1],rect[2],rect[3]);
}-*/;
/**
* Return the full URL for an image to be drawn in this canvas. <P> If the passed URL begins with the special
* prefix "[SKIN]", it will have the widget.skinImgDir and Page.skinImgDir prepended. Otherwise the image is
* assumed to be application-specific, and will have the widget.appImgDir and Page.appImgDir automatically
* prepended. <P> Note that if passed an absolute path (starting with "/" or "http://" for example), no extra
* image directory information will be prepended to the generated URL.//
*
* @param URL URL local to skin or application image directory
* @return URL to use
*/
public static native String getImgURL(String URL) /*-{
return $wnd.isc.Canvas.getImgURL(URL);
}-*/;
/**
* Return the full URL for an image to be drawn in this canvas. <P> If the passed URL begins with the special
* prefix "[SKIN]", it will have the widget.skinImgDir and Page.skinImgDir prepended. Otherwise the image is
* assumed to be application-specific, and will have the widget.appImgDir and Page.appImgDir automatically
* prepended. <P> Note that if passed an absolute path (starting with "/" or "http://" for example), no extra
* image directory information will be prepended to the generated URL.//
*
* @param URL URL local to skin or application image directory
* @param imgDir optional image directory to override the default for this Canvas
* @return URL to use
*/
public static native String getImgURL(String URL, String imgDir) /*-{
return $wnd.isc.Canvas.getImgURL(URL, imgDir);
}-*/;
/**
* Generates the HTML for an image unique to this Canvas. <P> The full URL for the image will be formed
* according to the rules documented for <code>{@link com.smartgwt.client.widgets.Canvas#getImgURL}</code>. <P>
* The created image will have an identifier unique to this Canvas, and subsequent calls to <code>{@link
* com.smartgwt.client.widgets.Canvas#getImage}</code> and <code>{@link com.smartgwt.client.widgets.Canvas#setImage}</code>
* with the name passed to this function will act on the image object produced by the HTML returned from this
* call.
*
* @param src URL local to the skin or application directory.<br> NOTE: instead of passing several parameters,
* you can pass an object as the 'src' parameter with properties for all the various function
* parameters with, eg:<br> canvas.imgHTML( {src:"foo", width:10, height:10} );
* @return HTML to draw the image.
*/
public static native String imgHTML(String src) /*-{
return $wnd.isc.Canvas.imgHTML(src);
}-*/;
/**
* Generates the HTML for an image unique to this Canvas. <P> The full URL for the image will be formed
* according to the rules documented for <code>{@link com.smartgwt.client.widgets.Canvas#getImgURL}</code>. <P>
* The created image will have an identifier unique to this Canvas, and subsequent calls to <code>{@link
* com.smartgwt.client.widgets.Canvas#getImage}</code> and <code>{@link com.smartgwt.client.widgets.Canvas#setImage}</code>
* with the name passed to this function will act on the image object produced by the HTML returned from this
* call.
*
* @param src URL local to the skin or application directory.<br> NOTE: instead of passing several
* parameters, you can pass an object as the 'src' parameter with properties for all the
* various function parameters with, eg:<br> canvas.imgHTML( {src:"foo", width:10,
* height:10} );
* @param width width of the image
* @param height height of the image
* @param name name for the image
* @param extraStuff additional attributes to write in the tag
* @param imgDir image-specific image directory to override the default for
* this Canvas
* @return HTML to draw the image.
*/
public static native String imgHTML(String src, int width, int height, String name, String extraStuff, String imgDir) /*-{
return $wnd.isc.Canvas.imgHTML(src, width, height, name, extraStuff, imgDir);
}-*/;
public static native String imgHTML(String src, int width, int height) /*-{
return $wnd.isc.Canvas.imgHTML(src, width, height);
}-*/;
/**
* Returns the scrollTop required to scroll vertically to the end of this widget's content.
*/
public native int getScrollBottom() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getScrollBottom();
}-*/;
/**
* Returns the scrollLeft required to scroll horizontally to the end of this widget's content.
*/
public native int getScrollRight() /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return self.getScrollRight();
}-*/;
/**
* Show a PrintWindow containing a printable view of the component passed in containing print HTML.
*
* @param component to get printable HTML for.
*/
public static native void showPrintPreview(Canvas component) /*-{
var componentJS = component.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
return $wnd.isc.Canvas.showPrintPreview(componentJS);
}-*/;
/**
* Show a Print containing a printable view of the components passed in.
* @param components components to get the print HTML for. May also include raw HTML strings which will be folded into the generated print
* output
*/
public static native void showPrintPreview(Object[] components) /*-{
var componentsJS = @com.smartgwt.client.util.JSOHelper::convertToJavaScriptArray([Ljava/lang/Object;)(components);
$wnd.isc.Canvas.showPrintPreview(componentsJS);
}-*/;
/**
* Show a Print containing a printable view of the components passed in.
* @param components components to get the print HTML for. May also include raw HTML strings which will be folded into the generated print
* output
* @param printProperties for customizing the print HTML output. If this parameter is passed as null, it will be ignored.
* @param title for the print window
* @param callback to fire when the print preview window has been created and shown
*/
public static native void showPrintPreview(Object[] components, PrintProperties printProperties, String title, PrintPreviewCallback callback) /*-{
var componentsJS = @com.smartgwt.client.util.JSOHelper::convertToJavaScriptArray([Ljava/lang/Object;)(components);
var ppJS = printProperties == null ? null : printProperties.@com.smartgwt.client.util.PrintProperties::getJsObj()();
var pvpJS = {};
if(title != null) $wnd.isc.addProperties(pvpJS, {title:title});
$wnd.isc.Canvas.showPrintPreview(componentsJS, ppJS, pvpJS,
callback == null ? null :
$entry(function (printCanvas, printWindow) {
var canvasJ = @com.smartgwt.client.widgets.PrintCanvas::getOrCreateRef(Lcom/google/gwt/core/client/JavaScriptObject;)(printCanvas);
var windowJ = @com.smartgwt.client.widgets.PrintWindow::getOrCreateRef(Lcom/google/gwt/core/client/JavaScriptObject;)(printWindow);
callback.@com.smartgwt.client.util.PrintPreviewCallback::execute(Lcom/smartgwt/client/widgets/PrintCanvas;Lcom/smartgwt/client/widgets/PrintWindow;)(canvasJ, windowJ);
})
);
}-*/;
/**
* Show a Print containing a printable view of the components passed in.
* @param components components to get the print HTML for. May also include raw HTML strings which will be folded into the generated print
* output
* @param printProperties for customizing the print HTML output. If this parameter is passed as null, it will be ignored.
* @param title for the print window
* @param callback to fire when the print preview window has been created and shown
* @param printWindowProperties the print window properties
* @param printButtonTitle the brint button title
*/
public static native void showPrintPreview(Object[] components, PrintProperties printProperties, String title, PrintPreviewCallback callback, Window printWindowProperties, String printButtonTitle) /*-{
var componentsJS = @com.smartgwt.client.util.JSOHelper::convertToJavaScriptArray([Ljava/lang/Object;)(components);
var ppJS = printProperties == null ? null : printProperties.@com.smartgwt.client.util.PrintProperties::getJsObj()();
var pvpJS = printWindowProperties == null ? {} : printWindowProperties.@com.smartgwt.client.widgets.Window::getConfig()();
if(title != null) $wnd.isc.addProperties(pvpJS, {title:title});
if(printButtonTitle != null) $wnd.isc.addProperties(pvpJS, {printButtonTitle:printButtonTitle});
$wnd.isc.Canvas.showPrintPreview(componentsJS, ppJS, pvpJS,
callback == null ? null :
$entry(function (printCanvas, printWindow) {
var canvasJ = @com.smartgwt.client.widgets.PrintCanvas::getOrCreateRef(Lcom/google/gwt/core/client/JavaScriptObject;)(printCanvas);
var windowJ = @com.smartgwt.client.widgets.PrintWindow::getOrCreateRef(Lcom/google/gwt/core/client/JavaScriptObject;)(printWindow);
callback.@com.smartgwt.client.util.PrintPreviewCallback::execute(Lcom/smartgwt/client/widgets/PrintCanvas;Lcom/smartgwt/client/widgets/PrintWindow;)(canvasJ, windowJ);
})
);
}-*/;
/**
* Returns print-formatted HTML for the specified list of components.
* @param components Components to get the print HTML for. Strings of raw HTML may also be included in this array, and will be integrated
* into the final HTML at the appropriate point.
* <code>HTML</code>.
* @param printProperties for customizing the print HTML output. If this parameter is passed as null, it will be ignored.
* @param callback to fire when the HTML has been generated
*/
public static native void getPrintHTML(Object[] components, PrintProperties printProperties, PrintHTMLCallback callback) /*-{
var componentsJS = @com.smartgwt.client.util.JSOHelper::convertToJavaScriptArray([Ljava/lang/Object;)(components);
var ppJS = printProperties == null ? null : printProperties.@com.smartgwt.client.util.PrintProperties::getJsObj()();
$wnd.isc.Canvas.getPrintHTML(componentsJS, ppJS,
callback == null ? null :
$entry(function (HTML) {
callback.@com.smartgwt.client.util.PrintHTMLCallback::setHTML(Ljava/lang/String;)(HTML);
}));
}-*/;
/**
* Retrieves printable HTML for this component and all printable subcomponents.
* By default any Canvas with children will simply collect the printable HTML of its
* children by calling getPrintHTML() on each child that has shouldPrint set to true and is not
* omitted as a control.
*
* If overriding this method for a custom component, you should <b>either</b> return a String of printable HTML string directly <b>or</b> return null,
* and call {@link PrintHTMLCallback#setHTML(String)}. This allows for providing a printable view for asynch interfaces
* - for example fetching records that aren't yet loaded for the print view, etc
*
* <b>Note: this is an override point.</b>
* @param printProperties properties to configure printing behavior - may be null
* @param callback to fire. Generated HTML should be passed to the execute method of the callback.
*/
public native String getPrintHTML(PrintProperties printProperties, PrintHTMLCallback callback) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
if (self._jsOverrideCall.getPrintHTML) {
self._fireDefaultMethod.getPrintHTML = true;
return;
}
var ppJS = printProperties == null ? null : printProperties.@com.smartgwt.client.util.PrintProperties::getJsObj()();
var ret = self.__getPrintHTML(
ppJS,
callback == null ? null :
$entry(function (HTML) {
callback.@com.smartgwt.client.util.PrintHTMLCallback::setHTML(Ljava/lang/String;)(HTML);
})
);
return ret === undefined ? null : ret;
}-*/;
private String getPrintHTMLJSCB(PrintProperties printProperties, final JavaScriptObject jscallback) {
if (jscallback == null) {
return getPrintHTML(printProperties, null);
} else {
PrintHTMLCallback jcb = new PrintHTMLCallback() {
public void setHTML (String HTML) {
executeJS(HTML, jscallback, getOrCreateJsObj());
}
private native void executeJS (String HTML, JavaScriptObject jscallback, JavaScriptObject canvas) /*-{
canvas.fireCallback(jscallback, ["HTML", "callback"], [HTML,jscallback]);
}-*/;
};
return getPrintHTML(printProperties, jcb);
}
}
/**
* Generate printable HTML for the designated components and trigger the native print dialog, without ever showing the
* printable HTML to the user.
* @param components components to get the print HTML for. May also include raw HTML strings which will be folded into the generated
* print output
*/
public static native void printComponents(Object[] components) /*-{
var componentsJS = @com.smartgwt.client.util.JSOHelper::convertToJavaScriptArray([Ljava/lang/Object;)(components);
$wnd.isc.Canvas.printComponents(componentsJS);
}-*/;
/**
* This Canvas's immediate parent, if any. <BR> Can be initialized, but any subsequent manipulation should be via
* {@link com.smartgwt.client.widgets.Canvas#addChild} and {@link com.smartgwt.client.widgets.Canvas#removeChild}
* calls on the parent. <p><b>Note : </b> This is an advanced setting</p>
*
* @param parentElement parentElement Default value is null
* @throws IllegalStateException this property cannot be changed after the component has been created
*/
public void setParentElement(Canvas parentElement) throws IllegalStateException {
setAttribute("parentElement", parentElement.getOrCreateJsObj(), false);
}
/**
* This Canvas's immediate parent, if any. <BR> Can be initialized, but any subsequent manipulation should be via
* {@link com.smartgwt.client.widgets.Canvas#addChild} and {@link com.smartgwt.client.widgets.Canvas#removeChild}
* calls on the parent.
*
* @return Canvas
*/
public Canvas getParentElement() {
JavaScriptObject parentJS = getAttributeAsJavaScriptObject("parentElement");
if(parentJS == null) return null;
Canvas canvas = (Canvas) BaseWidget.getRef(parentJS);
if (canvas == null) {
canvas = new Canvas(parentJS);
}
return canvas;
}
/**
* Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if
* name argument is provided, and draw the child if this widget has been drawn already. <P> If newChild has a parent
* it will be removed from it. If it has a master, it will be detached from it if the master is a child of a
* different parent. If newChild has peers, they'll be added to this widget as children as well.
*
* @param newChild new child canvas to add
*/
public void addChild(Widget widget) {
if (widget instanceof Canvas) {
addChild((Canvas) widget);
} else {
addChild(new WidgetCanvas(widget));
}
}
/**
* Array of all Canvii that are immediate children of this Canvas. <p><b>Note : </b> This is an advanced
* setting</p>
*
* @param children children Default value is null
*/
public void setChildren(Canvas... children) {
if(!isDrawn()) {
setAttribute("children", children, false);
} else {
for (int i = 0; i < children.length; i++) {
Canvas child = children[i];
addChild(child);
}
}
}
/**
* Array of all Canvii that are immediate children of this Canvas. <p><b>Note : </b> This is an advanced
* setting</p>
*/
public Canvas[] getChildren() {
return convertToCanvasArray(getAttributeAsJavaScriptObject("children"));
}
protected static Canvas[] convertToCanvasArray(JavaScriptObject nativeArray) {
if (nativeArray == null) {
return new Canvas[]{};
}
JavaScriptObject[] componentsj = JSOHelper.toArray(nativeArray);
Canvas[] objects = new Canvas[componentsj.length];
for (int i = 0; i < componentsj.length; i++) {
JavaScriptObject componentJS = componentsj[i];
Canvas obj = (Canvas) BaseWidget.getRef(componentJS);
if (obj == null) {
obj = new Canvas(componentJS);
}
objects[i] = obj;
}
return objects;
}
/**
* Remove a child from its parent if it has one.
*
* @param child Child canvas to remove from this parent.
*/
public native void removeChild(Canvas child) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var childJS= child.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.removeChild(childJS);
}-*/;
/**
* Remove a child from its parent if it has one.
*
* @param child Child canvas to remove from this parent.
* @param name If the child canvas was assigned a name, it should be passed in here to
* ensure this[name] is cleared
*/
public native void removeChild(Canvas child, String name) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var childJS= child.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
self.removeChild(childJS, name);
}-*/;
public int getOffsetHeight() {
return getVisibleHeight();
}
public int getOffsetWidth() {
return getVisibleWidth();
}
/**
* Set the minimum value for height.
* <p>
* For use with setOverflow(Overflow.VISIBLE), where widgets render only as large as their contents
* and/or children, and height and width settings act as a minimum size.
*/
public void setAutoHeight() {
setHeight(1);
}
/**
* Set the minimum value for width.
* <p>
* For use with setOverflow(Overflow.VISIBLE), where widgets render only as large as their contents
* and/or children, and height and width settings act as a minimum size.
*/
public void setAutoWidth() {
setWidth(1);
}
/**
* Show a clickMask over the entire screen that intercepts mouse clicks and fires some action. The mask created will be
* associated with this canvas - calling this method multiple times will not show multiple (stacked) clickMasks if the mask
* associated with this canvas is already up.<br><br> The clickMask useful for modal dialogs, menus and similar uses,
* where any click outside of some Canvas should either be suppressed (as in a modal dialog) or just cause something (like
* dismissing a menu).
* @param clickActionCallback action to fire when the user clicks on the mask
* @param mode whether to automatically hide the clickMask on mouseDown and suppress the mouseDown
* event from reaching the target under the mouse
* @param unmaskedTargets initially unmasked targets for this clickMask. Note that if this is a <code>"hard"</code> mask, unmasked children of
* masked parents are not supported so any non-top-level widgets passed in will have their parents unmasked. Children of
* masked parents can never be masked.
*
* @return clickMask ID
*/
public native String showClickMask(Function clickActionCallback, ClickMaskMode mode, Canvas[] unmaskedTargets) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var unmaskedTargetsJS = @com.smartgwt.client.util.JSOHelper::convertToJavaScriptArray([Ljava/lang/Object;)(unmaskedTargets);
return self.showClickMask($entry(function() {
if(clickActionCallback != null) clickActionCallback.@com.smartgwt.client.core.Function::execute()();
}), mode.@com.smartgwt.client.types.ClickMaskMode::getValue()(), unmaskedTargetsJS);
}-*/;
/**
* Does this widget contain the specified global (x,y) coordinates, and have no other widgets also at the specified
* position, obscuring this one? This is commonly used for (for example) drag and drop interactions.
* @param x GLOBAL x-coordinate
* @param y GLOBAL y-coordinate
* @param withinViewport point lies within our viewport rather than just our drawn area
* @param ignoreWidgets If passed ignore widget(s), do not check whether those widgets occludes this one
* @param upToParent If passed, only check for siblings occluding the component up as far as the specified parent widget
*
* @return true if this object contains the specified point; false otherwise
* @see com.smartgwt.client.docs.Positioning Positioning overview and related methods
*/
public native Boolean visibleAtPoint(int x, int y, boolean withinViewport, Canvas ignoreWidgets, Canvas upToParent) /*-{
var self = this.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()();
var retVal =self.visibleAtPoint(x, y, withinViewport, ignoreWidgets == null ? null : ignoreWidgets.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()(), upToParent == null ? null : upToParent.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
if(retVal == null || retVal === undefined) {
return null;
} else {
return @com.smartgwt.client.util.JSOHelper::toBoolean(Z)(retVal);
}
}-*/;
/**
* Add a onDrop handler.
* <p>
* Notification method fired when the user drops another canvas onto this one.
*
* @param handler the onDrop handler
* @return {@link com.google.gwt.event.shared.HandlerRegistration} used to remove this handler
*/
public HandlerRegistration addDropHandler(com.smartgwt.client.widgets.events.DropHandler handler) {
if(getHandlerCount(com.smartgwt.client.widgets.events.DropEvent.getType()) == 0) setupDropEvent();
return doAddHandler(handler, com.smartgwt.client.widgets.events.DropEvent.getType());
}
private native void setupDropEvent() /*-{
var obj = null;
var selfJ = this;
if(this.@com.smartgwt.client.widgets.BaseWidget::isCreated()()) {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getJsObj()();
obj.addProperties({onDrop:$debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DropEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}))
});
} else {
obj = this.@com.smartgwt.client.widgets.BaseWidget::getConfig()();
obj.onDrop = $debox($entry(function(){
var param = {};
var event = @com.smartgwt.client.widgets.events.DropEvent::new(Lcom/google/gwt/core/client/JavaScriptObject;)(param);
selfJ.@com.smartgwt.client.widgets.BaseWidget::fireEvent(Lcom/google/gwt/event/shared/GwtEvent;)(event);
var ret = event.@com.smartgwt.client.event.Cancellable::isCancelled()();
return !ret;
}));
}
}-*/;
}