Canvas (Smart GWT EE API 12.0p (2024-08-07))

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.smartgwt.client.widgets.BaseWidget
    - - com.smartgwt.client.widgets.Canvas

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, HasClearHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers

Direct Known Subclasses:

AceEditor, BrowserPlugin, Calendar, DetailViewer, DrawKnob, DrawPane, DynamicForm, EdgedCanvas, EditPane, GridRenderer, HTMLFlow, Layout, LayoutSpacer, PrintCanvas, RangeSlider, Slider, StatefulCanvas, TabSet, TileLayout, WidgetCanvas
```
public class Canvas
extends BaseWidget
implements HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasClearHandlers, HasDropHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers
```
Base class for all Smart GWT visual components (except FormItems).
Canvas provides:
- basic visual lifecycle support - creation and destruction of HTML via draw() and clear(), visibility via show() and hide(), z-layering via bringToFront() and sendToBack().
- consistent cross-browser positioning, sizing and size detection, with automatic compensation for browser CSS behavior differences.
- clipping, scrolling and overflow management of content via overflow
- consistent cross-browser key and mouse events, including mapping touch events to mouse events
- built-in drag and drop capabilities including moving, resizing, drag scrolling and snap-to-grid behavior.
- the ability to either contain HTML content or contain other Canvases, including an edge-based positioning and percent sizing system for children. For more advanced layout capabilities, see Layout.
- various other details like cursors, modal masking, animation, accessibility properties, and settings for automated testing.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
  com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary
- Fields inherited from class com.smartgwt.client.widgets.BaseWidget
  config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
- Fields inherited from class com.google.gwt.user.client.ui.UIObject
  DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description

Canvas()

Canvas(com.google.gwt.core.client.JavaScriptObject jsObj)

Canvas(java.lang.String id)

Constructors
Constructor and Description
`Canvas()`
`Canvas(com.google.gwt.core.client.JavaScriptObject jsObj)`
`Canvas(java.lang.String id)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Canvas`	`addChild(Canvas newChild)` 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.
`Canvas`	`addChild(Canvas newChild, java.lang.String name)`
`Canvas`	`addChild(Canvas newChild, java.lang.String name, boolean autoDraw)` 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.
`Canvas`	`addChild(Canvas newChild, java.lang.String name, java.lang.Boolean autoDraw)` 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.
`void`	`addChild(com.google.gwt.user.client.ui.Widget widget)` 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.
`com.google.gwt.event.shared.HandlerRegistration`	`addClearHandler(ClearHandler handler)` Add a clear handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addClickHandler(ClickHandler handler)` Add a click handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDoubleClickHandler(DoubleClickHandler handler)` Add a doubleClick handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragMoveHandler(DragMoveHandler handler)` Add a dragMove handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragRepositionMoveHandler(DragRepositionMoveHandler handler)` Add a dragRepositionMove handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragRepositionStartHandler(DragRepositionStartHandler handler)` Add a dragRepositionStart handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragRepositionStopHandler(DragRepositionStopHandler handler)` Add a dragRepositionStop handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragResizeMoveHandler(DragResizeMoveHandler handler)` Add a dragResizeMove handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragResizeStartHandler(DragResizeStartHandler handler)` Add a dragResizeStart handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragResizeStopHandler(DragResizeStopHandler handler)` Add a dragResizeStop handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragStartHandler(DragStartHandler handler)` Add a dragStart handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDragStopHandler(DragStopHandler handler)` Add a dragStop handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDropHandler(DropHandler handler)` Add a drop handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDropMoveHandler(DropMoveHandler handler)` Add a dropMove handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDropOutHandler(DropOutHandler handler)` Add a dropOut handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addDropOverHandler(DropOverHandler handler)` Add a dropOver handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addFocusChangedHandler(FocusChangedHandler handler)` Add a focusChanged handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addHoverHandler(HoverHandler handler)` Add a hover handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addHoverHiddenHandler(HoverHiddenHandler handler)` Add a hoverHidden handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addKeyDownHandler(KeyDownHandler handler)` Add a keyDown handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addKeyPressHandler(KeyPressHandler handler)` Add a keyPress handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addMouseDownHandler(MouseDownHandler handler)` Add a mouseDown handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addMouseMoveHandler(MouseMoveHandler handler)` Add a mouseMove handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addMouseOutHandler(MouseOutHandler handler)` Add a mouseOut handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addMouseOverHandler(MouseOverHandler handler)` Add a mouseOver handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addMouseStillDownHandler(MouseStillDownHandler handler)` Add a mouseStillDown handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addMouseUpHandler(MouseUpHandler handler)` Add a mouseUp handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addMouseWheelHandler(MouseWheelHandler handler)` Add a mouseWheel handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addMovedHandler(MovedHandler handler)` Add a moved handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addParentMovedHandler(ParentMovedHandler handler)` Add a parentMoved handler.
`Canvas`	`addPeer(Canvas newPeer)` 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.
`Canvas`	`addPeer(Canvas newPeer, java.lang.String name)`
`Canvas`	`addPeer(Canvas newPeer, java.lang.String name, java.lang.Boolean autoDraw)`
`Canvas`	`addPeer(Canvas newPeer, java.lang.String name, java.lang.Boolean autoDraw, java.lang.Boolean preDraw)` 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.
`com.google.gwt.event.shared.HandlerRegistration`	`addResizedHandler(ResizedHandler handler)` Add a resized handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addRightMouseDownHandler(RightMouseDownHandler handler)` Add a rightMouseDown handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addRuleContextChangedHandler(RuleContextChangedHandler handler)` Add a ruleContextChanged handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addScrolledHandler(ScrolledHandler handler)` Add a scrolled handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addShowContextMenuHandler(ShowContextMenuHandler handler)` Add a showContextMenu handler.
`void`	`addSnapAlignCandidate(Canvas newCandidate)` Add a candidate to `snapAlignCandidates`.
`void`	`addStyleName(java.lang.String style)` Multiple styles are currently not supported.
`com.google.gwt.event.shared.HandlerRegistration`	`addVisibilityChangedHandler(VisibilityChangedHandler handler)` Add a visibilityChanged handler.
`void`	`adjustForContent(boolean immediate)` This method tells a component to adjust for changes in the size of its content that happen outside of Smart GWT APIs.
`void`	`animateFade(int opacity)` Animate a change in opacity from the widget's current opacity to the specified opacity.
`void`	`animateFade(int opacity, AnimationCallback callback)` Animate a change in opacity from the widget's current opacity to the specified opacity.
`void`	`animateFade(int opacity, AnimationCallback callback, int duration)` Animate a change in opacity from the widget's current opacity to the specified opacity.
`void`	`animateFade(int opacity, AnimationCallback callback, int duration, AnimationAcceleration acceleration)` Animate a change in opacity from the widget's current opacity to the specified opacity.
`void`	`animateFade(java.lang.Integer opacity)` Animate a change in opacity from the widget's current opacity to the specified opacity.
`void`	`animateFade(java.lang.Integer opacity, AnimationCallback callback)`
`void`	`animateFade(java.lang.Integer opacity, AnimationCallback callback, java.lang.Integer duration)`
`void`	`animateFade(java.lang.Integer opacity, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)` Animate a change in opacity from the widget's current opacity to the specified opacity.
`void`	`animateHide()` Hide a canvas by shrinking it with default effect specified by `animateHideEffect`.
`void`	`animateHide(AnimateShowEffect effect)` Hide a canvas by shrinking it vertically to zero height over a period of time.
`void`	`animateHide(AnimateShowEffect effect, AnimationCallback callback)` Hide a canvas by shrinking it vertically to zero height over a period of time.
`void`	`animateHide(AnimateShowEffect effect, AnimationCallback callback, int duration)` Hide a canvas by shrinking it vertically to zero height over a period of time.
`void`	`animateHide(AnimationEffect effect)` Hide a canvas by shrinking it vertically to zero height over a period of time.
`void`	`animateHide(AnimationEffect effect, AnimationCallback callback)` Hide a canvas by shrinking it vertically to zero height over a period of time.
`void`	`animateHide(AnimationEffect effect, AnimationCallback callback, int duration)` Hide a canvas by shrinking it vertically to zero height over a period of time.
`void`	`animateMove(java.lang.Integer left, java.lang.Integer top)` Animate a reposition of this canvas from its current position to the specified position
`void`	`animateMove(java.lang.Integer left, java.lang.Integer top, AnimationCallback callback)`
`void`	`animateMove(java.lang.Integer left, java.lang.Integer top, AnimationCallback callback, java.lang.Integer duration)`
`void`	`animateMove(java.lang.Integer left, java.lang.Integer top, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)` Animate a reposition of this canvas from its current position to the specified position
`void`	`animateRect(java.lang.Integer left, java.lang.Integer top, java.lang.Integer width, java.lang.Integer height)` Animate a reposition / resize of this canvas from its current size and position.
`void`	`animateRect(java.lang.Integer left, java.lang.Integer top, java.lang.Integer width, java.lang.Integer height, AnimationCallback callback)`
`void`	`animateRect(java.lang.Integer left, java.lang.Integer top, java.lang.Integer width, java.lang.Integer height, AnimationCallback callback, java.lang.Integer duration)`
`void`	`animateRect(java.lang.Integer left, java.lang.Integer top, java.lang.Integer width, java.lang.Integer height, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)` Animate a reposition / resize of this canvas from its current size and position.
`void`	`animateResize(java.lang.Integer width, java.lang.Integer height)` Animate a resize of this canvas from its current size to the specified size
`void`	`animateResize(java.lang.Integer width, java.lang.Integer height, AnimationCallback callback)`
`void`	`animateResize(java.lang.Integer width, java.lang.Integer height, AnimationCallback callback, java.lang.Integer duration)`
`void`	`animateResize(java.lang.Integer width, java.lang.Integer height, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)` Animate a resize of this canvas from its current size to the specified size
`void`	`animateScroll(java.lang.Integer scrollLeft, java.lang.Integer scrollTop)` Animate a scroll from the current scroll position to the specified position.
`void`	`animateScroll(java.lang.Integer scrollLeft, java.lang.Integer scrollTop, AnimationCallback callback)`
`void`	`animateScroll(java.lang.Integer scrollLeft, java.lang.Integer scrollTop, AnimationCallback callback, java.lang.Integer duration)`
`void`	`animateScroll(java.lang.Integer scrollLeft, java.lang.Integer scrollTop, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)` Animate a scroll from the current scroll position to the specified position.
`void`	`animateScroll(int scrollLeft, int scrollTop, AnimationCallback callback)` Animate a scroll from the current scroll position to the specified position.
`void`	`animateScroll(int scrollLeft, int scrollTop, AnimationCallback callback, int duration)` Animate a scroll from the current scroll position to the specified position.
`void`	`animateShow()` Show a canvas by growing it with default effect specified by `animateShowEffect`.
`void`	`animateShow(AnimateShowEffect effect)` Show a canvas by growing it vertically to its fully drawn height over a period of time.
`void`	`animateShow(AnimateShowEffect effect, AnimationCallback callback)` Show a canvas by growing it vertically to its fully drawn height over a period of time.
`void`	`animateShow(AnimateShowEffect effect, AnimationCallback callback, int duration)` Show a canvas by growing it vertically to its fully drawn height over a period of time.
`void`	`animateShow(AnimationEffect effect)` Show a canvas by growing it vertically to its fully drawn height over a period of time.
`void`	`animateShow(AnimationEffect effect, AnimationCallback callback)` Show a canvas by growing it vertically to its fully drawn height over a period of time.
`void`	`animateShow(AnimationEffect effect, AnimationCallback callback, int duration)` Show a canvas by growing it vertically to its fully drawn height over a period of time.
`static <T extends Canvas> T`	`asSGWTComponent(com.google.gwt.core.client.JavaScriptObject jsObj)` Returns the existing SGWT widget, or creates and returns one if none exist, associated with the supplied `JavaScriptObject`.
`void`	`blur()` If this canvas has keyboard focus, blur it.
`void`	`bringToFront()` Puts this widget at the top of the stacking order, so it appears in front of all other widgets in the same parent.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)` Changes the defaults for Canvas AutoChildren named `autoChildName`.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)` Changes the defaults for FormItem AutoChildren named `autoChildName`.
`void`	`clear()` 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.
`void`	`clearExplicitTabIndex()` If an explicit `tabIndex` was assigned to this widget, clear it.
`java.lang.Boolean`	`clickMaskUp()` Determines whether a clickmask is showing
`java.lang.Boolean`	`clickMaskUp(java.lang.String ID)` Determines whether a clickmask is showing
`java.lang.Boolean`	`contains(Canvas canvas)` Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment hierarchy); and false otherwise.
`java.lang.Boolean`	`contains(Canvas canvas, java.lang.Boolean testSelf)` Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment hierarchy); and false otherwise.
`java.lang.Boolean`	`containsEvent()` Return true if the last event's mouse coordinates are within the bounds of this component.
`java.lang.Boolean`	`containsFocus()` Returns true if the keyboard focus is in this Canvas or any child of this Canvas.
`java.lang.Boolean`	`containsPoint(int x, int y)` Return whether or not this object contains the specified global (x,y) coordinates.
`java.lang.Boolean`	`containsPoint(int x, int y, java.lang.Boolean withinViewport)` Return whether or not this object contains the specified global (x,y) coordinates.
`protected com.google.gwt.core.client.JavaScriptObject`	`create()`
`void`	`deparent()` Remove this canvas from its parent if it has one.
`void`	`depeer()` Make this Canvas no longer a peer of its master
`void`	`disable()` Disables this widget and any children and peers of this widget.
`void`	`enable()` Enables this widget and any children / peers of this widget.
`java.lang.Boolean`	`encloses(Canvas other)` Returns true if the rectangle of this widget encloses the rectangle of the specified widget.
`void`	`focus()` If this canvas can accept focus, give it keyboard focus.
`void`	`focusAfterGroup()` Shifts focus to the next focusable element after this one, skipping any elements nested inside the tabbing group for this canvas, such as focusable children.
`void`	`focusAtEnd(boolean start)` Shifts focus to the start or end of this canvas and its descendants.
`void`	`focusInNextTabElement()` Shifts focus to the next focusable element after this one.
`void`	`focusInPreviousTabElement()` Shifts focus to the previous focusable element before this one.
`int`	`getAbsoluteLeft()` This method is similar to `getPageLeft()`.
`int`	`getAbsoluteTop()` This method is similar to `getPageTop()`.
`java.lang.String`	`getAccessKey()` If specified this governs the HTML accessKey for the widget.
`java.lang.Integer`	`getAdaptiveHeightPriority()` See `adaptiveWidthPriority`.
`java.lang.Integer`	`getAdaptiveWidthPriority()` If multiple widgets in the same Layout have `adaptive width`, `adaptiveWidthPriority` can be set to indicate which of the components should be given priority access to space.
`java.lang.Boolean`	`getAlwaysShowScrollbars()` On `touch devices` that support native touch scrolling, if `showCustomScrollbars` is `true` and touch scrolling has not been disabled by the `useTouchScrolling` and/or `disableTouchScrollingForDrag` settings, should custom scrollbars and native touch scrolling be enabled for this component? If `false` or unset, then only native touch scrolling will be enabled.
`AnimationAcceleration`	`getAnimateAcceleration()` Default acceleration effect to apply to all animations on this Canvas.
`java.lang.Integer`	`getAnimateFadeTime()` Default time for performing an animated fade.
`AnimationAcceleration`	`getAnimateHideAcceleration()` Default acceleration function for performing an animated hide.
`AnimationEffect`	`getAnimateHideEffect()` Default animation effect to use if `animateHide()` is called without an explicit effect parameter.
`java.lang.Integer`	`getAnimateHideTime()` Default time for performing an animated hide.
`AnimationAcceleration`	`getAnimateMoveAcceleration()` Default acceleration effect for performing an animated move.
`java.lang.Integer`	`getAnimateMoveTime()` Default time for performing an animated move.
`AnimationAcceleration`	`getAnimateRectAcceleration()` Default acceleration function for performing an animated move and resize.
`java.lang.Integer`	`getAnimateRectTime()` Default time for performing an animated setRect.
`AnimationAcceleration`	`getAnimateResizeAcceleration()` Default acceleration function for performing an animated resize.
`AnimationLayoutMode`	`getAnimateResizeLayoutMode()` When to update the `child layout` for a `size animation`.
`java.lang.Integer`	`getAnimateResizeTime()` Default time for performing an animated resize.
`AnimationAcceleration`	`getAnimateScrollAcceleration()` Default acceleration function for performing an animated scroll.
`java.lang.Integer`	`getAnimateScrollTime()` Default time for performing an animated scroll.
`AnimationAcceleration`	`getAnimateShowAcceleration()` Default acceleration function for performing an animated show.
`AnimationEffect`	`getAnimateShowEffect()` Default animation effect to use if `animateShow()` is called without an explicit effect parameter.
`java.lang.Integer`	`getAnimateShowTime()` Default time for performing an animated show.
`int`	`getAnimateTime()` Default total duration of animations.
`java.lang.String`	`getAppImgDir()` Default directory for app-specific images, relative to the Page-wide `appImgDir`.
`java.lang.String`	`getAriaRole()` ARIA role of this component.
`java.lang.Boolean`	`getAutoMaskComponents()` Deprecated. As of Smart GWT version 10.0, deprecated in favor of `EditProxy.autoMaskChildren`
`java.lang.String`	`getAutoParent()` This initialization property allows developers to create a canvas using the Class.addAutoChild() method, and have it added as a child to some other component.
`java.lang.Boolean`	`getAutoShowParent()` If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
`java.lang.String`	`getBackgroundColor()` The background color for this widget.
`java.lang.String`	`getBackgroundImage()` URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
`java.lang.String`	`getBackgroundPosition()` Specifies how the background image should be positioned on the widget.
`BackgroundRepeat`	`getBackgroundRepeat()` Specifies how the background image should be tiled if this widget is larger than the image.
`java.lang.String`	`getBorder()` Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid blue").
`int`	`getBottom()` Return the bottom coordinate of this object as rendered, relative to its enclosing context, in pixels.
`static Canvas`	`getById(java.lang.String ID)` Retrieve a Canvas by its global `ID`.
`static Canvas`	`getByJSObject(com.google.gwt.core.client.JavaScriptObject jsObj)` Retrieve a Canvas from its `JavaScriptObject`.
`Canvas`	`getByLocalId(java.lang.String ID)` Retrieve a child of this Canvas by it's local ID.
`java.lang.Boolean`	`getCanAcceptDrop()` Indicates that this object can receive dropped widgets (i.e.
`java.lang.Boolean`	`getCanAdaptHeight()` See `canAdaptWidth`.
`java.lang.Boolean`	`getCanAdaptWidth()` Indicates that this component is able to render itself at multiple possible sizes, in order to fit into less space when very little space is available, or to display more information or provide more immediate access to functionality when more space is available.
`java.lang.Boolean`	`getCanDrag()` Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize).
`java.lang.Boolean`	`getCanDragReposition()` Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
`java.lang.Boolean`	`getCanDragResize()` Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
`boolean`	`getCanDragScroll()` 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() if there are scrollbars.
`java.lang.Boolean`	`getCanDrop()` Indicates that this object can be dropped on top of other widgets.
`java.lang.Boolean`	`getCanDropBefore()` When explicitly set to false, disallows drop before this member in the Layout.
`java.lang.Boolean`	`getCanFocus()` Can this widget be allowed to become the target of keyboard events?
`java.lang.Boolean`	`getCanHover()` Will this Canvas fire hover events when the user hovers over it, or one of its children?
`java.lang.Boolean`	`getCanSelectText()` Whether native drag selection of contained text is allowed within this Canvas.
`Canvas`	`getCanvasAutoChild(java.lang.String autoChildName)` Returns the `Canvas` AutoChild named `autoChildName` if already created.
`CanvasItem`	`getCanvasItem()` If this canvas is being displayed in a `CanvasItem`, this property will be set to point at the item.
`Canvas[]`	`getChildren()` Array of all Canvii that are immediate children of this Canvas.
`java.lang.Boolean`	`getChildrenResizeSnapAlign()` Flag to disable snapping to alignment when children of this Canvas are resized
`java.lang.Boolean`	`getChildrenSnapAlign()` If enabled while `childrenSnapToGrid` is enabled, children dragged within this Canvas will also snap to positions where their edges or center lines would be aligned with the edges or centers of other components, and lines will be shown to point out the possible alignment (with appearance controlled by `snapAlignCenterLineStyle` and `snapAlignEdgeLineStyle` respectively.
`java.lang.Boolean`	`getChildrenSnapCenterAlign()` See `childrenSnapAlign`.
`java.lang.Boolean`	`getChildrenSnapEdgeAlign()` See `childrenSnapAlign`.
`java.lang.Boolean`	`getChildrenSnapResizeToGrid()` If true, causes this canvas's children to snap to its grid when resizing.
`java.lang.Boolean`	`getChildrenSnapToGrid()` If true, causes this canvas's children to snap to its grid when dragging.
`java.lang.Integer`	`getChildTabPosition(Canvas child)` For a given child widget where `updateTabPositionOnReparent` is true, return the expected tab position within this parent.
`java.lang.String`	`getClassName()` Returns the JavaScript class name.
`Canvas`	`getComponentMask()` Automatically generated mask canvas displayed when `showComponentMask()` is called.
`Canvas`	`getComponentMaskDefaults()` Defaults for the `componentMask` autoChild.
`com.google.gwt.user.client.Element`	`getContentElement()` Returns the DOM element for this Canvas which contains the `contents`, or for `parent components`, the DOM elements for any drawn children.
`java.lang.String`	`getContents()` The contents of a canvas or label widget.
`Menu`	`getContextMenu()` Context menu to show for this object, an instance of the Menu widget.
`java.lang.Boolean`	`getCorrectZoomOverflow()` Whether the Framework should correct for erroneous scrollHeight and scrollWidth values reported by the browser when zoomed (via browser or OS-level zoom) by allowing `maxZoomOverflowError` of overflow before enabling scrolling and displaying custom scrollbars.
`Cursor`	`getCursor()` Specifies the cursor image to display when the mouse pointer is over this widget.
`java.lang.String`	`getDataPath()` A dataPath may be specified on any canvas.
`int`	`getDefaultHeight()` For custom components, establishes a default height for the component.
`int`	`getDefaultWidth()` For custom components, establishes a default width for the component.
`java.lang.Boolean`	`getDestroyed()` If this property is set to `true`, the `destroy()` method has been called on this canvas.
`java.lang.Boolean`	`getDestroying()` This property is set to true when the `destroy()` method is called on a widget.
`boolean`	`getDisabled()` If set to true, the widget will be disabled.
`Cursor`	`getDisabledCursor()` Specifies the cursor image to display when the mouse pointer is over this widget if this widget is disabled.
`java.lang.Boolean`	`getDisableTouchScrollingForDrag()` Disables `useTouchScrolling` whenever a built-in drag operation has been enabled which is known to be non-functional if touch scrolling is enabled.
`int`	`getDoubleClickDelay()` Amount of time (in milliseconds) between which two clicks are considered a single click
`DragAppearance`	`getDragAppearance()` Visual appearance to show when the object is being dragged.
`DragIntersectStyle`	`getDragIntersectStyle()` This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection with the rectangle of the dragMoveTarget.
`DragMaskType`	`getDragMaskType()` This property controls what kind of mask is used in case `useDragMask` is enabled.
`int`	`getDragMaxHeight()` Sets maximum height that this Canvas can be resized to by a user.
`int`	`getDragMaxWidth()` Maximum width that this Canvas can be resized to by a user.
`int`	`getDragMinHeight()` Minimum height that this Canvas can be resized to by a user.
`int`	`getDragMinWidth()` Minimum width that this Canvas can be resized to by a user.
`java.lang.Integer`	`getDragOpacity()` If this widget has dragAppearance `"target"`, this value specifies the opacity to render the target while it is being dragged.
`DragAppearance`	`getDragRepositionAppearance()` If `canDragReposition` is true, this attributes specifies the visual appearance to show during drag reposition.
`Cursor`	`getDragRepositionCursor()` Cursor to switch to if the mouse is over a widget that is drag repositionable.
`DragAppearance`	`getDragResizeAppearance()` If `canDragResize` is true, this attributes specifies the visual appearance to show during drag resize.
`int`	`getDragScrollDelay()` If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the drag-scroll threshold before scrolling begins.
`int`	`getDragStartDistance()` Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
`Canvas`	`getDragTarget()` A different widget that should be actually dragged when dragging initiates on this widget.
`java.lang.String`	`getDragType()` Sets a `dragType` for this widget used, to be compared to `dropTypes` on possible drop target widgets.
`java.lang.String[]`	`getDropTypes()` When a drag and drop interaction occurs, if a `dragType` is configured on the source widget, it is compared to the `dropTypes` configured on the target widget, and a drop is only allowed if the `dragType` is listed in the target widget's `dropTypes` array.
`java.lang.String`	`getDropTypesAsString()` When a drag and drop interaction occurs, if a `dragType` is configured on the source widget, it is compared to the `dropTypes` configured on the target widget, and a drop is only allowed if the `dragType` is listed in the target widget's `dropTypes` array.
`java.lang.Boolean`	`getDynamicContents()` Dynamic contents allows the contents string to be treated as a simple, but powerful template.
`java.lang.String`	`getEdgeBackgroundColor()` Background color for the EdgedCanvas created to decorate this component.
`java.lang.String`	`getEdgeCenterBackgroundColor()` Background color for the center section only.
`java.lang.String`	`getEdgeImage()` Base name of images for edges.
`int`	`getEdgeMarginSize()` How far into the edge of an object do we consider the "edge" for drag resize purposes?
`java.lang.Integer`	`getEdgeOffset()` Amount the contained Canvas should be offset.
`java.lang.Integer`	`getEdgeOpacity()` Opacity of the edges.
`java.lang.Boolean`	`getEdgeShowCenter()` Whether to show media in the center section, that is, behind the decorated Canvas.
`int`	`getEdgeSize()` Size in pixels for corners and edges
`EditNode`	`getEditNode()` The component's `EditNode` for a component that has been created by a `Palette` from a `PaletteNode`.
`EditProxy`	`getEditProxy()` An `EditProxy` controls the behaviors of a component when it is placed into `editing mode`.
`java.lang.String`	`getEditProxyConstructor()` Default class used to construct the `EditProxy` for this component when the component is `first placed into edit mode`.
`com.google.gwt.user.client.Element`	`getElement()` Normal usage of SmartGWT is to call draw() on SmartGWT widgets, not to use use RootPanel.add().
`com.google.gwt.user.client.Element`	`getElement(boolean allowPreRender)`
`AdvancedCriteria`	`getEnableWhen()` Criteria to be evaluated to determine whether this Canvas should be enabled.
`java.lang.Boolean`	`getEndLine()` Whether this canvas should end the line it's in when used as a tile in a `FlowLayout`.
`static EdgeName`	`getEventEdge()` Check if an event is within an "edge" of this canvas.
`static EdgeName`	`getEventEdge(EdgeName... edgeMask)` Check if an event is within an "edge" of this canvas.
`int`	`getExtraSpace()` When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a Layout.
`java.lang.String`	`getFacetId()` If a Canvas is dropped onto a `CubeGrid`, and it has a `facetId` property specified then the Cube treats this as adding that facetId at the drop location.
`FormItem`	`getFormItemAutoChild(java.lang.String autoChildName)` Returns the `FormItem` AutoChild named `autoChildName` if already created.
`java.lang.String`	`getFullDataPath()` Returns a fully qualified `DataPath` for this canvas.
`java.lang.String`	`getGroupBorderCSS()` Sets the style for the grouping frame around the canvas.
`java.lang.String`	`getGroupLabelBackgroundColor()` If set, the background color of the grouping label.
`java.lang.String`	`getGroupLabelStyleName()` Sets the style for the grouping label.
`java.lang.String`	`getGroupTitle()` The title/label for the grouping.
`java.lang.Integer`	`getHeight()` Size for this component's vertical dimension.
`java.lang.String`	`getHeightAsString()`
`boolean`	`getHideUsingDisplayNone()` When this widget is hidden (see `visibility` and `hide()`), should display:none be applied to the `outer element`?
`Alignment`	`getHoverAlign()` If `this.showHover` is true, this property can be used to customize the alignment of content in the hover canvas.
`java.lang.Boolean`	`getHoverAutoDestroy()` If `this.showHover` is true and `getHoverComponent()` is implemented, should the hoverCanvas returned from it be automatically destroyed when it is hidden?
`int`	`getHoverAutoFitMaxWidth()` Maximum auto-fit width for a hover if `hoverAutoFitWidth` is enabled.
`java.lang.String`	`getHoverAutoFitMaxWidthAsString()` Maximum auto-fit width for a hover if `hoverAutoFitWidth` is enabled.
`java.lang.Boolean`	`getHoverAutoFitWidth()` if `showHover` is true, this property will cause the specified `hoverWidth` to be treated as a minimum width for the hover.
`Canvas`	`getHoverComponent()` When `showHoverComponents` is true, this method is called to get the component to show as a hover for this Canvas.
`int`	`getHoverDelay()` If `this.canHover` is true, how long should the mouse be kept over this widget before the hover event is fired
`java.lang.Integer`	`getHoverHeight()` If `this.showHover` is true, this property can be used to customize the height of the hover canvas shown.
`java.lang.String`	`getHoverHTML()` If `this.showHover` 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.
`java.lang.Boolean`	`getHoverMoveWithMouse()` If `this.showHover` is true, should this widget's hover canvas be moved with the mouse while visible?
`java.lang.Integer`	`getHoverOpacity()` If `this.showHover` is true, should the hover canvas be shown with opacity other than 100?
`java.lang.String`	`getHoverStyle()` If `this.showHover` is true, this property can be used to specify the css style to apply to the hover canvas.
`VerticalAlignment`	`getHoverVAlign()` If `this.showHover` is true, this property can be used to customize the vertical alignment of content in the hover canvas.
`int`	`getHoverWidth()` If `this.showHover` is true, this property can be used to customize the width of the hover canvas shown.
`java.lang.Boolean`	`getHoverWrap()` If `this.showHover` is true, this property can be used to customize the whether content in the hover canvas is displayed in a single line, or wraps.
`int`	`getHSnapOrigin()` Get an offset to be used when calculating snap positioning.
`int`	`getHSnapOrigin(Canvas snapChild)` Get an offset to be used when calculating snap positioning.
`int`	`getHSnapPosition(int coordinate)` Override this method to provide a custom snap-to grid.
`int`	`getHSnapPosition(int coordinate, java.lang.String direction)` Override this method to provide a custom snap-to grid.
`com.google.gwt.user.client.Element`	`getHtmlElement()` If specified as a pointer to an HTML element present in the DOM, this canvas will be rendered inside that element on `draw()`.
`DrawPosition`	`getHtmlPosition()` If `htmlElement` is specified, this attribute specifies the position where the canvas should be inserted relative to the `htmlElement` in the DOM.
`com.google.gwt.user.client.Element`	`getImage(java.lang.String identifier)` Retrieve a native image or SVG object element by name.
`static java.lang.String`	`getImgURL(java.lang.String URL)` Return the full URL for an image to be drawn in this canvas.
`static java.lang.String`	`getImgURL(java.lang.String URL, java.lang.String imgDir)` Return the full URL for an image to be drawn in this canvas.
`int`	`getInnerContentHeight()` Returns the amount of space available for interior content (or relatively positioned child widget(s)) without introducing clipping, scrolling or overflow. This is the space within the viewport of the widget (not including padding, and excluding margins, borders or scrollbars) rendered at its specified size.
`int`	`getInnerContentWidth()` Returns the amount of space available for interior content (or relatively positioned child widget(s)) without introducing clipping, scrolling or overflow. This is the space within the viewport of the widget (not including padding, and excluding margins, borders or scrollbars) rendered at its specified size.
`int`	`getInnerHeight()` Returns the amount of space available for (an) absolutely positioned child widget(s) or absolutely positioned HTML content, without introducing clipping, scrolling or overflow.
`int`	`getInnerWidth()` Returns the amount of space available for absolutely positioned child widget(s) or absolutely positioned HTML content, without introducing clipping, scrolling or overflow.
`boolean`	`getIsGroup()` Should a grouping frame be shown around this canvas.
`java.lang.Boolean`	`getIsPrinting()` This boolean flag will be set to true by framework logic while generating print HTML for this widget as a result to a call to `showPrintPreview()` (or just `getPrintHTML()`).
`java.lang.Boolean`	`getIsRuleScope()` Marks this Canvas as the `ruleScope` that will be discovered by any contained `DataBoundComponent`s which do not specify an explicit `ruleScope`.
`java.lang.Boolean`	`getIsSnapAlignCandidate()` Flag to disable snapping to alignment against this Canvas when other Canvases dragged into the same parent when `childrenSnapAlign` is enabled on this Canvas' parent.
`java.lang.Boolean`	`getKeepInParentRect()` Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array).
`Alignment`	`getLayoutAlign()` When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout.
`java.lang.Integer`	`getLeavePageSpace()` If set, overrides the global `defaultPageSpace`.
`int`	`getLeft()` 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 `position` property).
`java.lang.String`	`getLeftAsString()` 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 `position` property).
`java.lang.String`	`getLocalId()` Retrieve the local ID of this canvas.
`LocatorStrategy`	`getLocateChildrenBy()` Strategy to use when locating children in this canvas from an autoTest locator string.
`LocatorTypeStrategy`	`getLocateChildrenType()` `LocatorTypeStrategy` to use when finding children within this canvas.
`LocatorStrategy`	`getLocatePeersBy()` Strategy to use when locating peers of this canvas from an autoTest locator string.
`LocatorTypeStrategy`	`getLocatePeersType()` `LocatorTypeStrategy` to use when finding peers of this canvas.
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`getLogicalStructure()` Getter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
`java.lang.Integer`	`getMargin()` Set the CSS Margin, in pixels, for this component.
`Canvas`	`getMasterCanvas()` Returns this canvas's "master" (the canvas to which it was added as a peer), if any.
`Canvas`	`getMasterElement()` Deprecated. In favor or `getMasterCanvas()` as of Smart GWT release 9.1
`java.lang.Boolean`	`getMatchElement()` If `htmlElement` is specified, should this canvas initially be drawn at the same dimensions as the htmlElement? Note: setting this property will not force the canvas to resize if the element subsequently resizes (for example due to page reflow).
`int`	`getMaxHeight()` Maximum height available to this Canvas.
`int`	`getMaxWidth()` Maximum width available to this Canvas.
`int`	`getMaxZoomOverflowError()` When `correctZoomOverflow` is true and browser or OS-level zoom is active, determines how much overflow must occur before the Framework enables scrolling for this canvas.
`java.lang.String`	`getMenuConstructor()` Default class used to construct menus created by this component, including context menus.
`int`	`getMinHeight()` Minimum height available to this Canvas.
`int`	`getMinNonEdgeSize()` If the widget has drag resize configured on one or more of it's edges, and the edgeMarginSize is large enough that the remaining space is less than `minNonEdgeSize`, the edgeMarginSize will be reduced such that the non-edge part of the widget is at least 1/3 of the total space (with two draggable edges) or half of it (with one draggable edge).
`int`	`getMinWidth()` Minimum width available to this Canvas.
`double`	`getMomentumScrollMinSpeed()` The minimum speed in pixels per second that must be reached for momentum scrolling to kick in.
`int`	`getMouseStillDownDelay()` Amount of time (in milliseconds) between repeated 'mouseStillDown' events for this canvas.
`int`	`getMouseStillDownInitialDelay()` Amount of time (in milliseconds) before mouseStillDown events start to be fired repeatedly for this canvas.
`java.lang.String`	`getName()` Optional name for the canvas, which can later be used to reference it.
`int`	`getNextZIndex()` get the next zIndex for the next item to be drawn.
`java.lang.Boolean`	`getNoDoubleClicks()` If true, this canvas will receive all mouse-clicks as single `click` events rather than as `doubleClick` events.
`Cursor`	`getNoDropCursor()` Specifies the cursor image to display when the user drags a droppable canvas over this if it is not a valid drop target for the event and `showNoDropIndicator` is true.
`int`	`getOffsetHeight()`
`int`	`getOffsetWidth()`
`int`	`getOffsetX()` Return the X-coordinate of the last event relative to the left edge of the content of this Canvas. NOTE: To get a coordinate relative to the viewport of this Canvas, subtract this.getScrollLeft()
`int`	`getOffsetY()` Return the Y-coordinate of the last event, relative to the top edge of the content of this Canvas. NOTE: To get a coordinate relative to the viewport of this Canvas, subtract this.getScrollTop()
`java.lang.Integer`	`getOpacity()` Renders the widget to be partly transparent.
`static Canvas`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`com.google.gwt.user.client.Element`	`getOuterElement()` Returns the outer DOM element of this Canvas.
`Overflow`	`getOverflow()` 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.
`java.lang.Integer`	`getPadding()` Set the CSS padding of this component, in pixels.
`int`	`getPageBottom()` Return the page-relative bottom coordinate of this object, in pixels.
`int`	`getPageLeft()` Returns the page-relative left coordinate of the widget on the page, in pixels.
`Rectangle`	`getPageRect()`
`int`	`getPageRight()` Return the page-relative right coordinate of this object, in pixels.
`int`	`getPageTop()` Returns the page-relative top coordinate of the widget on the page, in pixels
`java.util.Map`	`getPaletteDefaults()` This method returns a Map of config properties suitable for use as the "defaults" attribute of a `PaletteNode`.
`Canvas`	`getPanelContainer()` Returns this Canvas's "panel container".
`Canvas`	`getParentCanvas()` This Canvas's immediate parent, if any.
`Canvas`	`getParentElement()` Deprecated. As of Smartclient version 9.1, deprecated in favor of `parentCanvas` and `getParentCanvas()`
`Canvas[]`	`getPeers()` Array of all Canvii that are peers of this Canvas.
`PercentBoxModel`	`getPercentBox()` Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a specified `snapTo`.
`Canvas`	`getPercentSource()` If this canvas has its size specified as a percentage, this property allows the user to explicitly designate another canvas upon which sizing will be based.
`Positioning`	`getPosition()` Absolute or relative, corresponding to the "absolute" (with respect to parent) or "relative" (with respect to document flow) values for the CSS position attribute.
`java.lang.String`	`getPrefix()`
`java.lang.Boolean`	`getPrintChildrenAbsolutelyPositioned()` Should this canvas print its children absolutely positioned when generating `printable HTML`.
`static void`	`getPrintHTML(java.lang.Object[] components, PrintProperties printProperties, PrintHTMLCallback callback)` Returns print-formatted HTML for the specified list of components.
`java.lang.String`	`getPrintHTML(PrintProperties printProperties, PrintHTMLCallback callback)` Retrieves printable HTML for this component and all printable subcomponents.
`java.lang.String`	`getPrompt()` Prompt displayed in hover canvas if `showHover` is true.
`java.lang.String[]`	`getProportionalResizeModifiers()` If `proportionalResizing` is set to `ProportionalResizeMode.MODIFIER` or `ProportionalResizeMode.MODIFIER_OFF` then proportional resizing of the DrawItem is activated or deactivated, respectively, whenever at least one key in this set of modifier keys is pressed.
`ProportionalResizeMode`	`getProportionalResizing()` If `canDragResize` is true, this property specifies the conditions for when proportional resizing is used.
`boolean`	`getReceiveScrollbarEvents()` Whether this canvas should receive `events` from its scrollbars, which are `peers`.
`Rectangle`	`getRect()` Get all four coordinates, relative to the enclosing context, at one.
`java.lang.Boolean`	`getRedrawOnResize()` Should this element be redrawn in response to a resize?
`java.lang.String`	`getResizeBarTarget()` When this Canvas is included as a member in a Layout, and `showResizeBar` is set to `true` so that a resizeBar is created, `resizeBarTarget:"next"` can be set to indicate that the resizeBar should resize the next member of the layout rather than this one.
`EdgeName[]`	`getResizeFrom()` When drag resizing is enabled via `canDragResize`, restricts resizes to only certain edges or corners.
`int`	`getRight()` Return the right coordinate of this object as rendered, relative to its enclosing context, in pixels.
`java.util.Map`	`getRuleContext()` Get the current value of the rule context collected by the `ruleScope` of this component (which may be this component itself or whatever component is managing the `ruleScope` for this component).
`java.util.Map`	`getRuleContext(boolean databoundOnly)` Get the current value of the rule context collected by the `ruleScope` of this component (which may be this component itself or whatever component is managing the `ruleScope` for this component).
`java.lang.String`	`getRuleScope()` `ID` of the component that gathers the context for evaluation of criteria-based rules specified by properties such as `FormItem.visibleWhen`.
`int`	`getScrollbarSize()` How thick should we make the scrollbars for this canvas.
`int`	`getScrollBottom()` Returns the scrollTop required to scroll vertically to the end of this widget's content.
`int`	`getScrollHeight()` Returns the scrollable height of the widget's contents, including children, ignoring clipping.
`int`	`getScrollLeft()` Get the number of pixels this Canvas is scrolled from its left edge.
`int`	`getScrollRight()` Returns the scrollLeft required to scroll horizontally to the end of this widget's content.
`int`	`getScrollTop()` Get the number of pixels this Canvas is scrolled from its top edge.
`int`	`getScrollWidth()` Returns the scrollable width of the widget's contents, including children, ignoring clipping.
`java.lang.String`	`getShadowColor()` Color for the css-based drop shadow shown if `useCSSShadow` is true and `showShadow` is true.
`int`	`getShadowDepth()` Depth of the shadow, or the virtual height above the page of the widget throwing the shadow.
`java.lang.Integer`	`getShadowHOffset()` Horizontal offset for the `shadow`.
`java.lang.String`	`getShadowImage()` If `useCSSShadow` is false, (or for browsers that do not support css3), this property supplies the base name of the series of images for the sides, corners, and center of the shadow.
`java.lang.Integer`	`getShadowOffset()` Offset of the shadow.
`java.lang.Integer`	`getShadowSoftness()` Softness, or degree of blurring, of the shadow.
`java.lang.Integer`	`getShadowSpread()` Explicit spread for the css-based drop shadow shown if `useCSSShadow` is true and `showShadow` is true.
`java.lang.Integer`	`getShadowVOffset()` Vertical offset for the `shadow`.
`java.lang.Boolean`	`getShouldPrint()` Whether this canvas should be included in a printable view.
`boolean`	`getShowCustomScrollbars()` Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
`java.lang.Boolean`	`getShowDragShadow()` When this widget is dragged, if its dragAppearance is `"target"`, should we show a shadow behind the canvas during the drag.
`java.lang.Boolean`	`getShowEdges()` Whether an `EdgedCanvas` should be used to show image-based edges around this component.
`java.lang.Boolean`	`getShowHover()` If `this.canHover` is true, should we show the global hover canvas by default when the user hovers over this canvas?
`java.lang.Boolean`	`getShowHoverComponents()` When set to true, shows a widget hovering at the mouse point instead of the builtin hover label.
`java.lang.Boolean`	`getShowResizeBar()` When this Canvas is included as a member in a `Layout`, whether a resizeBar should be shown after this member in the layout, to allow it to be resized.
`java.lang.Boolean`	`getShowShadow()` Whether to show a drop shadow for this Canvas.
`java.lang.Boolean`	`getShowSnapGrid()` Whether to show a snap grid for this Canvas.
`boolean`	`getShrinkElementOnHide()` This is an advanced setting.
`java.lang.Boolean`	`getSizeMayChangeOnRedraw()` Is it possible that a call to `redraw()` on this widget will change its size?
`java.lang.String`	`getSkinImgDir()` Default directory for skin images (those defined by the class), relative to the Page-wide `skinDir`.
`Canvas[]`	`getSnapAlignCandidates()` When `childrenSnapAlign` is enabled, list of candidates to check for alignment.
`java.lang.String`	`getSnapAlignCenterLineStyle()` CSS border declaration used for the line shown to indicate snapping to a center line when `childrenSnapAlign` is set.
`java.lang.String`	`getSnapAlignEdgeLineStyle()` CSS border declaration used for the line shown to indicate snapping to a edge line when `childrenSnapAlign` is set.
`java.lang.String`	`getSnapAxis()` Describes which axes to apply snap-to-grid to.
`java.lang.String`	`getSnapEdge()` If `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.
`java.lang.String`	`getSnapHDirection()` The horizontal snap direction.
`int`	`getSnapHGap()` The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
`java.lang.Integer`	`getSnapOffsetLeft()` If `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.
`java.lang.Integer`	`getSnapOffsetTop()` If `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.
`java.lang.Boolean`	`getSnapOnDrop()` 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).
`static Point`	`getSnapPosition(Canvas target, java.lang.String snapTo, Canvas snapper)` Return the position for `snapper` to be placed in order to "snap to" an edge or corner of `target`, in the same sense as `snapTo`.
`static Point`	`getSnapPosition(Canvas target, java.lang.String snapTo, Canvas snapper, java.lang.String snapEdge)` Return the position for `snapper` to be placed in order to "snap to" an edge or corner of `target`, in the same sense as `snapTo`.
`java.lang.Boolean`	`getSnapResizeToAlign()` Flag to disable snapping to alignment when this Canvas is resized.
`java.lang.Boolean`	`getSnapResizeToGrid()` Causes this canvas to snap to its parent's grid when resizing.
`java.lang.String`	`getSnapTo()` Position this widget such that it is aligned with ("snapped to") an edge of its `master` (if specified), or its `parent canvas`.
`java.lang.Boolean`	`getSnapToAlign()` Flag to disable snapping to alignment when this Canvas is dragged when `childrenSnapAlign` is enabled on this Canvas' parent.
`java.lang.Boolean`	`getSnapToCenterAlign()` Flag to disable snapping to center alignment when this Canvas is dragged when `childrenSnapAlign` is enabled on this Canvas' parent.
`java.lang.Boolean`	`getSnapToEdgeAlign()` Flag to disable snapping to edge alignment when this Canvas is dragged when `childrenSnapAlign` is enabled on this Canvas' parent.
`java.lang.Boolean`	`getSnapToGrid()` Causes this canvas to snap to its parent's grid when dragging.
`java.lang.String`	`getSnapVDirection()` The vertical snap direction.
`int`	`getSnapVGap()` The vertical grid size to use, in pixels, when snap-to-grid is enabled.
`java.lang.Boolean`	`getStartLine()` Whether this canvas should always start a new line when used as a tile in a `FlowLayout`.
`java.lang.String`	`getStyleName()` The CSS class applied to this widget as a whole.
`java.lang.Integer`	`getTabIndex()` If specified this governs the tabIndex of the widget in the page's tab order.
`protected Canvas`	`getTestInstance()`
`java.lang.String`	`getTitle()` Synonym for `getPrompt()`
`java.lang.String`	`getTooltip()` Synonym for `getPrompt()`
`int`	`getTop()` 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 `position` property).
`java.lang.String`	`getTopAsString()` 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 `position` property).
`Canvas`	`getTopElement()` The top-most Canvas (i.e., not a child of any other Canvas), if any, in this widget's containment hierarchy.
`boolean`	`getUpdateTabPositionOnDraw()` Should canvases with no `parent canvas` be moved to the end of the TabIndexManager tree on draw()?
`boolean`	`getUpdateTabPositionOnReparent()` Should canvases with a `parent canvas` be added to the TabIndexManager under the parent as described in `updateChildTabPositions()` and `updateChildTabPosition()`?
`java.lang.Boolean`	`getUseBackMask()` In earlier versions of Internet Explorer (pre IE9), a native limitation exists whereby if HTML elements are overlapping on the page, certain elements can appear to "burn through" elements in the same position with a higher z-index.
`boolean`	`getUseCSSShadow()` If `showShadow` is true, should we use the css `box-shadow` property (where supported) to achieve the shadow?
`boolean`	`getUseDragMask()` This flag controls whether we register the component as a maskable item with the EventHandler.
`boolean`	`getUseImageForSVG()` If set, forces the main SVG image or icon in the canvas to be rendered in an <image> tag rather than an <object> tag, the default.
`java.lang.Boolean`	`getUseNativeDrag()` If set, native HTML5 drag and drop will be used for all drags initiated on this widget (on browsers where this is supported).
`java.lang.Boolean`	`getUseOpacityFilter()` Configures where the Opacity filter is used for IE6-8.
`java.lang.Boolean`	`getUseTouchScrolling()` On `touch devices`, if this `Canvas` can be scrolled, should touch-dragging the content area result in scrolling? Set to `false` if touch-dragging should not cause scrolling.
`ValuesManager`	`getValuesManager()` `ValuesManager` for managing values displayed in this component.
`java.lang.String`	`getValuesManagerAsString()` `ValuesManager` for managing values displayed in this component.
`int`	`getViewportHeight()` Returns the height of the viewport onto the scrollable content.
`int`	`getViewportWidth()` Returns the width of the viewport onto the scrollable content.
`Visibility`	`getVisibility()` Controls widget visibility when the widget is initialized.
`int`	`getVisibleHeight()` Return the visible height of the Canvas.
`AdvancedCriteria`	`getVisibleWhen()` Criteria to be evaluated to determine whether this Canvas should be visible.
`int`	`getVisibleWidth()` Return the visible width of the Canvas.
`int`	`getVSnapOrigin()` Get an offset to be used when calculating snap positioning.
`int`	`getVSnapOrigin(Canvas snapChild)` Get an offset to be used when calculating snap positioning.
`int`	`getVSnapPosition(int coordinate)` Override this method to provide a custom snap-to grid.
`int`	`getVSnapPosition(int coordinate, java.lang.String direction)` Override this method to provide a custom snap-to grid.
`java.lang.Integer`	`getWidth()` Size for this component's horizontal dimension.
`java.lang.String`	`getWidthAsString()`
`int`	`getZIndex()` Get the z-Index of this canvas.
`int`	`getZIndex(boolean resolveToNumber)` Get the z-Index of this canvas.
`void`	`handleHover()` Handler fired on a delay when the user hovers the mouse over this hover-target.
`void`	`hide()` Sets the widget's CSS visibility attribute to "hidden".
`void`	`hideClickMask()` Hides the click mask associated with this canvas.
`void`	`hideClickMask(java.lang.String ID)` Hides the click mask associated with this canvas.
`void`	`hideComponentMask()` Hide the `component level clickMask` for this widget
`void`	`hideComponentMask(boolean suppressFocusReset)` Hide the `component level clickMask` for this widget
`void`	`hideContextMenu()` 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).
`static java.lang.String`	`imgHTML(java.lang.String src)` Generates the HTML for an image unique to this Canvas.
`static java.lang.String`	`imgHTML(java.lang.String src, int width, int height)`
`static java.lang.String`	`imgHTML(java.lang.String src, int width, int height, java.lang.String name, java.lang.String extraStuff, java.lang.String imgDir)` Generates the HTML for an image unique to this Canvas.
`java.lang.Boolean`	`intersects(Canvas other)` Returns true if the rectangles of this widget and the specified widget overlap.
`java.lang.Boolean`	`isDirty()` Returns whether a canvas is waiting to be redrawn.
`java.lang.Boolean`	`isDisabled()` 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.
`java.lang.Boolean`	`isFocused()` Returns true if this Canvas has the keyboard focus.
`boolean`	`isVisible()` 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.
`java.lang.Boolean`	`keyUp()` Executed when a key is released on a focusable widget (`canFocus`: true).
`void`	`layoutChildren(java.lang.String reason)` `layoutChildren()` is where a Canvas should implement a sizing policy for it's Canvas children.
`java.lang.String`	`linkHTML(java.lang.String href)` Generates the HTML for a standard link (anchor) element.
`java.lang.String`	`linkHTML(java.lang.String href, java.lang.String text)`
`java.lang.String`	`linkHTML(java.lang.String href, java.lang.String text, java.lang.String target)`
`java.lang.String`	`linkHTML(java.lang.String href, java.lang.String text, java.lang.String target, java.lang.String ID)`
`java.lang.String`	`linkHTML(java.lang.String href, java.lang.String text, java.lang.String target, java.lang.String ID, java.lang.Integer tabIndex)`
`java.lang.String`	`linkHTML(java.lang.String href, java.lang.String text, java.lang.String target, java.lang.String ID, java.lang.Integer tabIndex, java.lang.String accessKey)` Generates the HTML for a standard link (anchor) element.
`void`	`markForDestroy()` `destroy()` this canvas on a timeout.
`void`	`markForRedraw()` Marks the widget as "dirty" so that it will be added to a queue for redraw.
`void`	`markForRedraw(java.lang.String reason)` Marks the widget as "dirty" so that it will be added to a queue for redraw.
`void`	`moveAbove(Canvas canvas)` 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.
`void`	`moveBelow(Canvas canvas)` 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.
`java.lang.Boolean`	`moveBy(int deltaX, int deltaY)` Moves the widget deltaX pixels to the right and deltaY pixels down.
`boolean`	`moveTo(int left, int top)` Moves the widget so that its top-left corner is at the specified coordinates.
`protected void`	`onAttach()`
`protected void`	`onDetach()`
`protected void`	`onInit()`
`void`	`pageScrollDown()` This method is the programmatic equivalent of the user pressing the "Page Down" key while this widget has the focus.
`void`	`pageScrollUp()` This method is the programmatic equivalent of the user pressing the "Page Up" key while this widget has the focus.
`protected void`	`parentResized()` Fires when the interior size of the parent changes, including parent resize and scrollbar introduction or removal.
`void`	`placeNear()` Move this canvas to the specified point, or as close to the specified point as possible without this widget extending beyond the edge of the browser viewport on any side.
`void`	`placeNear(int left)`
`void`	`placeNear(int left, int top)` Move this canvas to the specified point, or as close to the specified point as possible without this widget extending beyond the edge of the browser viewport on any side.
`static void`	`printComponents(java.lang.Object[] components)` Generate printable HTML for the designated components and trigger the native print dialog, without ever showing the printable HTML to the user.
`void`	`provideRuleContext(java.lang.String dataPath, java.lang.Object data)` Provide data to the `com.smartgwt.client.widgets.Canvas#ruleScope` component, to be made available in the rule context at the specified `path`.
`void`	`provideRuleContext(java.lang.String dataPath, java.lang.Object data, DataBoundComponent dbc)` Provide data to the `com.smartgwt.client.widgets.Canvas#ruleScope` component, to be made available in the rule context at the specified `path`.
`void`	`redraw()` Redraws the widget immediately with its current property values.
`void`	`redraw(java.lang.String reason)` Redraws the widget immediately with its current property values.
`static void`	`registerFontScaledPaddingStyles(java.lang.String[] scaledStyles, java.lang.String[] baselineStyles, int targetSizeChange)` Registers one or more CSS classes to have their padding adjusted (independently on all edges) according to the `padding size change` applied to the page.
`void`	`removeChild(Canvas child)` Remove a child from this parent.
`void`	`removeChild(Canvas child, java.lang.String name)` Remove a child from this parent.
`void`	`removePeer(Canvas peer)` Remove a peer from this Canvas
`void`	`removePeer(Canvas peer, java.lang.String name)` Remove a peer from this Canvas
`void`	`removeSnapAlignCandidate(Canvas candidate)` Remove a candidate from `snapAlignCandidates`.
`static void`	`resizeAutoChildAttributes(java.lang.String policy, int delta)` Change the value of attributes registered via `registerAutoChildSizingAttributes()` by some number of pixels.
`java.lang.Boolean`	`resizeBy(int deltaX, int deltaY)` Resizes the widget, adding deltaX to its width and deltaY to its height (moves the right and/or bottom sides of the widget).
`static void`	`resizeControls(int delta)` Change the basic size of UI components in the current skin by "delta" pixels.
`static void`	`resizeFonts(int sizeChange)` Modify the size of fonts for some or all stylesheets defined in the page.
`static void`	`resizeFonts(int sizeChange, java.lang.String styleSheets)`
`static void`	`resizeFonts(int sizeChange, java.lang.String styleSheets, java.lang.Boolean resizeRelatedControls)` Modify the size of fonts for some or all stylesheets defined in the page.
`static void`	`resizeIcons(java.lang.String policy, int delta)` Change the basic size of icons in the current skin by "delta" pixels.
`static void`	`resizePadding(int fontSizeChange)` Modify the amount of padding for some CSS styles defined for the page.
`static void`	`resizePadding(int fontSizeChange, java.lang.String styleSheets)` Modify the amount of padding for some CSS styles defined for the page.
`java.lang.Boolean`	`resizeTo(int width, int height)` Resizes the widget to the specified width and height (moves the right and/ or bottom sides of the widget).
`java.lang.Boolean`	`resizeTo(java.lang.String width, java.lang.String height)` Resizes the widget to the specified width and height (moves the right and/ or bottom sides of the widget).
`void`	`revealChild(Canvas child)` Reveals the child Canvas passed in by showing it if it is currently hidden (note, this is stub functionality, certain Canvas subclasses such as `TabSet` have more useful implementations) NOTE: This is an override point.
`void`	`revealChild(java.lang.String childID)` Reveals the child Canvas passed in by showing it if it is currently hidden (note, this is stub functionality, certain Canvas subclasses such as `TabSet` have more useful implementations) NOTE: This is an override point.
`void`	`scrollBy(int dX, int dY)` Scroll this widget by some pixel increment in either (or both) direction(s).
`void`	`scrollByPercent(int dX, int dY)` Scroll this widget by some percentage of scroll size in either (or both) direction(s).
`void`	`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).
`void`	`scrollTo(java.lang.Integer left)`
`void`	`scrollTo(java.lang.Integer left, java.lang.Integer top)` 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).
`void`	`scrollToBottom()` Vertically scrolls the content of the widget to the end of its content
`void`	`scrollToLeft()` Horizontally scrolls the content of the widget to 0
`void`	`scrollToPercent(int left, int top)` Scroll this widget to some position specified as a percentage of scroll size in either (or both) direction(s).
`void`	`scrollToRight()` Horizontally scrolls the content of the widget to the end of its content
`void`	`scrollToTop()` Vertically scrolls the content of the widget to 0
`void`	`sendToBack()` Puts this widget at the bottom of the stacking order, so it appears behind all other widgets in the same parent.
`void`	`setAccessKey(java.lang.String accessKey)` If specified this governs the HTML accessKey for the widget.
`void`	`setAdaptHeightByCustomizer(AdaptHeightByCustomizer customizer)` Set customizer that defines `adaptHeightBy`.
`void`	`setAdaptiveHeightPriority(java.lang.Integer adaptiveHeightPriority)` See `adaptiveWidthPriority`.
`void`	`setAdaptiveWidthPriority(java.lang.Integer adaptiveWidthPriority)` If multiple widgets in the same Layout have `adaptive width`, `adaptiveWidthPriority` can be set to indicate which of the components should be given priority access to space.
`void`	`setAdaptWidthByCustomizer(AdaptWidthByCustomizer customizer)` Set customizer that defines `adaptWidthBy`.
`void`	`setAlign(Alignment align)`
`static void`	`setAllowExternalFilters(boolean allExternalFilters)` Changes the system-wide `allowExternalFilters` setting.
`void`	`setAlwaysShowScrollbars(java.lang.Boolean alwaysShowScrollbars)` On `touch devices` that support native touch scrolling, if `showCustomScrollbars` is `true` and touch scrolling has not been disabled by the `useTouchScrolling` and/or `disableTouchScrollingForDrag` settings, should custom scrollbars and native touch scrolling be enabled for this component? If `false` or unset, then only native touch scrolling will be enabled.
`void`	`setAnimateAcceleration(AnimationAcceleration animateAcceleration)` Default acceleration effect to apply to all animations on this Canvas.
`void`	`setAnimateFadeTime(java.lang.Integer animateFadeTime)` Default time for performing an animated fade.
`void`	`setAnimateHideAcceleration(AnimationAcceleration animateHideAcceleration)` Default acceleration function for performing an animated hide.
`void`	`setAnimateHideEffect(AnimationEffect animateHideEffect)` Default animation effect to use if `animateHide()` is called without an explicit effect parameter.
`void`	`setAnimateHideTime(java.lang.Integer animateHideTime)` Default time for performing an animated hide.
`void`	`setAnimateMoveAcceleration(AnimationAcceleration animateMoveAcceleration)` Default acceleration effect for performing an animated move.
`void`	`setAnimateMoveTime(java.lang.Integer animateMoveTime)` Default time for performing an animated move.
`void`	`setAnimateRectAcceleration(AnimationAcceleration animateRectAcceleration)` Default acceleration function for performing an animated move and resize.
`void`	`setAnimateRectTime(java.lang.Integer animateRectTime)` Default time for performing an animated setRect.
`void`	`setAnimateResizeAcceleration(AnimationAcceleration animateResizeAcceleration)` Default acceleration function for performing an animated resize.
`void`	`setAnimateResizeLayoutMode(AnimationLayoutMode animateResizeLayoutMode)` When to update the `child layout` for a `size animation`.
`void`	`setAnimateResizeTime(java.lang.Integer animateResizeTime)` Default time for performing an animated resize.
`void`	`setAnimateScrollAcceleration(AnimationAcceleration animateScrollAcceleration)` Default acceleration function for performing an animated scroll.
`void`	`setAnimateScrollTime(java.lang.Integer animateScrollTime)` Default time for performing an animated scroll.
`void`	`setAnimateShowAcceleration(AnimationAcceleration animateShowAcceleration)` Default acceleration function for performing an animated show.
`void`	`setAnimateShowEffect(AnimationEffect animateShowEffect)` Default animation effect to use if `animateShow()` is called without an explicit effect parameter.
`void`	`setAnimateShowTime(java.lang.Integer animateShowTime)` Default time for performing an animated show.
`void`	`setAnimateTime(int animateTime)` Default total duration of animations.
`void`	`setAppImgDir(java.lang.String appImgDir)` Default directory for app-specific images, relative to the Page-wide `appImgDir`.
`void`	`setAriaRole(java.lang.String ariaRole)` ARIA role of this component.
`void`	`setAriaState(java.lang.String stateName, java.lang.Object stateValue)` Set a specific ARIA state mapping for this component.
`void`	`setAutoChildConstructor(java.lang.String autoChildName, java.lang.String className)` Sets the SmartClient constructor for the AutoChild named `autoChildName`.
`void`	`setAutoChildProperties(java.lang.String autoChildName, Canvas properties)` Sets the properties for creating a `Canvas` AutoChild named `autoChildName`.
`void`	`setAutoChildProperties(java.lang.String autoChildName, EditContext properties)` Sets the properties for creating an AutoChild named `autoChildName`.
`void`	`setAutoChildProperties(java.lang.String autoChildName, EditProxy properties)` Sets the properties for creating an AutoChild named `autoChildName`.
`void`	`setAutoChildProperties(java.lang.String autoChildName, FormItem properties)` Sets the properties for creating a `FormItem` AutoChild named `autoChildName`.
`void`	`setAutoChildVisibility(java.lang.String autoChildName, boolean visible)` Sets whether to create and show the AutoChild named `autoChildName`.
`void`	`setAutoHeight()` Set the minimum value for height.
`void`	`setAutoMaskComponents(java.lang.Boolean autoMaskComponents)` Deprecated. As of Smart GWT version 10.0, deprecated in favor of `EditProxy.autoMaskChildren`
`void`	`setAutoParent(java.lang.String autoParent)` This initialization property allows developers to create a canvas using the Class.addAutoChild() method, and have it added as a child to some other component.
`static void`	`setAutoResizeAutoChildAttributes(boolean autoResize)` Should registered autoChild attributes be automatically resized with `controls` and `text`?
`static void`	`setAutoResizeIcons(boolean autoResizeIcons)` Should icons be automatically resized with `controls` and `text`?
`void`	`setAutoShowParent(java.lang.Boolean autoShowParent)` If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
`void`	`setAutoWidth()` Set the minimum value for width.
`void`	`setBackgroundColor(java.lang.String backgroundColor)` The background color for this widget.
`void`	`setBackgroundImage(java.lang.String backgroundImage)` URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
`void`	`setBackgroundPosition(java.lang.String backgroundPosition)` Specifies how the background image should be positioned on the widget.
`void`	`setBackgroundRepeat(BackgroundRepeat backgroundRepeat)` Specifies how the background image should be tiled if this widget is larger than the image.
`void`	`setBorder(java.lang.String border)` Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid blue").
`void`	`setBottom(int bottom)` Resizes the widget vertically to position its bottom edge at the specified coordinate.
`void`	`setCanAcceptDrop(java.lang.Boolean canAcceptDrop)` Indicates that this object can receive dropped widgets (i.e.
`void`	`setCanAdaptHeight(java.lang.Boolean canAdaptHeight)` See `canAdaptWidth`.
`void`	`setCanAdaptWidth(java.lang.Boolean canAdaptWidth)` Indicates that this component is able to render itself at multiple possible sizes, in order to fit into less space when very little space is available, or to display more information or provide more immediate access to functionality when more space is available.
`void`	`setCanDrag(java.lang.Boolean canDrag)` Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize).
`void`	`setCanDragReposition(java.lang.Boolean canDragReposition)` Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
`void`	`setCanDragResize(java.lang.Boolean canDragResize)` Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
`void`	`setCanDragScroll(boolean canDragScroll)` 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() if there are scrollbars.
`void`	`setCanDrop(java.lang.Boolean canDrop)` Indicates that this object can be dropped on top of other widgets.
`void`	`setCanDropBefore(java.lang.Boolean canDropBefore)` When explicitly set to false, disallows drop before this member in the Layout.
`void`	`setCanFocus(java.lang.Boolean canFocus)` Can this widget be allowed to become the target of keyboard events?
`void`	`setCanHover(java.lang.Boolean canHover)` Will this Canvas fire hover events when the user hovers over it, or one of its children?
`void`	`setCanSelectText(java.lang.Boolean canSelectText)` Whether native drag selection of contained text is allowed within this Canvas.
`void`	`setChildren(Canvas... children)` Array of all Canvii that are immediate children of this Canvas.
`void`	`setChildrenResizeSnapAlign(java.lang.Boolean childrenResizeSnapAlign)` Flag to disable snapping to alignment when children of this Canvas are resized
`void`	`setChildrenSnapAlign(java.lang.Boolean childrenSnapAlign)` If enabled while `childrenSnapToGrid` is enabled, children dragged within this Canvas will also snap to positions where their edges or center lines would be aligned with the edges or centers of other components, and lines will be shown to point out the possible alignment (with appearance controlled by `snapAlignCenterLineStyle` and `snapAlignEdgeLineStyle` respectively.
`void`	`setChildrenSnapCenterAlign(java.lang.Boolean childrenSnapCenterAlign)` See `childrenSnapAlign`.
`void`	`setChildrenSnapEdgeAlign(java.lang.Boolean childrenSnapEdgeAlign)` See `childrenSnapAlign`.
`void`	`setChildrenSnapResizeToGrid(java.lang.Boolean childrenSnapResizeToGrid)` If true, causes this canvas's children to snap to its grid when resizing.
`void`	`setChildrenSnapToGrid(java.lang.Boolean childrenSnapToGrid)` If true, causes this canvas's children to snap to its grid when dragging.
`void`	`setComponentMaskDefaults(Canvas componentMaskDefaults)` Defaults for the `componentMask` autoChild.
`void`	`setContents(java.lang.String contents)` The contents of a canvas or label widget.
`void`	`setContextMenu(Menu contextMenu)` Context menu to show for this object, an instance of the Menu widget.
`void`	`setCorrectZoomOverflow(java.lang.Boolean correctZoomOverflow)` Whether the Framework should correct for erroneous scrollHeight and scrollWidth values reported by the browser when zoomed (via browser or OS-level zoom) by allowing `maxZoomOverflowError` of overflow before enabling scrolling and displaying custom scrollbars.
`void`	`setCursor(Cursor cursor)` Specifies the cursor image to display when the mouse pointer is over this widget.
`void`	`setDataPath(java.lang.String dataPath)` A dataPath may be specified on any canvas.
`void`	`setDefaultHeight(int defaultHeight)` For custom components, establishes a default height for the component.
`static void`	`setDefaultPageSpace(int newDefaultPageSpace)` Changes the global `defaultPageSpace`.
`static void`	`setDefaultProperties(Canvas canvasProperties)` Class level method to set the default properties of this class.
`static void`	`setDefaultShowCustomScrollbars(boolean showCS)` Whether to use the browser's native scrollbars or SmartClient-based scrollbars by default for all canvases.
`void`	`setDefaultWidth(int defaultWidth)` For custom components, establishes a default width for the component.
`void`	`setDisabled(boolean disabled)` If set to true, the widget will be disabled.
`void`	`setDisabledCursor(Cursor disabledCursor)` Specifies the cursor image to display when the mouse pointer is over this widget if this widget is disabled.
`void`	`setDisableTouchScrollingForDrag(java.lang.Boolean disableTouchScrollingForDrag)` Disables `useTouchScrolling` whenever a built-in drag operation has been enabled which is known to be non-functional if touch scrolling is enabled.
`void`	`setDoubleClickDelay(int doubleClickDelay)` Amount of time (in milliseconds) between which two clicks are considered a single click
`void`	`setDragAppearance(DragAppearance dragAppearance)` Visual appearance to show when the object is being dragged.
`void`	`setDragIntersectStyle(DragIntersectStyle dragIntersectStyle)` This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection with the rectangle of the dragMoveTarget.
`void`	`setDragMaskType(DragMaskType dragMaskType)` This property controls what kind of mask is used in case `useDragMask` is enabled.
`void`	`setDragMaxHeight(int dragMaxHeight)` Sets maximum height that this Canvas can be resized to by a user.
`void`	`setDragMaxWidth(int dragMaxWidth)` Maximum width that this Canvas can be resized to by a user.
`void`	`setDragMinHeight(int dragMinHeight)` Minimum height that this Canvas can be resized to by a user.
`void`	`setDragMinWidth(int dragMinWidth)` Minimum width that this Canvas can be resized to by a user.
`void`	`setDragOpacity(java.lang.Integer dragOpacity)` If this widget has dragAppearance `"target"`, this value specifies the opacity to render the target while it is being dragged.
`void`	`setDragRepositionAppearance(DragAppearance dragRepositionAppearance)` If `canDragReposition` is true, this attributes specifies the visual appearance to show during drag reposition.
`void`	`setDragRepositionCursor(Cursor dragRepositionCursor)` Cursor to switch to if the mouse is over a widget that is drag repositionable.
`void`	`setDragResizeAppearance(DragAppearance dragResizeAppearance)` If `canDragResize` is true, this attributes specifies the visual appearance to show during drag resize.
`void`	`setDragScrollDelay(int dragScrollDelay)` If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the drag-scroll threshold before scrolling begins.
`void`	`setDragStartDistance(int dragStartDistance)` Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
`void`	`setDragTarget(Canvas dragTarget)` A different widget that should be actually dragged when dragging initiates on this widget.
`void`	`setDragType(java.lang.String dragType)` Sets a `dragType` for this widget used, to be compared to `dropTypes` on possible drop target widgets.
`void`	`setDropTypes(java.lang.String... dropTypes)` When a drag and drop interaction occurs, if a `dragType` is configured on the source widget, it is compared to the `dropTypes` configured on the target widget, and a drop is only allowed if the `dragType` is listed in the target widget's `dropTypes` array.
`void`	`setDropTypes(java.lang.String dropTypes)` When a drag and drop interaction occurs, if a `dragType` is configured on the source widget, it is compared to the `dropTypes` configured on the target widget, and a drop is only allowed if the `dragType` is listed in the target widget's `dropTypes` array.
`void`	`setDynamicContents(java.lang.Boolean dynamicContents)` Dynamic contents allows the contents string to be treated as a simple, but powerful template.
`void`	`setEdgeBackgroundColor(java.lang.String edgeBackgroundColor)` Background color for the EdgedCanvas created to decorate this component.
`void`	`setEdgeCenterBackgroundColor(java.lang.String edgeCenterBackgroundColor)` Background color for the center section only.
`void`	`setEdgeImage(java.lang.String edgeImage)` Base name of images for edges.
`void`	`setEdgeMarginSize(int edgeMarginSize)` How far into the edge of an object do we consider the "edge" for drag resize purposes?
`void`	`setEdgeOffset(java.lang.Integer edgeOffset)` Amount the contained Canvas should be offset.
`void`	`setEdgeOpacity(java.lang.Integer edgeOpacity)` Opacity of the edges.
`void`	`setEdgeShowCenter(java.lang.Boolean edgeShowCenter)` Whether to show media in the center section, that is, behind the decorated Canvas.
`void`	`setEdgeSize(int edgeSize)` Size in pixels for corners and edges
`void`	`setEditMode(boolean editingOn)` Enable or disable edit mode for this component.
`void`	`setEditMode(boolean editingOn, EditContext editContext)`
`void`	`setEditMode(boolean editingOn, EditContext editContext, EditNode editNode)` Enable or disable edit mode for this component.
`void`	`setEditProxyConstructor(java.lang.String editProxyConstructor)` Default class used to construct the `EditProxy` for this component when the component is `first placed into edit mode`.
`protected void`	`setElement(com.google.gwt.user.client.Element elem)` Normal usage of SmartGWT is to call draw() on SmartGWT widgets, not to use use RootPanel.add().
`void`	`setEnableWhen(AdvancedCriteria enableWhen)` Criteria to be evaluated to determine whether this Canvas should be enabled.
`void`	`setEndLine(java.lang.Boolean endLine)` Whether this canvas should end the line it's in when used as a tile in a `FlowLayout`.
`void`	`setExtraSpace(int extraSpace)` When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a Layout.
`void`	`setFacetId(java.lang.String facetId)` If a Canvas is dropped onto a `CubeGrid`, and it has a facetId property specified then the Cube treats this as adding that facetId at the drop location.
`void`	`setGroupBorderCSS(java.lang.String groupBorderCSS)` Sets the style for the grouping frame around the canvas.
`void`	`setGroupLabelBackgroundColor(java.lang.String groupLabelBackgroundColor)` If set, the background color of the grouping label.
`void`	`setGroupLabelStyleName(java.lang.String groupLabelStyleName)` Sets the style for the grouping label.
`void`	`setGroupTitle(java.lang.String groupTitle)` The title/label for the grouping.
`void`	`setHeight(int height)`
`void`	`setHeight(java.lang.Integer height)` Size for this component's vertical dimension.
`void`	`setHeight(java.lang.String height)` Size for this component's vertical dimension.
`void`	`setHeight100()` Convenience method that sets the height to 100%.
`void`	`setHideUsingDisplayNone(boolean hideUsingDisplayNone)` When this widget is hidden (see `visibility` and `hide()`), should display:none be applied to the `outer element`?
`void`	`setHoverAlign(Alignment hoverAlign)` If `this.showHover` is true, this property can be used to customize the alignment of content in the hover canvas.
`void`	`setHoverAutoDestroy(java.lang.Boolean hoverAutoDestroy)` If `this.showHover` is true and `getHoverComponent()` is implemented, should the hoverCanvas returned from it be automatically destroyed when it is hidden?
`void`	`setHoverAutoFitMaxWidth(int hoverAutoFitMaxWidth)` Maximum auto-fit width for a hover if `hoverAutoFitWidth` is enabled.
`void`	`setHoverAutoFitMaxWidth(java.lang.String hoverAutoFitMaxWidth)` Maximum auto-fit width for a hover if `hoverAutoFitWidth` is enabled.
`void`	`setHoverAutoFitWidth(java.lang.Boolean hoverAutoFitWidth)` if `showHover` is true, this property will cause the specified `hoverWidth` to be treated as a minimum width for the hover.
`void`	`setHoverDelay(int hoverDelay)` If `this.canHover` is true, how long should the mouse be kept over this widget before the hover event is fired
`void`	`setHoverHeight(java.lang.Integer hoverHeight)` If `this.showHover` is true, this property can be used to customize the height of the hover canvas shown.
`void`	`setHoverMoveWithMouse(java.lang.Boolean hoverMoveWithMouse)` If `this.showHover` is true, should this widget's hover canvas be moved with the mouse while visible?
`void`	`setHoverOpacity(java.lang.Integer hoverOpacity)` If `this.showHover` is true, should the hover canvas be shown with opacity other than 100?
`void`	`setHoverStyle(java.lang.String hoverStyle)` If `this.showHover` is true, this property can be used to specify the css style to apply to the hover canvas.
`void`	`setHoverVAlign(VerticalAlignment hoverVAlign)` If `this.showHover` is true, this property can be used to customize the vertical alignment of content in the hover canvas.
`void`	`setHoverWidth(int hoverWidth)` If `this.showHover` is true, this property can be used to customize the width of the hover canvas shown.
`void`	`setHoverWrap(java.lang.Boolean hoverWrap)` If `this.showHover` is true, this property can be used to customize the whether content in the hover canvas is displayed in a single line, or wraps.
`void`	`setHtmlElement(com.google.gwt.user.client.Element htmlElement)` If specified as a pointer to an HTML element present in the DOM, this canvas will be rendered inside that element on `draw()`.
`void`	`setHtmlPosition(DrawPosition htmlPosition)` If `htmlElement` is specified, this attribute specifies the position where the canvas should be inserted relative to the `htmlElement` in the DOM.
`void`	`setImage(java.lang.String identifier, java.lang.String URL)` Set the URL of an image or SVG object element by name.
`void`	`setImage(java.lang.String identifier, java.lang.String URL, java.lang.String imgDir)` Set the URL of an image or SVG object element by name.
`void`	`setInitHandler(CanvasInitHandler initHandler)` Specify a notification method to fire when this Canvas is initialized in JavaScript.
`void`	`setIsGroup(boolean isGroup)` Should a grouping frame be shown around this canvas.
`void`	`setIsRuleScope(java.lang.Boolean isRuleScope)` Marks this Canvas as the `ruleScope` that will be discovered by any contained `DataBoundComponent`s which do not specify an explicit `ruleScope`.
`void`	`setIsSnapAlignCandidate(java.lang.Boolean isSnapAlignCandidate)` Flag to disable snapping to alignment against this Canvas when other Canvases dragged into the same parent when `childrenSnapAlign` is enabled on this Canvas' parent.
`void`	`setKeepInParentRect(java.lang.Boolean keepInParentRect)` Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array).
`void`	`setKeepInParentRect(java.lang.Integer... keepInParentRect)` Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array).
`void`	`setKeepInParentRect(Rectangle rectangle)`
`void`	`setLayoutAlign(Alignment layoutAlign)` When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout.
`void`	`setLayoutAlign(VerticalAlignment layoutAlign)` When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout.
`void`	`setLeavePageSpace(java.lang.Integer leavePageSpace)` If set, overrides the global `defaultPageSpace`.
`void`	`setLeft(int 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 `position` property).
`void`	`setLeft(java.lang.String 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 `position` property).
`void`	`setLocateChildrenBy(LocatorStrategy locateChildrenBy)` Strategy to use when locating children in this canvas from an autoTest locator string.
`void`	`setLocateChildrenType(LocatorTypeStrategy locateChildrenType)` `LocatorTypeStrategy` to use when finding children within this canvas.
`void`	`setLocatePeersBy(LocatorStrategy locatePeersBy)` Strategy to use when locating peers of this canvas from an autoTest locator string.
`void`	`setLocatePeersType(LocatorTypeStrategy locatePeersType)` `LocatorTypeStrategy` to use when finding peers of this canvas.
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`setLogicalStructure(com.smartgwt.logicalstructure.widgets.CanvasLogicalStructure s)` Setter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
`void`	`setMargin(java.lang.Integer margin)` Set the CSS Margin, in pixels, for this component.
`void`	`setMatchElement(java.lang.Boolean matchElement)` If `htmlElement` is specified, should this canvas initially be drawn at the same dimensions as the htmlElement? Note: setting this property will not force the canvas to resize if the element subsequently resizes (for example due to page reflow).
`void`	`setMaxHeight(int maxHeight)` Maximum height available to this Canvas.
`void`	`setMaxWidth(int maxWidth)` Maximum width available to this Canvas.
`void`	`setMaxZoomOverflowError(int maxZoomOverflowError)` When `correctZoomOverflow` is true and browser or OS-level zoom is active, determines how much overflow must occur before the Framework enables scrolling for this canvas.
`void`	`setMenuConstructor(java.lang.String menuConstructor)` Default class used to construct menus created by this component, including context menus.
`void`	`setMinHeight(int minHeight)` Minimum height available to this Canvas.
`void`	`setMinNonEdgeSize(int minNonEdgeSize)` If the widget has drag resize configured on one or more of it's edges, and the edgeMarginSize is large enough that the remaining space is less than `minNonEdgeSize`, the edgeMarginSize will be reduced such that the non-edge part of the widget is at least 1/3 of the total space (with two draggable edges) or half of it (with one draggable edge).
`void`	`setMinWidth(int minWidth)` Minimum width available to this Canvas.
`void`	`setMomentumScrollMinSpeed(double momentumScrollMinSpeed)` The minimum speed in pixels per second that must be reached for momentum scrolling to kick in.
`void`	`setMouseStillDownDelay(int mouseStillDownDelay)` Amount of time (in milliseconds) between repeated 'mouseStillDown' events for this canvas.
`void`	`setMouseStillDownInitialDelay(int mouseStillDownInitialDelay)` Amount of time (in milliseconds) before mouseStillDown events start to be fired repeatedly for this canvas.
`void`	`setName(java.lang.String name)` Optional name for the canvas, which can later be used to reference it.
`static void`	`setNeverUseFilters(boolean neverUseFilters)` Changes the system-wide `neverUseFilters` setting.
`void`	`setNoDoubleClicks(java.lang.Boolean noDoubleClicks)` If true, this canvas will receive all mouse-clicks as single `click` events rather than as `doubleClick` events.
`void`	`setNoDropCursor(Cursor noDropCursor)` Specifies the cursor image to display when the user drags a droppable canvas over this if it is not a valid drop target for the event and `showNoDropIndicator` is true.
`void`	`setOpacity(java.lang.Integer opacity)` Renders the widget to be partly transparent.
`void`	`setOverflow(Overflow overflow)` 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.
`void`	`setPadding(java.lang.Integer padding)` Set the CSS padding of this component, in pixels.
`void`	`setPageLeft(int left)` Set the page-relative left coordinate of this widget.
`void`	`setPageTop(int top)` Set the page-relative top coordinate of this widget.
`void`	`setPanelContainer(Canvas container)` Sets this Canvas's "panel container".
`void`	`setParentCanvas(Canvas parentCanvas)` This Canvas's immediate parent, if any.
`void`	`setParentElement(Canvas parentElement)` Deprecated. As of Smartclient version 9.1, deprecated in favor of `parentCanvas` and `getParentCanvas()`
`void`	`setPeers(Canvas... peers)` Array of all Canvii that are peers of this Canvas.
`void`	`setPercentBox(PercentBoxModel percentBox)` Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a specified `snapTo`.
`void`	`setPercentSource(Canvas percentSource)` If this canvas has its size specified as a percentage, this property allows the user to explicitly designate another canvas upon which sizing will be based.
`void`	`setPosition(Positioning position)` Absolute or relative, corresponding to the "absolute" (with respect to parent) or "relative" (with respect to document flow) values for the CSS position attribute.
`void`	`setPrefix(java.lang.String prefix)`
`void`	`setPrintChildrenAbsolutelyPositioned(java.lang.Boolean printChildrenAbsolutelyPositioned)` Should this canvas print its children absolutely positioned when generating `printable HTML`.
`void`	`setPrompt(java.lang.String prompt)` Prompt displayed in hover canvas if `showHover` is true.
`void`	`setProportionalResizeModifiers(java.lang.String... proportionalResizeModifiers)` If `proportionalResizing` is set to `ProportionalResizeMode.MODIFIER` or `ProportionalResizeMode.MODIFIER_OFF` then proportional resizing of the DrawItem is activated or deactivated, respectively, whenever at least one key in this set of modifier keys is pressed.
`void`	`setProportionalResizing(ProportionalResizeMode proportionalResizing)` If `canDragResize` is true, this property specifies the conditions for when proportional resizing is used.
`void`	`setReceiveScrollbarEvents(boolean receiveScrollbarEvents)` Whether this canvas should receive `events` from its scrollbars, which are `peers`.
`void`	`setRect(int left, int top, int width, int height)` Set all four coordinates, relative to the enclosing context, at once.
`void`	`setRect(Rectangle rectangle)` Set all four coordinates, relative to the enclosing context, at once.
`void`	`setRedrawOnResize(java.lang.Boolean redrawOnResize)` Should this element be redrawn in response to a resize?
`void`	`setRelativeTabPosition(java.lang.Integer position)` Assign a relative tab position for this canvas.
`void`	`setResizeBarTarget(java.lang.String resizeBarTarget)` When this Canvas is included as a member in a Layout, and `showResizeBar` is set to `true` so that a resizeBar is created, `resizeBarTarget:"next"` can be set to indicate that the resizeBar should resize the next member of the layout rather than this one.
`void`	`setResizeFrom(EdgeName... resizeFrom)` When drag resizing is enabled via `canDragResize`, restricts resizes to only certain edges or corners.
`void`	`setResizeFrom(java.lang.String... resizeFrom)` Deprecated. use `#setResizeFrom(EdgeName)` instead.
`void`	`setRight(int right)` Resizes the widget horizontally to position its right side at the specified coordinate.
`void`	`setRuleScope(java.lang.String ruleScope)` `ID` of the component that gathers the context for evaluation of criteria-based rules specified by properties such as `FormItem.visibleWhen`.
`void`	`setScrollbarConstructor(java.lang.String scrollbarConstructor)` The class that will be used to create custom scrollbars for this component.
`void`	`setScrollbarSize(int scrollbarSize)` How thick should we make the scrollbars for this canvas.
`void`	`setShadowColor(java.lang.String shadowColor)` Color for the css-based drop shadow shown if `useCSSShadow` is true and `showShadow` is true.
`void`	`setShadowDepth(int shadowDepth)` Depth of the shadow, or the virtual height above the page of the widget throwing the shadow.
`void`	`setShadowHOffset(java.lang.Integer shadowHOffset)` Horizontal offset for the `shadow`.
`void`	`setShadowImage(java.lang.String shadowImage)` If `useCSSShadow` is false, (or for browsers that do not support css3), this property supplies the base name of the series of images for the sides, corners, and center of the shadow.
`void`	`setShadowOffset(java.lang.Integer shadowOffset)` Offset of the shadow.
`void`	`setShadowSoftness(java.lang.Integer shadowSoftness)` Softness, or degree of blurring, of the shadow.
`void`	`setShadowSpread(java.lang.Integer shadowSpread)` Explicit spread for the css-based drop shadow shown if `useCSSShadow` is true and `showShadow` is true.
`void`	`setShadowVOffset(java.lang.Integer shadowVOffset)` Vertical offset for the `shadow`.
`void`	`setShouldPrint(java.lang.Boolean shouldPrint)` Whether this canvas should be included in a printable view.
`void`	`setShowCustomScrollbars(boolean showCustomScrollbars)` Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
`void`	`setShowDragShadow(java.lang.Boolean showDragShadow)` When this widget is dragged, if its dragAppearance is `"target"`, should we show a shadow behind the canvas during the drag.
`void`	`setShowEdges(java.lang.Boolean showEdges)` Whether an `EdgedCanvas` should be used to show image-based edges around this component.
`void`	`setShowHover(java.lang.Boolean showHover)` If `this.canHover` is true, should we show the global hover canvas by default when the user hovers over this canvas?
`void`	`setShowHoverComponents(java.lang.Boolean showHoverComponents)` When set to true, shows a widget hovering at the mouse point instead of the builtin hover label.
`void`	`setShowResizeBar(java.lang.Boolean showResizeBar)` When this Canvas is included as a member in a `Layout`, whether a resizeBar should be shown after this member in the layout, to allow it to be resized.
`void`	`setShowShadow(java.lang.Boolean showShadow)` Whether to show a drop shadow for this Canvas.
`void`	`setShowSnapGrid(java.lang.Boolean showSnapGrid)` Whether to show a snap grid for this Canvas.
`void`	`setShrinkElementOnHide(boolean shrinkElementOnHide)` This is an advanced setting.
`void`	`setSizeMayChangeOnRedraw(java.lang.Boolean sizeMayChangeOnRedraw)` Is it possible that a call to `redraw()` on this widget will change its size?
`void`	`setSkinImgDir(java.lang.String skinImgDir)` Default directory for skin images (those defined by the class), relative to the Page-wide `skinDir`.
`void`	`setSmoothFade(java.lang.Boolean smoothFade)`
`void`	`setSnapAlignCandidates(Canvas... snapAlignCandidates)` When `childrenSnapAlign` is enabled, list of candidates to check for alignment.
`void`	`setSnapAlignCenterLineStyle(java.lang.String snapAlignCenterLineStyle)` CSS border declaration used for the line shown to indicate snapping to a center line when `childrenSnapAlign` is set.
`void`	`setSnapAlignEdgeLineStyle(java.lang.String snapAlignEdgeLineStyle)` CSS border declaration used for the line shown to indicate snapping to a edge line when `childrenSnapAlign` is set.
`void`	`setSnapAxis(java.lang.String snapAxis)` Describes which axes to apply snap-to-grid to.
`void`	`setSnapEdge(java.lang.String snapEdge)` If `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.
`void`	`setSnapHDirection(java.lang.String snapHDirection)` The horizontal snap direction.
`void`	`setSnapHGap(int snapHGap)` The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
`void`	`setSnapOffsetLeft(java.lang.Integer snapOffsetLeft)` If `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.
`void`	`setSnapOffsetTop(java.lang.Integer snapOffsetTop)` If `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.
`void`	`setSnapOnDrop(java.lang.Boolean snapOnDrop)` 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).
`void`	`setSnapResizeToAlign(java.lang.Boolean snapResizeToAlign)` Flag to disable snapping to alignment when this Canvas is resized.
`void`	`setSnapResizeToGrid(java.lang.Boolean snapResizeToGrid)` Causes this canvas to snap to its parent's grid when resizing.
`void`	`setSnapTo(java.lang.String snapTo)` Position this widget such that it is aligned with ("snapped to") an edge of its `master` (if specified), or its `parent canvas`.
`void`	`setSnapToAlign(java.lang.Boolean snapToAlign)` Flag to disable snapping to alignment when this Canvas is dragged when `childrenSnapAlign` is enabled on this Canvas' parent.
`void`	`setSnapToCenterAlign(java.lang.Boolean snapToCenterAlign)` Flag to disable snapping to center alignment when this Canvas is dragged when `childrenSnapAlign` is enabled on this Canvas' parent.
`void`	`setSnapToEdgeAlign(java.lang.Boolean snapToEdgeAlign)` Flag to disable snapping to edge alignment when this Canvas is dragged when `childrenSnapAlign` is enabled on this Canvas' parent.
`void`	`setSnapToGrid(java.lang.Boolean snapToGrid)` Causes this canvas to snap to its parent's grid when dragging.
`void`	`setSnapVDirection(java.lang.String snapVDirection)` The vertical snap direction.
`void`	`setSnapVGap(int snapVGap)` The vertical grid size to use, in pixels, when snap-to-grid is enabled.
`void`	`setStartLine(java.lang.Boolean startLine)` Whether this canvas should always start a new line when used as a tile in a `FlowLayout`.
`void`	`setStyleName(java.lang.String styleName)` The CSS class applied to this widget as a whole.
`void`	`setTabIndex(java.lang.Integer tabIndex)` If specified this governs the tabIndex of the widget in the page's tab order.
`void`	`setTitle(java.lang.String title)` Synonym for `setPrompt(String)`
`void`	`setTooltip(java.lang.String tooltip)` Synonym for `setPrompt(String)`
`void`	`setTop(int 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 `position` property).
`void`	`setTop(java.lang.String 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 `position` property).
`void`	`setUpdateTabPositionOnDraw(boolean updateTabPositionOnDraw)` Should canvases with no `parent canvas` be moved to the end of the TabIndexManager tree on draw()?
`void`	`setUpdateTabPositionOnReparent(boolean updateTabPositionOnReparent)` Should canvases with a `parent canvas` be added to the TabIndexManager under the parent as described in `updateChildTabPositions()` and `updateChildTabPosition()`?
`void`	`setUseBackMask(java.lang.Boolean useBackMask)` In earlier versions of Internet Explorer (pre IE9), a native limitation exists whereby if HTML elements are overlapping on the page, certain elements can appear to "burn through" elements in the same position with a higher z-index.
`void`	`setUseCSSShadow(boolean useCSSShadow)` If `showShadow` is true, should we use the css `box-shadow` property (where supported) to achieve the shadow?
`void`	`setUseDragMask(boolean useDragMask)` This flag controls whether we register the component as a maskable item with the EventHandler.
`void`	`setUseImageForSVG(boolean useImageForSVG)` If set, forces the main SVG image or icon in the canvas to be rendered in an <image> tag rather than an <object> tag, the default.
`void`	`setUseNativeDrag(java.lang.Boolean useNativeDrag)` If set, native HTML5 drag and drop will be used for all drags initiated on this widget (on browsers where this is supported).
`void`	`setUseOpacityFilter(java.lang.Boolean useOpacityFilter)` Configures where the Opacity filter is used for IE6-8.
`void`	`setUseTouchScrolling(java.lang.Boolean useTouchScrolling)` On `touch devices`, if this `Canvas` can be scrolled, should touch-dragging the content area result in scrolling? Set to `false` if touch-dragging should not cause scrolling.
`void`	`setValuesManager(java.lang.String valuesManager)` `ValuesManager` for managing values displayed in this component.
`void`	`setValuesManager(ValuesManager valuesManager)` `ValuesManager` for managing values displayed in this component.
`void`	`setVisibility(Visibility visibility)` Controls widget visibility when the widget is initialized.
`void`	`setVisible(boolean visible)`
`void`	`setVisibleWhen(AdvancedCriteria visibleWhen)` Criteria to be evaluated to determine whether this Canvas should be visible.
`void`	`setWidth(int width)`
`void`	`setWidth(java.lang.Integer width)` Size for this component's horizontal dimension.
`void`	`setWidth(java.lang.String width)` Size for this component's horizontal dimension.
`void`	`setWidth100()` Convenience method that sets the width to 100%.
`void`	`setZIndex(int newIndex)` Set the z-Index of the canvas.
`void`	`shouldDragScroll()` 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 if there are scrollbars, else false.
`void`	`show()` Sets this widget's visibility to "inherit", so that it becomes visible if all of its parents are visible or it has no parents.
`java.lang.String`	`showClickMask(Function clickActionCallback, ClickMaskMode mode, Canvas[] unmaskedTargets)` Show a clickMask over the entire screen that intercepts mouse clicks and fires some action.
`void`	`showComponentMask()` Temporariy block all user interaction with children of this widget, with the exception of those passed in in the `unmaskedChildren` parameter.
`void`	`showComponentMask(Canvas... unmaskedChildren)` Temporariy block all user interaction with children of this widget, with the exception of those passed in in the `unmaskedChildren` parameter.
`void`	`showNextTo(Canvas otherWidget)` Show this widget next to another widget on the page, positioned such that it will not extend beyond the browser viewport.
`void`	`showNextTo(Canvas otherWidget, java.lang.String side)`
`void`	`showNextTo(Canvas otherWidget, java.lang.String side, boolean canOcclude)`
`void`	`showNextTo(Canvas otherWidget, java.lang.String side, boolean canOcclude, boolean skipAnimation)` Show this widget next to another widget on the page, positioned such that it will not extend beyond the browser viewport.
`static void`	`showPrintPreview(Canvas component)` Show a PrintWindow containing a printable view of the component passed in containing print HTML.
`static void`	`showPrintPreview(java.lang.Object[] components)` Show a Print containing a printable view of the components passed in.
`static void`	`showPrintPreview(java.lang.Object[] components, PrintProperties printProperties, java.lang.String title, PrintPreviewCallback callback)` Show a Print containing a printable view of the components passed in.
`static void`	`showPrintPreview(java.lang.Object[] components, PrintProperties printProperties, java.lang.String title, PrintPreviewCallback callback, Window printWindowProperties, java.lang.String printButtonTitle)` Show a Print containing a printable view of the components passed in.
`void`	`showRecursively()` Recursively show the canvas and all its parents so the canvas will be visible.
`void`	`updateChildTabPosition(Canvas child)` Ensure that a specific child is slotted correctly into the page's tab order.
`void`	`updateChildTabPositions()` Update the childrens' tab positions, slotting them under this widget in the `TabIndexManager`, in the order defined by `getChildTabPosition()`.
`void`	`updateEditNode(EditContext editContext, EditNode editNode)` A callback invoked for each `liveObject` by `EditContext` when the EditContext is being serialized.
`void`	`updateHover()` If this canvas is currently showing a hover (see `handleHover()`), this method can be called to update the contents of the hover.
`void`	`updateHover(java.lang.String hoverHTML)` If this canvas is currently showing a hover (see `handleHover()`), this method can be called to update the contents of the hover.
`void`	`updateShadow()` Update the canvas shadow.
`void`	`updateTabPositionForDraw()` This method is executed on draw.
`java.lang.Boolean`	`visibleAtPoint(int x, int y, boolean withinViewport, Canvas ignoreWidgets, Canvas upToParent)` 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.
`java.lang.Boolean`	`willAcceptDrop()` Returns true if the widget object being dragged can be dropped on this widget, and false or null otherwise.

Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent

- Constructor Detail
  - Canvas
```
public Canvas()
```
  - Canvas
```
public Canvas(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - Canvas
```
public Canvas(java.lang.String id)
```
- Method Detail
  - getOrCreateRef
```
public static Canvas getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - getPaletteDefaults
```
public java.util.Map getPaletteDefaults()
```
    This method returns a Map of config properties suitable for use as the "defaults" attribute of a PaletteNode. Use it when you need to work with PaletteNodes indirectly, such when setting up TileRecords that will be used in a TilePalette. See the dev tools overview for examples of how to assemble and acquire a suitable defaults object when you are creating a PaletteNode indirectly
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)
```
    Changes the defaults for Canvas AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)
```
    Changes the defaults for FormItem AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - create
```
protected com.google.gwt.core.client.JavaScriptObject create()
```
    Overrides:
    
    create in class BaseWidget
  - setAccessKey
```
public void setAccessKey(java.lang.String accessKey)
```
    If specified this governs the HTML accessKey for the widget.
    This should be set to a character - when a user hits the html accessKey modifier for the browser, plus this character, focus will be given to the widget in question. The accessKey modifier can vary by browser and platform.
    The following list of default behavior is for reference only, developers should also consult browser documentation for additional information.
    - Internet Explorer (all platforms): Alt + accessKey
    - Mozilla Firefox (Windows, Unix): Alt+Shift + accessKey
    - Mozilla Firefox (Mac): Ctrl+Opt + accessKey
    - Chrome and Safari (Windows, Unix): Alt + accessKey
    - Chrome and Safari (Mac): Ctrl+Opt + accessKey
    If this method is called after the component has been drawn/initialized: Set the accessKey for this canvas.
    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].
    Note : This is an advanced setting
    Parameters:
    
    accessKey - Character to use as an accessKey for this widget. Case Insensitive. Default value is null
    
    See Also:
    
    Focus overview and related methods
  - getAccessKey
```
public java.lang.String getAccessKey()
```
    If specified this governs the HTML accessKey for the widget.
    This should be set to a character - when a user hits the html accessKey modifier for the browser, plus this character, focus will be given to the widget in question. The accessKey modifier can vary by browser and platform.
    The following list of default behavior is for reference only, developers should also consult browser documentation for additional information.
    - Internet Explorer (all platforms): Alt + accessKey
    - Mozilla Firefox (Windows, Unix): Alt+Shift + accessKey
    - Mozilla Firefox (Mac): Ctrl+Opt + accessKey
    - Chrome and Safari (Windows, Unix): Alt + accessKey
    - Chrome and Safari (Mac): Ctrl+Opt + accessKey
    Returns:
    
    Current accessKey value. Default value is null
    
    See Also:
    
    Focus overview and related methods
  - setAdaptiveHeightPriority
```
public void setAdaptiveHeightPriority(java.lang.Integer adaptiveHeightPriority)
                               throws java.lang.IllegalStateException
```
    See adaptiveWidthPriority.
    
    Parameters:
    
    adaptiveHeightPriority - New adaptiveHeightPriority value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getAdaptiveHeightPriority
```
public java.lang.Integer getAdaptiveHeightPriority()
```
    See adaptiveWidthPriority.
    
    Returns:
    
    Current adaptiveHeightPriority value. Default value is null
  - setAdaptiveWidthPriority
```
public void setAdaptiveWidthPriority(java.lang.Integer adaptiveWidthPriority)
                              throws java.lang.IllegalStateException
```
    If multiple widgets in the same Layout have adaptive width, adaptiveWidthPriority can be set to indicate which of the components should be given priority access to space.
    The widget with the highest priority setting will be offered surplus space first, and asked to give up space last. Lack of a priority setting is treated as zero. Any adaptive widgets with the same priority setting will be asked to give up or release space according to their order in Layout.members.
    
    Parameters:
    
    adaptiveWidthPriority - New adaptiveWidthPriority value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    setCanAdaptWidth(java.lang.Boolean)
  - getAdaptiveWidthPriority
```
public java.lang.Integer getAdaptiveWidthPriority()
```
    If multiple widgets in the same Layout have adaptive width, adaptiveWidthPriority can be set to indicate which of the components should be given priority access to space.
    The widget with the highest priority setting will be offered surplus space first, and asked to give up space last. Lack of a priority setting is treated as zero. Any adaptive widgets with the same priority setting will be asked to give up or release space according to their order in Layout.members.
    
    Returns:
    
    Current adaptiveWidthPriority value. Default value is null
    
    See Also:
    
    getCanAdaptWidth()
  - setAlwaysShowScrollbars
```
public void setAlwaysShowScrollbars(java.lang.Boolean alwaysShowScrollbars)
                             throws java.lang.IllegalStateException
```
    On touch devices that support native touch scrolling, if showCustomScrollbars is true and touch scrolling has not been disabled by the useTouchScrolling and/or disableTouchScrollingForDrag settings, should custom scrollbars and native touch scrolling be enabled for this component? If false or unset, then only native touch scrolling will be enabled. If true, then both scrolling mechanisms will be enabled.
    NOTE: Because native touch scrolling (also called momentum scrolling) is computationally intensive, some mobile browsers implement an optimization where the state of the DOM for the element being scrolled will be frozen or partially frozen during the scroll animation. This results in a delay between when the scroll position reaches a certain point in the animation and when the positions of the custom scrollbar thumbs are updated to reflect that scroll position.
    Note : This is an advanced setting
    
    Parameters:
    
    alwaysShowScrollbars - New alwaysShowScrollbars value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Scrolling overview and related methods
  - getAlwaysShowScrollbars
```
public java.lang.Boolean getAlwaysShowScrollbars()
```
    On touch devices that support native touch scrolling, if showCustomScrollbars is true and touch scrolling has not been disabled by the useTouchScrolling and/or disableTouchScrollingForDrag settings, should custom scrollbars and native touch scrolling be enabled for this component? If false or unset, then only native touch scrolling will be enabled. If true, then both scrolling mechanisms will be enabled.
    NOTE: Because native touch scrolling (also called momentum scrolling) is computationally intensive, some mobile browsers implement an optimization where the state of the DOM for the element being scrolled will be frozen or partially frozen during the scroll animation. This results in a delay between when the scroll position reaches a certain point in the animation and when the positions of the custom scrollbar thumbs are updated to reflect that scroll position.
    
    Returns:
    
    Current alwaysShowScrollbars value. Default value is null
    
    See Also:
    
    Scrolling overview and related methods
  - setAnimateAcceleration
```
public void setAnimateAcceleration(AnimationAcceleration animateAcceleration)
```
    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.
    Note : This is an advanced setting
    
    Parameters:
    
    animateAcceleration - New animateAcceleration value. Default value is "smoothEnd"
  - getAnimateAcceleration
```
public AnimationAcceleration getAnimateAcceleration()
```
    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.
    
    Returns:
    
    Current animateAcceleration value. Default value is "smoothEnd"
  - setAnimateFadeTime
```
public void setAnimateFadeTime(java.lang.Integer animateFadeTime)
```
    Default time for performing an animated fade. If unset, this.animateTime will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateFadeTime - New animateFadeTime value. Default value is null
  - getAnimateFadeTime
```
public java.lang.Integer getAnimateFadeTime()
```
    Default time for performing an animated fade. If unset, this.animateTime will be used by default instead
    
    Returns:
    
    Current animateFadeTime value. Default value is null
  - setAnimateHideAcceleration
```
public void setAnimateHideAcceleration(AnimationAcceleration animateHideAcceleration)
```
    Default acceleration function for performing an animated hide. If unset, this.animateAcceleration will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateHideAcceleration - New animateHideAcceleration value. Default value is null
  - getAnimateHideAcceleration
```
public AnimationAcceleration getAnimateHideAcceleration()
```
    Default acceleration function for performing an animated hide. If unset, this.animateAcceleration will be used by default instead
    
    Returns:
    
    Current animateHideAcceleration value. Default value is null
  - setAnimateHideTime
```
public void setAnimateHideTime(java.lang.Integer animateHideTime)
```
    Default time for performing an animated hide. If unset, this.animateTime will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateHideTime - New animateHideTime value. Default value is null
  - getAnimateHideTime
```
public java.lang.Integer getAnimateHideTime()
```
    Default time for performing an animated hide. If unset, this.animateTime will be used by default instead
    
    Returns:
    
    Current animateHideTime value. Default value is null
  - setAnimateMoveAcceleration
```
public void setAnimateMoveAcceleration(AnimationAcceleration animateMoveAcceleration)
```
    Default acceleration effect for performing an animated move. If unset, this.animateAcceleration will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateMoveAcceleration - New animateMoveAcceleration value. Default value is null
  - getAnimateMoveAcceleration
```
public AnimationAcceleration getAnimateMoveAcceleration()
```
    Default acceleration effect for performing an animated move. If unset, this.animateAcceleration will be used by default instead
    
    Returns:
    
    Current animateMoveAcceleration value. Default value is null
  - setAnimateMoveTime
```
public void setAnimateMoveTime(java.lang.Integer animateMoveTime)
```
    Default time for performing an animated move. If unset, this.animateTime will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateMoveTime - New animateMoveTime value. Default value is null
  - getAnimateMoveTime
```
public java.lang.Integer getAnimateMoveTime()
```
    Default time for performing an animated move. If unset, this.animateTime will be used by default instead
    
    Returns:
    
    Current animateMoveTime value. Default value is null
  - setAnimateRectAcceleration
```
public void setAnimateRectAcceleration(AnimationAcceleration animateRectAcceleration)
```
    Default acceleration function for performing an animated move and resize. If unset, this.animateAcceleration will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateRectAcceleration - New animateRectAcceleration value. Default value is null
  - getAnimateRectAcceleration
```
public AnimationAcceleration getAnimateRectAcceleration()
```
    Default acceleration function for performing an animated move and resize. If unset, this.animateAcceleration will be used by default instead
    
    Returns:
    
    Current animateRectAcceleration value. Default value is null
  - setAnimateRectTime
```
public void setAnimateRectTime(java.lang.Integer animateRectTime)
```
    Default time for performing an animated setRect. If unset, this.animateTime will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateRectTime - New animateRectTime value. Default value is null
  - getAnimateRectTime
```
public java.lang.Integer getAnimateRectTime()
```
    Default time for performing an animated setRect. If unset, this.animateTime will be used by default instead
    
    Returns:
    
    Current animateRectTime value. Default value is null
  - setAnimateResizeAcceleration
```
public void setAnimateResizeAcceleration(AnimationAcceleration animateResizeAcceleration)
```
    Default acceleration function for performing an animated resize. If unset, this.animateAcceleration will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateResizeAcceleration - New animateResizeAcceleration value. Default value is null
  - getAnimateResizeAcceleration
```
public AnimationAcceleration getAnimateResizeAcceleration()
```
    Default acceleration function for performing an animated resize. If unset, this.animateAcceleration will be used by default instead
    
    Returns:
    
    Current animateResizeAcceleration value. Default value is null
  - setAnimateResizeLayoutMode
```
public void setAnimateResizeLayoutMode(AnimationLayoutMode animateResizeLayoutMode)
```
    When to update the child layout for a size animation. Updating the child layout more often may improve appearance, but risks prohibitive overhead with more complicated widget hierarchies.
    Note : This is an advanced setting
    
    Parameters:
    
    animateResizeLayoutMode - New animateResizeLayoutMode value. Default value is "atEnd"
  - getAnimateResizeLayoutMode
```
public AnimationLayoutMode getAnimateResizeLayoutMode()
```
    When to update the child layout for a size animation. Updating the child layout more often may improve appearance, but risks prohibitive overhead with more complicated widget hierarchies.
    
    Returns:
    
    Current animateResizeLayoutMode value. Default value is "atEnd"
  - setAnimateResizeTime
```
public void setAnimateResizeTime(java.lang.Integer animateResizeTime)
```
    Default time for performing an animated resize. If unset, this.animateTime will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateResizeTime - New animateResizeTime value. Default value is null
  - getAnimateResizeTime
```
public java.lang.Integer getAnimateResizeTime()
```
    Default time for performing an animated resize. If unset, this.animateTime will be used by default instead
    
    Returns:
    
    Current animateResizeTime value. Default value is null
  - setAnimateScrollAcceleration
```
public void setAnimateScrollAcceleration(AnimationAcceleration animateScrollAcceleration)
```
    Default acceleration function for performing an animated scroll. If unset, this.animateAcceleration will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateScrollAcceleration - New animateScrollAcceleration value. Default value is null
  - getAnimateScrollAcceleration
```
public AnimationAcceleration getAnimateScrollAcceleration()
```
    Default acceleration function for performing an animated scroll. If unset, this.animateAcceleration will be used by default instead
    
    Returns:
    
    Current animateScrollAcceleration value. Default value is null
  - setAnimateScrollTime
```
public void setAnimateScrollTime(java.lang.Integer animateScrollTime)
```
    Default time for performing an animated scroll. If unset, this.animateTime will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateScrollTime - New animateScrollTime value. Default value is null
  - getAnimateScrollTime
```
public java.lang.Integer getAnimateScrollTime()
```
    Default time for performing an animated scroll. If unset, this.animateTime will be used by default instead
    
    Returns:
    
    Current animateScrollTime value. Default value is null
  - setAnimateShowAcceleration
```
public void setAnimateShowAcceleration(AnimationAcceleration animateShowAcceleration)
```
    Default acceleration function for performing an animated show. If unset, this.animateAcceleration will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateShowAcceleration - New animateShowAcceleration value. Default value is null
  - getAnimateShowAcceleration
```
public AnimationAcceleration getAnimateShowAcceleration()
```
    Default acceleration function for performing an animated show. If unset, this.animateAcceleration will be used by default instead
    
    Returns:
    
    Current animateShowAcceleration value. Default value is null
  - setAnimateShowTime
```
public void setAnimateShowTime(java.lang.Integer animateShowTime)
```
    Default time for performing an animated show. If unset, this.animateTime will be used by default instead
    Note : This is an advanced setting
    
    Parameters:
    
    animateShowTime - New animateShowTime value. Default value is null
  - getAnimateShowTime
```
public java.lang.Integer getAnimateShowTime()
```
    Default time for performing an animated show. If unset, this.animateTime will be used by default instead
    
    Returns:
    
    Current animateShowTime value. Default value is null
  - setAnimateTime
```
public void setAnimateTime(int animateTime)
```
    Default total duration of animations. Can be overridden by setting animation times for specific animations, or by passing a duration parameter into the appropriate animate...() method.
    Note : This is an advanced setting
    
    Parameters:
    
    animateTime - New animateTime value. Default value is 300
    
    See Also:
    
    Fly Onscreen Example
  - getAnimateTime
```
public int getAnimateTime()
```
    Default total duration of animations. Can be overridden by setting animation times for specific animations, or by passing a duration parameter into the appropriate animate...() method.
    
    Returns:
    
    Current animateTime value. Default value is 300
    
    See Also:
    
    Fly Onscreen Example
  - setAppImgDir
```
public void setAppImgDir(java.lang.String appImgDir)
```
    Default directory for app-specific images, relative to the Page-wide appImgDir.
    Note : This is an advanced setting
    
    Parameters:
    
    appImgDir - New appImgDir value. Default value is ""
    
    See Also:
    
    URL, Images overview and related methods
  - getAppImgDir
```
public java.lang.String getAppImgDir()
```
    Default directory for app-specific images, relative to the Page-wide appImgDir.
    
    Returns:
    
    Current appImgDir value. Default value is ""
    
    See Also:
    
    URL, Images overview and related methods
  - setAriaRole
```
public void setAriaRole(java.lang.String ariaRole)
                 throws java.lang.IllegalStateException
```
    ARIA role of this component. Usually does not need to be manually set - see Accessibility.
    
    Parameters:
    
    ariaRole - New ariaRole value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Accessibility overview and related methods
  - getAriaRole
```
public java.lang.String getAriaRole()
```
    ARIA role of this component. Usually does not need to be manually set - see Accessibility.
    
    Returns:
    
    Current ariaRole value. Default value is null
    
    See Also:
    
    Accessibility overview and related methods
  - setAutoMaskComponents
```
public void setAutoMaskComponents(java.lang.Boolean autoMaskComponents)
                           throws java.lang.IllegalStateException
```
    Deprecated. As of Smart GWT version 10.0, deprecated in favor of EditProxy.autoMaskChildren
    
    When nodes are added to an EditContext, should they be masked by setting EditProxy.useEditMask true if not explicitly set?
    
    Parameters:
    
    autoMaskComponents - New autoMaskComponents value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getAutoMaskComponents
```
public java.lang.Boolean getAutoMaskComponents()
```
    Deprecated. As of Smart GWT version 10.0, deprecated in favor of EditProxy.autoMaskChildren
    
    When nodes are added to an EditContext, should they be masked by setting EditProxy.useEditMask true if not explicitly set?
    
    Returns:
    
    Current autoMaskComponents value. Default value is null
  - setAutoParent
```
public void setAutoParent(java.lang.String autoParent)
                   throws java.lang.IllegalStateException
```
    This initialization property allows developers to create a canvas using the Class.addAutoChild() method, and have it added as a child to some other component. This property may be set to the childName of another already-created auto-child, or "none" to cause the component to be created without being added as a child to any other widget.
    If unset, the canvas will be added as a child to the component on which addAutoChild(...) was called.
    See autoChildren for an overview of the autoChild subsystem.
    Note : This is an advanced setting
    
    Parameters:
    
    autoParent - New autoParent value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getAutoParent
```
public java.lang.String getAutoParent()
```
    This initialization property allows developers to create a canvas using the Class.addAutoChild() method, and have it added as a child to some other component. This property may be set to the childName of another already-created auto-child, or "none" to cause the component to be created without being added as a child to any other widget.
    If unset, the canvas will be added as a child to the component on which addAutoChild(...) was called.
    See autoChildren for an overview of the autoChild subsystem.
    
    Returns:
    
    Current autoParent value. Default value is null
  - setAutoShowParent
```
public void setAutoShowParent(java.lang.Boolean autoShowParent)
```
    If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
    Note : This is an advanced setting
    
    Parameters:
    
    autoShowParent - New autoShowParent value. Default value is false
    
    See Also:
    
    Appearance overview and related methods
  - getAutoShowParent
```
public java.lang.Boolean getAutoShowParent()
```
    If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
    
    Returns:
    
    Current autoShowParent value. Default value is false
    
    See Also:
    
    Appearance overview and related methods
  - setBackgroundColor
```
public void setBackgroundColor(java.lang.String backgroundColor)
```
    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.
    
    If this method is called after the component has been drawn/initialized: Sets the background color of this component to newColor.
    
    Parameters:
    
    backgroundColor - new background color, or null to remove the current background color. Default value is null
    
    See Also:
    
    CSSColor, Appearance overview and related methods
  - getBackgroundColor
```
public java.lang.String getBackgroundColor()
```
    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.
    
    Returns:
    
    Current backgroundColor value. Default value is null
    
    See Also:
    
    CSSColor, Appearance overview and related methods
  - setBackgroundImage
```
public void setBackgroundImage(java.lang.String backgroundImage)
```
    URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
    
    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).
    
    Parameters:
    
    backgroundImage - new URL (local to Page image directory) for background image. Default value is null
    
    See Also:
    
    SCImgURL, Appearance overview and related methods
  - getBackgroundImage
```
public java.lang.String getBackgroundImage()
```
    URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
    
    Returns:
    
    Current backgroundImage value. Default value is null
    
    See Also:
    
    SCImgURL, Appearance overview and related methods
  - setBackgroundPosition
```
public void setBackgroundPosition(java.lang.String backgroundPosition)
                           throws java.lang.IllegalStateException
```
    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.
    
    Parameters:
    
    backgroundPosition - New backgroundPosition value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Appearance overview and related methods
  - getBackgroundPosition
```
public java.lang.String getBackgroundPosition()
```
    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.
    
    Returns:
    
    Current backgroundPosition value. Default value is null
    
    See Also:
    
    Appearance overview and related methods
  - setBackgroundRepeat
```
public void setBackgroundRepeat(BackgroundRepeat backgroundRepeat)
                         throws java.lang.IllegalStateException
```
    Specifies how the background image should be tiled if this widget is larger than the image. It corresponds to the CSS background-repeat attribute.
    The default of null means no background-repeat CSS will be written out. See BackgroundRepeat type for details on other settings.
    NOTE: this setting directly sets the CSS property background-repeat but does not attempt to work around various known bugs with this setting, or lack of support in IE6. If you need to apply CSS-based workarounds for browser limitations with this setting, it's best to do so via setting styleName.
    
    Parameters:
    
    backgroundRepeat - New backgroundRepeat value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Appearance overview and related methods
  - getBackgroundRepeat
```
public BackgroundRepeat getBackgroundRepeat()
```
    Specifies how the background image should be tiled if this widget is larger than the image. It corresponds to the CSS background-repeat attribute.
    The default of null means no background-repeat CSS will be written out. See BackgroundRepeat type for details on other settings.
    NOTE: this setting directly sets the CSS property background-repeat but does not attempt to work around various known bugs with this setting, or lack of support in IE6. If you need to apply CSS-based workarounds for browser limitations with this setting, it's best to do so via setting styleName.
    
    Returns:
    
    Current backgroundRepeat value. Default value is null
    
    See Also:
    
    Appearance overview and related methods
  - setBorder
```
public void setBorder(java.lang.String border)
```
    Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid blue").
    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 styleName.
    If isGroup is set to true then border is derived from the groupBorderCSS attribute, not from the explicit border property.
    
    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").
    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 styleName.
    
    Parameters:
    
    border - new border to set to (eg: "2px solid black"). Default value is null
    
    See Also:
    
    Appearance overview and related methods
  - getBorder
```
public java.lang.String getBorder()
```
    Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid blue").
    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 styleName.
    If isGroup is set to true then border is derived from the groupBorderCSS attribute, not from the explicit border property.
    
    Returns:
    
    Current border value. Default value is null
    
    See Also:
    
    Appearance overview and related methods
  - setCanAcceptDrop
```
public void setCanAcceptDrop(java.lang.Boolean canAcceptDrop)
```
    Indicates that this object can receive dropped widgets (i.e. other widgets can be dropped on top of it).
    Note : This is an advanced setting
    
    Parameters:
    
    canAcceptDrop - New canAcceptDrop value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - getCanAcceptDrop
```
public java.lang.Boolean getCanAcceptDrop()
```
    Indicates that this object can receive dropped widgets (i.e. other widgets can be dropped on top of it).
    
    Returns:
    
    Current canAcceptDrop value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - setCanAdaptHeight
```
public void setCanAdaptHeight(java.lang.Boolean canAdaptHeight)
```
    See canAdaptWidth.
    
    Parameters:
    
    canAdaptHeight - New canAdaptHeight value. Default value is null
  - getCanAdaptHeight
```
public java.lang.Boolean getCanAdaptHeight()
```
    See canAdaptWidth.
    
    Returns:
    
    Current canAdaptHeight value. Default value is null
  - setCanAdaptWidth
```
public void setCanAdaptWidth(java.lang.Boolean canAdaptWidth)
```
    Indicates that this component is able to render itself at multiple possible sizes, in order to fit into less space when very little space is available, or to display more information or provide more immediate access to functionality when more space is available.
    Unlike simply indicating a flexible size via width:"*", setting canAdaptWidth indicates that a component has 2 (or more) different ways of rendering itself with different discrete sizes, but does not have the ability to use every additional available pixel.
    For example, a menu embedded in a toolbar might show as only a fixed-size icon which reveals menu options when clicked, or if enough space is available, could show all of the menu options directly in the toolbar. In this example, the menu should either be allocated just enough space for an icon, or enough space for all options to appear inline; any other amount of space being allocated is just a waste.
    When a component with canAdaptWidth is part of a Layout, AdaptWidthByCustomizer.adaptWidthBy() will be called every time component sizes are being calculated, passing a positive or negative pixel value:
    - a positive pixel value indicates a surplus - all other component's minimum sizes can be accommodated, including any minWidth declared on the canAdaptWidth component itself
    - a negative pixel value indicates that the containing layout is going to be forced to Overflow (introduce scrollbars, clip content, etc) unless some component or set of components gives up at least this many pixels
    If a non-zero value is returned from adaptWidthBy, this means that the component is willing to shrink or expand by that many pixels. Returning 0 means that the component is unable to reduce size further, or for a surplus, cannot make good use of the surplus space.
    - A call to AdaptWidthByCustomizer.adaptWidthBy() may surrender as many pixels as desired (as long as the widget won't drop below its minimum allowed width), no matter whether a positive (surplus) or negative (overflow) pixel value is supplied, but
    - A call to AdaptWidthByCustomizer.adaptWidthBy() may not increase its size by more than the number of offered pixels - so if an overflow is present, it may not increase its size at all.
    Note that when the initial width is specified as a stretch size (e.g. "*"), then after AdaptWidthByCustomizer.adaptWidthBy() is called, the Framework will stretch (but not shrink) the member like any other stretch-size Layout member, but the unadaptedWidth argument will always reflect the unstretched width requested by the previous call to AdaptWidthByCustomizer.adaptWidthBy(). This behavior may be disabled by specifying the initial width as a number, or leaving it unspecified.
    Behavior is slightly different for overflow: "visible" members - in this case the unadaptedWidth passed in will reflect the current visible width of the member, rather than the last width requested by the previous call to AdaptWidthByCustomizer.adaptWidthBy() or the specified width (on the first call). However, note that the visible length will match your requested width unless the member is actually overflowed. Stretch sizing is not supported for adaptive-width members with overflow: "visible".
    Caution: you must either determine the current size of the canvas by maintaining your own internal state, or use the unadaptedWidth parameter passed to AdaptWidthByCustomizer.adaptWidthBy(). You must not call getWidth() or getVisibleWidth() on the canvas itself inside AdaptWidthByCustomizer.adaptWidthBy() as the size is in the processing of being determined, but you may draw children or call getVisibleWidth() on them, as we guarantee that the adaptive-width canvas is drawn before the first call to AdaptWidthByCustomizer.adaptWidthBy(). An example of drawing children in AdaptWidthByCustomizer.adaptWidthBy() to compute overall width may be seen in the Inlined Menu Mobile Sample.
    Note that reasonable settings for minWidth should be applied to all other flexible-sized members of a layout where a canAdaptWidth component appears, because when too little space is available, a canAdaptWidth component will absorb all available space until minimums for other components are hit (or the canAdaptWidth component reaches its maximum size). If more than one canAdaptWidth component is present, adaptiveWidthPriority to give priority to a particular component when allocating space.
    All of the above behaviors are exactly the same for height, using canAdaptHeight and AdaptHeightByCustomizer.adaptHeightBy().
    Parameters:
    
    canAdaptWidth - New canAdaptWidth value. Default value is null
    
    See Also:
    
    setCanAdaptHeight(java.lang.Boolean), AdaptWidthByCustomizer.adaptWidthBy(int, int), AdaptHeightByCustomizer.adaptHeightBy(int, int), Inlined Menu Example
  - getCanAdaptWidth
```
public java.lang.Boolean getCanAdaptWidth()
```
    Indicates that this component is able to render itself at multiple possible sizes, in order to fit into less space when very little space is available, or to display more information or provide more immediate access to functionality when more space is available.
    Unlike simply indicating a flexible size via width:"*", setting canAdaptWidth indicates that a component has 2 (or more) different ways of rendering itself with different discrete sizes, but does not have the ability to use every additional available pixel.
    For example, a menu embedded in a toolbar might show as only a fixed-size icon which reveals menu options when clicked, or if enough space is available, could show all of the menu options directly in the toolbar. In this example, the menu should either be allocated just enough space for an icon, or enough space for all options to appear inline; any other amount of space being allocated is just a waste.
    When a component with canAdaptWidth is part of a Layout, AdaptWidthByCustomizer.adaptWidthBy() will be called every time component sizes are being calculated, passing a positive or negative pixel value:
    - a positive pixel value indicates a surplus - all other component's minimum sizes can be accommodated, including any minWidth declared on the canAdaptWidth component itself
    - a negative pixel value indicates that the containing layout is going to be forced to Overflow (introduce scrollbars, clip content, etc) unless some component or set of components gives up at least this many pixels
    If a non-zero value is returned from adaptWidthBy, this means that the component is willing to shrink or expand by that many pixels. Returning 0 means that the component is unable to reduce size further, or for a surplus, cannot make good use of the surplus space.
    - A call to AdaptWidthByCustomizer.adaptWidthBy() may surrender as many pixels as desired (as long as the widget won't drop below its minimum allowed width), no matter whether a positive (surplus) or negative (overflow) pixel value is supplied, but
    - A call to AdaptWidthByCustomizer.adaptWidthBy() may not increase its size by more than the number of offered pixels - so if an overflow is present, it may not increase its size at all.
    Note that when the initial width is specified as a stretch size (e.g. "*"), then after AdaptWidthByCustomizer.adaptWidthBy() is called, the Framework will stretch (but not shrink) the member like any other stretch-size Layout member, but the unadaptedWidth argument will always reflect the unstretched width requested by the previous call to AdaptWidthByCustomizer.adaptWidthBy(). This behavior may be disabled by specifying the initial width as a number, or leaving it unspecified.
    Behavior is slightly different for overflow: "visible" members - in this case the unadaptedWidth passed in will reflect the current visible width of the member, rather than the last width requested by the previous call to AdaptWidthByCustomizer.adaptWidthBy() or the specified width (on the first call). However, note that the visible length will match your requested width unless the member is actually overflowed. Stretch sizing is not supported for adaptive-width members with overflow: "visible".
    Caution: you must either determine the current size of the canvas by maintaining your own internal state, or use the unadaptedWidth parameter passed to AdaptWidthByCustomizer.adaptWidthBy(). You must not call getWidth() or getVisibleWidth() on the canvas itself inside AdaptWidthByCustomizer.adaptWidthBy() as the size is in the processing of being determined, but you may draw children or call getVisibleWidth() on them, as we guarantee that the adaptive-width canvas is drawn before the first call to AdaptWidthByCustomizer.adaptWidthBy(). An example of drawing children in AdaptWidthByCustomizer.adaptWidthBy() to compute overall width may be seen in the Inlined Menu Mobile Sample.
    Note that reasonable settings for minWidth should be applied to all other flexible-sized members of a layout where a canAdaptWidth component appears, because when too little space is available, a canAdaptWidth component will absorb all available space until minimums for other components are hit (or the canAdaptWidth component reaches its maximum size). If more than one canAdaptWidth component is present, adaptiveWidthPriority to give priority to a particular component when allocating space.
    All of the above behaviors are exactly the same for height, using canAdaptHeight and AdaptHeightByCustomizer.adaptHeightBy().
    Returns:
    
    Current canAdaptWidth value. Default value is null
    
    See Also:
    
    getCanAdaptHeight(), AdaptWidthByCustomizer.adaptWidthBy(int, int), AdaptHeightByCustomizer.adaptHeightBy(int, int), Inlined Menu Example
  - setCanDrag
```
public void setCanDrag(java.lang.Boolean canDrag)
```
    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.
    If useNativeDrag is true and this widget has been drawn, then this widget must be redrawn in order for a change of the value of this attribute to take effect.
    Note : This is an advanced setting
    
    Parameters:
    
    canDrag - New canDrag value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - getCanDrag
```
public java.lang.Boolean getCanDrag()
```
    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.
    If useNativeDrag is true and this widget has been drawn, then this widget must be redrawn in order for a change of the value of this attribute to take effect.
    
    Returns:
    
    Current canDrag value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - setCanDragReposition
```
public void setCanDragReposition(java.lang.Boolean canDragReposition)
```
    Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
    Note : This is an advanced setting
    
    Parameters:
    
    canDragReposition - New canDragReposition value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag effects Example
  - getCanDragReposition
```
public java.lang.Boolean getCanDragReposition()
```
    Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
    
    Returns:
    
    Current canDragReposition value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag effects Example
  - setCanDragResize
```
public void setCanDragResize(java.lang.Boolean canDragResize)
```
    Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
    Note : This is an advanced setting
    
    Parameters:
    
    canDragResize - New canDragResize value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag resize Example
  - getCanDragResize
```
public java.lang.Boolean getCanDragResize()
```
    Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
    
    Returns:
    
    Current canDragResize value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag resize Example
  - setCanDragScroll
```
public void setCanDragScroll(boolean canDragScroll)
```
    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() if there are scrollbars.
    Note : This is an advanced setting
    
    Parameters:
    
    canDragScroll - New canDragScroll value. Default value is true
    
    See Also:
    
    shouldDragScroll()
  - getCanDragScroll
```
public boolean getCanDragScroll()
```
    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() if there are scrollbars.
    
    Returns:
    
    Current canDragScroll value. Default value is true
    
    See Also:
    
    shouldDragScroll()
  - setCanDrop
```
public void setCanDrop(java.lang.Boolean canDrop)
```
    Indicates that this object can be dropped on top of other widgets. Only valid if canDrag or canDragReposition is true.
    Note : This is an advanced setting
    
    Parameters:
    
    canDrop - New canDrop value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - getCanDrop
```
public java.lang.Boolean getCanDrop()
```
    Indicates that this object can be dropped on top of other widgets. Only valid if canDrag or canDragReposition is true.
    
    Returns:
    
    Current canDrop value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - setCanDropBefore
```
public void setCanDropBefore(java.lang.Boolean canDropBefore)
```
    When explicitly set to false, disallows drop before this member in the Layout.
    Note : This is an advanced setting
    
    Parameters:
    
    canDropBefore - New canDropBefore value. Default value is null
    
    See Also:
    
    Layout, LayoutMember overview and related methods
  - getCanDropBefore
```
public java.lang.Boolean getCanDropBefore()
```
    When explicitly set to false, disallows drop before this member in the Layout.
    
    Returns:
    
    Current canDropBefore value. Default value is null
    
    See Also:
    
    Layout, LayoutMember overview and related methods
  - setCanFocus
```
public void setCanFocus(java.lang.Boolean canFocus)
```
    Can this widget be allowed to become the target of keyboard events?
    If canFocus is unset (the default), only scrollable widgets with visible scrollbars are focusable, to allow for keyboard scrolling.
    A widget normally receives focus by being clicked on or tabbed to.
    
    If this method is called after the component has been drawn/initialized: Change whether a widget can accept keyboard focus.
    Note : This is an advanced setting
    
    Parameters:
    
    canFocus - whether the widget should now accept focus. Default value is null
    
    See Also:
    
    Focus overview and related methods, Focus & Tabbing Example
  - getCanFocus
```
public java.lang.Boolean getCanFocus()
```
    Can this widget be allowed to become the target of keyboard events?
    If canFocus is unset (the default), only scrollable widgets with visible scrollbars are focusable, to allow for keyboard scrolling.
    A widget normally receives focus by being clicked on or tabbed to.
    
    Returns:
    
    Current canFocus value. Default value is null
    
    See Also:
    
    Focus overview and related methods, Focus & Tabbing Example
  - setCanHover
```
public void setCanHover(java.lang.Boolean canHover)
```
    Will this Canvas fire hover events when the user hovers over it, or one of its children?
    
    Parameters:
    
    canHover - New canHover value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean), HoverEvent
  - getCanHover
```
public java.lang.Boolean getCanHover()
```
    Will this Canvas fire hover events when the user hovers over it, or one of its children?
    
    Returns:
    
    Current canHover value. Default value is null
    
    See Also:
    
    getShowHover(), HoverEvent
  - setCanSelectText
```
public void setCanSelectText(java.lang.Boolean canSelectText)
```
    Whether native drag selection of contained text is allowed within this Canvas.
    Note that setting this property to false will not avoid text selection which is initiated outside this Canvas from continuing into this Canvas, even if text selection began in another Canvas.
    Note : This is an advanced setting
    
    Parameters:
    
    canSelectText - New canSelectText value. Default value is false
  - getCanSelectText
```
public java.lang.Boolean getCanSelectText()
```
    Whether native drag selection of contained text is allowed within this Canvas.
    Note that setting this property to false will not avoid text selection which is initiated outside this Canvas from continuing into this Canvas, even if text selection began in another Canvas.
    
    Returns:
    
    Current canSelectText value. Default value is false
  - getCanvasItem
```
public CanvasItem getCanvasItem()
                         throws java.lang.IllegalStateException
```
    If this canvas is being displayed in a CanvasItem, this property will be set to point at the item. Otherwise this property will be null.
    Note : This method should be called only after the widget has been rendered.
    
    Returns:
    
    Current canvasItem value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - getChildren
```
public Canvas[] getChildren()
```
    Array of all Canvii that are immediate children of this Canvas.
    Use addChild() and removeChild() to add and remove children after a Canvas has been created/drawn.
    
    Returns:
    
    Current children value. Default value is null
    
    See Also:
    
    Containment overview and related methods
  - setChildrenResizeSnapAlign
```
public void setChildrenResizeSnapAlign(java.lang.Boolean childrenResizeSnapAlign)
```
    Flag to disable snapping to alignment when children of this Canvas are resized
    
    Parameters:
    
    childrenResizeSnapAlign - New childrenResizeSnapAlign value. Default value is null
  - getChildrenResizeSnapAlign
```
public java.lang.Boolean getChildrenResizeSnapAlign()
```
    Flag to disable snapping to alignment when children of this Canvas are resized
    
    Returns:
    
    Current childrenResizeSnapAlign value. Default value is null
  - setChildrenSnapAlign
```
public void setChildrenSnapAlign(java.lang.Boolean childrenSnapAlign)
```
    If enabled while childrenSnapToGrid is enabled, children dragged within this Canvas will also snap to positions where their edges or center lines would be aligned with the edges or centers of other components, and lines will be shown to point out the possible alignment (with appearance controlled by snapAlignCenterLineStyle and snapAlignEdgeLineStyle respectively.
    By default, edge- or center-snapping is enabled for all components, but the set of eligible components can be explicitly set via snapAlignCandidates.
    See also childrenSnapCenterAlign and childrenSnapEdgeAlign for enabling or disabling center alignment or edge alignment individually.
    
    Parameters:
    
    childrenSnapAlign - New childrenSnapAlign value. Default value is null
  - getChildrenSnapAlign
```
public java.lang.Boolean getChildrenSnapAlign()
```
    If enabled while childrenSnapToGrid is enabled, children dragged within this Canvas will also snap to positions where their edges or center lines would be aligned with the edges or centers of other components, and lines will be shown to point out the possible alignment (with appearance controlled by snapAlignCenterLineStyle and snapAlignEdgeLineStyle respectively.
    By default, edge- or center-snapping is enabled for all components, but the set of eligible components can be explicitly set via snapAlignCandidates.
    See also childrenSnapCenterAlign and childrenSnapEdgeAlign for enabling or disabling center alignment or edge alignment individually.
    
    Returns:
    
    Current childrenSnapAlign value. Default value is null
  - setChildrenSnapCenterAlign
```
public void setChildrenSnapCenterAlign(java.lang.Boolean childrenSnapCenterAlign)
```
    See childrenSnapAlign. This setting enables or disables snapping on center alignment only.
    
    Parameters:
    
    childrenSnapCenterAlign - New childrenSnapCenterAlign value. Default value is null
  - getChildrenSnapCenterAlign
```
public java.lang.Boolean getChildrenSnapCenterAlign()
```
    See childrenSnapAlign. This setting enables or disables snapping on center alignment only.
    
    Returns:
    
    Current childrenSnapCenterAlign value. Default value is null
  - setChildrenSnapEdgeAlign
```
public void setChildrenSnapEdgeAlign(java.lang.Boolean childrenSnapEdgeAlign)
```
    See childrenSnapAlign. This setting enables or disables snapping on edge alignment only.
    
    Parameters:
    
    childrenSnapEdgeAlign - New childrenSnapEdgeAlign value. Default value is null
  - getChildrenSnapEdgeAlign
```
public java.lang.Boolean getChildrenSnapEdgeAlign()
```
    See childrenSnapAlign. This setting enables or disables snapping on edge alignment only.
    
    Returns:
    
    Current childrenSnapEdgeAlign value. Default value is null
  - setChildrenSnapResizeToGrid
```
public void setChildrenSnapResizeToGrid(java.lang.Boolean childrenSnapResizeToGrid)
```
    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 snapToGrid or snapResizeToGrid value on the child.
    
    Parameters:
    
    childrenSnapResizeToGrid - New childrenSnapResizeToGrid value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - getChildrenSnapResizeToGrid
```
public java.lang.Boolean getChildrenSnapResizeToGrid()
```
    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 snapToGrid or snapResizeToGrid value on the child.
    
    Returns:
    
    Current childrenSnapResizeToGrid value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - setChildrenSnapToGrid
```
public void setChildrenSnapToGrid(java.lang.Boolean childrenSnapToGrid)
```
    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 snapToGrid value on the child.
    
    Parameters:
    
    childrenSnapToGrid - New childrenSnapToGrid value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - getChildrenSnapToGrid
```
public java.lang.Boolean getChildrenSnapToGrid()
```
    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 snapToGrid value on the child.
    
    Returns:
    
    Current childrenSnapToGrid value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - getComponentMask
```
public Canvas getComponentMask()
                        throws java.lang.IllegalStateException
```
    Automatically generated mask canvas displayed when showComponentMask() is called.
    This component is an AutoChild named "componentMask". For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    Current componentMask value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
    
    See Also:
    
    getComponentMaskDefaults()
  - setComponentMaskDefaults
```
public void setComponentMaskDefaults(Canvas componentMaskDefaults)
                              throws java.lang.IllegalStateException
```
    Defaults for the componentMask autoChild. Default properties include backgroundColor being set to "black" and opacity being set to 20.
    
    Parameters:
    
    componentMaskDefaults - New componentMaskDefaults value. Default value is {...}
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    SGWTProperties
  - getComponentMaskDefaults
```
public Canvas getComponentMaskDefaults()
```
    Defaults for the componentMask autoChild. Default properties include backgroundColor being set to "black" and opacity being set to 20.
    
    Returns:
    
    Current componentMaskDefaults value. Default value is {...}
  - setContents
```
public void setContents(java.lang.String contents)
```
    The contents of a canvas or label widget. Any HTML string is acceptable.
    
    If this method is called after the component has been drawn/initialized: Changes the contents of a widget to newContents, an HTML string.
    When dynamicContents is set, setContents() can also be called with no arguments to cause contents to be re-evaluated.
    Note : This is an advanced setting
    
    Parameters:
    
    contents - an HTML string to be set as the contents of this widget. Default value is " "
    
    See Also:
    
    setDynamicContents(java.lang.Boolean), HTMLString
  - getContents
```
public java.lang.String getContents()
```
    The contents of a canvas or label widget. Any HTML string is acceptable.
    
    Returns:
    
    Returns the contents of a Canvas. The contents are an HTML string. Default value is " "
    
    See Also:
    
    getDynamicContents(), HTMLString
  - setContextMenu
```
public void setContextMenu(Menu contextMenu)
```
    Context menu to show for this object, an instance of the Menu widget.
    Note: if destroy() is called on a canvas, any specified context menu is not automatically destroyed as well. This is in contrast to MenuButtons which automatically destroy their specified MenuButton.menu by default. The behavior is intentional as context menus are commonly reused across components.
    Note : This is an advanced setting
    
    Parameters:
    
    contextMenu - New contextMenu value. Default value is null
    
    See Also:
    
    ShowContextMenuEvent, Cues overview and related methods, Context menus Example
  - getContextMenu
```
public Menu getContextMenu()
```
    Context menu to show for this object, an instance of the Menu widget.
    Note: if destroy() is called on a canvas, any specified context menu is not automatically destroyed as well. This is in contrast to MenuButtons which automatically destroy their specified MenuButton.menu by default. The behavior is intentional as context menus are commonly reused across components.
    
    Returns:
    
    Current contextMenu value. Default value is null
    
    See Also:
    
    ShowContextMenuEvent, Cues overview and related methods, Context menus Example
  - setCorrectZoomOverflow
```
public void setCorrectZoomOverflow(java.lang.Boolean correctZoomOverflow)
```
    Whether the Framework should correct for erroneous scrollHeight and scrollWidth values reported by the browser when zoomed (via browser or OS-level zoom) by allowing maxZoomOverflowError of overflow before enabling scrolling and displaying custom scrollbars. Only relevant when overflow is "auto".
    This property is defaulted to true in the Canvas prototype for those browsers where the situation has been observed, except for Firefox, where a better solution is applied that doesn't rely on maxZoomOverflowError and never clips any content. Setting this property false will disable the workaround for all browsers, including Firefox. Without a workaround, scrollbars may oscillate rapidly when the browser or OS is zoomed.
    Note : This is an advanced setting
    
    Parameters:
    
    correctZoomOverflow - New correctZoomOverflow value. Default value is varies
  - getCorrectZoomOverflow
```
public java.lang.Boolean getCorrectZoomOverflow()
```
    Whether the Framework should correct for erroneous scrollHeight and scrollWidth values reported by the browser when zoomed (via browser or OS-level zoom) by allowing maxZoomOverflowError of overflow before enabling scrolling and displaying custom scrollbars. Only relevant when overflow is "auto".
    This property is defaulted to true in the Canvas prototype for those browsers where the situation has been observed, except for Firefox, where a better solution is applied that doesn't rely on maxZoomOverflowError and never clips any content. Setting this property false will disable the workaround for all browsers, including Firefox. Without a workaround, scrollbars may oscillate rapidly when the browser or OS is zoomed.
    
    Returns:
    
    Current correctZoomOverflow value. Default value is varies
  - setCursor
```
public void setCursor(Cursor cursor)
```
    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.
    See also disabledCursor and noDropCursor.
    
    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.
    Note : This is an advanced setting
    
    Parameters:
    
    cursor - new cursor. Default value is Canvas.DEFAULT
    
    See Also:
    
    Cues overview and related methods, Drag create Example, Cursors Example
  - getCursor
```
public Cursor getCursor()
```
    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.
    See also disabledCursor and noDropCursor.
    
    Returns:
    
    Current cursor value. Default value is Canvas.DEFAULT
    
    See Also:
    
    Cues overview and related methods, Drag create Example, Cursors Example
  - setDataPath
```
public void setDataPath(java.lang.String dataPath)
```
    A dataPath may be specified on any canvas. This provides a straightforward way to display or edit complex nested data.
    For components which support displaying or editing data values, (such as DynamicForm or 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.
    To provide a simple example - if a complex object existed with the following format:
```
       Map values = new HashMap();
       values.put("companyName", "Some company");
       Map addressMap = new HashMap();
       addressMap.put("street", "123 Main Street");
       addressMap.put("city", "New York");
       addressMap.put("state", "NY");
       values.put("address", addressMap);
  
```
    a developer could specify a DynamicForm instance with 'dataPath' set to "address" to edit the nested address object:
```
       ValuesManager vm = new ValuesManager();
       Map values = new HashMap();
       values.put("companyName", "Some company");
       Map addressMap = new HashMap();
       addressMap.put("street", "123 Main Street");
       addressMap.put("city", "New York");
       addressMap.put("state", "NY");
       values.put("address", addressMap);
       vm.setValues(values);
 
       DynamicForm form = new DynamicForm();
       form.setValuesManager(vm);
       form.setDataPath("address");  
       TextItem streetField = new TextItem("street");
       TextItem cityField = new TextItem("city");
       TextItem stateField = new TextItem("state");
       form.setItems(streetField, cityField, stateField);
  
```
    If a component is specified with a dataPath 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:
```
       ValuesManager vm = new ValuesManager();
       Map values = new HashMap();
       values.put("companyName", "Some company");
       Map addressMap = new HashMap();
       addressMap.put("street", "123 Main Street");
       addressMap.put("city", "New York");
       addressMap.put("state", "NY");
       values.put("address", addressMap);
       vm.setValues(values);
 
       Layout layout = new Layout();
       layout.setValuesManager(vm);
 
       DynamicForm form = new DynamicForm();
       form.setDataPath("/");  
       TextItem companyNameField = new TextItem("companyName");
       form.setItems(companyNameField);
 
       DynamicForm form1 = new DynamicForm();
       form1.setDataPath("address");  
       TextItem streetField = new TextItem("street");
       TextItem cityField = new TextItem("city");
       TextItem stateField = new TextItem("state");
       form1.setItems(streetField, cityField, stateField);
 
       layout.addMember(form);
       layout.addMember(form1);
  
```
    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.
    dataPaths from multiple nested components may also be combined. For example:
```
       ValuesManager vm = new ValuesManager();
 
       Map values = new HashMap();
       values.put("companyName", "Some company");
       Map addressMap = new HashMap();
       addressMap.put("street", "123 Main Street");
       addressMap.put("city", "New York");
       addressMap.put("state", "NY");
       values.put("address", addressMap);
 
       Map values1 = new HashMap();
       values1.put("companyName", "Some Corporation");
       Map addressMap1 = new HashMap();
       addressMap1.put("street", "1 High Street");
       addressMap1.put("city", "New York");
       addressMap1.put("state", "NY");
       values1.put("address", addressMap1);
       values.put("parentCompany", values1);
 
       vm.setValues(values);
       Layout layout = new Layout();
       layout.setValuesManager(vm);
 
       DynamicForm form = new DynamicForm();
       form.setDataPath("/");  
       TextItem companyNameField = new TextItem("companyName");
       form.setItems(companyNameField);
 
       DynamicForm form1 = new DynamicForm();
       form1.setDataPath("address");  
       TextItem streetField = new TextItem("street");
       TextItem cityField = new TextItem("city");
       TextItem stateField = new TextItem("state");
       form1.setItems(streetField, cityField, stateField);
 
       Layout innerlayout = new Layout();
       innerlayout.setDataPath("parentCompany");
 
       DynamicForm form3 = new DynamicForm();
       form3.setDataPath("");  
       StaticTextItem companyNameField1 = new StaticTextItem("companyName");
       form3.setItems(companyNameField1);
 
       DetailViewer detailViewer = new DetailViewer();
       detailViewer.setDataPath("address");  
       DetailViewerField streetDVField = new DetailViewerField("street");
       DetailViewerField cityDVField = new DetailViewerField("city");
       DetailViewerField stateDVField = new DetailViewerField("state");
       detailViewer.setFields(streetDVField, cityDVField, stateDVField);
 
       innerlayout.addMember(form3);
       innerlayout.addMember(detailViewer);
 
       layout.addMember(form);
       layout.addMember(form1);
       layout.addMember(innerlayout);
  
```
    In this example the detailViewer will display data from the parentCompany.address object within the base record.
    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 component.valuesManager).
    
    Difference between "" and "/" - relative and absolute datapaths
    In the above example, note how the form for entering the "main" company name is given a dataPath of "/", while the form for entering the parent company name is given a dataPath of "". The difference here is exactly the same as you would find in a filesystem path: a dataPath starting with "/" is absolute, so "/" by itself means "root". A dataPath that does not start with "/" is relative, and the empty string indicates that dataPaths for items below this one in the hierarchy should apply the dataPath so far from the hierarchy above.
    If that isn't clear, consider the form for entering the parent company name in the above example. The correct dataPath to the field is /parentCompany/companyName. We have the "parentCompany" part of that path provided by the containing Layout, so we cannot reiterate it on the form itself. However, if we omit the dataPath property altogether, the framework will not seek to apply dataPath at all. So, we specify the empty string, which tells Smart GWT to use dataPath and to retain the portion of the path derived so far from the containment hierarchy.
    One further clarification: relative paths are only different from absolute paths if they are relative to something other than the root. So in the above example, although we specify "/" as the dataPath of the "main" company name form, we would get exactly the same behavior by specifying it as "", because the correct dataPath for the companyName field is "/companyName" - ie, it is relative to the root.
    
    If this method is called after the component has been drawn/initialized: Setter for the 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' parent changes due to a call to addChild(). This method handles automatically binding the component to the appropriate valuesManager if necessary.
    Note : This is an advanced setting
    Parameters:
    
    dataPath - new dataPath. Default value is null
    
    See Also:
    
    DataPath
  - getDataPath
```
public java.lang.String getDataPath()
```
    A dataPath may be specified on any canvas. This provides a straightforward way to display or edit complex nested data.
    For components which support displaying or editing data values, (such as DynamicForm or 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.
    To provide a simple example - if a complex object existed with the following format:
```
       Map values = new HashMap();
       values.put("companyName", "Some company");
       Map addressMap = new HashMap();
       addressMap.put("street", "123 Main Street");
       addressMap.put("city", "New York");
       addressMap.put("state", "NY");
       values.put("address", addressMap);
  
```
    a developer could specify a DynamicForm instance with 'dataPath' set to "address" to edit the nested address object:
```
       ValuesManager vm = new ValuesManager();
       Map values = new HashMap();
       values.put("companyName", "Some company");
       Map addressMap = new HashMap();
       addressMap.put("street", "123 Main Street");
       addressMap.put("city", "New York");
       addressMap.put("state", "NY");
       values.put("address", addressMap);
       vm.setValues(values);
 
       DynamicForm form = new DynamicForm();
       form.setValuesManager(vm);
       form.setDataPath("address");  
       TextItem streetField = new TextItem("street");
       TextItem cityField = new TextItem("city");
       TextItem stateField = new TextItem("state");
       form.setItems(streetField, cityField, stateField);
  
```
    If a component is specified with a dataPath 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:
```
       ValuesManager vm = new ValuesManager();
       Map values = new HashMap();
       values.put("companyName", "Some company");
       Map addressMap = new HashMap();
       addressMap.put("street", "123 Main Street");
       addressMap.put("city", "New York");
       addressMap.put("state", "NY");
       values.put("address", addressMap);
       vm.setValues(values);
 
       Layout layout = new Layout();
       layout.setValuesManager(vm);
 
       DynamicForm form = new DynamicForm();
       form.setDataPath("/");  
       TextItem companyNameField = new TextItem("companyName");
       form.setItems(companyNameField);
 
       DynamicForm form1 = new DynamicForm();
       form1.setDataPath("address");  
       TextItem streetField = new TextItem("street");
       TextItem cityField = new TextItem("city");
       TextItem stateField = new TextItem("state");
       form1.setItems(streetField, cityField, stateField);
 
       layout.addMember(form);
       layout.addMember(form1);
  
```
    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.
    dataPaths from multiple nested components may also be combined. For example:
```
       ValuesManager vm = new ValuesManager();
 
       Map values = new HashMap();
       values.put("companyName", "Some company");
       Map addressMap = new HashMap();
       addressMap.put("street", "123 Main Street");
       addressMap.put("city", "New York");
       addressMap.put("state", "NY");
       values.put("address", addressMap);
 
       Map values1 = new HashMap();
       values1.put("companyName", "Some Corporation");
       Map addressMap1 = new HashMap();
       addressMap1.put("street", "1 High Street");
       addressMap1.put("city", "New York");
       addressMap1.put("state", "NY");
       values1.put("address", addressMap1);
       values.put("parentCompany", values1);
 
       vm.setValues(values);
       Layout layout = new Layout();
       layout.setValuesManager(vm);
 
       DynamicForm form = new DynamicForm();
       form.setDataPath("/");  
       TextItem companyNameField = new TextItem("companyName");
       form.setItems(companyNameField);
 
       DynamicForm form1 = new DynamicForm();
       form1.setDataPath("address");  
       TextItem streetField = new TextItem("street");
       TextItem cityField = new TextItem("city");
       TextItem stateField = new TextItem("state");
       form1.setItems(streetField, cityField, stateField);
 
       Layout innerlayout = new Layout();
       innerlayout.setDataPath("parentCompany");
 
       DynamicForm form3 = new DynamicForm();
       form3.setDataPath("");  
       StaticTextItem companyNameField1 = new StaticTextItem("companyName");
       form3.setItems(companyNameField1);
 
       DetailViewer detailViewer = new DetailViewer();
       detailViewer.setDataPath("address");  
       DetailViewerField streetDVField = new DetailViewerField("street");
       DetailViewerField cityDVField = new DetailViewerField("city");
       DetailViewerField stateDVField = new DetailViewerField("state");
       detailViewer.setFields(streetDVField, cityDVField, stateDVField);
 
       innerlayout.addMember(form3);
       innerlayout.addMember(detailViewer);
 
       layout.addMember(form);
       layout.addMember(form1);
       layout.addMember(innerlayout);
  
```
    In this example the detailViewer will display data from the parentCompany.address object within the base record.
    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 component.valuesManager).
    
    Difference between "" and "/" - relative and absolute datapaths
    In the above example, note how the form for entering the "main" company name is given a dataPath of "/", while the form for entering the parent company name is given a dataPath of "". The difference here is exactly the same as you would find in a filesystem path: a dataPath starting with "/" is absolute, so "/" by itself means "root". A dataPath that does not start with "/" is relative, and the empty string indicates that dataPaths for items below this one in the hierarchy should apply the dataPath so far from the hierarchy above.
    If that isn't clear, consider the form for entering the parent company name in the above example. The correct dataPath to the field is /parentCompany/companyName. We have the "parentCompany" part of that path provided by the containing Layout, so we cannot reiterate it on the form itself. However, if we omit the dataPath property altogether, the framework will not seek to apply dataPath at all. So, we specify the empty string, which tells Smart GWT to use dataPath and to retain the portion of the path derived so far from the containment hierarchy.
    One further clarification: relative paths are only different from absolute paths if they are relative to something other than the root. So in the above example, although we specify "/" as the dataPath of the "main" company name form, we would get exactly the same behavior by specifying it as "", because the correct dataPath for the companyName field is "/companyName" - ie, it is relative to the root.
    Returns:
    
    Current dataPath value. Default value is null
    
    See Also:
    
    DataPath
  - setDefaultHeight
```
public void setDefaultHeight(int defaultHeight)
```
    For custom components, establishes a default height for the component.
    For a component that should potentially be sized automatically by a Layout, set this property rather than height directly, because Layouts regard a height setting as an explicit size that shouldn't be changed.
    Note : This is an advanced setting
    
    Parameters:
    
    defaultHeight - New defaultHeight value. Default value is 100
    
    See Also:
    
    Sizing overview and related methods
  - getDefaultHeight
```
public int getDefaultHeight()
```
    For custom components, establishes a default height for the component.
    For a component that should potentially be sized automatically by a Layout, set this property rather than height directly, because Layouts regard a height setting as an explicit size that shouldn't be changed.
    
    Returns:
    
    Current defaultHeight value. Default value is 100
    
    See Also:
    
    Sizing overview and related methods
  - setDefaultWidth
```
public void setDefaultWidth(int defaultWidth)
```
    For custom components, establishes a default width for the component.
    For a component that should potentially be sized automatically by a Layout, set this property rather than width directly, because Layouts regard a width setting as an explicit size that shouldn't be changed.
    Note : This is an advanced setting
    
    Parameters:
    
    defaultWidth - New defaultWidth value. Default value is 100
    
    See Also:
    
    Sizing overview and related methods
  - getDefaultWidth
```
public int getDefaultWidth()
```
    For custom components, establishes a default width for the component.
    For a component that should potentially be sized automatically by a Layout, set this property rather than width directly, because Layouts regard a width setting as an explicit size that shouldn't be changed.
    
    Returns:
    
    Current defaultWidth value. Default value is 100
    
    See Also:
    
    Sizing overview and related methods
  - getDestroyed
```
public java.lang.Boolean getDestroyed()
                               throws java.lang.IllegalStateException
```
    If this property is set to true, the 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.
    Note : This method should be called only after the widget has been rendered.
    
    Returns:
    
    Current destroyed value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
    
    See Also:
    
    BaseWidget.destroy()
  - getDestroying
```
public java.lang.Boolean getDestroying()
                                throws java.lang.IllegalStateException
```
    This property is set to true when the destroy() method is called on a widget. If this property is true, but destroyed is not, this indicates the canvas is in the process of being destroyed.
    Note : This method should be called only after the widget has been rendered.
    
    Returns:
    
    Current destroying value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
    
    See Also:
    
    BaseWidget.destroy()
  - setDisabledCursor
```
public void setDisabledCursor(Cursor disabledCursor)
```
    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.
    Note : This is an advanced setting
    
    Parameters:
    
    disabledCursor - New disabledCursor value. Default value is Canvas.DEFAULT
    
    See Also:
    
    Cues overview and related methods
  - getDisabledCursor
```
public Cursor getDisabledCursor()
```
    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.
    
    Returns:
    
    Current disabledCursor value. Default value is Canvas.DEFAULT
    
    See Also:
    
    Cues overview and related methods
  - setDisableTouchScrollingForDrag
```
public void setDisableTouchScrollingForDrag(java.lang.Boolean disableTouchScrollingForDrag)
                                     throws java.lang.IllegalStateException
```
    Disables useTouchScrolling whenever a built-in drag operation has been enabled which is known to be non-functional if touch scrolling is enabled. Default behavior is to leave touch scrolling enabled even if it makes other enabled drag operations non-functional, since any accessible application must provide an alternative way to perform drag and drop operations anyway.
    disableTouchScrollingForDrag exists so that applications can change the default setting on a per-component basis (via setDefaultProperties), in order to make a system-wide or per-component-type decision about whether to favor touch scrolling vs retaining the ability to drag and drop via finger drags, instead of having to set useTouchScrolling on each individual instance.
    See the Mobile Development overview for more background information.
    
    Parameters:
    
    disableTouchScrollingForDrag - New disableTouchScrollingForDrag value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Scrolling overview and related methods
  - getDisableTouchScrollingForDrag
```
public java.lang.Boolean getDisableTouchScrollingForDrag()
```
    Disables useTouchScrolling whenever a built-in drag operation has been enabled which is known to be non-functional if touch scrolling is enabled. Default behavior is to leave touch scrolling enabled even if it makes other enabled drag operations non-functional, since any accessible application must provide an alternative way to perform drag and drop operations anyway.
    disableTouchScrollingForDrag exists so that applications can change the default setting on a per-component basis (via setDefaultProperties), in order to make a system-wide or per-component-type decision about whether to favor touch scrolling vs retaining the ability to drag and drop via finger drags, instead of having to set useTouchScrolling on each individual instance.
    See the Mobile Development overview for more background information.
    
    Returns:
    
    Current disableTouchScrollingForDrag value. Default value is null
    
    See Also:
    
    Scrolling overview and related methods
  - setDoubleClickDelay
```
public void setDoubleClickDelay(int doubleClickDelay)
```
    Amount of time (in milliseconds) between which two clicks are considered a single click
    Note : This is an advanced setting
    
    Parameters:
    
    doubleClickDelay - New doubleClickDelay value. Default value is 250
  - getDoubleClickDelay
```
public int getDoubleClickDelay()
```
    Amount of time (in milliseconds) between which two clicks are considered a single click
    
    Returns:
    
    Current doubleClickDelay value. Default value is 250
  - setDragAppearance
```
public void setDragAppearance(DragAppearance dragAppearance)
```
    Visual appearance to show when the object is being dragged. May be overridden for dragResize or dragReposition events via dragResizeAppearance and dragRepositionAppearance.
    Note : This is an advanced setting
    
    Parameters:
    
    dragAppearance - New dragAppearance value. Default value is EventHandler.OUTLINE
    
    See Also:
    
    Dragdrop overview and related methods
  - getDragAppearance
```
public DragAppearance getDragAppearance()
```
    Visual appearance to show when the object is being dragged. May be overridden for dragResize or dragReposition events via dragResizeAppearance and dragRepositionAppearance.
    
    Returns:
    
    Current dragAppearance value. Default value is EventHandler.OUTLINE
    
    See Also:
    
    Dragdrop overview and related methods
  - setDragIntersectStyle
```
public void setDragIntersectStyle(DragIntersectStyle dragIntersectStyle)
```
    This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection with the rectangle of the dragMoveTarget.
    Note : This is an advanced setting
    
    Parameters:
    
    dragIntersectStyle - New dragIntersectStyle value. Default value is "mouse"
    
    See Also:
    
    Dragdrop overview and related methods
  - getDragIntersectStyle
```
public DragIntersectStyle getDragIntersectStyle()
```
    This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection with the rectangle of the dragMoveTarget.
    
    Returns:
    
    Current dragIntersectStyle value. Default value is "mouse"
    
    See Also:
    
    Dragdrop overview and related methods
  - setDragMaskType
```
public void setDragMaskType(DragMaskType dragMaskType)
```
    This property controls what kind of mask is used in case useDragMask is enabled.
    
    Parameters:
    
    dragMaskType - New dragMaskType value. Default value is "div"
    
    See Also:
    
    Dragdrop overview and related methods
  - getDragMaskType
```
public DragMaskType getDragMaskType()
```
    This property controls what kind of mask is used in case useDragMask is enabled.
    
    Returns:
    
    Current dragMaskType value. Default value is "div"
    
    See Also:
    
    Dragdrop overview and related methods
  - setDragMaxHeight
```
public void setDragMaxHeight(int dragMaxHeight)
```
    Sets maximum height that this Canvas can be resized to by a user. Actual limit will be minimum of dragMaxHeight and maxHeight.
    Note : This is an advanced setting
    
    Parameters:
    
    dragMaxHeight - New dragMaxHeight value. Default value is 10000
    
    See Also:
    
    Sizing overview and related methods
  - getDragMaxHeight
```
public int getDragMaxHeight()
```
    Sets maximum height that this Canvas can be resized to by a user. Actual limit will be minimum of dragMaxHeight and maxHeight.
    
    Returns:
    
    Current dragMaxHeight value. Default value is 10000
    
    See Also:
    
    Sizing overview and related methods
  - setDragMaxWidth
```
public void setDragMaxWidth(int dragMaxWidth)
```
    Maximum width that this Canvas can be resized to by a user. Actual limit will be minimum of dragMaxWidth and maxWidth.
    Note : This is an advanced setting
    
    Parameters:
    
    dragMaxWidth - New dragMaxWidth value. Default value is 10000
    
    See Also:
    
    Sizing overview and related methods
  - getDragMaxWidth
```
public int getDragMaxWidth()
```
    Maximum width that this Canvas can be resized to by a user. Actual limit will be minimum of dragMaxWidth and maxWidth.
    
    Returns:
    
    Current dragMaxWidth value. Default value is 10000
    
    See Also:
    
    Sizing overview and related methods
  - setDragMinHeight
```
public void setDragMinHeight(int dragMinHeight)
```
    Minimum height that this Canvas can be resized to by a user. See dragMinWidth for details of behavior.
    Note : This is an advanced setting
    
    Parameters:
    
    dragMinHeight - New dragMinHeight value. Default value is 10
    
    See Also:
    
    setMinHeight(int), Sizing overview and related methods
  - getDragMinHeight
```
public int getDragMinHeight()
```
    Minimum height that this Canvas can be resized to by a user. See dragMinWidth for details of behavior.
    
    Returns:
    
    Current dragMinHeight value. Default value is 10
    
    See Also:
    
    getMinHeight(), Sizing overview and related methods
  - setDragMinWidth
```
public void setDragMinWidth(int dragMinWidth)
```
    Minimum width that this Canvas can be resized to by a user. Actual limit will be maximum of dragMinWidth and minWidth.
    Note that a Canvas with overflow:"visible" has an implicit minimize size based on it's contents.
    Note that dragMinWidth affects only user-initiated drag resizes. To set the minimum width of a Canvas embedded in a Layout, you can set +{minWidth}, or Layout.minMemberLength to constrain the minimum size along the length axis of all members of the Layout.
    Note : This is an advanced setting
    
    Parameters:
    
    dragMinWidth - New dragMinWidth value. Default value is 10
    
    See Also:
    
    Sizing overview and related methods
  - getDragMinWidth
```
public int getDragMinWidth()
```
    Minimum width that this Canvas can be resized to by a user. Actual limit will be maximum of dragMinWidth and minWidth.
    Note that a Canvas with overflow:"visible" has an implicit minimize size based on it's contents.
    Note that dragMinWidth affects only user-initiated drag resizes. To set the minimum width of a Canvas embedded in a Layout, you can set +{minWidth}, or Layout.minMemberLength to constrain the minimum size along the length axis of all members of the Layout.
    
    Returns:
    
    Current dragMinWidth value. Default value is 10
    
    See Also:
    
    Sizing overview and related methods
  - setDragOpacity
```
public void setDragOpacity(java.lang.Integer dragOpacity)
```
    If this widget has dragAppearance "target", this value specifies the opacity to render the target while it is being dragged. A null value implies we do not modify the opacity.
    Note : This is an advanced setting
    
    Parameters:
    
    dragOpacity - New dragOpacity value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag effects Example
  - getDragOpacity
```
public java.lang.Integer getDragOpacity()
```
    If this widget has dragAppearance "target", this value specifies the opacity to render the target while it is being dragged. A null value implies we do not modify the opacity.
    
    Returns:
    
    Current dragOpacity value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag effects Example
  - setDragRepositionAppearance
```
public void setDragRepositionAppearance(DragAppearance dragRepositionAppearance)
```
    If canDragReposition is true, this attributes specifies the visual appearance to show during drag reposition. If unset dragAppearance will be used.
    Note : This is an advanced setting
    
    Parameters:
    
    dragRepositionAppearance - New dragRepositionAppearance value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - getDragRepositionAppearance
```
public DragAppearance getDragRepositionAppearance()
```
    If canDragReposition is true, this attributes specifies the visual appearance to show during drag reposition. If unset dragAppearance will be used.
    
    Returns:
    
    Current dragRepositionAppearance value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - setDragRepositionCursor
```
public void setDragRepositionCursor(Cursor dragRepositionCursor)
```
    Cursor to switch to if the mouse is over a widget that is drag repositionable.
    Note : This is an advanced setting
    
    Parameters:
    
    dragRepositionCursor - New dragRepositionCursor value. Default value is Canvas.MOVE
    
    See Also:
    
    Dragdrop overview and related methods
  - getDragRepositionCursor
```
public Cursor getDragRepositionCursor()
```
    Cursor to switch to if the mouse is over a widget that is drag repositionable.
    
    Returns:
    
    Current dragRepositionCursor value. Default value is Canvas.MOVE
    
    See Also:
    
    Dragdrop overview and related methods
  - setDragResizeAppearance
```
public void setDragResizeAppearance(DragAppearance dragResizeAppearance)
```
    If canDragResize is true, this attributes specifies the visual appearance to show during drag resize. If unset dragAppearance will be used.
    Note : This is an advanced setting
    
    Parameters:
    
    dragResizeAppearance - New dragResizeAppearance value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - getDragResizeAppearance
```
public DragAppearance getDragResizeAppearance()
```
    If canDragResize is true, this attributes specifies the visual appearance to show during drag resize. If unset dragAppearance will be used.
    
    Returns:
    
    Current dragResizeAppearance value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - setDragScrollDelay
```
public void setDragScrollDelay(int dragScrollDelay)
```
    If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the drag-scroll threshold before scrolling begins.
    Note : This is an advanced setting
    
    Parameters:
    
    dragScrollDelay - New dragScrollDelay value. Default value is 100
  - getDragScrollDelay
```
public int getDragScrollDelay()
```
    If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the drag-scroll threshold before scrolling begins.
    
    Returns:
    
    Current dragScrollDelay value. Default value is 100
  - setDragStartDistance
```
public void setDragStartDistance(int dragStartDistance)
```
    Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
    Note : This is an advanced setting
    
    Parameters:
    
    dragStartDistance - New dragStartDistance value. Default value is 5
    
    See Also:
    
    Dragdrop overview and related methods
  - getDragStartDistance
```
public int getDragStartDistance()
```
    Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
    
    Returns:
    
    Current dragStartDistance value. Default value is 5
    
    See Also:
    
    Dragdrop overview and related methods
  - setDragType
```
public void setDragType(java.lang.String dragType)
```
    Sets a dragType for this widget used, to be compared to dropTypes on possible drop target widgets. See dropTypes for a full explanation.
    Note : This is an advanced setting
    
    Parameters:
    
    dragType - New dragType value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - getDragType
```
public java.lang.String getDragType()
```
    Sets a dragType for this widget used, to be compared to dropTypes on possible drop target widgets. See dropTypes for a full explanation.
    
    Returns:
    
    Current dragType value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - setDropTypes
```
public void setDropTypes(java.lang.String... dropTypes)
```
    When a drag and drop interaction occurs, if a dragType is configured on the source widget, it is compared to the dropTypes configured on the target widget, and a drop is only allowed if the dragType is listed in the target widget's dropTypes array.
    The default setting means any dragType is eligible for dropping on this widget, including no dragType setting.
    See also willAcceptDrop() for dynamic determination of drop eligibility.
    Note : This is an advanced setting
    
    Parameters:
    
    dropTypes - New dropTypes value. Default value is Canvas.ANYTHING
    
    See Also:
    
    Dragdrop overview and related methods
  - getDropTypes
```
public java.lang.String[] getDropTypes()
```
    When a drag and drop interaction occurs, if a dragType is configured on the source widget, it is compared to the dropTypes configured on the target widget, and a drop is only allowed if the dragType is listed in the target widget's dropTypes array.
    The default setting means any dragType is eligible for dropping on this widget, including no dragType setting.
    See also willAcceptDrop() for dynamic determination of drop eligibility.
    
    Returns:
    
    Current dropTypes value. Default value is Canvas.ANYTHING
    
    See Also:
    
    Dragdrop overview and related methods
  - setDropTypes
```
public void setDropTypes(java.lang.String dropTypes)
```
    When a drag and drop interaction occurs, if a dragType is configured on the source widget, it is compared to the dropTypes configured on the target widget, and a drop is only allowed if the dragType is listed in the target widget's dropTypes array.
    The default setting means any dragType is eligible for dropping on this widget, including no dragType setting.
    See also willAcceptDrop() for dynamic determination of drop eligibility.
    Note : This is an advanced setting
    
    Parameters:
    
    dropTypes - New dropTypes value. Default value is Canvas.ANYTHING
    
    See Also:
    
    Dragdrop overview and related methods
  - getDropTypesAsString
```
public java.lang.String getDropTypesAsString()
```
    When a drag and drop interaction occurs, if a dragType is configured on the source widget, it is compared to the dropTypes configured on the target widget, and a drop is only allowed if the dragType is listed in the target widget's dropTypes array.
    The default setting means any dragType is eligible for dropping on this widget, including no dragType setting.
    See also willAcceptDrop() for dynamic determination of drop eligibility.
    
    Returns:
    
    Current dropTypes value. Default value is Canvas.ANYTHING
    
    See Also:
    
    Dragdrop overview and related methods
  - setDynamicContents
```
public void setDynamicContents(java.lang.Boolean dynamicContents)
```
    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.
    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:
    "The slider value is ${sliderInstance.getValue()}."
    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:
```
  Slider.create({
      ID: "mySlider"
  });
 
  Canvas.create({
      ID: "myCanvas",
      dynamicContents: true,
      contents: "The slider value is ${mySlider.getValue()}."
  });
 
  myCanvas.observe(mySlider, "valueChanged",
                   "observer.markForRedraw()");
  
```
    You can embed an arbitrary number of dynamic expressions in the contents string. The search and replace is optimized for speed.
    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.
    The value of a function is its return value. The value of any variable is the same as that returned by its toString() representation.
    Inside the evaluation contentext, this 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.
    Note : This is an advanced setting
    Parameters:
    
    dynamicContents - New dynamicContents value. Default value is false
    
    See Also:
    
    setContents(java.lang.String), com.smartgwt.client.widgets.Canvas#setDynamicContentsVars
  - getDynamicContents
```
public java.lang.Boolean getDynamicContents()
```
    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.
    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:
    "The slider value is ${sliderInstance.getValue()}."
    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:
```
  Slider.create({
      ID: "mySlider"
  });
 
  Canvas.create({
      ID: "myCanvas",
      dynamicContents: true,
      contents: "The slider value is ${mySlider.getValue()}."
  });
 
  myCanvas.observe(mySlider, "valueChanged",
                   "observer.markForRedraw()");
  
```
    You can embed an arbitrary number of dynamic expressions in the contents string. The search and replace is optimized for speed.
    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.
    The value of a function is its return value. The value of any variable is the same as that returned by its toString() representation.
    Inside the evaluation contentext, this 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.
    Returns:
    
    Current dynamicContents value. Default value is false
    
    See Also:
    
    getContents(), com.smartgwt.client.widgets.Canvas#getDynamicContentsVars
  - setEdgeBackgroundColor
```
public void setEdgeBackgroundColor(java.lang.String edgeBackgroundColor)
                            throws java.lang.IllegalStateException
```
    Background color for the EdgedCanvas created to decorate this component. This can be used to provide an underlying "tint" color for translucent edge media
    
    Parameters:
    
    edgeBackgroundColor - New edgeBackgroundColor value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    CSSColor
  - getEdgeBackgroundColor
```
public java.lang.String getEdgeBackgroundColor()
```
    Background color for the EdgedCanvas created to decorate this component. This can be used to provide an underlying "tint" color for translucent edge media
    
    Returns:
    
    Current edgeBackgroundColor value. Default value is null
    
    See Also:
    
    CSSColor
  - setEdgeCenterBackgroundColor
```
public void setEdgeCenterBackgroundColor(java.lang.String edgeCenterBackgroundColor)
                                  throws java.lang.IllegalStateException
```
    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.
    
    Parameters:
    
    edgeCenterBackgroundColor - New edgeCenterBackgroundColor value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    CSSColor
  - getEdgeCenterBackgroundColor
```
public java.lang.String getEdgeCenterBackgroundColor()
```
    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.
    
    Returns:
    
    Current edgeCenterBackgroundColor value. Default value is null
    
    See Also:
    
    CSSColor
  - setEdgeImage
```
public void setEdgeImage(java.lang.String edgeImage)
                  throws java.lang.IllegalStateException
```
    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".
    The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".
    
    Parameters:
    
    edgeImage - New edgeImage value. Default value is "[SKIN]edge.gif"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    SCImgURL, Edges Example
  - getEdgeImage
```
public java.lang.String getEdgeImage()
```
    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".
    The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".
    
    Returns:
    
    Current edgeImage value. Default value is "[SKIN]edge.gif"
    
    See Also:
    
    SCImgURL, Edges Example
  - setEdgeMarginSize
```
public void setEdgeMarginSize(int edgeMarginSize)
```
    How far into the edge of an object do we consider the "edge" for drag resize purposes?
    Note : This is an advanced setting
    
    Parameters:
    
    edgeMarginSize - New edgeMarginSize value. Default value is 5
    
    See Also:
    
    Dragdrop overview and related methods, Drag resize Example
  - getEdgeMarginSize
```
public int getEdgeMarginSize()
```
    How far into the edge of an object do we consider the "edge" for drag resize purposes?
    
    Returns:
    
    Current edgeMarginSize value. Default value is 5
    
    See Also:
    
    Dragdrop overview and related methods, Drag resize Example
  - setEdgeOffset
```
public void setEdgeOffset(java.lang.Integer edgeOffset)
                   throws java.lang.IllegalStateException
```
    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.
    
    Parameters:
    
    edgeOffset - New edgeOffset value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Corners Example
  - getEdgeOffset
```
public java.lang.Integer getEdgeOffset()
```
    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.
    
    Returns:
    
    Current edgeOffset value. Default value is null
    
    See Also:
    
    Corners Example
  - setEdgeOpacity
```
public void setEdgeOpacity(java.lang.Integer edgeOpacity)
                    throws java.lang.IllegalStateException
```
    Opacity of the edges. Defaults to matching this.opacity. if 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)
    
    If this method is called after the component has been drawn/initialized: Set the edgeOpacity and mark the canvas for redraw
    
    Parameters:
    
    edgeOpacity - new edge-opacity level. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Edges Example
  - getEdgeOpacity
```
public java.lang.Integer getEdgeOpacity()
```
    Opacity of the edges. Defaults to matching this.opacity. if 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)
    
    Returns:
    
    Current edgeOpacity value. Default value is null
    
    See Also:
    
    Edges Example
  - setEdgeShowCenter
```
public void setEdgeShowCenter(java.lang.Boolean edgeShowCenter)
                       throws java.lang.IllegalStateException
```
    Whether to show media in the center section, that is, behind the decorated Canvas.
    
    Parameters:
    
    edgeShowCenter - New edgeShowCenter value. Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Corners Example
  - getEdgeShowCenter
```
public java.lang.Boolean getEdgeShowCenter()
```
    Whether to show media in the center section, that is, behind the decorated Canvas.
    
    Returns:
    
    Current edgeShowCenter value. Default value is false
    
    See Also:
    
    Corners Example
  - setEdgeSize
```
public void setEdgeSize(int edgeSize)
                 throws java.lang.IllegalStateException
```
    Size in pixels for corners and edges
    
    Parameters:
    
    edgeSize - New edgeSize value. Default value is 10
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Edges Example
  - getEdgeSize
```
public int getEdgeSize()
```
    Size in pixels for corners and edges
    
    Returns:
    
    Current edgeSize value. Default value is 10
    
    See Also:
    
    Edges Example
  - getEditNode
```
public EditNode getEditNode()
                     throws java.lang.IllegalStateException
```
    The component's EditNode for a component that has been created by a Palette from a PaletteNode.
    Note : This method should be called only after the widget has been rendered.
    
    Returns:
    
    Current editNode value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - getEditProxy
```
public EditProxy getEditProxy()
                       throws java.lang.IllegalStateException
```
    An EditProxy controls the behaviors of a component when it is placed into editing mode.
    The editProxy AutoChild is created when a component is first placed into edit mode via setEditMode().
    editProxy properties can be supplied on a PaletteNode or EditNode as editProxyProperties, but must be provided before the component is first placed into edit mode.
    Most editable components use a custom EditProxy. See the documentation for each class' editProxyConstructor to determine the class.
    This component is an AutoChild named "editProxy". For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    Current editProxy value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
    
    See Also:
    
    setEditMode(boolean)
  - setEditProxyConstructor
```
public void setEditProxyConstructor(java.lang.String editProxyConstructor)
                             throws java.lang.IllegalStateException
```
    Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
    
    Parameters:
    
    editProxyConstructor - New editProxyConstructor value. Default value is "CanvasEditProxy"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    SCClassName
  - getEditProxyConstructor
```
public java.lang.String getEditProxyConstructor()
```
    Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
    
    Returns:
    
    Current editProxyConstructor value. Default value is "CanvasEditProxy"
    
    See Also:
    
    SCClassName
  - setEnableWhen
```
public void setEnableWhen(AdvancedCriteria enableWhen)
                   throws java.lang.IllegalStateException
```
    Criteria to be evaluated to determine whether this Canvas should be enabled. Re-evaluated whenever data in the ruleScope changes.
    A basic criteria uses textMatchStyle:"exact". When specified in Component XML this property allows shorthand formats for defining criteria.
    
    Parameters:
    
    enableWhen - New enableWhen value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    RuleCriteria overview and related methods
  - getEnableWhen
```
public AdvancedCriteria getEnableWhen()
```
    Criteria to be evaluated to determine whether this Canvas should be enabled. Re-evaluated whenever data in the ruleScope changes.
    A basic criteria uses textMatchStyle:"exact". When specified in Component XML this property allows shorthand formats for defining criteria.
    
    Returns:
    
    Current enableWhen value. Default value is null
    
    See Also:
    
    RuleCriteria overview and related methods
  - setEndLine
```
public void setEndLine(java.lang.Boolean endLine)
```
    Whether this canvas should end the line it's in when used as a tile in a FlowLayout. This property is not supported in a TileLayout with TileLayout.layoutPolicy: "fit" or if databound (i.e.TileGrid).
    
    Parameters:
    
    endLine - New endLine value. Default value is false
    
    See Also:
    
    TileLayout.setAutoWrapLines(java.lang.Boolean)
  - getEndLine
```
public java.lang.Boolean getEndLine()
```
    Whether this canvas should end the line it's in when used as a tile in a FlowLayout. This property is not supported in a TileLayout with TileLayout.layoutPolicy: "fit" or if databound (i.e.TileGrid).
    
    Returns:
    
    Current endLine value. Default value is false
    
    See Also:
    
    TileLayout.getAutoWrapLines()
  - setExtraSpace
```
public void setExtraSpace(int extraSpace)
                   throws java.lang.IllegalStateException
```
    When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a Layout.
    
    Parameters:
    
    extraSpace - New extraSpace value. Default value is 0
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    LayoutSpacer, LayoutMember overview and related methods
  - getExtraSpace
```
public int getExtraSpace()
```
    When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a Layout.
    
    Returns:
    
    Current extraSpace value. Default value is 0
    
    See Also:
    
    LayoutSpacer, LayoutMember overview and related methods
  - setGroupBorderCSS
```
public void setGroupBorderCSS(java.lang.String groupBorderCSS)
                       throws java.lang.IllegalStateException
```
    Sets the style for the grouping frame around the canvas. Only necessary when isGroup is set to true.
    
    Parameters:
    
    groupBorderCSS - New groupBorderCSS value. Default value is "2px solid black"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Appearance overview and related methods
  - getGroupBorderCSS
```
public java.lang.String getGroupBorderCSS()
```
    Sets the style for the grouping frame around the canvas. Only necessary when isGroup is set to true.
    
    Returns:
    
    Current groupBorderCSS value. Default value is "2px solid black"
    
    See Also:
    
    Appearance overview and related methods
  - setGroupLabelBackgroundColor
```
public void setGroupLabelBackgroundColor(java.lang.String groupLabelBackgroundColor)
```
    If set, the background color of the grouping label. Only applicable when isGroup is set to true.
    This corresponds to the CSS background-color property on the grouping label. 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.
    The getter for this attribute, getGroupLabelBackgroundColor(), returns the color that will actually be used; i.e. if groupLabelBackgroundColor is left unset or is set to null, then getGroupLabelBackgroundColor() returns the color string that will be used.
    
    If this method is called after the component has been drawn/initialized: Setter for groupLabelBackgroundColor.
    
    Parameters:
    
    groupLabelBackgroundColor - the new grouping label background color. Default value is null
    
    See Also:
    
    CSSColor, Appearance overview and related methods
  - getGroupLabelBackgroundColor
```
public java.lang.String getGroupLabelBackgroundColor()
```
    If set, the background color of the grouping label. Only applicable when isGroup is set to true.
    This corresponds to the CSS background-color property on the grouping label. 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.
    The getter for this attribute, getGroupLabelBackgroundColor(), returns the color that will actually be used; i.e. if groupLabelBackgroundColor is left unset or is set to null, then getGroupLabelBackgroundColor() returns the color string that will be used.
    
    Returns:
    
    Current groupLabelBackgroundColor value. Default value is null
    
    See Also:
    
    CSSColor, Appearance overview and related methods
  - setGroupLabelStyleName
```
public void setGroupLabelStyleName(java.lang.String groupLabelStyleName)
                            throws java.lang.IllegalStateException
```
    Sets the style for the grouping label. Only necessary when isGroup is set to true.
    Note that groupLabelBackgroundColor overrides any background-color of this style.
    
    Parameters:
    
    groupLabelStyleName - New groupLabelStyleName value. Default value is "groupLabel"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    CSSStyleName, Appearance overview and related methods
  - getGroupLabelStyleName
```
public java.lang.String getGroupLabelStyleName()
```
    Sets the style for the grouping label. Only necessary when isGroup is set to true.
    Note that groupLabelBackgroundColor overrides any background-color of this style.
    
    Returns:
    
    Current groupLabelStyleName value. Default value is "groupLabel"
    
    See Also:
    
    CSSStyleName, Appearance overview and related methods
  - setGroupTitle
```
public void setGroupTitle(java.lang.String groupTitle)
```
    The title/label for the grouping. Only applicable when isGroup is set to true.
    
    If this method is called after the component has been drawn/initialized: Setter for groupTitle.
    
    Parameters:
    
    groupTitle - The new title for the grouping. Default value is null
    
    See Also:
    
    HTMLString, Appearance overview and related methods
  - getGroupTitle
```
public java.lang.String getGroupTitle()
```
    The title/label for the grouping. Only applicable when isGroup is set to true.
    
    Returns:
    
    Current groupTitle value. Default value is null
    
    See Also:
    
    HTMLString, Appearance overview and related methods
  - setHeight
```
public void setHeight(java.lang.Integer height)
```
    Size for this component's vertical dimension.
    Can be a number of pixels, or a percentage like "50%". See documentation for width for details on how percentage values are resolved actual size.
    Note that if overflow is set to "visible", this size is a minimum, and the component may overflow to show all content and/or children.
    If trying to establish a default height for a custom component, set defaultHeight instead.
    
    If this method is called after the component has been drawn/initialized: 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.
    NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
    
    Parameters:
    
    height - new height. Default value is null
    
    See Also:
    
    Sizing overview and related methods
  - getHeight
```
public java.lang.Integer getHeight()
```
    Size for this component's vertical dimension.
    Can be a number of pixels, or a percentage like "50%". See documentation for width for details on how percentage values are resolved actual size.
    Note that if overflow is set to "visible", this size is a minimum, and the component may overflow to show all content and/or children.
    If trying to establish a default height for a custom component, set defaultHeight instead.
    
    Returns:
    
    Return the height of this object, in pixels. Default value is null
    
    See Also:
    
    Sizing overview and related methods
  - setHeight
```
public void setHeight(java.lang.String height)
```
    Size for this component's vertical dimension.
    Can be a number of pixels, or a percentage like "50%". See documentation for width for details on how percentage values are resolved actual size.
    Note that if overflow is set to "visible", this size is a minimum, and the component may overflow to show all content and/or children.
    If trying to establish a default height for a custom component, set defaultHeight instead.
    
    If this method is called after the component has been drawn/initialized: 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.
    NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
    
    Overrides:
    
    setHeight in class com.google.gwt.user.client.ui.UIObject
    
    Parameters:
    
    height - new height. Default value is null
    
    See Also:
    
    Sizing overview and related methods
  - setHideUsingDisplayNone
```
public void setHideUsingDisplayNone(boolean hideUsingDisplayNone)
                             throws java.lang.IllegalStateException
```
    When this widget is hidden (see visibility and hide()), should display:none be applied to the outer element?
    This setting is not supported for general use, but in certain cases, it has been shown that display:none is a work-around for browser bugs involving burn-through of iframes or plugins, where the content of the iframe or plugin may still be visible despite the containing widget being hidden.
    Note : This is an advanced setting
    
    Parameters:
    
    hideUsingDisplayNone - New hideUsingDisplayNone value. Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Appearance overview and related methods
  - getHideUsingDisplayNone
```
public boolean getHideUsingDisplayNone()
```
    When this widget is hidden (see visibility and hide()), should display:none be applied to the outer element?
    This setting is not supported for general use, but in certain cases, it has been shown that display:none is a work-around for browser bugs involving burn-through of iframes or plugins, where the content of the iframe or plugin may still be visible despite the containing widget being hidden.
    
    Returns:
    
    Current hideUsingDisplayNone value. Default value is false
    
    See Also:
    
    Appearance overview and related methods
  - setHoverAlign
```
public void setHoverAlign(Alignment hoverAlign)
```
    If this.showHover is true, this property can be used to customize the alignment of content in the hover canvas.
    
    Parameters:
    
    hoverAlign - New hoverAlign value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean)
  - getHoverAlign
```
public Alignment getHoverAlign()
```
    If this.showHover is true, this property can be used to customize the alignment of content in the hover canvas.
    
    Returns:
    
    Current hoverAlign value. Default value is null
    
    See Also:
    
    getShowHover()
  - setHoverAutoDestroy
```
public void setHoverAutoDestroy(java.lang.Boolean hoverAutoDestroy)
```
    If this.showHover is true and getHoverComponent() is implemented, should the hoverCanvas returned from it be automatically destroyed when it is hidden?
    The default of null indicates that the component will be automatically destroyed. Set to false to prevent this.
    
    Parameters:
    
    hoverAutoDestroy - New hoverAutoDestroy value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean)
  - getHoverAutoDestroy
```
public java.lang.Boolean getHoverAutoDestroy()
```
    If this.showHover is true and getHoverComponent() is implemented, should the hoverCanvas returned from it be automatically destroyed when it is hidden?
    The default of null indicates that the component will be automatically destroyed. Set to false to prevent this.
    
    Returns:
    
    Current hoverAutoDestroy value. Default value is null
    
    See Also:
    
    getShowHover()
  - setHoverAutoFitMaxWidth
```
public void setHoverAutoFitMaxWidth(int hoverAutoFitMaxWidth)
```
    Maximum auto-fit width for a hover if hoverAutoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.
    
    Parameters:
    
    hoverAutoFitMaxWidth - New hoverAutoFitMaxWidth value. Default value is 100
  - getHoverAutoFitMaxWidth
```
public int getHoverAutoFitMaxWidth()
```
    Maximum auto-fit width for a hover if hoverAutoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.
    
    Returns:
    
    Current hoverAutoFitMaxWidth value. Default value is 100
  - setHoverAutoFitMaxWidth
```
public void setHoverAutoFitMaxWidth(java.lang.String hoverAutoFitMaxWidth)
```
    Maximum auto-fit width for a hover if hoverAutoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.
    
    Parameters:
    
    hoverAutoFitMaxWidth - New hoverAutoFitMaxWidth value. Default value is 100
  - getHoverAutoFitMaxWidthAsString
```
public java.lang.String getHoverAutoFitMaxWidthAsString()
```
    Maximum auto-fit width for a hover if hoverAutoFitWidth is enabled. May be specified as a pixel value, or a percentage of page width.
    
    Returns:
    
    Current hoverAutoFitMaxWidth value. Default value is 100
  - setHoverAutoFitWidth
```
public void setHoverAutoFitWidth(java.lang.Boolean hoverAutoFitWidth)
```
    if showHover is true, this property will cause the specified hoverWidth to be treated as a minimum width for the hover. If the hover content string exceeds this, the hover will expand to accomodate it up to hoverAutoFitMaxWidth (without the text wrapping).
    Using this settings differs from simply disabling wrapping via hoverWrap:false as the content will wrap if the hoverAutoFitMaxWidth is exceeded.
    Note : This is an advanced setting
    
    Parameters:
    
    hoverAutoFitWidth - New hoverAutoFitWidth value. Default value is true
    
    See Also:
    
    setShowHover(java.lang.Boolean)
  - getHoverAutoFitWidth
```
public java.lang.Boolean getHoverAutoFitWidth()
```
    if showHover is true, this property will cause the specified hoverWidth to be treated as a minimum width for the hover. If the hover content string exceeds this, the hover will expand to accomodate it up to hoverAutoFitMaxWidth (without the text wrapping).
    Using this settings differs from simply disabling wrapping via hoverWrap:false as the content will wrap if the hoverAutoFitMaxWidth is exceeded.
    
    Returns:
    
    Current hoverAutoFitWidth value. Default value is true
    
    See Also:
    
    getShowHover()
  - setHoverDelay
```
public void setHoverDelay(int hoverDelay)
```
    If this.canHover is true, how long should the mouse be kept over this widget before the hover event is fired
    
    Parameters:
    
    hoverDelay - New hoverDelay value. Default value is 300
    
    See Also:
    
    setCanHover(java.lang.Boolean), HoverEvent
  - getHoverDelay
```
public int getHoverDelay()
```
    If this.canHover is true, how long should the mouse be kept over this widget before the hover event is fired
    
    Returns:
    
    Current hoverDelay value. Default value is 300
    
    See Also:
    
    getCanHover(), HoverEvent
  - setHoverHeight
```
public void setHoverHeight(java.lang.Integer hoverHeight)
```
    If this.showHover is true, this property can be used to customize the height of the hover canvas shown.
    
    Parameters:
    
    hoverHeight - New hoverHeight value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean)
  - getHoverHeight
```
public java.lang.Integer getHoverHeight()
```
    If this.showHover is true, this property can be used to customize the height of the hover canvas shown.
    
    Returns:
    
    Current hoverHeight value. Default value is null
    
    See Also:
    
    getShowHover()
  - setHoverMoveWithMouse
```
public void setHoverMoveWithMouse(java.lang.Boolean hoverMoveWithMouse)
```
    If this.showHover is true, should this widget's hover canvas be moved with the mouse while visible?
    
    Parameters:
    
    hoverMoveWithMouse - New hoverMoveWithMouse value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean)
  - getHoverMoveWithMouse
```
public java.lang.Boolean getHoverMoveWithMouse()
```
    If this.showHover is true, should this widget's hover canvas be moved with the mouse while visible?
    
    Returns:
    
    Current hoverMoveWithMouse value. Default value is null
    
    See Also:
    
    getShowHover()
  - setHoverOpacity
```
public void setHoverOpacity(java.lang.Integer hoverOpacity)
```
    If this.showHover is true, should the hover canvas be shown with opacity other than 100?
    
    Parameters:
    
    hoverOpacity - New hoverOpacity value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean), Hovers / Tooltips Example
  - getHoverOpacity
```
public java.lang.Integer getHoverOpacity()
```
    If this.showHover is true, should the hover canvas be shown with opacity other than 100?
    
    Returns:
    
    Current hoverOpacity value. Default value is null
    
    See Also:
    
    getShowHover(), Hovers / Tooltips Example
  - setHoverStyle
```
public void setHoverStyle(java.lang.String hoverStyle)
```
    If this.showHover is true, this property can be used to specify the css style to apply to the hover canvas.
    
    Parameters:
    
    hoverStyle - New hoverStyle value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean), CSSStyleName, Hovers / Tooltips Example
  - getHoverStyle
```
public java.lang.String getHoverStyle()
```
    If this.showHover is true, this property can be used to specify the css style to apply to the hover canvas.
    
    Returns:
    
    Current hoverStyle value. Default value is null
    
    See Also:
    
    getShowHover(), CSSStyleName, Hovers / Tooltips Example
  - setHoverVAlign
```
public void setHoverVAlign(VerticalAlignment hoverVAlign)
```
    If this.showHover is true, this property can be used to customize the vertical alignment of content in the hover canvas.
    
    Parameters:
    
    hoverVAlign - New hoverVAlign value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean)
  - getHoverVAlign
```
public VerticalAlignment getHoverVAlign()
```
    If this.showHover is true, this property can be used to customize the vertical alignment of content in the hover canvas.
    
    Returns:
    
    Current hoverVAlign value. Default value is null
    
    See Also:
    
    getShowHover()
  - setHoverWidth
```
public void setHoverWidth(int hoverWidth)
```
    If this.showHover is true, this property can be used to customize the width of the hover canvas shown. See also hoverAutoFitWidth and hoverAutoFitMaxWidth.
    
    Parameters:
    
    hoverWidth - New hoverWidth value. Default value is 1
    
    See Also:
    
    setShowHover(java.lang.Boolean), Hovers / Tooltips Example
  - getHoverWidth
```
public int getHoverWidth()
```
    If this.showHover is true, this property can be used to customize the width of the hover canvas shown. See also hoverAutoFitWidth and hoverAutoFitMaxWidth.
    
    Returns:
    
    Current hoverWidth value. Default value is 1
    
    See Also:
    
    getShowHover(), Hovers / Tooltips Example
  - setHoverWrap
```
public void setHoverWrap(java.lang.Boolean hoverWrap)
```
    If this.showHover is true, this property can be used to customize the whether content in the hover canvas is displayed in a single line, or wraps.
    Note that if developers wish to have hovers expand horizontally to fit their text without wrapping *up to some maximum*, and then wrap rather than exceeding that maximum, the hoverAutoFitWidth and hoverAutoFitMaxWidth attributes may be used instead of simply setting hoverWrap to false.
    
    Parameters:
    
    hoverWrap - New hoverWrap value. Default value is null
    
    See Also:
    
    setShowHover(java.lang.Boolean)
  - getHoverWrap
```
public java.lang.Boolean getHoverWrap()
```
    If this.showHover is true, this property can be used to customize the whether content in the hover canvas is displayed in a single line, or wraps.
    Note that if developers wish to have hovers expand horizontally to fit their text without wrapping *up to some maximum*, and then wrap rather than exceeding that maximum, the hoverAutoFitWidth and hoverAutoFitMaxWidth attributes may be used instead of simply setting hoverWrap to false.
    
    Returns:
    
    Current hoverWrap value. Default value is null
    
    See Also:
    
    getShowHover()
  - setHtmlElement
```
public void setHtmlElement(com.google.gwt.user.client.Element htmlElement)
```
    If specified as a pointer to an HTML element present in the DOM, this canvas will be rendered inside that element on draw().
    NOTES:
    This feature is intended for temporary integration with legacy page architectures only; the native browser's reaction to DOM insertion is unspecified and unsupported. For consistent cross-browser layout and positioning semantics, use Canvas parents (especially Layouts) and use absolute positioning at top level.
    Persistence of htmlElement: If htmlPosition is set to "replace" the htmlElement will be removed from the DOM when the canvas is drawn - therefore the htmlElement attribute will be cleared at this time. Otherwise if a Canvas is clear()d and then draw()n again it will be rendered inside the same htmlElement.
    If a Canvas is added as a child to Canvas parent, its htmlElement will be dropped.
    position should typically be set to "relative" if the widget is to be rendered inline within a standard page.
    
    If this method is called after the component has been drawn/initialized: Setter for the htmlElement.
    Note : This is an advanced setting
    
    Overrides:
    
    setHtmlElement in class BaseWidget
    
    Parameters:
    
    htmlElement - New htmlElement for this canvas, or Null to clear the existing htmlElement. Default value is null
    
    See Also:
    
    Positioning overview and related methods
  - getHtmlElement
```
public com.google.gwt.user.client.Element getHtmlElement()
```
    If specified as a pointer to an HTML element present in the DOM, this canvas will be rendered inside that element on draw().
    NOTES:
    This feature is intended for temporary integration with legacy page architectures only; the native browser's reaction to DOM insertion is unspecified and unsupported. For consistent cross-browser layout and positioning semantics, use Canvas parents (especially Layouts) and use absolute positioning at top level.
    Persistence of htmlElement: If htmlPosition is set to "replace" the htmlElement will be removed from the DOM when the canvas is drawn - therefore the htmlElement attribute will be cleared at this time. Otherwise if a Canvas is clear()d and then draw()n again it will be rendered inside the same htmlElement.
    If a Canvas is added as a child to Canvas parent, its htmlElement will be dropped.
    position should typically be set to "relative" if the widget is to be rendered inline within a standard page.
    
    Returns:
    
    Current htmlElement value. Default value is null
    
    See Also:
    
    Positioning overview and related methods
  - setHtmlPosition
```
public void setHtmlPosition(DrawPosition htmlPosition)
```
    If htmlElement is specified, this attribute specifies the position where the canvas should be inserted relative to the htmlElement in the DOM.
    
    If this method is called after the component has been drawn/initialized: Setter for the htmlPosition.
    Note : This is an advanced setting
    
    Parameters:
    
    htmlPosition - New htmlPosition for this canvas. Default value is "afterBegin"
    
    See Also:
    
    Positioning overview and related methods
  - getHtmlPosition
```
public DrawPosition getHtmlPosition()
```
    If htmlElement is specified, this attribute specifies the position where the canvas should be inserted relative to the htmlElement in the DOM.
    
    Returns:
    
    Current htmlPosition value. Default value is "afterBegin"
    
    See Also:
    
    Positioning overview and related methods
  - setIsGroup
```
public void setIsGroup(boolean isGroup)
                throws java.lang.IllegalStateException
```
    Should a grouping frame be shown around this canvas.
    
    Parameters:
    
    isGroup - New isGroup value. Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    setGroupBorderCSS(java.lang.String), setGroupLabelStyleName(java.lang.String), setGroupLabelBackgroundColor(java.lang.String)
  - getIsGroup
```
public boolean getIsGroup()
```
    Should a grouping frame be shown around this canvas.
    
    Returns:
    
    Current isGroup value. Default value is false
    
    See Also:
    
    getGroupBorderCSS(), getGroupLabelStyleName(), getGroupLabelBackgroundColor()
  - getIsPrinting
```
public java.lang.Boolean getIsPrinting()
                                throws java.lang.IllegalStateException
```
    This boolean flag will be set to true by framework logic while generating print HTML for this widget as a result to a call to showPrintPreview() (or just getPrintHTML()). Note that this flag is set recursively as parent widgets generate print HTML for their children.
    This is a read-only property and should not be modified by application code.
    Note : This method should be called only after the widget has been rendered.
    
    Returns:
    
    Current isPrinting value. Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setIsRuleScope
```
public void setIsRuleScope(java.lang.Boolean isRuleScope)
                    throws java.lang.IllegalStateException
```
    Marks this Canvas as the ruleScope that will be discovered by any contained DataBoundComponents which do not specify an explicit ruleScope.
    
    Parameters:
    
    isRuleScope - New isRuleScope value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getIsRuleScope
```
public java.lang.Boolean getIsRuleScope()
```
    Marks this Canvas as the ruleScope that will be discovered by any contained DataBoundComponents which do not specify an explicit ruleScope.
    
    Returns:
    
    Current isRuleScope value. Default value is null
  - setIsSnapAlignCandidate
```
public void setIsSnapAlignCandidate(java.lang.Boolean isSnapAlignCandidate)
```
    Flag to disable snapping to alignment against this Canvas when other Canvases dragged into the same parent when childrenSnapAlign is enabled on this Canvas' parent.
    
    Parameters:
    
    isSnapAlignCandidate - New isSnapAlignCandidate value. Default value is null
  - getIsSnapAlignCandidate
```
public java.lang.Boolean getIsSnapAlignCandidate()
```
    Flag to disable snapping to alignment against this Canvas when other Canvases dragged into the same parent when childrenSnapAlign is enabled on this Canvas' parent.
    
    Returns:
    
    Current isSnapAlignCandidate value. Default value is null
  - setKeepInParentRect
```
public void setKeepInParentRect(java.lang.Boolean keepInParentRect)
```
    Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array). In the latter mode you may use negative offsets for left/top and a width/height greater than the visible or scroll width of the parent to allow positioning beyond the confines of the parent.
    If this canvas has no parent, constrains dragging to within the browser window.
    Affects target and outline dragAppearance, not tracker.
    Note: keepInParentRect affects only user drag interactions, not programmatic moves.
    Example use cases:
    keepInParentRect: true - confine to parent
    keepInParentRect: [0, 0, 500, 500] - confine to top left 500x500 region within parent
    keepInParentRect: [0, 0, 10000, 10000] - in combination with overflow: "auto", confine to parent, but allow moving off the right and bottom of the parent to force scrolling (and hence enlarge the scrollWidth of the parent).
    Note : This is an advanced setting
    
    Parameters:
    
    keepInParentRect - New keepInParentRect value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - getKeepInParentRect
```
public java.lang.Boolean getKeepInParentRect()
```
    Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array). In the latter mode you may use negative offsets for left/top and a width/height greater than the visible or scroll width of the parent to allow positioning beyond the confines of the parent.
    If this canvas has no parent, constrains dragging to within the browser window.
    Affects target and outline dragAppearance, not tracker.
    Note: keepInParentRect affects only user drag interactions, not programmatic moves.
    Example use cases:
    keepInParentRect: true - confine to parent
    keepInParentRect: [0, 0, 500, 500] - confine to top left 500x500 region within parent
    keepInParentRect: [0, 0, 10000, 10000] - in combination with overflow: "auto", confine to parent, but allow moving off the right and bottom of the parent to force scrolling (and hence enlarge the scrollWidth of the parent).
    
    Returns:
    
    Current keepInParentRect value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - setKeepInParentRect
```
public void setKeepInParentRect(java.lang.Integer... keepInParentRect)
```
    Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array). In the latter mode you may use negative offsets for left/top and a width/height greater than the visible or scroll width of the parent to allow positioning beyond the confines of the parent.
    If this canvas has no parent, constrains dragging to within the browser window.
    Affects target and outline dragAppearance, not tracker.
    Note: keepInParentRect affects only user drag interactions, not programmatic moves.
    Example use cases:
    keepInParentRect: true - confine to parent
    keepInParentRect: [0, 0, 500, 500] - confine to top left 500x500 region within parent
    keepInParentRect: [0, 0, 10000, 10000] - in combination with overflow: "auto", confine to parent, but allow moving off the right and bottom of the parent to force scrolling (and hence enlarge the scrollWidth of the parent).
    Note : This is an advanced setting
    
    Parameters:
    
    keepInParentRect - New keepInParentRect value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag create Example
  - setLayoutAlign
```
public void setLayoutAlign(Alignment layoutAlign)
```
    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.
    
    Parameters:
    
    layoutAlign - New layoutAlign value. Default value is null
    
    See Also:
    
    LayoutMember overview and related methods
  - getLayoutAlign
```
public Alignment getLayoutAlign()
```
    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.
    
    Returns:
    
    Current layoutAlign value. Default value is null
    
    See Also:
    
    LayoutMember overview and related methods
  - setLayoutAlign
```
public void setLayoutAlign(VerticalAlignment layoutAlign)
```
    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.
    
    Parameters:
    
    layoutAlign - New layoutAlign value. Default value is null
    
    See Also:
    
    LayoutMember overview and related methods
  - setLeavePageSpace
```
public void setLeavePageSpace(java.lang.Integer leavePageSpace)
```
    If set, overrides the global defaultPageSpace.
    
    If this method is called after the component has been drawn/initialized: Setter for leavePageSpace.
    Note : This is an advanced setting
    
    Parameters:
    
    leavePageSpace - new value for leavePageSpace. Default value is null
    
    See Also:
    
    Positioning overview and related methods
  - getLeavePageSpace
```
public java.lang.Integer getLeavePageSpace()
```
    If set, overrides the global defaultPageSpace.
    
    Returns:
    
    Current leavePageSpace value. Default value is null
    
    See Also:
    
    Positioning overview and related methods
  - setLeft
```
public void setLeft(int 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 position property).
    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 parent.
    
    If this method is called after the component has been drawn/initialized: 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
    
    Parameters:
    
    left - new left coordinate. Default value is 0
    
    See Also:
    
    Positioning overview and related methods
  - getLeft
```
public int getLeft()
```
    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 position property).
    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 parent.
    
    Returns:
    
    Return the left coordinate of this object, relative to its enclosing context, in pixels. Default value is 0
    
    See Also:
    
    Positioning overview and related methods
  - setLeft
```
public void setLeft(java.lang.String 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 position property).
    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 parent.
    
    If this method is called after the component has been drawn/initialized: 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
    
    Parameters:
    
    left - new left coordinate. Default value is 0
    
    See Also:
    
    Positioning overview and related methods
  - setLocateChildrenBy
```
public void setLocateChildrenBy(LocatorStrategy locateChildrenBy)
```
    Strategy to use when locating children in this canvas from an autoTest locator string.
    Note : This is an advanced setting
    
    Parameters:
    
    locateChildrenBy - New locateChildrenBy value. Default value is null
  - getLocateChildrenBy
```
public LocatorStrategy getLocateChildrenBy()
```
    Strategy to use when locating children in this canvas from an autoTest locator string.
    
    Returns:
    
    Current locateChildrenBy value. Default value is null
  - setLocateChildrenType
```
public void setLocateChildrenType(LocatorTypeStrategy locateChildrenType)
```
    LocatorTypeStrategy to use when finding children within this canvas.
    Note : This is an advanced setting
    
    Parameters:
    
    locateChildrenType - New locateChildrenType value. Default value is null
  - getLocateChildrenType
```
public LocatorTypeStrategy getLocateChildrenType()
```
    LocatorTypeStrategy to use when finding children within this canvas.
    
    Returns:
    
    Current locateChildrenType value. Default value is null
  - setLocatePeersBy
```
public void setLocatePeersBy(LocatorStrategy locatePeersBy)
```
    Strategy to use when locating peers of this canvas from an autoTest locator string.
    Note : This is an advanced setting
    
    Parameters:
    
    locatePeersBy - New locatePeersBy value. Default value is null
  - getLocatePeersBy
```
public LocatorStrategy getLocatePeersBy()
```
    Strategy to use when locating peers of this canvas from an autoTest locator string.
    
    Returns:
    
    Current locatePeersBy value. Default value is null
  - setLocatePeersType
```
public void setLocatePeersType(LocatorTypeStrategy locatePeersType)
```
    LocatorTypeStrategy to use when finding peers of this canvas.
    Note : This is an advanced setting
    
    Parameters:
    
    locatePeersType - New locatePeersType value. Default value is null
  - getLocatePeersType
```
public LocatorTypeStrategy getLocatePeersType()
```
    LocatorTypeStrategy to use when finding peers of this canvas.
    
    Returns:
    
    Current locatePeersType value. Default value is null
  - setMargin
```
public void setMargin(java.lang.Integer margin)
```
    Set the CSS Margin, in pixels, for this component. Margin provides blank space outside of the border.
    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 styleName.
    Note that the specified size of the widget will be the size including the margin thickness on each side.
    
    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.
    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 styleName.
    Note that the specified size of the widget will be the size including the margin thickness on each side.
    
    Parameters:
    
    margin - new margin in pixels. Default value is null
    
    See Also:
    
    Appearance overview and related methods
  - getMargin
```
public java.lang.Integer getMargin()
```
    Set the CSS Margin, in pixels, for this component. Margin provides blank space outside of the border.
    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 styleName.
    Note that the specified size of the widget will be the size including the margin thickness on each side.
    
    Returns:
    
    Current margin value. Default value is null
    
    See Also:
    
    Appearance overview and related methods
  - getMasterElement
```
public Canvas getMasterElement()
                        throws java.lang.IllegalStateException
```
    Deprecated. In favor or getMasterCanvas() as of Smart GWT release 9.1
    
    This Canvas's "master" (the Canvas to which it was added as a peer), if any.
    Note : This method should be called only after the widget has been rendered.
    
    Returns:
    
    Current masterElement value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
    
    See Also:
    
    Containment overview and related methods
  - setMatchElement
```
public void setMatchElement(java.lang.Boolean matchElement)
```
    If htmlElement is specified, should this canvas initially be drawn at the same dimensions as the htmlElement?
    Note: setting this property will not force the canvas to resize if the element subsequently resizes (for example due to page reflow).
    Note : This is an advanced setting
    
    Parameters:
    
    matchElement - New matchElement value. Default value is null
  - getMatchElement
```
public java.lang.Boolean getMatchElement()
```
    If htmlElement is specified, should this canvas initially be drawn at the same dimensions as the htmlElement?
    Note: setting this property will not force the canvas to resize if the element subsequently resizes (for example due to page reflow).
    
    Returns:
    
    Current matchElement value. Default value is null
  - setMaxHeight
```
public void setMaxHeight(int maxHeight)
```
    Maximum height available to this Canvas. See maxWidth for details of behavior.
    Note : This is an advanced setting
    
    Parameters:
    
    maxHeight - New maxHeight value. Default value is 10000
    
    See Also:
    
    setDragMaxHeight(int), Sizing overview and related methods
  - getMaxHeight
```
public int getMaxHeight()
```
    Maximum height available to this Canvas. See maxWidth for details of behavior.
    
    Returns:
    
    Current maxHeight value. Default value is 10000
    
    See Also:
    
    getDragMaxHeight(), Sizing overview and related methods
  - setMaxWidth
```
public void setMaxWidth(int maxWidth)
```
    Maximum width available to this Canvas.
    The maxWidth and maxHeight settings apply to:
    - For a canvas being managed as a member of a Layout, the maximum size the layout should apply to the canvas.
    - For a canvas with a width or height specified as a percent value, a maximum numeric pixel value to limit how large the canvas is sized.
    - determining size for a Canvas in a CanvasItem (maxHeight only)
    - end user drag resizing
    Maximum sizes do not apply in various other circumstances where sizes are being determined, such as ListGrid recordComponents.
    Note : This is an advanced setting
    Parameters:
    
    maxWidth - New maxWidth value. Default value is 10000
    
    See Also:
    
    setDragMaxWidth(int), Sizing overview and related methods
  - getMaxWidth
```
public int getMaxWidth()
```
    Maximum width available to this Canvas.
    The maxWidth and maxHeight settings apply to:
    - For a canvas being managed as a member of a Layout, the maximum size the layout should apply to the canvas.
    - For a canvas with a width or height specified as a percent value, a maximum numeric pixel value to limit how large the canvas is sized.
    - determining size for a Canvas in a CanvasItem (maxHeight only)
    - end user drag resizing
    Maximum sizes do not apply in various other circumstances where sizes are being determined, such as ListGrid recordComponents.
    Returns:
    
    Current maxWidth value. Default value is 10000
    
    See Also:
    
    getDragMaxWidth(), Sizing overview and related methods
  - setMaxZoomOverflowError
```
public void setMaxZoomOverflowError(int maxZoomOverflowError)
```
    When correctZoomOverflow is true and browser or OS-level zoom is active, determines how much overflow must occur before the Framework enables scrolling for this canvas.
    The larger the value, the more clipping that can occur before scrolling is enabled. So, this property should never be set larger than the minimum amount needed to prevent scrollbar oscillation when zoomed - which is the maximum scrollHeight or scrollWidth error.
    Note : This is an advanced setting
    
    Parameters:
    
    maxZoomOverflowError - New maxZoomOverflowError value. Default value is varies
  - getMaxZoomOverflowError
```
public int getMaxZoomOverflowError()
```
    When correctZoomOverflow is true and browser or OS-level zoom is active, determines how much overflow must occur before the Framework enables scrolling for this canvas.
    The larger the value, the more clipping that can occur before scrolling is enabled. So, this property should never be set larger than the minimum amount needed to prevent scrollbar oscillation when zoomed - which is the maximum scrollHeight or scrollWidth error.
    
    Returns:
    
    Current maxZoomOverflowError value. Default value is varies
  - setMenuConstructor
```
public void setMenuConstructor(java.lang.String menuConstructor)
                        throws java.lang.IllegalStateException
```
    Default class used to construct menus created by this component, including context menus.
    
    Parameters:
    
    menuConstructor - New menuConstructor value. Default value is "Menu"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    ShowContextMenuEvent, SCClassName, Cues overview and related methods
  - getMenuConstructor
```
public java.lang.String getMenuConstructor()
```
    Default class used to construct menus created by this component, including context menus.
    
    Returns:
    
    Current menuConstructor value. Default value is "Menu"
    
    See Also:
    
    ShowContextMenuEvent, SCClassName, Cues overview and related methods
  - setMinHeight
```
public void setMinHeight(int minHeight)
```
    Minimum height available to this Canvas. See minWidth for details of behavior.
    
    If this method is called after the component has been drawn/initialized: Resizes the widget vertically if required to satisfy the specified minHeight.
    Note : This is an advanced setting
    
    Parameters:
    
    minHeight - new minimum height. Default value is 0
    
    See Also:
    
    setDragMinHeight(int), Sizing overview and related methods
  - getMinHeight
```
public int getMinHeight()
```
    Minimum height available to this Canvas. See minWidth for details of behavior.
    
    Returns:
    
    Current minHeight value. Default value is 0
    
    See Also:
    
    getDragMinHeight(), Sizing overview and related methods
  - setMinNonEdgeSize
```
public void setMinNonEdgeSize(int minNonEdgeSize)
```
    If the widget has drag resize configured on one or more of it's edges, and the edgeMarginSize is large enough that the remaining space is less than minNonEdgeSize, the edgeMarginSize will be reduced such that the non-edge part of the widget is at least 1/3 of the total space (with two draggable edges) or half of it (with one draggable edge).
    Note : This is an advanced setting
    
    Parameters:
    
    minNonEdgeSize - New minNonEdgeSize value. Default value is 0
    
    See Also:
    
    Dragdrop overview and related methods, Drag resize Example
  - getMinNonEdgeSize
```
public int getMinNonEdgeSize()
```
    If the widget has drag resize configured on one or more of it's edges, and the edgeMarginSize is large enough that the remaining space is less than minNonEdgeSize, the edgeMarginSize will be reduced such that the non-edge part of the widget is at least 1/3 of the total space (with two draggable edges) or half of it (with one draggable edge).
    
    Returns:
    
    Current minNonEdgeSize value. Default value is 0
    
    See Also:
    
    Dragdrop overview and related methods, Drag resize Example
  - setMinWidth
```
public void setMinWidth(int minWidth)
```
    Minimum width available to this Canvas.
    The minWidth and minHeight settings apply to:
    - For a canvas being managed as a member of a Layout, the minimum size the layout should apply to the canvas.
    - For a canvas with a width or height specified as a percent value, a minimum numeric pixel value to limit how large the canvas is sized.
    - determining size for a Canvas in a CanvasItem (minHeight only)
    - end user drag resizing
    - minimum size when using Overflow "visible" outside of a Layout - minimum size will be the greater of this setting or the minimum size needed to make all content visible
    Minimum sizes do not apply in various other circumstances where sizes are being determined, such as ListGrid recordComponents.
    See also Layout.minMemberLength as a way of establishing minimum sizes along the length axis for all members of a Layout with a single setting.
    
    If this method is called after the component has been drawn/initialized: Resizes the widget horizontally if required to satisfy the specified minWidth.
    Note : This is an advanced setting
    Parameters:
    
    minWidth - new minimum width. Default value is 0
    
    See Also:
    
    setDragMinWidth(int), Sizing overview and related methods
  - getMinWidth
```
public int getMinWidth()
```
    Minimum width available to this Canvas.
    The minWidth and minHeight settings apply to:
    - For a canvas being managed as a member of a Layout, the minimum size the layout should apply to the canvas.
    - For a canvas with a width or height specified as a percent value, a minimum numeric pixel value to limit how large the canvas is sized.
    - determining size for a Canvas in a CanvasItem (minHeight only)
    - end user drag resizing
    - minimum size when using Overflow "visible" outside of a Layout - minimum size will be the greater of this setting or the minimum size needed to make all content visible
    Minimum sizes do not apply in various other circumstances where sizes are being determined, such as ListGrid recordComponents.
    See also Layout.minMemberLength as a way of establishing minimum sizes along the length axis for all members of a Layout with a single setting.
    Returns:
    
    Current minWidth value. Default value is 0
    
    See Also:
    
    getDragMinWidth(), Sizing overview and related methods
  - setMomentumScrollMinSpeed
```
public void setMomentumScrollMinSpeed(double momentumScrollMinSpeed)
```
    The minimum speed in pixels per second that must be reached for momentum scrolling to kick in. This setting only applies to touch-enabled devices.
    Note : This is an advanced setting
    
    Parameters:
    
    momentumScrollMinSpeed - New momentumScrollMinSpeed value. Default value is 200
  - getMomentumScrollMinSpeed
```
public double getMomentumScrollMinSpeed()
```
    The minimum speed in pixels per second that must be reached for momentum scrolling to kick in. This setting only applies to touch-enabled devices.
    
    Returns:
    
    Current momentumScrollMinSpeed value. Default value is 200
  - setMouseStillDownDelay
```
public void setMouseStillDownDelay(int mouseStillDownDelay)
```
    Amount of time (in milliseconds) between repeated 'mouseStillDown' events for this canvas. See Canvas.mouseStillDown() for details.
    Note : This is an advanced setting
    
    Parameters:
    
    mouseStillDownDelay - New mouseStillDownDelay value. Default value is 100
  - getMouseStillDownDelay
```
public int getMouseStillDownDelay()
```
    Amount of time (in milliseconds) between repeated 'mouseStillDown' events for this canvas. See Canvas.mouseStillDown() for details.
    
    Returns:
    
    Current mouseStillDownDelay value. Default value is 100
  - setMouseStillDownInitialDelay
```
public void setMouseStillDownInitialDelay(int mouseStillDownInitialDelay)
```
    Amount of time (in milliseconds) before mouseStillDown events start to be fired repeatedly for this canvas. See Canvas.mouseStillDown() for details.
    Note : This is an advanced setting
    
    Parameters:
    
    mouseStillDownInitialDelay - New mouseStillDownInitialDelay value. Default value is 400
  - getMouseStillDownInitialDelay
```
public int getMouseStillDownInitialDelay()
```
    Amount of time (in milliseconds) before mouseStillDown events start to be fired repeatedly for this canvas. See Canvas.mouseStillDown() for details.
    
    Returns:
    
    Current mouseStillDownInitialDelay value. Default value is 400
  - setName
```
public void setName(java.lang.String name)
             throws java.lang.IllegalStateException
```
    Optional name for the canvas, which can later be used to reference it. Need not be globally unique, but should be unique within the parent to get defined results for Layout.getMember() and Layout.getMemberNumber().
    
    Parameters:
    
    name - New name value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    BaseWidget.setID(java.lang.String), Identifier
  - getName
```
public java.lang.String getName()
```
    Optional name for the canvas, which can later be used to reference it. Need not be globally unique, but should be unique within the parent to get defined results for Layout.getMember() and Layout.getMemberNumber().
    
    Returns:
    
    Current name value. Default value is null
    
    See Also:
    
    BaseWidget.getID(), Identifier
  - setNoDoubleClicks
```
public void setNoDoubleClicks(java.lang.Boolean noDoubleClicks)
```
    If true, this canvas will receive all mouse-clicks as single click events rather than as doubleClick events.
    Note : This is an advanced setting
    
    Parameters:
    
    noDoubleClicks - New noDoubleClicks value. Default value is null
  - getNoDoubleClicks
```
public java.lang.Boolean getNoDoubleClicks()
```
    If true, this canvas will receive all mouse-clicks as single click events rather than as doubleClick events.
    
    Returns:
    
    Current noDoubleClicks value. Default value is null
  - setNoDropCursor
```
public void setNoDropCursor(Cursor noDropCursor)
```
    Specifies the cursor image to display when the user drags a droppable canvas over this if it is not a valid drop target for the event and showNoDropIndicator is true.
    Note : This is an advanced setting
    
    Parameters:
    
    noDropCursor - New noDropCursor value. Default value is Canvas.NOT_ALLOWED
    
    See Also:
    
    Cues overview and related methods
  - getNoDropCursor
```
public Cursor getNoDropCursor()
```
    Specifies the cursor image to display when the user drags a droppable canvas over this if it is not a valid drop target for the event and showNoDropIndicator is true.
    
    Returns:
    
    Current noDropCursor value. Default value is Canvas.NOT_ALLOWED
    
    See Also:
    
    Cues overview and related methods
  - setOpacity
```
public void setOpacity(java.lang.Integer opacity)
```
    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 have a performance impact on some older browsers.
    In older versions of Internet Explorer (Pre IE9 / HTML5), opacity is achieved through proprietary filters. If filters have been disabled within this application developers must set useOpacityFilter to true for specific components on which opacity support is required.
    Also note that opacity is incompatible with backMasks.
    
    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). Null means don't specify opacity directly. Note that heavy use of opacity may have a performance impact on some older browsers.
    In older versions of Internet Explorer (Pre IE9 / HTML5), opacity is achieved through proprietary filters. If filters have been disabled within this application developers must set useOpacityFilter to true for specific components on which opacity support is required.
    Also note that opacity is incompatible with backMasks.
    Note : This is an advanced setting
    
    Parameters:
    
    opacity - new opacity level. Default value is null
    
    See Also:
    
    Cues overview and related methods
  - getOpacity
```
public java.lang.Integer getOpacity()
```
    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 have a performance impact on some older browsers.
    In older versions of Internet Explorer (Pre IE9 / HTML5), opacity is achieved through proprietary filters. If filters have been disabled within this application developers must set useOpacityFilter to true for specific components on which opacity support is required.
    Also note that opacity is incompatible with backMasks.
    
    Returns:
    
    Current opacity value. Default value is null
    
    See Also:
    
    Cues overview and related methods
  - setOverflow
```
public void setOverflow(Overflow overflow)
```
    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.
    
    If this method is called after the component has been drawn/initialized: Update the overflow of a Canvas after it has been created.
    
    Parameters:
    
    overflow - New overflow value. Default value is Canvas.VISIBLE
    
    See Also:
    
    Sizing overview and related methods
  - getOverflow
```
public Overflow getOverflow()
```
    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.
    
    Returns:
    
    Current overflow value. Default value is Canvas.VISIBLE
    
    See Also:
    
    Sizing overview and related methods
  - setPadding
```
public void setPadding(java.lang.Integer padding)
```
    Set the CSS padding of this component, in pixels. Padding provides space between the border and the component's contents.
    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 styleName.
    Note that CSS padding does not affect the placement of children. To provide a blank area around children, either use CSS margins or use a Layout as the parent instead, and use properties such as Layout.layoutMargin to create blank space.
    
    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.
    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 styleName.
    
    Parameters:
    
    padding - new padding in pixels. Default value is null
    
    See Also:
    
    Appearance overview and related methods
  - getPadding
```
public java.lang.Integer getPadding()
```
    Set the CSS padding of this component, in pixels. Padding provides space between the border and the component's contents.
    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 styleName.
    Note that CSS padding does not affect the placement of children. To provide a blank area around children, either use CSS margins or use a Layout as the parent instead, and use properties such as Layout.layoutMargin to create blank space.
    
    Returns:
    
    Current padding value. Default value is null
    
    See Also:
    
    Appearance overview and related methods
  - setParentCanvas
```
public void setParentCanvas(Canvas parentCanvas)
                     throws java.lang.IllegalStateException
```
    This Canvas's immediate parent, if any.
    Can be initialized, but any subsequent manipulation should be via addChild() and removeChild() calls on the parent. The parent Canvas should be fetched using getParentCanvas().
    
    Parameters:
    
    parentCanvas - New parentCanvas value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Containment overview and related methods
  - getParentCanvas
```
public Canvas getParentCanvas()
```
    This Canvas's immediate parent, if any.
    Can be initialized, but any subsequent manipulation should be via addChild() and removeChild() calls on the parent. The parent Canvas should be fetched using getParentCanvas().
    
    Returns:
    
    Returns the parent of this canvas, if any. Default value is null
    
    See Also:
    
    Containment overview and related methods
  - setParentElement
```
public void setParentElement(Canvas parentElement)
                      throws java.lang.IllegalStateException
```
    Deprecated. As of Smartclient version 9.1, deprecated in favor of parentCanvas and getParentCanvas()
    
    This Canvas's immediate parent, if any.
    Can be initialized, but any subsequent manipulation should be via addChild() and removeChild() calls on the parent.
    Note : This is an advanced setting
    
    Parameters:
    
    parentElement - New parentElement value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Containment overview and related methods
  - getParentElement
```
public Canvas getParentElement()
```
    Deprecated. As of Smartclient version 9.1, deprecated in favor of parentCanvas and getParentCanvas()
    
    This Canvas's immediate parent, if any.
    Can be initialized, but any subsequent manipulation should be via addChild() and removeChild() calls on the parent.
    
    Returns:
    
    Current parentElement value. Default value is null
    
    See Also:
    
    Containment overview and related methods
  - setPeers
```
public void setPeers(Canvas... peers)
              throws java.lang.IllegalStateException
```
    Array of all Canvii that are peers of this Canvas.
    Use addPeer() and removePeer() to add and remove peers after a Canvas has been created/drawn.
    Note : This is an advanced setting
    
    Parameters:
    
    peers - New peers value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Containment overview and related methods
  - getPeers
```
public Canvas[] getPeers()
```
    Array of all Canvii that are peers of this Canvas.
    Use addPeer() and removePeer() to add and remove peers after a Canvas has been created/drawn.
    
    Returns:
    
    Current peers value. Default value is null
    
    See Also:
    
    Containment overview and related methods
  - setPercentBox
```
public void setPercentBox(PercentBoxModel percentBox)
                   throws java.lang.IllegalStateException
```
    Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a specified snapTo.
    Only affects widgets with a a specified percentSource, or widgets that have snapTo set and are peers of some other canvas.
    Determines whether the coordinates used for sizing (for percentage sized widgets) and positioning (if snapTo is set) should be relative to the visible size or the viewport size of the percentSource or master canvas widget.
    Note : This is an advanced setting
    
    Parameters:
    
    percentBox - New percentBox value. Default value is "visible"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Sizing overview and related methods
  - getPercentBox
```
public PercentBoxModel getPercentBox()
```
    Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a specified snapTo.
    Only affects widgets with a a specified percentSource, or widgets that have snapTo set and are peers of some other canvas.
    Determines whether the coordinates used for sizing (for percentage sized widgets) and positioning (if snapTo is set) should be relative to the visible size or the viewport size of the percentSource or master canvas widget.
    
    Returns:
    
    Current percentBox value. Default value is "visible"
    
    See Also:
    
    Sizing overview and related methods
  - setPercentSource
```
public void setPercentSource(Canvas percentSource)
```
    If this canvas has its size specified as a percentage, this property allows the user to explicitly designate another canvas upon which sizing will be based.
    If unset percentage sizing is based on
    - the master canvas if there is one and snapTo is set,
    - otherwise on the amount of space available in this widget's parent canvas, if this is a child of some other widget
    - otherwise the page size.
    
    If this method is called after the component has been drawn/initialized: Setter method for the percentSource attribute.
    Note : This is an advanced setting
    
    Parameters:
    
    percentSource - eterNew percent source (if omitted existing percentSource will just be cleared). Default value is null
    
    See Also:
    
    setPercentBox(com.smartgwt.client.types.PercentBoxModel), Sizing overview and related methods
  - getPercentSource
```
public Canvas getPercentSource()
```
    If this canvas has its size specified as a percentage, this property allows the user to explicitly designate another canvas upon which sizing will be based.
    If unset percentage sizing is based on
    - the master canvas if there is one and snapTo is set,
    - otherwise on the amount of space available in this widget's parent canvas, if this is a child of some other widget
    - otherwise the page size.
    
    Returns:
    
    Current percentSource value. Default value is null
    
    See Also:
    
    getPercentBox(), Sizing overview and related methods
  - setPosition
```
public void setPosition(Positioning position)
```
    Absolute or relative, corresponding to the "absolute" (with respect to parent) or "relative" (with respect to document flow) values for the CSS position attribute.
    Setting position:"relative" 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 "relative" on a top level component (a component with no getParentCanvas()).
    There are 2 ways to embed relatively positioned canvases in the DOM - by default the component will be written out inline when it gets drawn()n. For example to embed a canvas in an HTML table you could use this code:
```
  <table>
    <tr>
      <td>
        <script>
          isc.Canvas.create({autoDraw:true, backgroundColor:"red", position:"relative"});
        </script>
      <td>
    </tr>
  </table>
  
```
    Alternatively you can make use of the htmlElement attribute.
    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 Layout class would typically be used. For best consistency and flexibility across browsers, all Smart GWT layout managers use absolute positioning.
    For canvases with a specified htmlElement, this attribute defaults to "relative". In all other cases the default value will be "absolute".
    Note : This is an advanced setting
    Parameters:
    
    position - New position value. Default value is null
    
    See Also:
    
    Positioning overview and related methods
  - getPosition
```
public Positioning getPosition()
```
    Absolute or relative, corresponding to the "absolute" (with respect to parent) or "relative" (with respect to document flow) values for the CSS position attribute.
    Setting position:"relative" 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 "relative" on a top level component (a component with no getParentCanvas()).
    There are 2 ways to embed relatively positioned canvases in the DOM - by default the component will be written out inline when it gets drawn()n. For example to embed a canvas in an HTML table you could use this code:
```
  <table>
    <tr>
      <td>
        <script>
          isc.Canvas.create({autoDraw:true, backgroundColor:"red", position:"relative"});
        </script>
      <td>
    </tr>
  </table>
  
```
    Alternatively you can make use of the htmlElement attribute.
    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 Layout class would typically be used. For best consistency and flexibility across browsers, all Smart GWT layout managers use absolute positioning.
    For canvases with a specified htmlElement, this attribute defaults to "relative". In all other cases the default value will be "absolute".
    Returns:
    
    Current position value. Default value is null
    
    See Also:
    
    Positioning overview and related methods
  - setPrintChildrenAbsolutelyPositioned
```
public void setPrintChildrenAbsolutelyPositioned(java.lang.Boolean printChildrenAbsolutelyPositioned)
```
    Should this canvas print its children absolutely positioned when generating printable HTML.
    By default explicitly specified absolute positioning and sizing is ignored when generating print HTML. This is done intentionally: there is no way for the framework to predict how explicit sizes will translate to a the printed page and if HTML for printing includes the same absolute positioning and sizing as is displayed within an application it is very common to encounter undesirable effects, such as seeing tables get broken over several pages horizontally when there is enough room to print them on a single page of paper.
    In some cases, however, a developer may wish to have explicit sizing and positioning respected within the print-view. Setting this attribute to true will cause this to occur.
    Note : This is an advanced setting
    
    Parameters:
    
    printChildrenAbsolutelyPositioned - New printChildrenAbsolutelyPositioned value. Default value is false
    
    See Also:
    
    Printing overview and related methods
  - getPrintChildrenAbsolutelyPositioned
```
public java.lang.Boolean getPrintChildrenAbsolutelyPositioned()
```
    Should this canvas print its children absolutely positioned when generating printable HTML.
    By default explicitly specified absolute positioning and sizing is ignored when generating print HTML. This is done intentionally: there is no way for the framework to predict how explicit sizes will translate to a the printed page and if HTML for printing includes the same absolute positioning and sizing as is displayed within an application it is very common to encounter undesirable effects, such as seeing tables get broken over several pages horizontally when there is enough room to print them on a single page of paper.
    In some cases, however, a developer may wish to have explicit sizing and positioning respected within the print-view. Setting this attribute to true will cause this to occur.
    
    Returns:
    
    Current printChildrenAbsolutelyPositioned value. Default value is false
    
    See Also:
    
    Printing overview and related methods
  - setPrompt
```
public void setPrompt(java.lang.String prompt)
```
    Prompt displayed in hover canvas if showHover is true.
    
    Parameters:
    
    prompt - New prompt value. Default value is null
    
    See Also:
    
    HTMLString, Hovers / Tooltips Example
  - getPrompt
```
public java.lang.String getPrompt()
```
    Prompt displayed in hover canvas if showHover is true.
    
    Returns:
    
    Current prompt value. Default value is null
    
    See Also:
    
    HTMLString, Hovers / Tooltips Example
  - setProportionalResizing
```
public void setProportionalResizing(ProportionalResizeMode proportionalResizing)
                             throws java.lang.IllegalStateException
```
    If canDragResize is true, this property specifies the conditions for when proportional resizing is used. The default is ProportionalResizeMode.MODIFIER_OFF , which means that proportional resizing is disabled.
    
    Parameters:
    
    proportionalResizing - New proportionalResizing value. Default value is "none"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    setProportionalResizeModifiers(java.lang.String...), Dragdrop overview and related methods
  - getProportionalResizing
```
public ProportionalResizeMode getProportionalResizing()
```
    If canDragResize is true, this property specifies the conditions for when proportional resizing is used. The default is ProportionalResizeMode.MODIFIER_OFF , which means that proportional resizing is disabled.
    
    Returns:
    
    Current proportionalResizing value. Default value is "none"
    
    See Also:
    
    getProportionalResizeModifiers(), Dragdrop overview and related methods
  - setReceiveScrollbarEvents
```
public void setReceiveScrollbarEvents(boolean receiveScrollbarEvents)
                               throws java.lang.IllegalStateException
```
    Whether this canvas should receive events from its scrollbars, which are peers. Normally, a canvas only gets bubbled events from its children.
    Note that this property only has an impact if showCustomScrollbars is true.
    
    Parameters:
    
    receiveScrollbarEvents - New receiveScrollbarEvents value. Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    setShowCustomScrollbars(boolean), Scrolling overview and related methods
  - getReceiveScrollbarEvents
```
public boolean getReceiveScrollbarEvents()
```
    Whether this canvas should receive events from its scrollbars, which are peers. Normally, a canvas only gets bubbled events from its children.
    Note that this property only has an impact if showCustomScrollbars is true.
    
    Returns:
    
    Current receiveScrollbarEvents value. Default value is true
    
    See Also:
    
    getShowCustomScrollbars(), Scrolling overview and related methods
  - setRedrawOnResize
```
public void setRedrawOnResize(java.lang.Boolean redrawOnResize)
```
    Should this element be redrawn in response to a resize?
    Should be set to true for components whose inner HTML will not automatically reflow to fit the component's new size.
    Note : This is an advanced setting
    
    Parameters:
    
    redrawOnResize - New redrawOnResize value. Default value is null
    
    See Also:
    
    Drawing overview and related methods
  - getRedrawOnResize
```
public java.lang.Boolean getRedrawOnResize()
```
    Should this element be redrawn in response to a resize?
    Should be set to true for components whose inner HTML will not automatically reflow to fit the component's new size.
    
    Returns:
    
    Current redrawOnResize value. Default value is null
    
    See Also:
    
    Drawing overview and related methods
  - setResizeBarTarget
```
public void setResizeBarTarget(java.lang.String resizeBarTarget)
                        throws java.lang.IllegalStateException
```
    When this Canvas is included as a member in a Layout, and showResizeBar is set to true so that a resizeBar is created, resizeBarTarget:"next" 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, resizeBarTarget:"next" also means that the next member will be the one hidden.
    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.
    NOTE: 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 right should have flexible size. With resizeBarTarget:"next", the member on the left should have flexible size.
    
    Parameters:
    
    resizeBarTarget - New resizeBarTarget value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    setShowResizeBar(java.lang.Boolean), LayoutMember overview and related methods
  - getResizeBarTarget
```
public java.lang.String getResizeBarTarget()
```
    When this Canvas is included as a member in a Layout, and showResizeBar is set to true so that a resizeBar is created, resizeBarTarget:"next" 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, resizeBarTarget:"next" also means that the next member will be the one hidden.
    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.
    NOTE: 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 right should have flexible size. With resizeBarTarget:"next", the member on the left should have flexible size.
    
    Returns:
    
    Current resizeBarTarget value. Default value is null
    
    See Also:
    
    getShowResizeBar(), LayoutMember overview and related methods
  - setResizeFrom
```
public void setResizeFrom(EdgeName... resizeFrom)
```
    When drag resizing is enabled via canDragResize, restricts resizes to only certain edges or corners.
    The default of null indicates the widget can be resized from any corner or edge (if canDragResize is true).
    To restrict resizing to only certain corners, set resizeFrom to an Array of EdgeNames.
    Note : This is an advanced setting
    
    Parameters:
    
    resizeFrom - New resizeFrom value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag resize Example
  - getResizeFrom
```
public EdgeName[] getResizeFrom()
```
    When drag resizing is enabled via canDragResize, restricts resizes to only certain edges or corners.
    The default of null indicates the widget can be resized from any corner or edge (if canDragResize is true).
    To restrict resizing to only certain corners, set resizeFrom to an Array of EdgeNames.
    
    Returns:
    
    Current resizeFrom value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag resize Example
  - setRuleScope
```
public void setRuleScope(java.lang.String ruleScope)
                  throws java.lang.IllegalStateException
```
    ID of the component that gathers the context for evaluation of criteria-based rules specified by properties such as FormItem.visibleWhen.
    If not specified, this component will search through it's parentCanvas chain until it either reaches the top or reaches a parent marked isRuleScope. Determination of the ruleScope happens when the component is first drawn.
    The component designated as the ruleScope manages a nested data structure called the "rule context" which contains information from all DataBoundComponents that are registered with the ruleScope. By specifying Criterion.fieldName as a DataPath, AdvancedCriteria defined in properties such as FormItem.visibleWhen can access any part of the rule context.
    By default, the rule context contains data as follows:
    - any DataBoundComponent that has a DataSource contributes the values of the selected record or record being edited under the ID of the DataSource. For any collision an editable display (such as a form or editable grid) wins over a static display (such as a non-editable grid with a selection.)
    - any ListGrid or other component that manages a selection and has been assigned an explicit ID will contribute the values of the selected record under <componentId>.selectedRecord, and also contributes 3 flags for checking for selection: anySelected, multiSelected, numSelected.
    - any DynamicForm or other component that edits values and has been assigned an explicit ID contributes its current values under <componentId>.values, and contributes a flag hasChanges.
    - any DynamicForm or ListGrid that has been assigned an explicit ID contributes a value <componentId>.focusField. When present the value indicates the component has focus along with the name of the field that has focus. Its absense indicates the component does not have focus at all.
    - any ListGrid that has been assigned an explicit ID contributes a flag isGrouped under <componentId>.
    For example, given a screen where:
    - a ListGrid with ID "itemGrid" and DynamicForm with ID "itemForm" are both bound to the supplyItem sample DataSource
    - the ListGrid has a single selection, and the record selected in the ListGrid is being edited in the form, and has been changed
    The default rule context available from getRuleContext(), expressed as JSON, would be:
```
  {
   supplyItem : {
      itemID : "654321",
      itemName : "Sewing Machine",
      price : 5.50, // note: user change
      ..other properties..
   },
   itemForm.values : {
      itemID : "654321",
      itemName : "Sewing Machine",
      price : 5.50, // note: user change
      ..other properties..
   },
   itemForm.focusField : "itemName",
   itemForm.hasChanges : true,
   itemGrid.selectedRecord : {
      itemID : "654321",
      itemName : "Sewing Machine",
      price : 3.50, // note: old price
      ..other properties..
   },
   itemGrid.anySelected : true,
   itemGrid.multiSelected : false,
   itemGrid.numSelected : 1,
   itemGrid.isGrouped : false
  }
  
```
    In addition, an application can put custom data into the ruleScope via provideRuleContext().
    Parameters:
    
    ruleScope - New ruleScope value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getRuleScope
```
public java.lang.String getRuleScope()
```
    ID of the component that gathers the context for evaluation of criteria-based rules specified by properties such as FormItem.visibleWhen.
    If not specified, this component will search through it's parentCanvas chain until it either reaches the top or reaches a parent marked isRuleScope. Determination of the ruleScope happens when the component is first drawn.
    The component designated as the ruleScope manages a nested data structure called the "rule context" which contains information from all DataBoundComponents that are registered with the ruleScope. By specifying Criterion.fieldName as a DataPath, AdvancedCriteria defined in properties such as FormItem.visibleWhen can access any part of the rule context.
    By default, the rule context contains data as follows:
    - any DataBoundComponent that has a DataSource contributes the values of the selected record or record being edited under the ID of the DataSource. For any collision an editable display (such as a form or editable grid) wins over a static display (such as a non-editable grid with a selection.)
    - any ListGrid or other component that manages a selection and has been assigned an explicit ID will contribute the values of the selected record under <componentId>.selectedRecord, and also contributes 3 flags for checking for selection: anySelected, multiSelected, numSelected.
    - any DynamicForm or other component that edits values and has been assigned an explicit ID contributes its current values under <componentId>.values, and contributes a flag hasChanges.
    - any DynamicForm or ListGrid that has been assigned an explicit ID contributes a value <componentId>.focusField. When present the value indicates the component has focus along with the name of the field that has focus. Its absense indicates the component does not have focus at all.
    - any ListGrid that has been assigned an explicit ID contributes a flag isGrouped under <componentId>.
    For example, given a screen where:
    - a ListGrid with ID "itemGrid" and DynamicForm with ID "itemForm" are both bound to the supplyItem sample DataSource
    - the ListGrid has a single selection, and the record selected in the ListGrid is being edited in the form, and has been changed
    The default rule context available from getRuleContext(), expressed as JSON, would be:
```
  {
   supplyItem : {
      itemID : "654321",
      itemName : "Sewing Machine",
      price : 5.50, // note: user change
      ..other properties..
   },
   itemForm.values : {
      itemID : "654321",
      itemName : "Sewing Machine",
      price : 5.50, // note: user change
      ..other properties..
   },
   itemForm.focusField : "itemName",
   itemForm.hasChanges : true,
   itemGrid.selectedRecord : {
      itemID : "654321",
      itemName : "Sewing Machine",
      price : 3.50, // note: old price
      ..other properties..
   },
   itemGrid.anySelected : true,
   itemGrid.multiSelected : false,
   itemGrid.numSelected : 1,
   itemGrid.isGrouped : false
  }
  
```
    In addition, an application can put custom data into the ruleScope via provideRuleContext().
    Returns:
    
    Current ruleScope value. Default value is null
  - setScrollbarConstructor
```
public void setScrollbarConstructor(java.lang.String scrollbarConstructor)
                             throws java.lang.IllegalStateException
```
    The class that will be used to create custom scrollbars for this component. Set this attribute to a Scrollbar subclass with e.g. a different skinImgDir, to customize scrollbar appearance for this component only.
    When spriting is enabled and supported by the skin, the default scrollbarConstructor is changed to a different scrollbar class which handles scrollbar spriting. Spriting of the scrollbars of an individual component can therefore be disabled by creating the component with scrollbarConstructor set to the "Scrollbar" class. "Scrollbar" is a basic scrollbar class that does not employ spriting.
    Note : This is an advanced setting
    
    Parameters:
    
    scrollbarConstructor - New scrollbarConstructor value. Default value is "Scrollbar"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Scrolling overview and related methods
  - setScrollbarSize
```
public void setScrollbarSize(int scrollbarSize)
```
    How thick should we make the scrollbars for this canvas. This only applies if showCustomScrollbars is true.
    NOTE: When spriting is enabled, changing the scrollbarSize may cause tiling of certain images and backgrounds that make up the custom scrollbar. This can be fixed for a component by creating it with scrollbarConstructor set to "Scrollbar"—a basic scrollbar class that does not employ spriting.
    Note : This is an advanced setting
    
    Parameters:
    
    scrollbarSize - New scrollbarSize value. Default value is 16
    
    See Also:
    
    getScrollbarSize(), Scrolling overview and related methods
  - getScrollbarSize
```
public int getScrollbarSize()
```
    How thick should we make the scrollbars for this canvas. This only applies if showCustomScrollbars is true.
    NOTE: When spriting is enabled, changing the scrollbarSize may cause tiling of certain images and backgrounds that make up the custom scrollbar. This can be fixed for a component by creating it with scrollbarConstructor set to "Scrollbar"—a basic scrollbar class that does not employ spriting.
    
    Returns:
    
    Returns the thickness of this widget's scrollbars.
    For canvases showing custom scrollbars this is determined from this.scrollbarSize. Default value is 16
    
    See Also:
    
    getScrollbarSize(), Scrolling overview and related methods
  - setShadowColor
```
public void setShadowColor(java.lang.String shadowColor)
```
    Color for the css-based drop shadow shown if useCSSShadow is true and showShadow is true.
    Has no effect if we are not using css-based shadows - in that case, use shadowImage instead.
    Note : This is an advanced setting
    
    Parameters:
    
    shadowColor - New shadowColor value. Default value is "#AAAAAA"
    
    See Also:
    
    CSSColor
  - getShadowColor
```
public java.lang.String getShadowColor()
```
    Color for the css-based drop shadow shown if useCSSShadow is true and showShadow is true.
    Has no effect if we are not using css-based shadows - in that case, use shadowImage instead.
    
    Returns:
    
    Current shadowColor value. Default value is "#AAAAAA"
    
    See Also:
    
    CSSColor
  - setShadowDepth
```
public void setShadowDepth(int shadowDepth)
                    throws java.lang.IllegalStateException
```
    Depth of the shadow, or the virtual height above the page of the widget throwing the shadow.
    This is a single parameter that can be used to control both shadowSoftness and shadowOffset.
    
    Parameters:
    
    shadowDepth - New shadowDepth value. Default value is 4
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShadowDepth
```
public int getShadowDepth()
```
    Depth of the shadow, or the virtual height above the page of the widget throwing the shadow.
    This is a single parameter that can be used to control both shadowSoftness and shadowOffset.
    
    Returns:
    
    Current shadowDepth value. Default value is 4
  - setShadowHOffset
```
public void setShadowHOffset(java.lang.Integer shadowHOffset)
```
    Horizontal offset for the shadow. Takes precedence over shadowOffset if set. Has no effect if css-shadows are not being used for this canvas.
    Note : This is an advanced setting
    
    Parameters:
    
    shadowHOffset - New shadowHOffset value. Default value is null
  - getShadowHOffset
```
public java.lang.Integer getShadowHOffset()
```
    Horizontal offset for the shadow. Takes precedence over shadowOffset if set. Has no effect if css-shadows are not being used for this canvas.
    
    Returns:
    
    Current shadowHOffset value. Default value is null
  - setShadowImage
```
public void setShadowImage(java.lang.String shadowImage)
                    throws java.lang.IllegalStateException
```
    If useCSSShadow is false, (or for browsers that do not support css3), this property supplies the base name of the series of images for the sides, corners, and center of the shadow.
    The actual image names fetched for the dropShadow combine the segment name and the shadowDepth 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".
    The names for segments are the same as those given for controlling resizable edges; see 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".
    Note : This is an advanced setting
    
    Parameters:
    
    shadowImage - New shadowImage value. Default value is "[SKIN]ds.png"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    SCImgURL
  - getShadowImage
```
public java.lang.String getShadowImage()
```
    If useCSSShadow is false, (or for browsers that do not support css3), this property supplies the base name of the series of images for the sides, corners, and center of the shadow.
    The actual image names fetched for the dropShadow combine the segment name and the shadowDepth 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".
    The names for segments are the same as those given for controlling resizable edges; see 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".
    
    Returns:
    
    Current shadowImage value. Default value is "[SKIN]ds.png"
    
    See Also:
    
    SCImgURL
  - setShadowOffset
```
public void setShadowOffset(java.lang.Integer shadowOffset)
```
    Offset of the shadow. Defaults to half of shadowDepth if unset.
    Because of the blurred edges, a shadow is larger than the originating component by 2xsoftness. An shadowOffset of 0 means that the shadow will extend around the originating component equally in all directions.
    If css shadows are being used, separate vertical and horizontal offsets may be specified via shadowHOffset and shadowVOffset.
    Note : This is an advanced setting
    
    Parameters:
    
    shadowOffset - New shadowOffset value. Default value is null
    
    See Also:
    
    Shadows Example
  - getShadowOffset
```
public java.lang.Integer getShadowOffset()
```
    Offset of the shadow. Defaults to half of shadowDepth if unset.
    Because of the blurred edges, a shadow is larger than the originating component by 2xsoftness. An shadowOffset of 0 means that the shadow will extend around the originating component equally in all directions.
    If css shadows are being used, separate vertical and horizontal offsets may be specified via shadowHOffset and shadowVOffset.
    
    Returns:
    
    Current shadowOffset value. Default value is null
    
    See Also:
    
    Shadows Example
  - setShadowSoftness
```
public void setShadowSoftness(java.lang.Integer shadowSoftness)
```
    Softness, or degree of blurring, of the shadow.
    A shadow with softness:x 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.
    Defaults to shadowDepth if unset.
    Note : This is an advanced setting
    
    Parameters:
    
    shadowSoftness - New shadowSoftness value. Default value is null
    
    See Also:
    
    Shadows Example
  - getShadowSoftness
```
public java.lang.Integer getShadowSoftness()
```
    Softness, or degree of blurring, of the shadow.
    A shadow with softness:x 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.
    Defaults to shadowDepth if unset.
    
    Returns:
    
    Current shadowSoftness value. Default value is null
    
    See Also:
    
    Shadows Example
  - setShadowSpread
```
public void setShadowSpread(java.lang.Integer shadowSpread)
```
    Explicit spread for the css-based drop shadow shown if useCSSShadow is true and showShadow is true. This property governs how much larger than the widget the shadow will appear. A negative value (coupled with an explicit offset) will result in a smaller shadow.
    Has no effect if we are not using css-based shadows - in that case, use shadowImage instead.
    Note : This is an advanced setting
    
    Parameters:
    
    shadowSpread - New shadowSpread value. Default value is null
  - getShadowSpread
```
public java.lang.Integer getShadowSpread()
```
    Explicit spread for the css-based drop shadow shown if useCSSShadow is true and showShadow is true. This property governs how much larger than the widget the shadow will appear. A negative value (coupled with an explicit offset) will result in a smaller shadow.
    Has no effect if we are not using css-based shadows - in that case, use shadowImage instead.
    
    Returns:
    
    Current shadowSpread value. Default value is null
  - setShadowVOffset
```
public void setShadowVOffset(java.lang.Integer shadowVOffset)
```
    Vertical offset for the shadow. Takes precedence over shadowOffset if set. Has no effect if css-shadows are not being used for this canvas.
    Note : This is an advanced setting
    
    Parameters:
    
    shadowVOffset - New shadowVOffset value. Default value is null
  - getShadowVOffset
```
public java.lang.Integer getShadowVOffset()
```
    Vertical offset for the shadow. Takes precedence over shadowOffset if set. Has no effect if css-shadows are not being used for this canvas.
    
    Returns:
    
    Current shadowVOffset value. Default value is null
  - setShouldPrint
```
public void setShouldPrint(java.lang.Boolean shouldPrint)
```
    Whether this canvas should be included in a printable view.
    Default is to:
    - omit all peers (edges generated by showEdges:true, etc)
    - omit anything considered a "control", such as a button or menu (see PrintProperties.omitControls)
    - include everything else not marked shouldPrint:false
    Parameters:
    
    shouldPrint - New shouldPrint value. Default value is null
    
    See Also:
    
    Printing overview and related methods
  - getShouldPrint
```
public java.lang.Boolean getShouldPrint()
```
    Whether this canvas should be included in a printable view.
    Default is to:
    - omit all peers (edges generated by showEdges:true, etc)
    - omit anything considered a "control", such as a button or menu (see PrintProperties.omitControls)
    - include everything else not marked shouldPrint:false
    Returns:
    
    Current shouldPrint value. Default value is null
    
    See Also:
    
    Printing overview and related methods
  - setShowCustomScrollbars
```
public void setShowCustomScrollbars(boolean showCustomScrollbars)
                             throws java.lang.IllegalStateException
```
    Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
    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 variable height records in grids in combination with data paging.
    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.
    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 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.
    The showCustomScrollbars 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 setDefaultShowCustomScrollbars(boolean) method or calling setProperty() , like so:
```
       Canvas canvas = new Canvas();
       canvas.setProperty("showCustomScrollbars", false);
  
```
    On touch devices, custom scrollbars are disabled in favor of enabling native touch scrolling if available. However, custom scrollbars and native touch scrolling can be enabled for the component by setting alwaysShowScrollbars to true.
    Note : This is an advanced setting
    Parameters:
    
    showCustomScrollbars - New showCustomScrollbars value. Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    setReceiveScrollbarEvents(boolean), Scrolling overview and related methods
  - getShowCustomScrollbars
```
public boolean getShowCustomScrollbars()
```
    Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
    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 variable height records in grids in combination with data paging.
    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.
    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 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.
    The showCustomScrollbars 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 setDefaultShowCustomScrollbars(boolean) method or calling setProperty() , like so:
```
       Canvas canvas = new Canvas();
       canvas.setProperty("showCustomScrollbars", false);
  
```
    On touch devices, custom scrollbars are disabled in favor of enabling native touch scrolling if available. However, custom scrollbars and native touch scrolling can be enabled for the component by setting alwaysShowScrollbars to true.
    Returns:
    
    Current showCustomScrollbars value. Default value is true
    
    See Also:
    
    getReceiveScrollbarEvents(), Scrolling overview and related methods
  - setShowDragShadow
```
public void setShowDragShadow(java.lang.Boolean showDragShadow)
```
    When this widget is dragged, if its dragAppearance is "target", should we show a shadow behind the canvas during the drag.
    Note : This is an advanced setting
    
    Parameters:
    
    showDragShadow - New showDragShadow value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag effects Example
  - getShowDragShadow
```
public java.lang.Boolean getShowDragShadow()
```
    When this widget is dragged, if its dragAppearance is "target", should we show a shadow behind the canvas during the drag.
    
    Returns:
    
    Current showDragShadow value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Drag effects Example
  - setShowEdges
```
public void setShowEdges(java.lang.Boolean showEdges)
                  throws java.lang.IllegalStateException
```
    Whether an EdgedCanvas should be used to show image-based edges around this component.
    
    Parameters:
    
    showEdges - New showEdges value. Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Edges Example
  - getShowEdges
```
public java.lang.Boolean getShowEdges()
```
    Whether an EdgedCanvas should be used to show image-based edges around this component.
    
    Returns:
    
    Current showEdges value. Default value is false
    
    See Also:
    
    Edges Example
  - setShowHover
```
public void setShowHover(java.lang.Boolean showHover)
```
    If this.canHover is true, should we show the global hover canvas by default when the user hovers over this canvas?
    
    Parameters:
    
    showHover - New showHover value. Default value is true
    
    See Also:
    
    getHoverHTML()
  - getShowHover
```
public java.lang.Boolean getShowHover()
```
    If this.canHover is true, should we show the global hover canvas by default when the user hovers over this canvas?
    
    Returns:
    
    Current showHover value. Default value is true
    
    See Also:
    
    getHoverHTML()
  - setShowHoverComponents
```
public void setShowHoverComponents(java.lang.Boolean showHoverComponents)
```
    When set to true, shows a widget hovering at the mouse point instead of the builtin hover label. Override getHoverComponent to provide the Canvas to show as the hoverComponent.
    Note : This is an advanced setting
    
    Parameters:
    
    showHoverComponents - New showHoverComponents value. Default value is false
  - getShowHoverComponents
```
public java.lang.Boolean getShowHoverComponents()
```
    When set to true, shows a widget hovering at the mouse point instead of the builtin hover label. Override getHoverComponent to provide the Canvas to show as the hoverComponent.
    
    Returns:
    
    Current showHoverComponents value. Default value is false
  - setShowResizeBar
```
public void setShowResizeBar(java.lang.Boolean showResizeBar)
```
    When this Canvas is included as a member in a Layout, whether a resizeBar should be shown after this member in the layout, to allow it to be resized.
    Whether a resizeBar is actually shown also depends on the defaultResizeBars attribute of the layout, and whether this Canvas is the last layout member.
    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 resizeBarTarget as well.
    
    If this method is called after the component has been drawn/initialized: When this Canvas is included as a member in a Layout, dynamically updates whether a resizeBar should be shown after this member in the layout, to allow it to be resized.
    Whether a resizeBar is actually shown also depends on the defaultResizeBars attribute of the layout, and whether this Canvas is the last layout member.
    
    Parameters:
    
    showResizeBar - setting for this.showResizeBar. Default value is false
    
    See Also:
    
    setResizeBarTarget(java.lang.String), Layout.setDefaultResizeBars(com.smartgwt.client.types.LayoutResizeBarPolicy), LayoutMember overview and related methods, Nesting Example
  - getShowResizeBar
```
public java.lang.Boolean getShowResizeBar()
```
    When this Canvas is included as a member in a Layout, whether a resizeBar should be shown after this member in the layout, to allow it to be resized.
    Whether a resizeBar is actually shown also depends on the defaultResizeBars attribute of the layout, and whether this Canvas is the last layout member.
    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 resizeBarTarget as well.
    
    Returns:
    
    Current showResizeBar value. Default value is false
    
    See Also:
    
    getResizeBarTarget(), Layout.getDefaultResizeBars(), LayoutMember overview and related methods, Nesting Example
  - setShowShadow
```
public void setShowShadow(java.lang.Boolean showShadow)
```
    Whether to show a drop shadow for this Canvas.
    Shadows may be rendered using css or via images. The appearance of shadows can be customized via shadowColor (for css-based shadows) or shadowImage (for image based shadows), shadowDepth, shadowOffset and shadowSoftness.
    When useCSSShadow is false, developers should be aware that the drop shadow is rendered as a peer and is drawn outside the specified width and height of the widget meaning a widget with shadows takes up a little more space than it otherwise would. A full screen canvas with showShadow set to true as this would be likely to cause browser scrollbars to appear - developers can handle this by either setting this property to false on full-screen widgets, or by setting overflow to "hidden" on the <body> element if browser-level scrolling is never intended to occur.
    
    If this method is called after the component has been drawn/initialized: Method to update showShadow.
    
    Parameters:
    
    showShadow - true if the shadow should be visible false if not. Default value is false
    
    See Also:
    
    Shadows Example
  - getShowShadow
```
public java.lang.Boolean getShowShadow()
```
    Whether to show a drop shadow for this Canvas.
    Shadows may be rendered using css or via images. The appearance of shadows can be customized via shadowColor (for css-based shadows) or shadowImage (for image based shadows), shadowDepth, shadowOffset and shadowSoftness.
    When useCSSShadow is false, developers should be aware that the drop shadow is rendered as a peer and is drawn outside the specified width and height of the widget meaning a widget with shadows takes up a little more space than it otherwise would. A full screen canvas with showShadow set to true as this would be likely to cause browser scrollbars to appear - developers can handle this by either setting this property to false on full-screen widgets, or by setting overflow to "hidden" on the <body> element if browser-level scrolling is never intended to occur.
    
    Returns:
    
    Current showShadow value. Default value is false
    
    See Also:
    
    Shadows Example
  - setShowSnapGrid
```
public void setShowSnapGrid(java.lang.Boolean showSnapGrid)
```
    Whether to show a snap grid for this Canvas. Note that the grid is only shown when either childrenSnapToGrid or childrenSnapResizeToGrid is true.
    Grid is based on snapHGap and snapVGap properties.
    
    If this method is called after the component has been drawn/initialized: Set the showSnapGrid property.
    
    Parameters:
    
    showSnapGrid - New showSnapGrid value. Default value is null
  - getShowSnapGrid
```
public java.lang.Boolean getShowSnapGrid()
```
    Whether to show a snap grid for this Canvas. Note that the grid is only shown when either childrenSnapToGrid or childrenSnapResizeToGrid is true.
    Grid is based on snapHGap and snapVGap properties.
    
    Returns:
    
    Current showSnapGrid value. Default value is null
  - setShrinkElementOnHide
```
public void setShrinkElementOnHide(boolean shrinkElementOnHide)
```
    This is an advanced setting. If set to true, when a widget is hidden, the widget's handle will be resized such that it takes up no space, in addition to having its css visibility property set to "hidden".
    In addition to preventing the size of this widget from impacting the scroll size of any parent widget while hidden, this setting works around a native bug observed in Internet Explorer 10, whereby an <IFRAME> element with visibility set to hidden can cause rendering problems, if the HTML loaded by the <IFRAME> contains a <frameset>. In this case the browser may refuse to draw other elements at the same coordinates with a lower z-index than the hidden frame. Setting this property to true works around this problem for cases where an <IFRAME> containing a <frameset will be rendered out, for example in an HTMLFlow with contentsType set to "page".
    Note : This is an advanced setting
    
    Parameters:
    
    shrinkElementOnHide - New shrinkElementOnHide value. Default value is false
    
    See Also:
    
    Visibility overview and related methods
  - getShrinkElementOnHide
```
public boolean getShrinkElementOnHide()
```
    This is an advanced setting. If set to true, when a widget is hidden, the widget's handle will be resized such that it takes up no space, in addition to having its css visibility property set to "hidden".
    In addition to preventing the size of this widget from impacting the scroll size of any parent widget while hidden, this setting works around a native bug observed in Internet Explorer 10, whereby an <IFRAME> element with visibility set to hidden can cause rendering problems, if the HTML loaded by the <IFRAME> contains a <frameset>. In this case the browser may refuse to draw other elements at the same coordinates with a lower z-index than the hidden frame. Setting this property to true works around this problem for cases where an <IFRAME> containing a <frameset will be rendered out, for example in an HTMLFlow with contentsType set to "page".
    
    Returns:
    
    Current shrinkElementOnHide value. Default value is false
    
    See Also:
    
    Visibility overview and related methods
  - setSizeMayChangeOnRedraw
```
public void setSizeMayChangeOnRedraw(java.lang.Boolean sizeMayChangeOnRedraw)
```
    Is it possible that a call to redraw() on this widget will change its size?
    Used by framework layout code when determining whether a component which has been marked as dirty needs an immediate redraw to determine its drawn size.
    If unset, default behavior assumes any component with overflow set to "visible" may change size on redraw, and any component with overflow set to "hidden", "scroll", or "auto" will not. This property overrides that behavior, and may be used to indicate that some component with non visible overflow can change size on redraw. An example use case would be a custom component with an override to explicitly resize the component as part of the redraw() flow.
    Note : This is an advanced setting
    
    Parameters:
    
    sizeMayChangeOnRedraw - New sizeMayChangeOnRedraw value. Default value is null
  - getSizeMayChangeOnRedraw
```
public java.lang.Boolean getSizeMayChangeOnRedraw()
```
    Is it possible that a call to redraw() on this widget will change its size?
    Used by framework layout code when determining whether a component which has been marked as dirty needs an immediate redraw to determine its drawn size.
    If unset, default behavior assumes any component with overflow set to "visible" may change size on redraw, and any component with overflow set to "hidden", "scroll", or "auto" will not. This property overrides that behavior, and may be used to indicate that some component with non visible overflow can change size on redraw. An example use case would be a custom component with an override to explicitly resize the component as part of the redraw() flow.
    
    Returns:
    
    Current sizeMayChangeOnRedraw value. Default value is null
  - setSkinImgDir
```
public void setSkinImgDir(java.lang.String skinImgDir)
```
    Default directory for skin images (those defined by the class), relative to the Page-wide skinDir.
    Note : This is an advanced setting
    
    Parameters:
    
    skinImgDir - New skinImgDir value. Default value is "images/"
    
    See Also:
    
    SCImgURL, Images overview and related methods
  - getSkinImgDir
```
public java.lang.String getSkinImgDir()
```
    Default directory for skin images (those defined by the class), relative to the Page-wide skinDir.
    
    Returns:
    
    Current skinImgDir value. Default value is "images/"
    
    See Also:
    
    SCImgURL, Images overview and related methods
  - setSnapAlignCandidates
```
public void setSnapAlignCandidates(Canvas... snapAlignCandidates)
```
    When childrenSnapAlign is enabled, list of candidates to check for alignment.
    If a list of snapAlignCandidates is never provided, the default is to use all children that are not explicitly excluded via isSnapAlignCandidate, including automatically adding newly added children as candidates, and ignoring children that have been removed. Use addSnapAlignCandidate() and removeSnapAlignCandidate() to add and remove special candidates while retaining all children as default candidates.
    Possible candidates which are not drawn or are hidden are automatically ignored.
    
    Parameters:
    
    snapAlignCandidates - New snapAlignCandidates value. Default value is null
  - getSnapAlignCandidates
```
public Canvas[] getSnapAlignCandidates()
```
    When childrenSnapAlign is enabled, list of candidates to check for alignment.
    If a list of snapAlignCandidates is never provided, the default is to use all children that are not explicitly excluded via isSnapAlignCandidate, including automatically adding newly added children as candidates, and ignoring children that have been removed. Use addSnapAlignCandidate() and removeSnapAlignCandidate() to add and remove special candidates while retaining all children as default candidates.
    Possible candidates which are not drawn or are hidden are automatically ignored.
    
    Returns:
    
    Current snapAlignCandidates value. Default value is null
  - setSnapAlignCenterLineStyle
```
public void setSnapAlignCenterLineStyle(java.lang.String snapAlignCenterLineStyle)
                                 throws java.lang.IllegalStateException
```
    CSS border declaration used for the line shown to indicate snapping to a center line when childrenSnapAlign is set.
    
    Parameters:
    
    snapAlignCenterLineStyle - New snapAlignCenterLineStyle value. Default value is "1px solid blue"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getSnapAlignCenterLineStyle
```
public java.lang.String getSnapAlignCenterLineStyle()
```
    CSS border declaration used for the line shown to indicate snapping to a center line when childrenSnapAlign is set.
    
    Returns:
    
    Current snapAlignCenterLineStyle value. Default value is "1px solid blue"
  - setSnapAlignEdgeLineStyle
```
public void setSnapAlignEdgeLineStyle(java.lang.String snapAlignEdgeLineStyle)
                               throws java.lang.IllegalStateException
```
    CSS border declaration used for the line shown to indicate snapping to a edge line when childrenSnapAlign is set.
    
    Parameters:
    
    snapAlignEdgeLineStyle - New snapAlignEdgeLineStyle value. Default value is "1px solid #555555"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getSnapAlignEdgeLineStyle
```
public java.lang.String getSnapAlignEdgeLineStyle()
```
    CSS border declaration used for the line shown to indicate snapping to a edge line when childrenSnapAlign is set.
    
    Returns:
    
    Current snapAlignEdgeLineStyle value. Default value is "1px solid #555555"
  - setSnapAxis
```
public void setSnapAxis(java.lang.String snapAxis)
```
    Describes which axes to apply snap-to-grid to. Valid values are "horizontal", "vertical" or "both".
    
    Parameters:
    
    snapAxis - New snapAxis value. Default value is "both"
    
    See Also:
    
    setSnapToGrid(java.lang.Boolean), setSnapResizeToGrid(java.lang.Boolean), setChildrenSnapToGrid(java.lang.Boolean), setChildrenSnapResizeToGrid(java.lang.Boolean), Dragdrop overview and related methods
  - getSnapAxis
```
public java.lang.String getSnapAxis()
```
    Describes which axes to apply snap-to-grid to. Valid values are "horizontal", "vertical" or "both".
    
    Returns:
    
    Current snapAxis value. Default value is "both"
    
    See Also:
    
    getSnapToGrid(), getSnapResizeToGrid(), getChildrenSnapToGrid(), getChildrenSnapResizeToGrid(), Dragdrop overview and related methods
  - setSnapEdge
```
public void setSnapEdge(java.lang.String snapEdge)
```
    If 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.
    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.
    
    If this method is called after the component has been drawn/initialized: Set the snapEdge property of this canvas, and handle repositioning.
    
    Parameters:
    
    snapEdge - new snapEdge value. Default value is null
    
    See Also:
    
    setSnapTo(java.lang.String), Sizing overview and related methods
  - getSnapEdge
```
public java.lang.String getSnapEdge()
```
    If 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.
    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.
    
    Returns:
    
    Return the snapEdge value of this object. Default value is null
    
    See Also:
    
    getSnapTo(), Sizing overview and related methods
  - setSnapHDirection
```
public void setSnapHDirection(java.lang.String snapHDirection)
```
    The horizontal snap direction. Set this value to "before" to snap to the nearest gridpoint to the left; set it to "after" to snap to the nearest gridpoint to the right; and set it to "nearest" to snap to the nearest gridpoint in either direction.
    
    Parameters:
    
    snapHDirection - New snapHDirection value. Default value is "after"
    
    See Also:
    
    setSnapToGrid(java.lang.Boolean), setSnapResizeToGrid(java.lang.Boolean), setChildrenSnapToGrid(java.lang.Boolean), setChildrenSnapResizeToGrid(java.lang.Boolean), Dragdrop overview and related methods
  - getSnapHDirection
```
public java.lang.String getSnapHDirection()
```
    The horizontal snap direction. Set this value to "before" to snap to the nearest gridpoint to the left; set it to "after" to snap to the nearest gridpoint to the right; and set it to "nearest" to snap to the nearest gridpoint in either direction.
    
    Returns:
    
    Current snapHDirection value. Default value is "after"
    
    See Also:
    
    getSnapToGrid(), getSnapResizeToGrid(), getChildrenSnapToGrid(), getChildrenSnapResizeToGrid(), Dragdrop overview and related methods
  - setSnapHGap
```
public void setSnapHGap(int snapHGap)
```
    The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
    
    Parameters:
    
    snapHGap - New snapHGap value. Default value is 20
    
    See Also:
    
    setSnapToGrid(java.lang.Boolean), setSnapResizeToGrid(java.lang.Boolean), setChildrenSnapToGrid(java.lang.Boolean), setChildrenSnapResizeToGrid(java.lang.Boolean), Dragdrop overview and related methods
  - getSnapHGap
```
public int getSnapHGap()
```
    The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
    
    Returns:
    
    Current snapHGap value. Default value is 20
    
    See Also:
    
    getSnapToGrid(), getSnapResizeToGrid(), getChildrenSnapToGrid(), getChildrenSnapResizeToGrid(), Dragdrop overview and related methods
  - setSnapOffsetLeft
```
public void setSnapOffsetLeft(java.lang.Integer snapOffsetLeft)
```
    If 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.
    For example if snapTo is specified as "L" and snapOffsetLeft is set to 6, this widget will be rendered 6px inside the left edge of its parent or master element. Alternatively if snapTo was set to "R", a snapOffsetLeft value of -6 would cause the component to be rendered 6px inside the right edge of its parent or master canvas.
    
    If this method is called after the component has been drawn/initialized: Setter for snapOffsetLeft.
    
    Parameters:
    
    snapOffsetLeft - new snapOffsetLeft value. Default value is null
    
    See Also:
    
    setSnapTo(java.lang.String), Sizing overview and related methods
  - getSnapOffsetLeft
```
public java.lang.Integer getSnapOffsetLeft()
```
    If 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.
    For example if snapTo is specified as "L" and snapOffsetLeft is set to 6, this widget will be rendered 6px inside the left edge of its parent or master element. Alternatively if snapTo was set to "R", a snapOffsetLeft value of -6 would cause the component to be rendered 6px inside the right edge of its parent or master canvas.
    
    Returns:
    
    Current snapOffsetLeft value. Default value is null
    
    See Also:
    
    getSnapTo(), Sizing overview and related methods
  - setSnapOffsetTop
```
public void setSnapOffsetTop(java.lang.Integer snapOffsetTop)
```
    If 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.
    For example if snapTo is specified as "T" and snapOffsetTop is set to 6, this widget will be rendered 6px below the top edge of its parent or master element. . Alternatively if snapTo was set to "B", a snapOffsetTop value of -6 would cause the component to be rendered 6px inside the bottom edge of its parent or master canvas.
    
    If this method is called after the component has been drawn/initialized: Setter for snapOffsetTop.
    
    Parameters:
    
    snapOffsetTop - new snapOffsetTop value. Default value is null
    
    See Also:
    
    setSnapTo(java.lang.String), Sizing overview and related methods
  - getSnapOffsetTop
```
public java.lang.Integer getSnapOffsetTop()
```
    If 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.
    For example if snapTo is specified as "T" and snapOffsetTop is set to 6, this widget will be rendered 6px below the top edge of its parent or master element. . Alternatively if snapTo was set to "B", a snapOffsetTop value of -6 would cause the component to be rendered 6px inside the bottom edge of its parent or master canvas.
    
    Returns:
    
    Current snapOffsetTop value. Default value is null
    
    See Also:
    
    getSnapTo(), Sizing overview and related methods
  - setSnapOnDrop
```
public void setSnapOnDrop(java.lang.Boolean snapOnDrop)
```
    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).
    Note : This is an advanced setting
    
    Parameters:
    
    snapOnDrop - New snapOnDrop value. Default value is true
    
    See Also:
    
    setSnapToGrid(java.lang.Boolean), com.smartgwt.client.widgets.Canvas#shouldSnapOnDrop, Dragdrop overview and related methods
  - getSnapOnDrop
```
public java.lang.Boolean getSnapOnDrop()
```
    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).
    
    Returns:
    
    Current snapOnDrop value. Default value is true
    
    See Also:
    
    getSnapToGrid(), com.smartgwt.client.widgets.Canvas#shouldSnapOnDrop, Dragdrop overview and related methods
  - setSnapResizeToAlign
```
public void setSnapResizeToAlign(java.lang.Boolean snapResizeToAlign)
```
    Flag to disable snapping to alignment when this Canvas is resized.
    To control snapping to align for the children resized within this Canvas, see childrenResizeSnapAlign instead.
    
    Parameters:
    
    snapResizeToAlign - New snapResizeToAlign value. Default value is null
  - getSnapResizeToAlign
```
public java.lang.Boolean getSnapResizeToAlign()
```
    Flag to disable snapping to alignment when this Canvas is resized.
    To control snapping to align for the children resized within this Canvas, see childrenResizeSnapAlign instead.
    
    Returns:
    
    Current snapResizeToAlign value. Default value is null
  - setSnapResizeToGrid
```
public void setSnapResizeToGrid(java.lang.Boolean snapResizeToGrid)
```
    Causes this canvas to snap to its parent's grid when resizing. Note that this value defaults to the Canvas's snapToGrid value if undefined.
    
    Parameters:
    
    snapResizeToGrid - New snapResizeToGrid value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - getSnapResizeToGrid
```
public java.lang.Boolean getSnapResizeToGrid()
```
    Causes this canvas to snap to its parent's grid when resizing. Note that this value defaults to the Canvas's snapToGrid value if undefined.
    
    Returns:
    
    Current snapResizeToGrid value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods
  - setSnapTo
```
public void setSnapTo(java.lang.String snapTo)
```
    Position this widget such that it is aligned with ("snapped to") an edge of its master (if specified), or its parent canvas.
    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 percentSource, sizing will be calculated based on the size of the master canvas when snapTo is set.
    Possible values: BR, BL, TR, TL, R, L, B, T, C where B=Bottom, T=Top, L=Left, R=right and C=center
    Standard snapTo behavior will attach the outer edge of the widget to the parent or master element - for example setting snapTo to "B" 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). 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 master canvas.
    snapOffsetLeft and snapOffsetTop may also be specified to offset the element from exact snapTo alignment.
    
    If this method is called after the component has been drawn/initialized: Set the snapTo property of this canvas, and handle repositioning.
    
    Parameters:
    
    snapTo - new snapTo value. Default value is null
    
    See Also:
    
    setSnapEdge(java.lang.String), setPercentBox(com.smartgwt.client.types.PercentBoxModel), Sizing overview and related methods
  - getSnapTo
```
public java.lang.String getSnapTo()
```
    Position this widget such that it is aligned with ("snapped to") an edge of its master (if specified), or its parent canvas.
    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 percentSource, sizing will be calculated based on the size of the master canvas when snapTo is set.
    Possible values: BR, BL, TR, TL, R, L, B, T, C where B=Bottom, T=Top, L=Left, R=right and C=center
    Standard snapTo behavior will attach the outer edge of the widget to the parent or master element - for example setting snapTo to "B" 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). 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 master canvas.
    snapOffsetLeft and snapOffsetTop may also be specified to offset the element from exact snapTo alignment.
    
    Returns:
    
    Return the snapTo value of this object. Default value is null
    
    See Also:
    
    getSnapEdge(), getPercentBox(), Sizing overview and related methods
  - setSnapToAlign
```
public void setSnapToAlign(java.lang.Boolean snapToAlign)
```
    Flag to disable snapping to alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
    To control snapping to align for the children dragged within this Canvas, see childrenSnapAlign instead.
    
    Parameters:
    
    snapToAlign - New snapToAlign value. Default value is null
  - getSnapToAlign
```
public java.lang.Boolean getSnapToAlign()
```
    Flag to disable snapping to alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
    To control snapping to align for the children dragged within this Canvas, see childrenSnapAlign instead.
    
    Returns:
    
    Current snapToAlign value. Default value is null
  - setSnapToCenterAlign
```
public void setSnapToCenterAlign(java.lang.Boolean snapToCenterAlign)
```
    Flag to disable snapping to center alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
    
    Parameters:
    
    snapToCenterAlign - New snapToCenterAlign value. Default value is null
  - getSnapToCenterAlign
```
public java.lang.Boolean getSnapToCenterAlign()
```
    Flag to disable snapping to center alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
    
    Returns:
    
    Current snapToCenterAlign value. Default value is null
  - setSnapToEdgeAlign
```
public void setSnapToEdgeAlign(java.lang.Boolean snapToEdgeAlign)
```
    Flag to disable snapping to edge alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
    
    Parameters:
    
    snapToEdgeAlign - New snapToEdgeAlign value. Default value is null
  - getSnapToEdgeAlign
```
public java.lang.Boolean getSnapToEdgeAlign()
```
    Flag to disable snapping to edge alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
    
    Returns:
    
    Current snapToEdgeAlign value. Default value is null
  - setSnapToGrid
```
public void setSnapToGrid(java.lang.Boolean snapToGrid)
```
    Causes this canvas to snap to its parent's grid when dragging.
    
    Parameters:
    
    snapToGrid - New snapToGrid value. Default value is null
    
    See Also:
    
    setChildrenSnapToGrid(java.lang.Boolean), Dragdrop overview and related methods
  - getSnapToGrid
```
public java.lang.Boolean getSnapToGrid()
```
    Causes this canvas to snap to its parent's grid when dragging.
    
    Returns:
    
    Current snapToGrid value. Default value is null
    
    See Also:
    
    getChildrenSnapToGrid(), Dragdrop overview and related methods
  - setSnapVDirection
```
public void setSnapVDirection(java.lang.String snapVDirection)
```
    The vertical snap direction. Set this value to "before" to snap to the nearest gridpoint above; set it to "after" to snap to the nearest gridpoint below; and set it to "nearest" to snap to the nearest gridpoint in either direction.
    
    Parameters:
    
    snapVDirection - New snapVDirection value. Default value is "after"
    
    See Also:
    
    setSnapToGrid(java.lang.Boolean), setSnapResizeToGrid(java.lang.Boolean), setChildrenSnapToGrid(java.lang.Boolean), setChildrenSnapResizeToGrid(java.lang.Boolean), Dragdrop overview and related methods
  - getSnapVDirection
```
public java.lang.String getSnapVDirection()
```
    The vertical snap direction. Set this value to "before" to snap to the nearest gridpoint above; set it to "after" to snap to the nearest gridpoint below; and set it to "nearest" to snap to the nearest gridpoint in either direction.
    
    Returns:
    
    Current snapVDirection value. Default value is "after"
    
    See Also:
    
    getSnapToGrid(), getSnapResizeToGrid(), getChildrenSnapToGrid(), getChildrenSnapResizeToGrid(), Dragdrop overview and related methods
  - setSnapVGap
```
public void setSnapVGap(int snapVGap)
```
    The vertical grid size to use, in pixels, when snap-to-grid is enabled.
    
    Parameters:
    
    snapVGap - New snapVGap value. Default value is 20
    
    See Also:
    
    setSnapToGrid(java.lang.Boolean), setSnapResizeToGrid(java.lang.Boolean), setChildrenSnapToGrid(java.lang.Boolean), setChildrenSnapResizeToGrid(java.lang.Boolean), Dragdrop overview and related methods
  - getSnapVGap
```
public int getSnapVGap()
```
    The vertical grid size to use, in pixels, when snap-to-grid is enabled.
    
    Returns:
    
    Current snapVGap value. Default value is 20
    
    See Also:
    
    getSnapToGrid(), getSnapResizeToGrid(), getChildrenSnapToGrid(), getChildrenSnapResizeToGrid(), Dragdrop overview and related methods
  - setStartLine
```
public void setStartLine(java.lang.Boolean startLine)
```
    Whether this canvas should always start a new line when used as a tile in a FlowLayout. This property is not supported in a TileLayout with TileLayout.layoutPolicy: "fit" or if databound (i.e. for a TileGrid).
    
    Parameters:
    
    startLine - New startLine value. Default value is false
    
    See Also:
    
    TileLayout.setAutoWrapLines(java.lang.Boolean)
  - getStartLine
```
public java.lang.Boolean getStartLine()
```
    Whether this canvas should always start a new line when used as a tile in a FlowLayout. This property is not supported in a TileLayout with TileLayout.layoutPolicy: "fit" or if databound (i.e. for a TileGrid).
    
    Returns:
    
    Current startLine value. Default value is false
    
    See Also:
    
    TileLayout.getAutoWrapLines()
  - setStyleName
```
public void setStyleName(java.lang.String styleName)
```
    The CSS class applied to this widget as a whole.
    
    If this method is called after the component has been drawn/initialized: Sets the CSS class for this widget
    
    Overrides:
    
    setStyleName in class com.google.gwt.user.client.ui.UIObject
    
    Parameters:
    
    styleName - new CSS style name. Default value is "normal"
    
    See Also:
    
    CSSStyleName, Appearance overview and related methods, CSS styles Example
  - getStyleName
```
public java.lang.String getStyleName()
```
    The CSS class applied to this widget as a whole.
    
    Overrides:
    
    getStyleName in class com.google.gwt.user.client.ui.UIObject
    
    Returns:
    
    Current styleName value. Default value is "normal"
    
    See Also:
    
    CSSStyleName, Appearance overview and related methods, CSS styles Example
  - setTabIndex
```
public void setTabIndex(java.lang.Integer tabIndex)
```
    If specified this governs the tabIndex of the widget in the page's tab order. Setting this value to -1 will ensure the canvas does not show up in the page's tab order, though if canFocus is true, the user may still give it keyboard focus by clicking on the widget directly.
    By default Smart GWT auto-assigns tab-indices, ensuring focusable widgets are reachable by tabbing in an intuitive order based on widget hierarchy and draw order. Specifying an explicit tab index means a widget will not participate in this automatic tab position allocation and is typically not recommended except for very simple cases.
    For more information on automatic tab index assignment, including recommended approaches for customizing tab order assignation, see the TabOrderOverview. Developers may call clearExplicitTabIndex() to clear any explicitly assigned tab index, and have the widget participate in automatic tab position allocation.
    canvas.tabIndex cannot be set to greater than TAB_INDEX_FLOOR - as we reserve the values above this range for auto-assigned tab-indices.
    
    If this method is called after the component has been drawn/initialized: Assign an explicit tabIndex to this widget at runtime.
    Developers may also call clearExplicitTabIndex() to clear any explicitly assigned tab index, and have the widget participate in automatic tab position allocation. For more information see tabIndex
    Note : This is an advanced setting
    
    Parameters:
    
    tabIndex - New tabIndex for this widget. Must be less than TAB_INDEX_FLOOR to avoid interfering with auto-assigned tab indices on the page. Default value is null
    
    See Also:
    
    Focus overview and related methods
  - getTabIndex
```
public java.lang.Integer getTabIndex()
```
    If specified this governs the tabIndex of the widget in the page's tab order. Setting this value to -1 will ensure the canvas does not show up in the page's tab order, though if canFocus is true, the user may still give it keyboard focus by clicking on the widget directly.
    By default Smart GWT auto-assigns tab-indices, ensuring focusable widgets are reachable by tabbing in an intuitive order based on widget hierarchy and draw order. Specifying an explicit tab index means a widget will not participate in this automatic tab position allocation and is typically not recommended except for very simple cases.
    For more information on automatic tab index assignment, including recommended approaches for customizing tab order assignation, see the TabOrderOverview. Developers may call clearExplicitTabIndex() to clear any explicitly assigned tab index, and have the widget participate in automatic tab position allocation.
    canvas.tabIndex cannot be set to greater than TAB_INDEX_FLOOR - as we reserve the values above this range for auto-assigned tab-indices.
    
    Returns:
    
    Current tabIndex value. Default value is null
    
    See Also:
    
    Focus overview and related methods
  - setTop
```
public void setTop(int 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 position property).
    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 parent.
    
    If this method is called after the component has been drawn/initialized: Set the top coordinate of this object, relative to its enclosing context, in pixels.
    NOTE: if you're setting multiple coordinates, use setRect() or moveTo() instead
    
    Parameters:
    
    top - new top coordinate. Default value is 0
    
    See Also:
    
    Positioning overview and related methods
  - getTop
```
public int getTop()
```
    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 position property).
    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 parent.
    
    Returns:
    
    Return the top coordinate of this object, relative to its enclosing context, in pixels. Default value is 0
    
    See Also:
    
    Positioning overview and related methods
  - setTop
```
public void setTop(java.lang.String 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 position property).
    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 parent.
    
    If this method is called after the component has been drawn/initialized: Set the top coordinate of this object, relative to its enclosing context, in pixels.
    NOTE: if you're setting multiple coordinates, use setRect() or moveTo() instead
    
    Parameters:
    
    top - new top coordinate. Default value is 0
    
    See Also:
    
    Positioning overview and related methods
  - getTopElement
```
public Canvas getTopElement()
                     throws java.lang.IllegalStateException
```
    The top-most Canvas (i.e., not a child of any other Canvas), if any, in this widget's containment hierarchy.
    Note : This method should be called only after the widget has been rendered.
    
    Returns:
    
    Current topElement value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
    
    See Also:
    
    Containment overview and related methods
  - setUpdateTabPositionOnDraw
```
public void setUpdateTabPositionOnDraw(boolean updateTabPositionOnDraw)
```
    Should canvases with no parent canvas be moved to the end of the TabIndexManager tree on draw()?
    If set to false, the tab-position will not be modified on draw.
    This property is useful for cases where the tab position of a widget will be managed by some explicit tabIndex management code.
    Note : This is an advanced setting
    
    Parameters:
    
    updateTabPositionOnDraw - New updateTabPositionOnDraw value. Default value is true
  - getUpdateTabPositionOnDraw
```
public boolean getUpdateTabPositionOnDraw()
```
    Should canvases with no parent canvas be moved to the end of the TabIndexManager tree on draw()?
    If set to false, the tab-position will not be modified on draw.
    This property is useful for cases where the tab position of a widget will be managed by some explicit tabIndex management code.
    
    Returns:
    
    Current updateTabPositionOnDraw value. Default value is true
  - setUpdateTabPositionOnReparent
```
public void setUpdateTabPositionOnReparent(boolean updateTabPositionOnReparent)
```
    Should canvases with a parent canvas be added to the TabIndexManager under the parent as described in updateChildTabPositions() and updateChildTabPosition()?
    If set to false, the tab-position will not be modified on parent change.
    This property is useful for cases where the tab position of a widget will be managed by something other than the parent canvas, for example for canvasItem canvases.
    
    If this method is called after the component has been drawn/initialized: Setter for the updateTabPositionOnReparent attribute.
    Note : This is an advanced setting
    
    Parameters:
    
    updateTabPositionOnReparent - new value for canvas.updateTabPositionOnReparent. Default value is true
  - getUpdateTabPositionOnReparent
```
public boolean getUpdateTabPositionOnReparent()
```
    Should canvases with a parent canvas be added to the TabIndexManager under the parent as described in updateChildTabPositions() and updateChildTabPosition()?
    If set to false, the tab-position will not be modified on parent change.
    This property is useful for cases where the tab position of a widget will be managed by something other than the parent canvas, for example for canvasItem canvases.
    
    Returns:
    
    Current updateTabPositionOnReparent value. Default value is true
  - setUseBackMask
```
public void setUseBackMask(java.lang.Boolean useBackMask)
```
    In earlier versions of Internet Explorer (pre IE9), a native limitation exists whereby if HTML elements are overlapping on the page, certain elements can appear to "burn through" elements in the same position with a higher z-index. Specific cases in which this have been observed include Applets, <IFRAME> elements, and for older versions of IE, native <SELECT> items.
    The backMask is a workaround for this issue. If useBackMask is set to true, the component will render an empty <IFRAME> element behind the canvas, which prevents this effect in all known cases.
    Has no effect in other browsers.
    Note : This is an advanced setting
    
    Parameters:
    
    useBackMask - New useBackMask value. Default value is false
  - getUseBackMask
```
public java.lang.Boolean getUseBackMask()
```
    In earlier versions of Internet Explorer (pre IE9), a native limitation exists whereby if HTML elements are overlapping on the page, certain elements can appear to "burn through" elements in the same position with a higher z-index. Specific cases in which this have been observed include Applets, <IFRAME> elements, and for older versions of IE, native <SELECT> items.
    The backMask is a workaround for this issue. If useBackMask is set to true, the component will render an empty <IFRAME> element behind the canvas, which prevents this effect in all known cases.
    Has no effect in other browsers.
    
    Returns:
    
    Current useBackMask value. Default value is false
  - setUseCSSShadow
```
public void setUseCSSShadow(boolean useCSSShadow)
                     throws java.lang.IllegalStateException
```
    If showShadow is true, should we use the css box-shadow property (where supported) to achieve the shadow?
    Set this property to false to switch to a media-based approach, achieved by rendering the shadowImage in an automatically generated peer. This approach is also used regardless of this property value in older browsers where the css box-shadow property isn't supported.
    See also shadowColor, shadowDepth, shadowOffset, shadowSoftness and shadowSpread
    Note : This is an advanced setting
    
    Parameters:
    
    useCSSShadow - New useCSSShadow value. Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getUseCSSShadow
```
public boolean getUseCSSShadow()
```
    If showShadow is true, should we use the css box-shadow property (where supported) to achieve the shadow?
    Set this property to false to switch to a media-based approach, achieved by rendering the shadowImage in an automatically generated peer. This approach is also used regardless of this property value in older browsers where the css box-shadow property isn't supported.
    See also shadowColor, shadowDepth, shadowOffset, shadowSoftness and shadowSpread
    
    Returns:
    
    Current useCSSShadow value. Default value is true
  - setUseDragMask
```
public void setUseDragMask(boolean useDragMask)
```
    This flag controls whether we register the component as a maskable item with the EventHandler. If enabled, a backmask will be automatically created for the dragMoveTarget on the fly to avoid burnthrough e.g. by plugins or frames.
    Note that this property will be defaulted to false unless the canvas contains an IFrame, in which case it will be defaulted to true.
    The dragMaskType property controls what kind of mask is used in case useDragMask is enabled.
    
    Parameters:
    
    useDragMask - New useDragMask value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods
  - getUseDragMask
```
public boolean getUseDragMask()
```
    This flag controls whether we register the component as a maskable item with the EventHandler. If enabled, a backmask will be automatically created for the dragMoveTarget on the fly to avoid burnthrough e.g. by plugins or frames.
    Note that this property will be defaulted to false unless the canvas contains an IFrame, in which case it will be defaulted to true.
    The dragMaskType property controls what kind of mask is used in case useDragMask is enabled.
    
    Returns:
    
    Current useDragMask value. Default value is false
    
    See Also:
    
    Dragdrop overview and related methods
  - setUseImageForSVG
```
public void setUseImageForSVG(boolean useImageForSVG)
                       throws java.lang.IllegalStateException
```
    If set, forces the main SVG image or icon in the canvas to be rendered in an <image> tag rather than an <object> tag, the default. Typical use cases might be configuring the image of an Img or ImgButton, or the icon of a Button.
    Rendering via <object> tag provides the maximum support for CSS in SVG, but may result in a flicker at the browser level when changing images - either manually such as with setImage() or via state change from rollover, mouseDown, etc. Using <image> tags to inline the images breaks CSS support but may avoid flickering.
    If this property is not set, then you can also control whether an SVG image is rendered in an object or image tag by setting the query param "tag" on the image URL - see SCImgURL for details.
    Note that if multiple icons are potentially present in a canvas (e.g. removeIcons in the cells of a grid body), then setting this property on the widget instance may have no effect. In such case, the Canvas prototype is consulted.
    Note : This is an advanced setting
    
    Parameters:
    
    useImageForSVG - New useImageForSVG value. Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Img.setSrc(java.lang.String), Button.setIcon(java.lang.String), Images overview and related methods
  - getUseImageForSVG
```
public boolean getUseImageForSVG()
```
    If set, forces the main SVG image or icon in the canvas to be rendered in an <image> tag rather than an <object> tag, the default. Typical use cases might be configuring the image of an Img or ImgButton, or the icon of a Button.
    Rendering via <object> tag provides the maximum support for CSS in SVG, but may result in a flicker at the browser level when changing images - either manually such as with setImage() or via state change from rollover, mouseDown, etc. Using <image> tags to inline the images breaks CSS support but may avoid flickering.
    If this property is not set, then you can also control whether an SVG image is rendered in an object or image tag by setting the query param "tag" on the image URL - see SCImgURL for details.
    Note that if multiple icons are potentially present in a canvas (e.g. removeIcons in the cells of a grid body), then setting this property on the widget instance may have no effect. In such case, the Canvas prototype is consulted.
    
    Returns:
    
    Current useImageForSVG value. Default value is false
    
    See Also:
    
    Img.getSrc(), Button.getIcon(), Images overview and related methods
  - setUseNativeDrag
```
public void setUseNativeDrag(java.lang.Boolean useNativeDrag)
                      throws java.lang.IllegalStateException
```
    If set, native HTML5 drag and drop will be used for all drags initiated on this widget (on browsers where this is supported).
    When using native HTML5 drags, the same series of events fires as for a normal drag (Canvas.dragStart(), Canvas.dropMove(), etc.), and the dragType / dropTypes system works. dragAppearance is not supported; however, basic customization of the browser's tracker image is supported in certain browsers via the EventHandler.setDragTrackerImage() API.
    The primary difference with a native drag is that it can be cross-frame; that is, the user can drag out of the current browser window and drop into a different window or tab.
    To provide information that will be available to a foreign frame, use EventHandler.setNativeDragData(). This API must be called when the Canvas.dragStart() event fires, and will not work if called at any other time.
    However, due to browser bugs and/or browser-imposed limitations, the information provided to setNativeDragData cannot be accessed in the foreign frame until the actual drop occurs (mouse button released). This means drop eligibility cannot be determined dynamically based on the dragged data; instead, eligibility can only be determined based on the dragType / dropTypes system. For this reason, a dragType must be set on the source of a drag.
    NOTE: Although Internet Explorer 10+ and Edge support a subset of the HTML5 drag and drop standard, native drag and drop is disabled in IE and Edge because cross-window drags—the primary purpose of this API—are not possible.
    
    Parameters:
    
    useNativeDrag - New useNativeDrag value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Dragdrop overview and related methods, Native Drag Create Example
  - getUseNativeDrag
```
public java.lang.Boolean getUseNativeDrag()
```
    If set, native HTML5 drag and drop will be used for all drags initiated on this widget (on browsers where this is supported).
    When using native HTML5 drags, the same series of events fires as for a normal drag (Canvas.dragStart(), Canvas.dropMove(), etc.), and the dragType / dropTypes system works. dragAppearance is not supported; however, basic customization of the browser's tracker image is supported in certain browsers via the EventHandler.setDragTrackerImage() API.
    The primary difference with a native drag is that it can be cross-frame; that is, the user can drag out of the current browser window and drop into a different window or tab.
    To provide information that will be available to a foreign frame, use EventHandler.setNativeDragData(). This API must be called when the Canvas.dragStart() event fires, and will not work if called at any other time.
    However, due to browser bugs and/or browser-imposed limitations, the information provided to setNativeDragData cannot be accessed in the foreign frame until the actual drop occurs (mouse button released). This means drop eligibility cannot be determined dynamically based on the dragged data; instead, eligibility can only be determined based on the dragType / dropTypes system. For this reason, a dragType must be set on the source of a drag.
    NOTE: Although Internet Explorer 10+ and Edge support a subset of the HTML5 drag and drop standard, native drag and drop is disabled in IE and Edge because cross-window drags—the primary purpose of this API—are not possible.
    
    Returns:
    
    Current useNativeDrag value. Default value is null
    
    See Also:
    
    Dragdrop overview and related methods, Native Drag Create Example
  - setUseOpacityFilter
```
public void setUseOpacityFilter(java.lang.Boolean useOpacityFilter)
                         throws java.lang.IllegalStateException
```
    Configures where the Opacity filter is used for IE6-8.
    With the default of null, opacity filters are used unless neverUseFilters has been set. When set explicitly to true, opacity filters are used even if neverUseFilters is true.
    See IEFilters for background.
    
    Parameters:
    
    useOpacityFilter - New useOpacityFilter value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    IEFilters overview and related methods
  - getUseOpacityFilter
```
public java.lang.Boolean getUseOpacityFilter()
```
    Configures where the Opacity filter is used for IE6-8.
    With the default of null, opacity filters are used unless neverUseFilters has been set. When set explicitly to true, opacity filters are used even if neverUseFilters is true.
    See IEFilters for background.
    
    Returns:
    
    Current useOpacityFilter value. Default value is null
    
    See Also:
    
    IEFilters overview and related methods
  - setUseTouchScrolling
```
public void setUseTouchScrolling(java.lang.Boolean useTouchScrolling)
                          throws java.lang.IllegalStateException
```
    On touch devices, if this Canvas can be scrolled, should touch-dragging the content area result in scrolling? Set to false if touch-dragging should not cause scrolling. Note that setting to false enables the use of custom scrollbars on touch devices.
    useTouchScrolling can default to false if disableTouchScrollingForDrag is true and various built-in drag operations are enabled that normally interfere with touch scrolling (e.g. ListGrid.canDragSelect and ListGrid.canReorderRecords).
    When touch scrolling is disabled, it can be difficult to interact with parts of the custom scrollbars at their default size of 16 pixels. In touch browsers, any touch 8px before the thumb of a custom scrollbar will be mapped to the thumb, but the other parts of the scrollbar do not have a similar tolerance applied. The width of the custom scrollbars can be increased by setting the scrollbarSize to a larger value, but note that when spriting is enabled, changing the scrollbarSize may cause tiling of certain images and backgrounds that make up the custom scrollbar. This can be fixed for a component by creating it with scrollbarConstructor set to "Scrollbar"—a basic scrollbar class that does not employ spriting.
    Note : This is an advanced setting
    
    Parameters:
    
    useTouchScrolling - New useTouchScrolling value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Scrolling overview and related methods
  - getUseTouchScrolling
```
public java.lang.Boolean getUseTouchScrolling()
```
    On touch devices, if this Canvas can be scrolled, should touch-dragging the content area result in scrolling? Set to false if touch-dragging should not cause scrolling. Note that setting to false enables the use of custom scrollbars on touch devices.
    useTouchScrolling can default to false if disableTouchScrollingForDrag is true and various built-in drag operations are enabled that normally interfere with touch scrolling (e.g. ListGrid.canDragSelect and ListGrid.canReorderRecords).
    When touch scrolling is disabled, it can be difficult to interact with parts of the custom scrollbars at their default size of 16 pixels. In touch browsers, any touch 8px before the thumb of a custom scrollbar will be mapped to the thumb, but the other parts of the scrollbar do not have a similar tolerance applied. The width of the custom scrollbars can be increased by setting the scrollbarSize to a larger value, but note that when spriting is enabled, changing the scrollbarSize may cause tiling of certain images and backgrounds that make up the custom scrollbar. This can be fixed for a component by creating it with scrollbarConstructor set to "Scrollbar"—a basic scrollbar class that does not employ spriting.
    
    Returns:
    
    Current useTouchScrolling value. Default value is null
    
    See Also:
    
    Scrolling overview and related methods
  - setValuesManager
```
public void setValuesManager(ValuesManager valuesManager)
```
    ValuesManager for managing values displayed in this component. If specified at initialization time, this component will be added to the valuesManager via ValuesManager.addMember().
    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.
    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 DataPath.
    Note that components may be automatically bound to an existing valuesManager attached to a parent component if dataPath is specified. See 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
    
    If this method is called after the component has been drawn/initialized: Setter for the valuesManager attribute. This method may be called directly at runtime to set the ValuesManager for a component; it has the same effect as calling ValuesManager.addMember(), passing in this DataBoundComponent.
    Note : This is an advanced setting
    
    Parameters:
    
    valuesManager - new dataPath. Default value is null
  - getValuesManager
```
public ValuesManager getValuesManager()
```
    ValuesManager for managing values displayed in this component. If specified at initialization time, this component will be added to the valuesManager via ValuesManager.addMember().
    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.
    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 DataPath.
    Note that components may be automatically bound to an existing valuesManager attached to a parent component if dataPath is specified. See 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
    
    Returns:
    
    Current valuesManager value. Default value is null
  - setValuesManager
```
public void setValuesManager(java.lang.String valuesManager)
```
    ValuesManager for managing values displayed in this component. If specified at initialization time, this component will be added to the valuesManager via ValuesManager.addMember().
    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.
    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 DataPath.
    Note that components may be automatically bound to an existing valuesManager attached to a parent component if dataPath is specified. See 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
    
    If this method is called after the component has been drawn/initialized: Setter for the valuesManager attribute. This method may be called directly at runtime to set the ValuesManager for a component; it has the same effect as calling ValuesManager.addMember(), passing in this DataBoundComponent.
    Note : This is an advanced setting
    
    Parameters:
    
    valuesManager - new dataPath. Default value is null
    
    See Also:
    
    GlobalId
  - getValuesManagerAsString
```
public java.lang.String getValuesManagerAsString()
```
    ValuesManager for managing values displayed in this component. If specified at initialization time, this component will be added to the valuesManager via ValuesManager.addMember().
    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.
    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 DataPath.
    Note that components may be automatically bound to an existing valuesManager attached to a parent component if dataPath is specified. See 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
    
    Returns:
    
    Current valuesManager value. Default value is null
    
    See Also:
    
    GlobalId
  - setVisibility
```
public void setVisibility(Visibility visibility)
```
    Controls widget visibility when the widget is initialized. See Visibility type for details.
    Specifying "visible" sets the CSS visiblity to "visible", forcing a child to be visible even if the parent is hidden. Not supported for use with Smart GWT layouts, scrolling or auto-sizing but may be useful when working with third-party or legacy DOM layout systems.
    Note that if hideUsingDisplayNone is set for a hidden ancestor, setting visibility will have no effect at all until that ancestor becomes visible.
    
    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 of its parents are visible or it has no parents.
    If the widget has not yet been drawn (and doesn't have a parent or master), this method calls the draw method as well.
    
    Parameters:
    
    visibility - New visibility value. Default value is Canvas.INHERIT
    
    See Also:
    
    Appearance overview and related methods
  - getVisibility
```
public Visibility getVisibility()
```
    Controls widget visibility when the widget is initialized. See Visibility type for details.
    Specifying "visible" sets the CSS visiblity to "visible", forcing a child to be visible even if the parent is hidden. Not supported for use with Smart GWT layouts, scrolling or auto-sizing but may be useful when working with third-party or legacy DOM layout systems.
    Note that if hideUsingDisplayNone is set for a hidden ancestor, setting visibility will have no effect at all until that ancestor becomes visible.
    
    Returns:
    
    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.
    NOTE: Undrawn widgets will report themselves as visible if they would be visible if drawn. Default value is Canvas.INHERIT
    
    See Also:
    
    Appearance overview and related methods
  - setVisibleWhen
```
public void setVisibleWhen(AdvancedCriteria visibleWhen)
                    throws java.lang.IllegalStateException
```
    Criteria to be evaluated to determine whether this Canvas should be visible. Re-evaluated whenever data in the ruleScope changes.
    A basic criteria uses textMatchStyle:"exact". When specified in Component XML this property allows shorthand formats for defining criteria.
    
    Parameters:
    
    visibleWhen - New visibleWhen value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    RuleCriteria overview and related methods
  - getVisibleWhen
```
public AdvancedCriteria getVisibleWhen()
```
    Criteria to be evaluated to determine whether this Canvas should be visible. Re-evaluated whenever data in the ruleScope changes.
    A basic criteria uses textMatchStyle:"exact". When specified in Component XML this property allows shorthand formats for defining criteria.
    
    Returns:
    
    Current visibleWhen value. Default value is null
    
    See Also:
    
    RuleCriteria overview and related methods
  - setWidth
```
public void setWidth(java.lang.Integer width)
```
    Size for this component's horizontal dimension.
    Can be a number of pixels, or a percentage like "50%". Percentage sizes are resolved to pixel values as follows:
    - If a canvas has a specified percentSource, sizing will be a percentage of the size of that widget (see also percentBox).
    - Otherwise, if a canvas has a master canvas, and snapTo is set for the widget, sizing will be a percentage of the size of that widget (see also percentBox).
    - Otherwise if this is a child of some other canvas, percentages will be based on the inner size of the parent canvas's viewport.
    - Otherwise, for top level widgets, sizing is calculated as a percentage of page size.
    Note that if a maxWidth or minWidth are specified (or maxHeight / minHeight for heights), these properties act as explicit pixel limits on the canvas' size. For example, a canvas with maxWidth set to 500, and width specified as "100%" will not render larger than 500 pixels in width even if there is more space available in the parent canvas or percentSource.
    Layouts may specially interpret percentage sizes on their children, and also allow "*" as a size.
    Note that if overflow is set to "visible", this size is a minimum, and the component may overflow to show all content and/or children.
    If trying to establish a default width for a custom component, set defaultWidth instead.
    
    If this method is called after the component has been drawn/initialized: 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.
    NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
    Parameters:
    
    width - new width. Default value is null
    
    See Also:
    
    Sizing overview and related methods
  - getWidth
```
public java.lang.Integer getWidth()
```
    Size for this component's horizontal dimension.
    Can be a number of pixels, or a percentage like "50%". Percentage sizes are resolved to pixel values as follows:
    - If a canvas has a specified percentSource, sizing will be a percentage of the size of that widget (see also percentBox).
    - Otherwise, if a canvas has a master canvas, and snapTo is set for the widget, sizing will be a percentage of the size of that widget (see also percentBox).
    - Otherwise if this is a child of some other canvas, percentages will be based on the inner size of the parent canvas's viewport.
    - Otherwise, for top level widgets, sizing is calculated as a percentage of page size.
    Note that if a maxWidth or minWidth are specified (or maxHeight / minHeight for heights), these properties act as explicit pixel limits on the canvas' size. For example, a canvas with maxWidth set to 500, and width specified as "100%" will not render larger than 500 pixels in width even if there is more space available in the parent canvas or percentSource.
    Layouts may specially interpret percentage sizes on their children, and also allow "*" as a size.
    Note that if overflow is set to "visible", this size is a minimum, and the component may overflow to show all content and/or children.
    If trying to establish a default width for a custom component, set defaultWidth instead.
    Returns:
    
    Return the width of this object, in pixels. Default value is null
    
    See Also:
    
    Sizing overview and related methods
  - setWidth
```
public void setWidth(java.lang.String width)
```
    Size for this component's horizontal dimension.
    Can be a number of pixels, or a percentage like "50%". Percentage sizes are resolved to pixel values as follows:
    - If a canvas has a specified percentSource, sizing will be a percentage of the size of that widget (see also percentBox).
    - Otherwise, if a canvas has a master canvas, and snapTo is set for the widget, sizing will be a percentage of the size of that widget (see also percentBox).
    - Otherwise if this is a child of some other canvas, percentages will be based on the inner size of the parent canvas's viewport.
    - Otherwise, for top level widgets, sizing is calculated as a percentage of page size.
    Note that if a maxWidth or minWidth are specified (or maxHeight / minHeight for heights), these properties act as explicit pixel limits on the canvas' size. For example, a canvas with maxWidth set to 500, and width specified as "100%" will not render larger than 500 pixels in width even if there is more space available in the parent canvas or percentSource.
    Layouts may specially interpret percentage sizes on their children, and also allow "*" as a size.
    Note that if overflow is set to "visible", this size is a minimum, and the component may overflow to show all content and/or children.
    If trying to establish a default width for a custom component, set defaultWidth instead.
    
    If this method is called after the component has been drawn/initialized: 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.
    NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
    Overrides:
    
    setWidth in class com.google.gwt.user.client.ui.UIObject
    
    Parameters:
    
    width - new width. Default value is null
    
    See Also:
    
    Sizing overview and related methods
  - addChild
```
public Canvas addChild(Canvas newChild)
```
    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.
    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.
    
    Parameters:
    
    newChild - new child canvas to add
    
    Returns:
    
    the new child, or null if it couldn't be added
    
    See Also:
    
    Containment overview and related methods
  - addChild
```
public Canvas addChild(Canvas newChild,
                       java.lang.String name)
```
    See Also:
    
    addChild(com.smartgwt.client.widgets.Canvas)
  - addChild
```
public Canvas addChild(Canvas newChild,
                       java.lang.String name,
                       java.lang.Boolean autoDraw)
```
    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.
    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.
    
    Parameters:
    
    newChild - new child canvas to add
    
    name - name to assign to child (eg: this[name] == child)
    
    autoDraw - if false, child will not automatically be drawn (only for advanced use)
    
    Returns:
    
    the new child, or null if it couldn't be added
    
    See Also:
    
    Containment overview and related methods
  - addPeer
```
public Canvas addPeer(Canvas newPeer)
```
    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.
    
    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)
    
    Parameters:
    
    newPeer - new peer widget to add
    
    Returns:
    
    the new peer, or null if it couldn't be added
    
    See Also:
    
    Containment overview and related methods
  - addPeer
```
public Canvas addPeer(Canvas newPeer,
                      java.lang.String name)
```
    See Also:
    
    addPeer(com.smartgwt.client.widgets.Canvas)
  - addPeer
```
public Canvas addPeer(Canvas newPeer,
                      java.lang.String name,
                      java.lang.Boolean autoDraw)
```
    See Also:
    
    addPeer(com.smartgwt.client.widgets.Canvas)
  - addPeer
```
public Canvas addPeer(Canvas newPeer,
                      java.lang.String name,
                      java.lang.Boolean autoDraw,
                      java.lang.Boolean preDraw)
```
    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.
    
    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)
    
    Parameters:
    
    newPeer - new peer widget to add
    
    name - name to assign to peer (eg: this[peer] == child)
    
    autoDraw - if true, peer will not automatically be drawn (only for advanced use)
    
    preDraw - if true, when draw is called on the master widget, the peer will be drawn before the master
    
    Returns:
    
    the new peer, or null if it couldn't be added
    
    See Also:
    
    Containment overview and related methods
  - addSnapAlignCandidate
```
public void addSnapAlignCandidate(Canvas newCandidate)
```
    Add a candidate to snapAlignCandidates. Duplicates are automatically avoided.
    
    Parameters:
    
    newCandidate -
  - adjustForContent
```
public void adjustForContent(boolean immediate)
```
    This method tells a component to adjust for changes in the size of its content that happen outside of Smart GWT APIs. This may include:
    1. size changes due to "replaced" HTML elements (elements that may change size after their content loads, such as <img> tags with no sizes). To avoid the need to call adjustForContent(), specify sizes on replaced elements wherever possible.
    2. modification of HTML contained in a Canvas by direct manipulation of the DOM - see the DOM-level Integration overview. Note that only contents supplied to a widget via contents or via an override of 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.
    Parameters:
    
    immediate - By default the adjustment will occur on a small delay for performance reasons. Pass in this parameter to force immediate adjustment.
    
    See Also:
    
    Sizing overview and related methods
  - animateFade
```
public void animateFade(java.lang.Integer opacity)
```
    Animate a change in opacity from the widget's current opacity to the specified opacity.
    
    Parameters:
    
    opacity - desired final opacity
    
    See Also:
    
    Fade Show & Hide Example
  - animateFade
```
public void animateFade(java.lang.Integer opacity,
                        AnimationCallback callback)
```
    See Also:
    
    animateFade(java.lang.Integer)
  - animateFade
```
public void animateFade(java.lang.Integer opacity,
                        AnimationCallback callback,
                        java.lang.Integer duration)
```
    See Also:
    
    animateFade(java.lang.Integer)
  - animateFade
```
public void animateFade(java.lang.Integer opacity,
                        AnimationCallback callback,
                        java.lang.Integer duration,
                        AnimationAcceleration acceleration)
```
    Animate a change in opacity from the widget's current opacity to the specified opacity.
    
    Parameters:
    
    opacity - desired final opacity
    
    callback - When the fade completes this callback will be fired. Single 'earlyFinish' parameter will be passed if the animation was cut short, for example by a call to the non-animated API setOpacity().
    
    duration - Duration in ms of the animated fade
    
    acceleration - Optional animation acceleration to bias the ratios
    
    See Also:
    
    Fade Show & Hide Example
  - animateMove
```
public void animateMove(java.lang.Integer left,
                        java.lang.Integer top)
```
    Animate a reposition of this canvas from its current position to the specified position
    
    Parameters:
    
    left - new left position (or null for unchanged)
    
    top - new top position (or null for unchanged)
    
    See Also:
    
    Fly Onscreen Example
  - animateMove
```
public void animateMove(java.lang.Integer left,
                        java.lang.Integer top,
                        AnimationCallback callback)
```
    See Also:
    
    animateMove(java.lang.Integer, java.lang.Integer)
  - animateMove
```
public void animateMove(java.lang.Integer left,
                        java.lang.Integer top,
                        AnimationCallback callback,
                        java.lang.Integer duration)
```
    See Also:
    
    animateMove(java.lang.Integer, java.lang.Integer)
  - animateMove
```
public void animateMove(java.lang.Integer left,
                        java.lang.Integer top,
                        AnimationCallback callback,
                        java.lang.Integer duration,
                        AnimationAcceleration acceleration)
```
    Animate a reposition of this canvas from its current position to the specified position
    
    Parameters:
    
    left - new left position (or null for unchanged)
    
    top - new top position (or null for unchanged)
    
    callback - When the move completes this callback will be fired. Single 'earlyFinish' parameter will be passed if the animation was cut short, for example by a call to the non-animated APIs moveTo() or moveBy().
    
    duration - Duration in ms of the animated move
    
    acceleration - Optional acceleration effect to bias the ratios
    
    See Also:
    
    Fly Onscreen Example
  - animateRect
```
public void animateRect(java.lang.Integer left,
                        java.lang.Integer top,
                        java.lang.Integer width,
                        java.lang.Integer height)
```
    Animate a reposition / resize of this canvas from its current size and position.
    
    Parameters:
    
    left - new left position (or null for unchanged)
    
    top - new top position (or null for unchanged)
    
    width - new width (or null for unchanged)
    
    height - new height (or null for unchanged)
    
    See Also:
    
    Zoom & Shrink Example
  - animateRect
```
public void animateRect(java.lang.Integer left,
                        java.lang.Integer top,
                        java.lang.Integer width,
                        java.lang.Integer height,
                        AnimationCallback callback)
```
    See Also:
    
    animateRect(java.lang.Integer, java.lang.Integer, java.lang.Integer, java.lang.Integer)
  - animateRect
```
public void animateRect(java.lang.Integer left,
                        java.lang.Integer top,
                        java.lang.Integer width,
                        java.lang.Integer height,
                        AnimationCallback callback,
                        java.lang.Integer duration)
```
    See Also:
    
    animateRect(java.lang.Integer, java.lang.Integer, java.lang.Integer, java.lang.Integer)
  - animateRect
```
public void animateRect(java.lang.Integer left,
                        java.lang.Integer top,
                        java.lang.Integer width,
                        java.lang.Integer height,
                        AnimationCallback callback,
                        java.lang.Integer duration,
                        AnimationAcceleration acceleration)
```
    Animate a reposition / resize of this canvas from its current size and position.
    
    Parameters:
    
    left - new left position (or null for unchanged)
    
    top - new top position (or null for unchanged)
    
    width - new width (or null for unchanged)
    
    height - new height (or null for unchanged)
    
    callback - When the setRect completes this callback will be fired. Single 'earlyFinish' parameter will be passed if the animation was cut short, for example by a call to the non-animated API setRect().
    
    duration - Duration in ms of the animated setRect
    
    acceleration - Optional acceleration effect to apply to the animation
    
    See Also:
    
    Zoom & Shrink Example
  - animateResize
```
public void animateResize(java.lang.Integer width,
                          java.lang.Integer height)
```
    Animate a resize of this canvas from its current size to the specified size
    Note that animateResizeLayoutMode allows you to control whether child layout is rerun during every step of the animation, or just at the end, since the former may incur significant overhead depending on the widget hierarchy.
    
    Parameters:
    
    width - new width (or null for unchanged)
    
    height - new height (or null for unchanged)
    
    See Also:
    
    Resize Example
  - animateResize
```
public void animateResize(java.lang.Integer width,
                          java.lang.Integer height,
                          AnimationCallback callback)
```
    See Also:
    
    animateResize(java.lang.Integer, java.lang.Integer)
  - animateResize
```
public void animateResize(java.lang.Integer width,
                          java.lang.Integer height,
                          AnimationCallback callback,
                          java.lang.Integer duration)
```
    See Also:
    
    animateResize(java.lang.Integer, java.lang.Integer)
  - animateResize
```
public void animateResize(java.lang.Integer width,
                          java.lang.Integer height,
                          AnimationCallback callback,
                          java.lang.Integer duration,
                          AnimationAcceleration acceleration)
```
    Animate a resize of this canvas from its current size to the specified size
    Note that animateResizeLayoutMode allows you to control whether child layout is rerun during every step of the animation, or just at the end, since the former may incur significant overhead depending on the widget hierarchy.
    
    Parameters:
    
    width - new width (or null for unchanged)
    
    height - new height (or null for unchanged)
    
    callback - When the resize completes this callback will be fired. Single 'earlyFinish' parameter will be passed if the animation was cut short, for example by a call to the non-animated APIs resizeTo() or resizeBy().
    
    duration - Duration in ms of the animated resize
    
    acceleration - Optional acceleration effect to apply to the resize
    
    See Also:
    
    Resize Example
  - animateScroll
```
public void animateScroll(java.lang.Integer scrollLeft,
                          java.lang.Integer scrollTop)
```
    Animate a scroll from the current scroll position to the specified position.
    
    Parameters:
    
    scrollLeft - desired final left scroll position
    
    scrollTop - desired final top scroll position
  - animateScroll
```
public void animateScroll(java.lang.Integer scrollLeft,
                          java.lang.Integer scrollTop,
                          AnimationCallback callback)
```
    See Also:
    
    animateScroll(java.lang.Integer, java.lang.Integer)
  - animateScroll
```
public void animateScroll(java.lang.Integer scrollLeft,
                          java.lang.Integer scrollTop,
                          AnimationCallback callback,
                          java.lang.Integer duration)
```
    See Also:
    
    animateScroll(java.lang.Integer, java.lang.Integer)
  - animateScroll
```
public void animateScroll(java.lang.Integer scrollLeft,
                          java.lang.Integer scrollTop,
                          AnimationCallback callback,
                          java.lang.Integer duration,
                          AnimationAcceleration acceleration)
```
    Animate a scroll from the current scroll position to the specified position.
    
    Parameters:
    
    scrollLeft - desired final left scroll position
    
    scrollTop - desired final top scroll position
    
    callback - When the scroll completes this callback will be fired. Single 'earlyFinish' parameter will be passed if the animation was cut short, for example by a call to the non-animated APIs scrollTo() or scrollBy().
    
    duration - Duration in ms of the animated scroll
    
    acceleration - Optional acceleration to bias the animation ratios
  - blur
```
public void blur()
```
    If this canvas has keyboard focus, blur it. After this method, the canvas will no longer appear focused and will stop receiving keyboard events.
    
    See Also:
    
    Focus overview and related methods
  - bringToFront
```
public void bringToFront()
```
    Puts this widget at the top of the stacking order, so it appears in front of all other widgets in the same parent.
    
    See Also:
    
    ZIndex overview and related methods, Layer Example
  - clear
```
public void clear()
```
    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.
    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 destroy().
    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.
    Note: a clear() will happen as part of moving a Canvas to a different parent. See addChild().
  - clearExplicitTabIndex
```
public void clearExplicitTabIndex()
```
    If an explicit tabIndex was assigned to this widget, clear it. This will enable automatic tab index managment behaviors via the TabIndexManager class as described in the TabOrderOverview
  - addClickHandler
```
public com.google.gwt.event.shared.HandlerRegistration addClickHandler(ClickHandler handler)
```
    Add a click handler.
    Executed when the left mouse is clicked (pressed and then released) on this widget. No default implementation.
    
    Specified by:
    
    addClickHandler in interface HasClickHandlers
    
    Parameters:
    
    handler - the click handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - clickMaskUp
```
public java.lang.Boolean clickMaskUp()
```
    Determines whether a clickmask is showing
    
    Returns:
    
    whether or not a clickmask is showing
    
    See Also:
    
    showClickMask(com.smartgwt.client.core.Function, com.smartgwt.client.types.ClickMaskMode, com.smartgwt.client.widgets.Canvas[])
  - clickMaskUp
```
public java.lang.Boolean clickMaskUp(java.lang.String ID)
```
    Determines whether a clickmask is showing
    
    Parameters:
    
    ID - optional ID of specific clickMask to check. If not passed, checks for the click mask associated with this widget only.
    
    Returns:
    
    whether or not a clickmask is showing
    
    See Also:
    
    showClickMask(com.smartgwt.client.core.Function, com.smartgwt.client.types.ClickMaskMode, com.smartgwt.client.widgets.Canvas[])
  - contains
```
public java.lang.Boolean contains(Canvas canvas)
```
    Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment hierarchy); and false otherwise.
    
    Parameters:
    
    canvas - the canvas to be tested
    
    Returns:
    
    true if specified element is a descendant of this canvas; false otherwise
    
    See Also:
    
    Containment overview and related methods
  - contains
```
public java.lang.Boolean contains(Canvas canvas,
                                  java.lang.Boolean testSelf)
```
    Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment hierarchy); and false otherwise.
    
    Parameters:
    
    canvas - the canvas to be tested
    
    testSelf - If passed this method will return true if the canvas parameter is a pointer to this widget.
    
    Returns:
    
    true if specified element is a descendant of this canvas; false otherwise
    
    See Also:
    
    Containment overview and related methods
  - containsEvent
```
public java.lang.Boolean containsEvent()
```
    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.
    
    Returns:
    
    true if the event occurred within the bounds of this component
    
    See Also:
    
    Positioning overview and related methods
  - containsFocus
```
public java.lang.Boolean containsFocus()
```
    Returns true if the keyboard focus is in this Canvas or any child of this Canvas.
    
    Returns:
    
    whether this Canvas contains the keyboard focus
    
    See Also:
    
    Focus overview and related methods
  - containsPoint
```
public java.lang.Boolean containsPoint(int x,
                                       int y)
```
    Return whether or not this object contains the specified global (x,y) coordinates.
    Will return false if any parent canvas 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)
    
    Parameters:
    
    x - GLOBAL x-coordinate
    
    y - GLOBAL y-coordinate
    
    Returns:
    
    true if this object contains the specified point; false otherwise
    
    See Also:
    
    Positioning overview and related methods
  - containsPoint
```
public java.lang.Boolean containsPoint(int x,
                                       int y,
                                       java.lang.Boolean withinViewport)
```
    Return whether or not this object contains the specified global (x,y) coordinates.
    Will return false if any parent canvas 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)
    
    Parameters:
    
    x - GLOBAL x-coordinate
    
    y - GLOBAL y-coordinate
    
    withinViewport - point lies specifically within our viewport (drawn area excluding margins and scrollbars if present)
    
    Returns:
    
    true if this object contains the specified point; false otherwise
    
    See Also:
    
    Positioning overview and related methods
  - deparent
```
public void deparent()
```
    Remove this canvas from its parent if it has one.
    
    See Also:
    
    Containment overview and related methods
  - depeer
```
public void depeer()
```
    Make this Canvas no longer a peer of its master
    
    See Also:
    
    Containment overview and related methods
  - disable
```
public void disable()
```
    Disables this widget and any children and peers of this widget.
    
    See Also:
    
    Enable overview and related methods
  - addDoubleClickHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler)
```
    Add a doubleClick handler.
    Executed when the left mouse button is clicked twice in rapid succession (within Canvas.doubleClickDelay by default) in this object.
    
    Specified by:
    
    addDoubleClickHandler in interface HasDoubleClickHandlers
    
    Parameters:
    
    handler - the doubleClick handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragMoveHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragMoveHandler(DragMoveHandler handler)
```
    Add a dragMove handler.
    Executed every time the mouse moves while dragging this canvas.
    
    Specified by:
    
    addDragMoveHandler in interface HasDragMoveHandlers
    
    Parameters:
    
    handler - the dragMove handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragRepositionMoveHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragRepositionMoveHandler(DragRepositionMoveHandler handler)
```
    Add a dragRepositionMove handler.
    Executed every time the mouse moves while drag-repositioning. If this method does not Call DragRepositionMoveEvent.cancel() from within DragRepositionMoveHandler.onDragRepositionMove(com.smartgwt.client.widgets.events.DragRepositionMoveEvent), the Canvas.dragTarget (or outline if Canvas.dragAppearance is set to "outline") will automatically be moved as appropriate whenever the mouse moves.
    
    Specified by:
    
    addDragRepositionMoveHandler in interface HasDragRepositionMoveHandlers
    
    Parameters:
    
    handler - the dragRepositionMove handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragRepositionStartHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragRepositionStartHandler(DragRepositionStartHandler handler)
```
    Add a dragRepositionStart handler.
    Executed when dragging first starts. No default implementation. Create this handler to set things up for the drag reposition.
    
    Specified by:
    
    addDragRepositionStartHandler in interface HasDragRepositionStartHandlers
    
    Parameters:
    
    handler - the dragRepositionStart handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragRepositionStopHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragRepositionStopHandler(DragRepositionStopHandler handler)
```
    Add a dragRepositionStop handler.
    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.
    Returning true from this handler will cause the Canvas.dragTarget (or outline if Canvas.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.
    
    Specified by:
    
    addDragRepositionStopHandler in interface HasDragRepositionStopHandlers
    
    Parameters:
    
    handler - the dragRepositionStop handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragResizeMoveHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragResizeMoveHandler(DragResizeMoveHandler handler)
```
    Add a dragResizeMove handler.
    Executed every time the mouse moves while drag-resizing. If this method does not Call DragResizeMoveEvent.cancel() from within DragResizeMoveHandler.onDragResizeMove(com.smartgwt.client.widgets.events.DragResizeMoveEvent), the Canvas.dragTarget (or outline if Canvas.dragAppearance is set to "outline") will automatically be moved as appropriate whenever the mouse moves.
    
    Specified by:
    
    addDragResizeMoveHandler in interface HasDragResizeMoveHandlers
    
    Parameters:
    
    handler - the dragResizeMove handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragResizeStartHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragResizeStartHandler(DragResizeStartHandler handler)
```
    Add a dragResizeStart handler.
    Executed when resize dragging first starts. No default implementation. Create this handler to set things up for the drag resize.
    
    Specified by:
    
    addDragResizeStartHandler in interface HasDragResizeStartHandlers
    
    Parameters:
    
    handler - the dragResizeStart handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragResizeStopHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragResizeStopHandler(DragResizeStopHandler handler)
```
    Add a dragResizeStop handler.
    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.
    Returning true from this handler will cause the Canvas.dragTarget (or outline if Canvas.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
    
    Specified by:
    
    addDragResizeStopHandler in interface HasDragResizeStopHandlers
    
    Parameters:
    
    handler - the dragResizeStop handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragStartHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragStartHandler(DragStartHandler handler)
```
    Add a dragStart handler.
    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.
    A drag action is considered to be begin when the mouse has moved Canvas.dragStartDistance with the left mouse down.
    
    Specified by:
    
    addDragStartHandler in interface HasDragStartHandlers
    
    Parameters:
    
    handler - the dragStart handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragStopHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragStopHandler(DragStopHandler handler)
```
    Add a dragStop handler.
    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.
    
    Specified by:
    
    addDragStopHandler in interface HasDragStopHandlers
    
    Parameters:
    
    handler - the dragStop handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDropMoveHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDropMoveHandler(DropMoveHandler handler)
```
    Add a dropMove handler.
    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, or to show the no-drop cursor to indicate that this is not a valid drop target, typically if Canvas.willAcceptDrop() returns false.
    For details on showing a 'no drop' cursor when the user drags over all invalid drop targets, see showNoDropIndicator.
    
    Specified by:
    
    addDropMoveHandler in interface HasDropMoveHandlers
    
    Parameters:
    
    handler - the dropMove handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDropOutHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDropOutHandler(DropOutHandler handler)
```
    Add a dropOut handler.
    Executed when the dragged object is no longer over this drop target, including when the drag interaction is ending with a drop on this drop target. If you have set a visual indication in dropOver or dropMove, you should reset it to its normal state in dropOut.
    
    Specified by:
    
    addDropOutHandler in interface HasDropOutHandlers
    
    Parameters:
    
    handler - the dropOut handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDropOverHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDropOverHandler(DropOverHandler handler)
```
    Add a dropOver handler.
    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.
    
    Specified by:
    
    addDropOverHandler in interface HasDropOverHandlers
    
    Parameters:
    
    handler - the dropOver handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - enable
```
public void enable()
```
    Enables this widget and any children / peers of this widget.
    
    See Also:
    
    Enable overview and related methods
  - encloses
```
public java.lang.Boolean encloses(Canvas other)
```
    Returns true if the rectangle of this widget encloses the rectangle of the specified widget.
    
    Parameters:
    
    other - other canvas to test for enclosure
    
    Returns:
    
    true if this canvas encloses other; false otherwise
    
    See Also:
    
    Positioning overview and related methods
  - focus
```
public void focus()
```
    If this canvas can accept focus, give it keyboard focus. After this method, the canvas will appear focused and will receive keyboard events.
    
    See Also:
    
    Focus overview and related methods
  - focusAfterGroup
```
public void focusAfterGroup()
```
    Shifts focus to the next focusable element after this one, skipping any elements nested inside the tabbing group for this canvas, such as focusable children.
    This method makes use of the TabIndexManager.shiftFocusAfterGroup() method to request focus be changed to the next registered entry. By default standard focusable Smart GWT UI elements, including Canvases, FormItems, FormItemIcons, etc are registered with the TabIndexManager in the appropriate order, and will accept focus if focusable, and not disabled or masked.
    This method differs from focusInNextTabElement() in that it will skip any descendants of this widget in the TabIndexManager's hierarchy of potential focus target. By default this means focus will be moved to the next target on the page which is not a descendant of this widget.
    FormItems support a similar method: FormItem.focusAfterItem().
    NOTE: Focusable elements created directly in the raw HTML bootstrap or by application code will not be passed focus by this method unless they have also been explicitly registered with the TabIndexManager. See the TabOrderOverview for more information.
    
    See Also:
    
    getTabIndex(), focusInNextTabElement(), Focus overview and related methods
  - focusAtEnd
```
public void focusAtEnd(boolean start)
```
    Shifts focus to the start or end of this canvas and its descendants.
    This method makes use of the TabIndexManager.shiftFocusWithinGroup() API to request focus be changed within the set of focusable targets registered under this canvas.
    If the start parameter is true, if the canvas itself is focusable it will be given focus, otherwise the first focusable descendant will be given focus. If the start parameter is false, the last focusable descendant will be given focus (or if the canvas itself is focusable but there are no focusable descendants, it will receive focus).
    A use case for this might be to programmatically shift focus to the first or last button in a toolbar or similar.
    
    Parameters:
    
    start - Should we focus at the start or the end of this widget and its descendants.
  - addFocusChangedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addFocusChangedHandler(FocusChangedHandler handler)
```
    Add a focusChanged handler.
    Notification function fired when this widget receives or loses keyboard focus.
    
    Specified by:
    
    addFocusChangedHandler in interface HasFocusChangedHandlers
    
    Parameters:
    
    handler - the focusChanged handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - focusInNextTabElement
```
public void focusInNextTabElement()
```
    Shifts focus to the next focusable element after this one. This programatically simulates the user experience of a Tab keypress, and is used automatically when a blocking clickMask is up to ensure focus does not move to any masked elements in the UI.
    This method makes use of the TabIndexManager.shiftFocus() method to request focus be changed to the adjacent registered entry. By default standard focusable Smart GWT UI elements, including Canvases, FormItems, FormItemIcons, etc are registered with the TabIndexManager in the appropriate order, and will accept focus if focusable, and not disabled or masked.
    The TabIndexManager maintains a hierarchy of focusable targets - so if a parent canvas contains focusable children, they will typically be nested under the parent canvas in this hierarchy. If you want to shift focus to the next target outside this hierarchy (IE: skip any children and put focus into the next widget on the page outside this one), you can use use focusAfterGroup().
    NOTE: Focusable elements created directly in the raw HTML bootstrap or by application code will not be passed focus by this method unless they have also been explicitly registered with the TabIndexManager. See the TabOrderOverview for more information.
    
    See Also:
    
    getTabIndex(), focusInPreviousTabElement(), focusAfterGroup(), Focus overview and related methods
  - focusInPreviousTabElement
```
public void focusInPreviousTabElement()
```
    Shifts focus to the previous focusable element before this one. This programatically simulates the user experience of a Shift+Tab keypress.
    This method makes use of the TabIndexManager.shiftFocus() method to request focus be changed to the adjacent registered entry. By default standard focusable Smart GWT UI elements, including Canvases, FormItems, FormItemIcons, etc are registered with the TabIndexManager in the appropriate order, and will accept focus if focusable, and not disabled or masked.
    NOTE: Focusable elements created directly in the raw HTML bootstrap or by application code will not be passed focus by this method unless they have also been explicitly registered with the TabIndexManager. See the TabOrderOverview for more information.
    
    See Also:
    
    getTabIndex(), focusInNextTabElement(), Focus overview and related methods
  - getBottom
```
public int getBottom()
```
    Return the bottom coordinate of this object as rendered, relative to its enclosing context, in pixels.
    
    Returns:
    
    bottom coordinate
    
    See Also:
    
    Positioning overview and related methods
  - getChildTabPosition
```
public java.lang.Integer getChildTabPosition(Canvas child)
```
    For a given child widget where updateTabPositionOnReparent is true, return the expected tab position within this parent. Default implementation will any explicit relative tab position specified by setRelativeTabPosition(), and otherwise put children in the same order as defined in the children array
    Overridden in the Layout class to return the position in the members array.
    
    Parameters:
    
    child - Child to get local tab position for
    
    Returns:
    
    tab position of child within this parent
  - getContentElement
```
public com.google.gwt.user.client.Element getContentElement()
```
    Returns the DOM element for this Canvas which contains the contents, or for parent components, the DOM elements for any drawn children. This method is provided for the very rare cases where a programmer needs to examine the DOM hierarchy created by a drawn Smart GWT component.
    Direct manipulation of the DOM elements created by Smart GWT components is not supported. Smart GWT components should be rendered or cleared using standard methods such as draw(), clear(). If direct integration with existing DOM structures is required, this should be achieved via the htmlElement attribute, rather than by attempting to move the component's outer element via native browser APIs.
    The content of Smart GWT components' DOM elements should also not be directly manipulated using native browser APIs - standard methods such as setContents(), addChild(), removeChild(), markForRedraw() and redraw() should be used instead.
    In some cases, the element returned may match the element returned by getOuterElement(), but this will not always be the case.
    If the widget is undrawn, this method will return null.
    
    Returns:
    
    The outer DOM element for a drawn Canvas.
  - getFullDataPath
```
public java.lang.String getFullDataPath()
```
    Returns a fully qualified DataPath for this canvas. This is calculated by combining the canvas' specified DataPath with the dataPath of any parent canvases up to whichever canvas has a specified valuesManager specified to actually manage values from this component.
    
    Returns:
    
    fully qualified dataPath for this component. See DataPath
  - getHoverHTML
```
public java.lang.String getHoverHTML()
```
    If this.showHover 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 this.prompt - override for custom hover HTML. Note that returning null or an empty string will suppress the hover canvas altogether.
    
    Returns:
    
    the string to show in the hover. See HTMLString
    
    See Also:
    
    getShowHover()
  - getHSnapOrigin
```
public int getHSnapOrigin()
```
    Get an offset to be used when calculating snap positioning. Returns 0 by default.
    
    Returns:
    
    The offset to use when snapping
    
    See Also:
    
    getHSnapPosition(int), Positioning overview and related methods
  - getHSnapOrigin
```
public int getHSnapOrigin(Canvas snapChild)
```
    Get an offset to be used when calculating snap positioning. Returns 0 by default.
    
    Parameters:
    
    snapChild - the child that is being snapped
    
    Returns:
    
    The offset to use when snapping
    
    See Also:
    
    getHSnapPosition(int), Positioning overview and related methods
  - getHSnapPosition
```
public int getHSnapPosition(int 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 snapHGap and snapVGap. You should only override this method if you want to provide support for a grid of irregularly-placed points
    
    Parameters:
    
    coordinate - x-coordinate of the drag event relative to the inside of this widget
    
    Returns:
    
    The horizontal coordinate to snap to
    
    See Also:
    
    Dragdrop overview and related methods
  - getHSnapPosition
```
public int getHSnapPosition(int coordinate,
                            java.lang.String direction)
```
    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 snapHGap and snapVGap. You should only override this method if you want to provide support for a grid of irregularly-placed points
    
    Parameters:
    
    coordinate - x-coordinate of the drag event relative to the inside of this widget
    
    direction - "before" or "after" denoting whether the returned coordinate should match the left or right edge of the current square. If unset snapHDirection will be used by default
    
    Returns:
    
    The horizontal coordinate to snap to
    
    See Also:
    
    Dragdrop overview and related methods
  - getImage
```
public com.google.gwt.user.client.Element getImage(java.lang.String identifier)
```
    Retrieve a native image or SVG object element by name.
    The element must have been created from HTML generated by calling imgHTML() on this particular Canvas.
    
    Parameters:
    
    identifier - name of the image or SVG object to get, as originally passed to imgHTML()
    
    Returns:
    
    DOM image or SVG object element if found, else null
    
    See Also:
    
    Images overview and related methods
  - getInnerContentHeight
```
public int getInnerContentHeight()
```
    Returns the amount of space available for interior content (or relatively positioned child widget(s)) without introducing clipping, scrolling or overflow.
    This is the space within the viewport of the widget (not including padding, and excluding margins, borders or scrollbars) rendered at its specified size.
    
    Returns:
    
    inner height of the widget in pixels
    
    See Also:
    
    getInnerContentWidth(), getInnerHeight(), getInnerWidth(), Sizing overview and related methods
  - getInnerContentWidth
```
public int getInnerContentWidth()
```
    Returns the amount of space available for interior content (or relatively positioned child widget(s)) without introducing clipping, scrolling or overflow.
    This is the space within the viewport of the widget (not including padding, and excluding margins, borders or scrollbars) rendered at its specified size.
    
    Returns:
    
    inner height of the widget in pixels
    
    See Also:
    
    getInnerContentHeight(), getInnerHeight(), getInnerWidth(), Sizing overview and related methods
  - getInnerHeight
```
public int getInnerHeight()
```
    Returns the amount of space available for (an) absolutely positioned child widget(s) or absolutely positioned HTML content, without introducing clipping, scrolling or overflow.
    This is the space within the viewport of the widget (including padding, but excluding margins, borders or scrollbars) rendered at its specified size.
    
    Returns:
    
    inner height of the widget in pixels
    
    See Also:
    
    getInnerWidth(), getInnerContentHeight(), getInnerContentWidth(), Sizing overview and related methods
  - getInnerWidth
```
public int getInnerWidth()
```
    Returns the amount of space available for absolutely positioned child widget(s) or absolutely positioned HTML content, without introducing clipping, scrolling or overflow.
    This is the space within the viewport of the widget (including padding, but excluding margins, borders or scrollbars) rendered at its specified size.
    
    Returns:
    
    inner width of the widget in pixels
    
    See Also:
    
    getInnerHeight(), getInnerContentHeight(), getInnerContentWidth(), Sizing overview and related methods
  - getLocalId
```
public java.lang.String getLocalId()
```
    Retrieve the local ID of this canvas. If no local ID is assigned the normal canvas ID is returned making this method a safe replacement for getID().
    A "local ID" is name for a child widget which is unique only for this parent, and not globally unique as is required for ID. Widgets receive local IDs when loaded via RPCManager.loadScreen() or RPCManager.cacheScreens() and RPCManager.createScreen().
    
    Returns:
    
    the local ID or standard ID of the Canvas
  - getMasterCanvas
```
public Canvas getMasterCanvas()
```
    Returns this canvas's "master" (the canvas to which it was added as a peer), if any.
    
    Returns:
    
    the master canvas, null if none exists.
    
    See Also:
    
    Containment overview and related methods
  - getOffsetX
```
public int getOffsetX()
```
    Return the X-coordinate of the last event relative to the left edge of the content of this Canvas.
    
    NOTE: To get a coordinate relative to the viewport of this Canvas, subtract this.getScrollLeft()
    
    Returns:
    
    See Also:
    
    Positioning overview and related methods
  - getOffsetY
```
public int getOffsetY()
```
    Return the Y-coordinate of the last event, relative to the top edge of the content of this Canvas.
    
    NOTE: To get a coordinate relative to the viewport of this Canvas, subtract this.getScrollTop()
    
    Returns:
    
    See Also:
    
    Positioning overview and related methods
  - getOuterElement
```
public com.google.gwt.user.client.Element getOuterElement()
```
    Returns the outer DOM element of this Canvas. This method is provided for the very rare cases where a programmer needs to examine the DOM hierarchy created by a drawn Smart GWT component.
    Direct manipulation of the DOM elements created by Smart GWT components is not supported. Smart GWT components should be rendered or cleared using standard methods such as draw(), clear(). If direct integration with existing DOM structures is required, this should be achieved via the htmlElement attribute, rather than by attempting to move the component's outer element via native browser APIs.
    The content of Smart GWT components' DOM elements should also not be directly manipulated using native browser APIs - standard methods such as setContents(), addChild(), removeChild(), markForRedraw() and redraw() should be used instead.
    In some cases, the element returned may match the element returned by getContentElement(), but this will not always be the case.
    If the widget is undrawn, this method will return null.
    
    Returns:
    
    The outer DOM element for a drawn Canvas.
  - getPageBottom
```
public int getPageBottom()
```
    Return the page-relative bottom coordinate of this object, in pixels.
    
    Returns:
    
    GLOBAL bottom coordinate
    
    See Also:
    
    Positioning overview and related methods
  - getPageLeft
```
public int getPageLeft()
```
    Returns the page-relative left coordinate of the widget on the page, in pixels.
    
    Returns:
    
    global left coordinate
    
    See Also:
    
    Positioning overview and related methods
  - getPageRight
```
public int getPageRight()
```
    Return the page-relative right coordinate of this object, in pixels.
    
    Returns:
    
    GLOBAL right coordinate
    
    See Also:
    
    Positioning overview and related methods
  - getPageTop
```
public int getPageTop()
```
    Returns the page-relative top coordinate of the widget on the page, in pixels
    
    Returns:
    
    GLOBAL top coordinate
    
    See Also:
    
    Positioning overview and related methods
  - getPanelContainer
```
public Canvas getPanelContainer()
```
    Returns this Canvas's "panel container". A panel container is a widget that manages a collection of panels, like a TabSet or SectionStack. If this Canvas is not a child of such a panel container, this method returns null.
    
    Returns:
    
    the Canvas's panel container, or null if the Canvas is not a chlld of a panel container
  - getRight
```
public int getRight()
```
    Return the right coordinate of this object as rendered, relative to its enclosing context, in pixels.
    
    Returns:
    
    right coordinate
    
    See Also:
    
    Positioning overview and related methods
  - getRuleContext
```
public java.util.Map getRuleContext()
```
    Get the current value of the rule context collected by the ruleScope of this component (which may be this component itself or whatever component is managing the ruleScope for this component).
    If the databoundOnly parameter is passed as true, only data from components that actually have a DataSource is included.
    Use Canvas.ruleContextChanged() to get a notification of changes to the rule context.
    
    Returns:
    
    the ruleContext object, or null if canvas is not part of a ruleScope
  - getRuleContext
```
public java.util.Map getRuleContext(boolean databoundOnly)
```
    Get the current value of the rule context collected by the ruleScope of this component (which may be this component itself or whatever component is managing the ruleScope for this component).
    If the databoundOnly parameter is passed as true, only data from components that actually have a DataSource is included.
    Use Canvas.ruleContextChanged() to get a notification of changes to the rule context.
    
    Parameters:
    
    databoundOnly - whether to include only data from components that have a DataSource
    
    Returns:
    
    the ruleContext object, or null if canvas is not part of a ruleScope
  - getScrollBottom
```
public int getScrollBottom()
```
    Returns the scrollTop required to scroll vertically to the end of this widget's content.
    
    Returns:
    
    scroll bottom coordinate
    
    See Also:
    
    Scrolling overview and related methods
  - getScrollHeight
```
public int getScrollHeight()
```
    Returns the scrollable height of the widget's contents, including children, ignoring clipping.
    
    Returns:
    
    height of the element that can scroll
    
    See Also:
    
    Sizing overview and related methods
  - getScrollLeft
```
public int getScrollLeft()
```
    Get the number of pixels this Canvas is scrolled from its left edge.
    
    Returns:
    
    scrollLeft
    
    See Also:
    
    Positioning overview and related methods
  - getScrollRight
```
public int getScrollRight()
```
    Returns the scrollLeft required to scroll horizontally to the end of this widget's content.
    
    Returns:
    
    scroll bottom coordinate
    
    See Also:
    
    Scrolling overview and related methods
  - getScrollTop
```
public int getScrollTop()
```
    Get the number of pixels this Canvas is scrolled from its top edge.
    
    Returns:
    
    scrollTop
    
    See Also:
    
    Positioning overview and related methods
  - getScrollWidth
```
public int getScrollWidth()
```
    Returns the scrollable width of the widget's contents, including children, ignoring clipping.
    
    Returns:
    
    the scrollable width of the widget's contents
    
    See Also:
    
    Sizing overview and related methods
  - getViewportHeight
```
public int getViewportHeight()
```
    Returns the height of the viewport onto the scrollable content.
    
    Returns:
    
    height of the viewport, in pixels
    
    See Also:
    
    Sizing overview and related methods
  - getViewportWidth
```
public int getViewportWidth()
```
    Returns the width of the viewport onto the scrollable content.
    
    Returns:
    
    width of the viewport, in pixels
    
    See Also:
    
    Sizing overview and related methods
  - getVisibleHeight
```
public int getVisibleHeight()
```
    Return the visible height of the Canvas.
    
    Returns:
    
    visible height in pixels
    
    See Also:
    
    Sizing overview and related methods
  - getVisibleWidth
```
public int getVisibleWidth()
```
    Return the visible width of the Canvas.
    
    Returns:
    
    visible width in pixels
    
    See Also:
    
    Sizing overview and related methods
  - getVSnapOrigin
```
public int getVSnapOrigin()
```
    Get an offset to be used when calculating snap positioning. Returns 0 by default.
    
    Returns:
    
    The offset to use when snapping
    
    See Also:
    
    getVSnapPosition(int), Positioning overview and related methods
  - getVSnapOrigin
```
public int getVSnapOrigin(Canvas snapChild)
```
    Get an offset to be used when calculating snap positioning. Returns 0 by default.
    
    Parameters:
    
    snapChild - the child that is being snapped
    
    Returns:
    
    The offset to use when snapping
    
    See Also:
    
    getVSnapPosition(int), Positioning overview and related methods
  - getVSnapPosition
```
public int getVSnapPosition(int 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 snapHGap and snapVGap. You should only override this method if you want to provide support for a grid of irregularly-placed points
    
    Parameters:
    
    coordinate - y-coordinate of the drag event relative to the inside of this widget
    
    Returns:
    
    The vertical coordinate to snap to
    
    See Also:
    
    Dragdrop overview and related methods
  - getVSnapPosition
```
public int getVSnapPosition(int coordinate,
                            java.lang.String direction)
```
    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 snapHGap and snapVGap. You should only override this method if you want to provide support for a grid of irregularly-placed points
    
    Parameters:
    
    coordinate - y-coordinate of the drag event relative to the inside of this widget
    
    direction - "before" or "after" denoting whether the returned coordinate should match the top or bottom edge of the current square. If unset snapHDirection will be used by default
    
    Returns:
    
    The vertical coordinate to snap to
    
    See Also:
    
    Dragdrop overview and related methods
  - getZIndex
```
public int getZIndex(boolean resolveToNumber)
```
    Get the z-Index of this canvas.
    
    Parameters:
    
    resolveToNumber - If passed true, for undrawn widgets, resolve "auto" to the next available zIndex.
    
    Returns:
    
    See Also:
    
    ZIndex overview and related methods
  - handleHover
```
public void handleHover()
```
    Handler fired on a delay when the user hovers the mouse over this hover-target. Default implementation will fire this.hover() (if defined), and handle showing the hover canvas if this.showHover is true.
    
    See Also:
    
    getCanHover(), getShowHover(), HoverEvent
  - hide
```
public void hide()
```
    Sets the widget's CSS visibility attribute to "hidden".
    
    See Also:
    
    Visibility overview and related methods, Show & Hide Example
  - hideClickMask
```
public void hideClickMask()
```
    Hides the click mask associated with this canvas.
    
    See Also:
    
    showClickMask(com.smartgwt.client.core.Function, com.smartgwt.client.types.ClickMaskMode, com.smartgwt.client.widgets.Canvas[])
  - hideClickMask
```
public void hideClickMask(java.lang.String ID)
```
    Hides the click mask associated with this canvas.
    
    Parameters:
    
    ID - optional ID of specific clickMask to hide. If not passed, defaults to hiding the click mask associated with this widget only.
    
    See Also:
    
    showClickMask(com.smartgwt.client.core.Function, com.smartgwt.client.types.ClickMaskMode, com.smartgwt.client.widgets.Canvas[])
  - hideComponentMask
```
public void hideComponentMask()
```
    Hide the component level clickMask for this widget
  - hideComponentMask
```
public void hideComponentMask(boolean suppressFocusReset)
```
    Hide the component level clickMask for this widget
    
    Parameters:
    
    suppressFocusReset - By default when the component-level mask is hidden it will attempt to reset focus to whatever had focus before the mask was shown. Pass this parameter to suppress this behavior.
  - hideContextMenu
```
public void hideContextMenu()
```
    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.
    
    See Also:
    
    ShowContextMenuEvent, Menu.hideContextMenu(), getOffsetX(), getOffsetY()
  - addHoverHandler
```
public com.google.gwt.event.shared.HandlerRegistration addHoverHandler(HoverHandler handler)
```
    Add a hover handler.
    If canHover is true for this widget, the hover 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 this.showHover is true.
    
    Specified by:
    
    addHoverHandler in interface HasHoverHandlers
    
    Parameters:
    
    handler - the hover handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addHoverHiddenHandler
```
public com.google.gwt.event.shared.HandlerRegistration addHoverHiddenHandler(HoverHiddenHandler handler)
```
    Add a hoverHidden handler.
    If showHover is true for this canvas, this notification method will be fired whenever the hover shown in response to handleHover() is hidden. This method may be observed or overridden.
    
    Specified by:
    
    addHoverHiddenHandler in interface HasHoverHiddenHandlers
    
    Parameters:
    
    handler - the hoverHidden handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - intersects
```
public java.lang.Boolean intersects(Canvas other)
```
    Returns true if the rectangles of this widget and the specified widget overlap.
    
    Parameters:
    
    other - other canvas to test for intersection
    
    Returns:
    
    true if this canvas intersects other; false otherwise
    
    See Also:
    
    Positioning overview and related methods
  - isDirty
```
public java.lang.Boolean isDirty()
```
    Returns whether a canvas is waiting to be redrawn. Will return true if markForRedraw() has been called, but this canvas has not yet been redrawn.
    
    Returns:
    
    true is this canvas needs to be redrawn; false otherwise
    
    See Also:
    
    Drawing overview and related methods
  - isDisabled
```
public java.lang.Boolean isDisabled()
```
    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.
    
    Returns:
    
    true if the widget or any widget above it in the containment hierarchy are disabled.
    
    See Also:
    
    Enable overview and related methods
  - isFocused
```
public java.lang.Boolean isFocused()
```
    Returns true if this Canvas has the keyboard focus. Note that in Internet Explorer focus notifications can be asynchronous (see synchronousFocusNotifications). In this case, canvas.isFocused() method can correctly return false when, intuitively, you would expect it to return true:
```
      someCanvas.focus();
      if (someCanvas.isFocused()) {
          // In most browsers we would get here, but not in Internet Explorer with
          // EventHandler.synchronousFocusNotifications disabled.
      }
```
    Returns:
    
    whether this Canvas has the keyboard focus
    
    See Also:
    
    containsFocus()
  - addKeyDownHandler
```
public com.google.gwt.event.shared.HandlerRegistration addKeyDownHandler(KeyDownHandler handler)
```
    Add a keyDown handler.
    Executed when a key is pressed on a focusable widget (Canvas.canFocus: true).
    Use EventHandler.getKey() to find out the String of the key that was pressed, and use EventHandler.shiftKeyDown() and related functions to determine whether modifier keys were down.
    
    Specified by:
    
    addKeyDownHandler in interface HasKeyDownHandlers
    
    Parameters:
    
    handler - the keyDown handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addKeyPressHandler
```
public com.google.gwt.event.shared.HandlerRegistration addKeyPressHandler(KeyPressHandler handler)
```
    Add a keyPress handler.
    Executed when a key is pressed and released on a focusable widget (Canvas.canFocus: true).
    Use EventHandler.getKey() to find out the String of the key that was pressed, and use EventHandler.shiftKeyDown() and related functions to determine whether modifier keys were down.
    
    Specified by:
    
    addKeyPressHandler in interface HasKeyPressHandlers
    
    Parameters:
    
    handler - the keyPress handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - keyUp
```
public java.lang.Boolean keyUp()
```
    Executed when a key is released on a focusable widget (canFocus: true).
    Use EventHandler.getKey() to find out the String of the key that was pressed, and use EventHandler.shiftKeyDown() and related functions to determine whether modifier keys were down.
    
    Returns:
    
    false to prevent this event from bubbling to this widget's parent, true or undefined to bubble.
    
    See Also:
    
    getCanFocus()
  - layoutChildren
```
public void layoutChildren(java.lang.String reason)
```
    layoutChildren() is where a Canvas should implement a sizing policy for it's Canvas children. Since layoutChildren calls parentResized() on its children, parentResized() is a good place for a child to implement a layout policy that can be used within any parent.
    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.
    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.
    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.
    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.
    
    Parameters:
    
    reason - reason why layoutChildren() is being called, passed when framework code invokes layoutChildren()
    
    See Also:
    
    Sizing overview and related methods
  - linkHTML
```
public java.lang.String linkHTML(java.lang.String href)
```
    Generates the HTML for a standard link (anchor) element.
    
    Parameters:
    
    href - URL for the link to point to
    
    Returns:
    
    HTML for the link. See HTMLString
  - linkHTML
```
public java.lang.String linkHTML(java.lang.String href,
                                 java.lang.String text)
```
    See Also:
    
    linkHTML(java.lang.String)
  - linkHTML
```
public java.lang.String linkHTML(java.lang.String href,
                                 java.lang.String text,
                                 java.lang.String target)
```
    See Also:
    
    linkHTML(java.lang.String)
  - linkHTML
```
public java.lang.String linkHTML(java.lang.String href,
                                 java.lang.String text,
                                 java.lang.String target,
                                 java.lang.String ID)
```
    See Also:
    
    linkHTML(java.lang.String)
  - linkHTML
```
public java.lang.String linkHTML(java.lang.String href,
                                 java.lang.String text,
                                 java.lang.String target,
                                 java.lang.String ID,
                                 java.lang.Integer tabIndex)
```
    See Also:
    
    linkHTML(java.lang.String)
  - linkHTML
```
public java.lang.String linkHTML(java.lang.String href,
                                 java.lang.String text,
                                 java.lang.String target,
                                 java.lang.String ID,
                                 java.lang.Integer tabIndex,
                                 java.lang.String accessKey)
```
    Generates the HTML for a standard link (anchor) element.
    
    Parameters:
    
    href - URL for the link to point to
    
    text - HTML to display in the link element (defaults to the href). See HTMLString
    
    target - Target window for the link (defaults to opening in a new, unnamed window)
    
    ID - optional ID for the link element to be written out
    
    tabIndex - optional tabIndex for the link
    
    accessKey - optional accessKey for the link
    
    Returns:
    
    HTML for the link. See HTMLString
  - markForDestroy
```
public void markForDestroy()
```
    destroy() this canvas on a timeout. This method should be used instead of calling canvas.destroy() directly unless there's a reason a the canvas needs to be destroyed synchronously. By using a timeout, this method ensures the destroy() 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.
    
    See Also:
    
    BaseWidget.destroy()
  - markForRedraw
```
public void 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 markForRedraw() instead of calling 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.
    
    See Also:
    
    Drawing overview and related methods
  - markForRedraw
```
public void markForRedraw(java.lang.String reason)
```
    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 markForRedraw() instead of calling 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.
    
    Parameters:
    
    reason - reason for performing the redraw
    
    See Also:
    
    Drawing overview and related methods
  - addMouseDownHandler
```
public com.google.gwt.event.shared.HandlerRegistration addMouseDownHandler(MouseDownHandler handler)
```
    Add a mouseDown handler.
    Executed when the left mouse button is pressed on this widget. No default implementation.
    
    Specified by:
    
    addMouseDownHandler in interface HasMouseDownHandlers
    
    Parameters:
    
    handler - the mouseDown handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addMouseMoveHandler
```
public com.google.gwt.event.shared.HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler)
```
    Add a mouseMove handler.
    Executed when the mouse moves within this widget. No default implementation.
    
    Specified by:
    
    addMouseMoveHandler in interface HasMouseMoveHandlers
    
    Parameters:
    
    handler - the mouseMove handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addMouseOutHandler
```
public com.google.gwt.event.shared.HandlerRegistration addMouseOutHandler(MouseOutHandler handler)
```
    Add a mouseOut handler.
    Executed when the mouse leaves this widget. No default implementation.
    
    Specified by:
    
    addMouseOutHandler in interface HasMouseOutHandlers
    
    Parameters:
    
    handler - the mouseOut handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addMouseOverHandler
```
public com.google.gwt.event.shared.HandlerRegistration addMouseOverHandler(MouseOverHandler handler)
```
    Add a mouseOver handler.
    Executed when mouse enters this widget. No default implementation.
    
    Specified by:
    
    addMouseOverHandler in interface HasMouseOverHandlers
    
    Parameters:
    
    handler - the mouseOver handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addMouseStillDownHandler
```
public com.google.gwt.event.shared.HandlerRegistration addMouseStillDownHandler(MouseStillDownHandler handler)
```
    Add a mouseStillDown handler.
    Repeating notification method for the user holding the left mouse button down over this canvas.
    The mouseStillDown event is fired immediately when the mouse goes down. If the user holds the mouse down, after a pause of Canvas.mouseStillDownInitialDelay, it will begin to fire repeatedly every Canvas.mouseStillDownDelay milliseconds.
    This provides developers with a simple way to handle the common "repeated action" use case where a user can click a UI element to perform an action once, or click and hold to perform the action repeatedly.
    Examples of this include standard scrollbar button behavior and buttons to increase or decrease the value in a spinner type input element.
    This event is not native to JavaScript, but is provided by the ISC system.
    
    Specified by:
    
    addMouseStillDownHandler in interface HasMouseStillDownHandlers
    
    Parameters:
    
    handler - the mouseStillDown handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addMouseUpHandler
```
public com.google.gwt.event.shared.HandlerRegistration addMouseUpHandler(MouseUpHandler handler)
```
    Add a mouseUp handler.
    Executed when the left mouse is released on this widget. No default implementation.
    
    Specified by:
    
    addMouseUpHandler in interface HasMouseUpHandlers
    
    Parameters:
    
    handler - the mouseUp handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addMouseWheelHandler
```
public com.google.gwt.event.shared.HandlerRegistration addMouseWheelHandler(MouseWheelHandler handler)
```
    Add a mouseWheel handler.
    Executed when the mouse wheel is actuated.
    
    Specified by:
    
    addMouseWheelHandler in interface HasMouseWheelHandlers
    
    Parameters:
    
    handler - the mouseWheel handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - moveAbove
```
public void moveAbove(Canvas canvas)
```
    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.
    
    Parameters:
    
    canvas - canvas to move above
    
    See Also:
    
    ZIndex overview and related methods, Layer Example
  - moveBelow
```
public void moveBelow(Canvas canvas)
```
    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.
    
    Parameters:
    
    canvas - canvas to move below
    
    See Also:
    
    ZIndex overview and related methods, Layer Example
  - moveBy
```
public java.lang.Boolean moveBy(int deltaX,
                                int deltaY)
```
    Moves the widget deltaX pixels to the right and deltaY pixels down. Pass negative numbers to move up and/or to the left.
    
    Parameters:
    
    deltaX - amount to move horizontally (may be negative)
    
    deltaY - amount to move vertically (may be negative)
    
    Returns:
    
    whether the component actually moved
    
    See Also:
    
    Positioning overview and related methods, Move Example
  - addMovedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addMovedHandler(MovedHandler handler)
```
    Add a moved handler.
    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 Canvas.parentMoved() method provides a notification entry point to catch that case as well.
    
    Specified by:
    
    addMovedHandler in interface HasMovedHandlers
    
    Parameters:
    
    handler - the moved handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - moveTo
```
public boolean moveTo(int left,
                      int top)
```
    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.
    
    Parameters:
    
    left - x-coordinate to move to in LOCAL coordinates or Object with left and top properties.
    
    top - y-coordinate to move to in LOCAL coordinates
    
    Returns:
    
    whether the component actually moved
    
    See Also:
    
    Positioning overview and related methods, Move Example
  - addClearHandler
```
public com.google.gwt.event.shared.HandlerRegistration addClearHandler(ClearHandler handler)
```
    Add a clear handler.
    Notification method fired when the canvas is removed from the DOM via a call to Canvas.clear(). Canvases are cleared recursively, so if a parent is clear()'d, all of its descendants will also be cleared. This notification is fired before the canvas has been removed from the DOM, and Canvas.isDrawn() will return true if called while the notification is running.
    
    Specified by:
    
    addClearHandler in interface HasClearHandlers
    
    Parameters:
    
    handler - the clear handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDropHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDropHandler(DropHandler handler)
```
    Add a drop handler.
    Notification method fired when the user drops another canvas onto this one. Returning false from this method will prevent any default drop behavior from occurring
    
    Specified by:
    
    addDropHandler in interface HasDropHandlers
    
    Parameters:
    
    handler - the drop handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - pageScrollDown
```
public void pageScrollDown()
```
    This method is the programmatic equivalent of the user pressing the "Page Down" key while this widget has the focus. It scrolls the widget's content downwards by the viewport height, if the content can be scrolled that far downwards
  - pageScrollUp
```
public void pageScrollUp()
```
    This method is the programmatic equivalent of the user pressing the "Page Up" key while this widget has the focus. It scrolls the widget's content upwards by the viewport height, if the content can be scrolled that far upwards
  - addParentMovedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addParentMovedHandler(ParentMovedHandler handler)
```
    Add a parentMoved handler.
    Notification method fire when an ancestor of this component's position changes.
    
    Specified by:
    
    addParentMovedHandler in interface HasParentMovedHandlers
    
    Parameters:
    
    handler - the parentMoved handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - placeNear
```
public void placeNear()
```
    Move this canvas to the specified point, or as close to the specified point as possible without this widget extending beyond the edge of the browser viewport on any side.
    
    See Also:
    
    Positioning overview and related methods
  - placeNear
```
public void placeNear(int left)
```
    See Also:
    
    placeNear()
  - placeNear
```
public void placeNear(int left,
                      int top)
```
    Move this canvas to the specified point, or as close to the specified point as possible without this widget extending beyond the edge of the browser viewport on any side.
    
    Parameters:
    
    left - Left coordinate (defaults to mouse position)
    
    top - Top coordinate (defaults to mouse position)
    
    See Also:
    
    Positioning overview and related methods
  - redraw
```
public void 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.
    
    See Also:
    
    Drawing overview and related methods
  - redraw
```
public void redraw(java.lang.String reason)
```
    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.
    
    Parameters:
    
    reason - reason for performing the redraw
    
    See Also:
    
    Drawing overview and related methods
  - removeChild
```
public void removeChild(Canvas child)
```
    Remove a child from this parent.
    
    Parameters:
    
    child - Child canvas to remove from this parent.
    
    See Also:
    
    Containment overview and related methods
  - removeChild
```
public void removeChild(Canvas child,
                        java.lang.String name)
```
    Remove a child from this parent.
    
    Parameters:
    
    child - Child canvas to remove from this parent.
    
    name - If the child canvas was assigned a name when added via addChild(), it should be passed in here to ensure no reference is kept to the child
    
    See Also:
    
    Containment overview and related methods
  - removePeer
```
public void removePeer(Canvas peer)
```
    Remove a peer from this Canvas
    
    Parameters:
    
    peer - Peer to be removed from this canvas
    
    See Also:
    
    Containment overview and related methods
  - removePeer
```
public void removePeer(Canvas peer,
                       java.lang.String name)
```
    Remove a peer from this Canvas
    
    Parameters:
    
    peer - Peer to be removed from this canvas
    
    name - If this peer was assigned a name when added via addPeer(), it should be passed in here to ensure no reference is kept to the peer
    
    See Also:
    
    Containment overview and related methods
  - removeSnapAlignCandidate
```
public void removeSnapAlignCandidate(Canvas candidate)
```
    Remove a candidate from snapAlignCandidates. If the passed widget was not actually a candidate, nothing happens and no warning is logged.
    
    Parameters:
    
    candidate -
  - resizeBy
```
public java.lang.Boolean resizeBy(int deltaX,
                                  int deltaY)
```
    Resizes the widget, adding deltaX to its width and deltaY to its height (moves the right and/or bottom sides of the widget).
    
    Parameters:
    
    deltaX - amount to resize horizontally (may be negative)
    
    deltaY - amount to resize vertically (may be negative)
    
    Returns:
    
    whether the component actually changed size
    
    See Also:
    
    Sizing overview and related methods, Resize Example
  - addResizedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addResizedHandler(ResizedHandler handler)
```
    Add a resized handler.
    Observable method called whenever a Canvas changes size. Note that if this canvas is overflow:"visible", and is waiting for a queued redraw (see Canvas.isDirty()), the value for Canvas.getVisibleWidth() and Canvas.getVisibleHeight() will be unreliable until redraw() fires.
    
    Specified by:
    
    addResizedHandler in interface HasResizedHandlers
    
    Parameters:
    
    handler - the resized handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - resizeTo
```
public java.lang.Boolean resizeTo(int width,
                                  int height)
```
    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.
    
    Parameters:
    
    width - new width for canvas.
    
    height - new height for canvas
    
    Returns:
    
    whether the size actually changed
    
    See Also:
    
    Sizing overview and related methods, Resize Example
  - addRightMouseDownHandler
```
public com.google.gwt.event.shared.HandlerRegistration addRightMouseDownHandler(RightMouseDownHandler handler)
```
    Add a rightMouseDown handler.
    Executed when the right mouse button is pressed on this widget. No default implementation.
    
    Specified by:
    
    addRightMouseDownHandler in interface HasRightMouseDownHandlers
    
    Parameters:
    
    handler - the rightMouseDown handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addRuleContextChangedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addRuleContextChangedHandler(RuleContextChangedHandler handler)
```
    Add a ruleContextChanged handler.
    Notification that the rule context gathered by the Canvas.ruleScope has changed.
    This notification fires only on the component designated as the Canvas.ruleScope; components that are merely contributing data to the rule context do not fire ruleContextChanged.
    
    Specified by:
    
    addRuleContextChangedHandler in interface HasRuleContextChangedHandlers
    
    Parameters:
    
    handler - the ruleContextChanged handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - scrollBy
```
public void scrollBy(int dX,
                     int dY)
```
    Scroll this widget by some pixel increment in either (or both) direction(s).
    
    Parameters:
    
    dX - Number of pixels to scroll horizontally
    
    dY - Number of pixels to scroll vertically
    
    See Also:
    
    Scrolling overview and related methods
  - scrollByPercent
```
public void scrollByPercent(int dX,
                            int dY)
```
    Scroll this widget by some percentage of scroll size in either (or both) direction(s).
    
    Parameters:
    
    dX - Percentage to scroll horizontally. Will accept either a numeric percent value, or a string like "10%".
    
    dY - Percentage to scroll horizontally. Will accept either a numeric percent value, or a string like "10%".
    
    See Also:
    
    Scrolling overview and related methods
  - addScrolledHandler
```
public com.google.gwt.event.shared.HandlerRegistration addScrolledHandler(ScrolledHandler handler)
```
    Add a scrolled handler.
    Notification that this component has just scrolled. Use with observation.
    Fires for both CSS and "synthetic" scrollbars.
    
    Specified by:
    
    addScrolledHandler in interface HasScrolledHandlers
    
    Parameters:
    
    handler - the scrolled handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - scrollTo
```
public void 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).
    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.
    
    See Also:
    
    Scrolling overview and related methods
  - scrollTo
```
public void scrollTo(java.lang.Integer left)
```
    See Also:
    
    scrollTo()
  - scrollTo
```
public void scrollTo(java.lang.Integer left,
                     java.lang.Integer top)
```
    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).
    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.
    
    Parameters:
    
    left - the left coordinate
    
    top - the top coordinate
    
    See Also:
    
    Scrolling overview and related methods
  - scrollToBottom
```
public void scrollToBottom()
```
    Vertically scrolls the content of the widget to the end of its content
    
    See Also:
    
    Scrolling overview and related methods
  - scrollToLeft
```
public void scrollToLeft()
```
    Horizontally scrolls the content of the widget to 0
    
    See Also:
    
    Scrolling overview and related methods
  - scrollToPercent
```
public void scrollToPercent(int left,
                            int top)
```
    Scroll this widget to some position specified as a percentage of scroll size in either (or both) direction(s).
    
    Parameters:
    
    left - Left Percentage position to scroll to Will accept either a numeric percent value, or a string like "10%".
    
    top - Top Percentage position to scroll to Will accept either a numeric percent value, or a string like "10%".
    
    See Also:
    
    Scrolling overview and related methods
  - scrollToRight
```
public void scrollToRight()
```
    Horizontally scrolls the content of the widget to the end of its content
    
    See Also:
    
    Scrolling overview and related methods
  - scrollToTop
```
public void scrollToTop()
```
    Vertically scrolls the content of the widget to 0
    
    See Also:
    
    Scrolling overview and related methods
  - sendToBack
```
public void sendToBack()
```
    Puts this widget at the bottom of the stacking order, so it appears behind all other widgets in the same parent.
    
    See Also:
    
    ZIndex overview and related methods, Layer Example
  - setBottom
```
public void setBottom(int bottom)
```
    Resizes the widget vertically to position its bottom edge at the specified coordinate.
    NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo() instead
    
    Parameters:
    
    bottom - new bottom coordinate
    
    See Also:
    
    Sizing overview and related methods
  - setEditMode
```
public void setEditMode(boolean editingOn)
```
    Enable or disable edit mode for this component. Components in editMode must be associated with an EditNode within an EditContext.
    Components with editMode enabled support certain editing interactions which vary depending on the componentType and settings on the editProxy.
    To disable edit mode just pass editingOn as false. The other parameters are not needed.
    To enable edit mode on this component all three parameters are required. The editNode is the edit node for this component as it exists within the editContext.
    An alternative method, EditContext.enableEditing(), can be used when only an editContext and editNode are available.
    Placing a component into editMode causes the component's editProxy to be created.
    
    Parameters:
    
    editingOn - true to enable editMode; false to disable
    
    See Also:
    
    EditTree, EditContext
  - setEditMode
```
public void setEditMode(boolean editingOn,
                        EditContext editContext)
```
    See Also:
    
    setEditMode(boolean)
  - setEditMode
```
public void setEditMode(boolean editingOn,
                        EditContext editContext,
                        EditNode editNode)
```
    Enable or disable edit mode for this component. Components in editMode must be associated with an EditNode within an EditContext.
    Components with editMode enabled support certain editing interactions which vary depending on the componentType and settings on the editProxy.
    To disable edit mode just pass editingOn as false. The other parameters are not needed.
    To enable edit mode on this component all three parameters are required. The editNode is the edit node for this component as it exists within the editContext.
    An alternative method, EditContext.enableEditing(), can be used when only an editContext and editNode are available.
    Placing a component into editMode causes the component's editProxy to be created.
    
    Parameters:
    
    editingOn - true to enable editMode; false to disable
    
    editContext - the EditContext
    
    editNode - the EditNode
    
    See Also:
    
    EditTree, EditContext
  - setImage
```
public void setImage(java.lang.String identifier,
                     java.lang.String URL)
```
    Set the URL of an image or SVG object element by name.
    The element must have been created from HTML generated by calling canvas.imgHTML() on this particular Canvas.
    
    Parameters:
    
    identifier - name of the image to change, as originally passed to imgHTML
    
    URL - URL for the image. See SCImgURL
    
    See Also:
    
    Images overview and related methods
  - setImage
```
public void setImage(java.lang.String identifier,
                     java.lang.String URL,
                     java.lang.String imgDir)
```
    Set the URL of an image or SVG object element by name.
    The element must have been created from HTML generated by calling canvas.imgHTML() on this particular Canvas.
    
    Parameters:
    
    identifier - name of the image to change, as originally passed to imgHTML
    
    URL - URL for the image. See SCImgURL
    
    imgDir - optional image directory, overrides the default for this Canvas
    
    See Also:
    
    Images overview and related methods
  - setPageLeft
```
public void setPageLeft(int left)
```
    Set the page-relative left coordinate of this widget.
    
    Parameters:
    
    left - new left coordinate in pixels
    
    See Also:
    
    Positioning overview and related methods
  - setPageTop
```
public void setPageTop(int top)
```
    Set the page-relative top coordinate of this widget.
    
    Parameters:
    
    top - new top coordinate in pixels
    
    See Also:
    
    Positioning overview and related methods
  - setPanelContainer
```
public void setPanelContainer(Canvas container)
```
    Sets this Canvas's "panel container". A panel container is a widget that manages a collection of panels, like a TabSet or SectionStack. Smart GWT uses this method internally when child panels are added to panel container widgets; if you need to create a panel container widget that does not extend one of the built-in ones (these are TabSet, SectionStack and Window), your code should do the same thing.
    
    Parameters:
    
    container - The container widget for this canvas
  - setRelativeTabPosition
```
public void setRelativeTabPosition(java.lang.Integer position)
```
    Assign a relative tab position for this canvas. The meaning of a "relative" tab position varies depending on where the canvas is in the page.
    For canvases with no specified parent canvas, (or where updateTabPositionOnReparent is false), this method will and move the canvas to the appropriate tab-position among other top level canvases. It will also disable updateTabPositionOnDraw so if this method is called before draw, drawing this canvas will not cause its tab position to change.
    For canvases embedded in a getParentCanvas(), this method will move the canvas to the appropriate tab position among the other children of the parent.
    Implementation note: This is achieved by setting an internal property to indicate the new tab position which will be respected by the default getChildTabPosition() implementation, and calling updateChildTabPositions() to implement a reflow. Therefore if getChildTabPosition() has been overridden, this method may have no effect.
    As with other APIs related to tab index management, tab indices are treated as a hierarchy by default. By setting the relative tab position of a canvas which is not itself focusable but has focusable descendents, these descendents' tab position will be updated.
    Note that after this method has been called, the tab position can be modified by subsequent code to shift another sibling in front of this one, or reparent this canvas.
    
    Parameters:
    
    position - new relative tab position
  - setRight
```
public void setRight(int right)
```
    Resizes the widget horizontally to position its right side at the specified coordinate.
    NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo() instead
    
    Parameters:
    
    right - new right coordinate
    
    See Also:
    
    Sizing overview and related methods
  - shouldDragScroll
```
public void shouldDragScroll()
```
    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 if there are scrollbars, else false.
    
    See Also:
    
    Dragdrop overview and related methods
  - show
```
public void show()
```
    Sets this widget's visibility to "inherit", so that it becomes visible if all of its parents are visible or it has no parents.
    If the widget has not yet been drawn (and doesn't have a parent or master), this method calls the draw method as well.
    
    See Also:
    
    Visibility overview and related methods, Show & Hide Example
  - showComponentMask
```
public void showComponentMask()
```
    Temporariy block all user interaction with children of this widget, with the exception of those passed in in the unmaskedChildren parameter. Children will remain blocked until hideComponentMask() is called.
    This method will show the componentMask canvas to block mouse interaction with children, and temporarily remove masked children from the page's tab-order.
    This behavior differs from the standard click mask in that the modal mask shown by showClickMask() will cover the entire screen and typically only allow "unmasking" of top level components.
    Use hideComponentMask() to hide the component level mask.
  - showComponentMask
```
public void showComponentMask(Canvas... unmaskedChildren)
```
    Temporariy block all user interaction with children of this widget, with the exception of those passed in in the unmaskedChildren parameter. Children will remain blocked until hideComponentMask() is called.
    This method will show the componentMask canvas to block mouse interaction with children, and temporarily remove masked children from the page's tab-order.
    This behavior differs from the standard click mask in that the modal mask shown by showClickMask() will cover the entire screen and typically only allow "unmasking" of top level components.
    Use hideComponentMask() to hide the component level mask.
    
    Parameters:
    
    unmaskedChildren - Children passed into this parameter will continue to be interactive while other children are blocked. They will be moved above the componentMask in the page's z-order and remain accessible via keyboard navigation. Note that this array should contain direct children of this widget only.
  - addShowContextMenuHandler
```
public com.google.gwt.event.shared.HandlerRegistration addShowContextMenuHandler(ShowContextMenuHandler handler)
```
    Add a showContextMenu handler.
    Executed when the right mouse button is clicked. The default implementation of this method auto-creates a Menu from the Canvas.contextMenu property on this component and then calls Menu.showContextMenu() on it to show it.
    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.
    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.
    
    Specified by:
    
    addShowContextMenuHandler in interface HasShowContextMenuHandlers
    
    Parameters:
    
    handler - the showContextMenu handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - showNextTo
```
public void showNextTo(Canvas otherWidget)
```
    Show this widget next to another widget on the page, positioned such that it will not extend beyond the browser viewport.
    Note that this method simply sets the coordinates of the widget and displays it (using a animateShow() by default). It will not change the parentElement of either component.
    An example use case might be showing a menu next to a menu-button.
    
    Parameters:
    
    otherWidget - Canvas to show next to
  - showNextTo
```
public void showNextTo(Canvas otherWidget,
                       java.lang.String side)
```
    See Also:
    
    showNextTo(com.smartgwt.client.widgets.Canvas)
  - showNextTo
```
public void showNextTo(Canvas otherWidget,
                       java.lang.String side,
                       boolean canOcclude)
```
    See Also:
    
    showNextTo(com.smartgwt.client.widgets.Canvas)
  - showNextTo
```
public void showNextTo(Canvas otherWidget,
                       java.lang.String side,
                       boolean canOcclude,
                       boolean skipAnimation)
```
    Show this widget next to another widget on the page, positioned such that it will not extend beyond the browser viewport.
    Note that this method simply sets the coordinates of the widget and displays it (using a animateShow() by default). It will not change the parentElement of either component.
    An example use case might be showing a menu next to a menu-button.
    
    Parameters:
    
    otherWidget - Canvas to show next to
    
    side - Which side of the other canvas should we put. Options are "top", "bottom", "left", "right". (Defaults to "right")
    
    canOcclude - This argument controls whether this canvas can be positioned on top of the other widget if there isn't room to put it next to the other widget extending out of the browser viewport
    If 'canOcclude' is true, simply shift this widget over the other widget, so that it ends up onscreen. If 'canOcclude' is false, avoid extending offscreen by positioning this widget on the other side of the other widget.
    
    skipAnimation - If false do not use an animation to show the component.
  - showRecursively
```
public void showRecursively()
```
    Recursively show the canvas and all its parents so the canvas will be visible.
    If the widget has not yet been drawn, this method calls the draw method as well.
    
    See Also:
    
    Visibility overview and related methods
  - updateChildTabPosition
```
public void updateChildTabPosition(Canvas child)
```
    Ensure that a specific child is slotted correctly into the page's tab order. Default implementation will, if updateTabPositionOnReparent is true, ensure the child canvas shows up in the TabIndexManager tree under the entry for this widget (the parent), in the position returned by getChildTabPosition().
    This method is called automatically in cases where a single child's tab position may need to be updated - such as if a child is added to a drawn parent.
    See also updateChildTabPositions()
    
    Parameters:
    
    child - child to have tab position updated.
  - updateChildTabPositions
```
public void updateChildTabPositions()
```
    Update the childrens' tab positions, slotting them under this widget in the TabIndexManager, in the order defined by getChildTabPosition(). This method will skip any children where updateTabPositionOnReparent is false.
    This method is called automatically on canvas draw(). It may be overridden by subclasses for custom tab-order behavior.
  - updateHover
```
public void updateHover()
```
    If this canvas is currently showing a hover (see 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.
  - updateHover
```
public void updateHover(java.lang.String hoverHTML)
```
    If this canvas is currently showing a hover (see 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.
    
    Parameters:
    
    hoverHTML - Option to specify new HTML for the hover. If not passed, the result of this.getHoverHTML() will be used instead. Note that if the hover HTML is empty the hover will be hidden.
  - updateTabPositionForDraw
```
public void updateTabPositionForDraw()
```
    This method is executed on draw. Default implementation for top-level widgets ensures this widget is at the end of the tab-sequence.
    Has no effect if this canvas is embedded in a parent.
  - addVisibilityChangedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addVisibilityChangedHandler(VisibilityChangedHandler handler)
```
    Add a visibilityChanged handler.
    Notification fired when this canvas becomes visible or hidden to the user. Note - this method is fired when the Canvas.isVisible() state of this component changes. It may be fired in response an explicit call to Canvas.show() or Canvas.hide(), or in response to a parent component being shown or hidden when this widgets Canvas.visibility is set to "inherit".
    Note that a call to Canvas.show() or Canvas.hide() will not always fire this notification. If this widget has a hidden parent, show or hide would change this components Canvas.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.
    Note also that this notification will only be fired for components which have been drawn.
    
    Specified by:
    
    addVisibilityChangedHandler in interface HasVisibilityChangedHandlers
    
    Parameters:
    
    handler - the visibilityChanged handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - getEventEdge
```
public static EdgeName getEventEdge()
```
    Check if an event is within an "edge" of this canvas.
    
    Returns:
    
    edge where the mouse is positioned, or null if not within a legal edge (including being in the center)
    
    See Also:
    
    getResizeFrom()
  - getEventEdge
```
public static EdgeName getEventEdge(EdgeName... edgeMask)
```
    Check if an event is within an "edge" of this canvas.
    
    Parameters:
    
    edgeMask - Array of legal edges. Default is all the edges that allow resizing (see resizeFrom)
    
    Returns:
    
    edge where the mouse is positioned, or null if not within a legal edge (including being in the center)
    
    See Also:
    
    getResizeFrom()
  - getSnapPosition
```
public static Point getSnapPosition(Canvas target,
                                    java.lang.String snapTo,
                                    Canvas snapper)
```
    Return the position for snapper to be placed in order to "snap to" an edge or corner of target, in the same sense as snapTo.
    Default for snapEdge is the opposite edge or corner from snapTo. For example, snapTo of "T" (top) means snapEdge will default to "B" (bottom), so the returned coordinates would place snapper centered along the top edge of target. A snapTo of "TL" (top left) means snapEdge will default to "BR" (bottom right), so the returned coordinates would place the bottom right of snapper at the top left corner of target.
    target can be passed as either a Canvas or 4-element Array giving the top, left, width and height of the target.
    
    Parameters:
    
    target - canvas to snap to
    
    snapTo - edge against which to snap
    
    snapper - canvas being snapped
    
    Returns:
    
    the position for snapper to be placed in order to "snap to" an edge or corner of target
  - getSnapPosition
```
public static Point getSnapPosition(Canvas target,
                                    java.lang.String snapTo,
                                    Canvas snapper,
                                    java.lang.String snapEdge)
```
    Return the position for snapper to be placed in order to "snap to" an edge or corner of target, in the same sense as snapTo.
    Default for snapEdge is the opposite edge or corner from snapTo. For example, snapTo of "T" (top) means snapEdge will default to "B" (bottom), so the returned coordinates would place snapper centered along the top edge of target. A snapTo of "TL" (top left) means snapEdge will default to "BR" (bottom right), so the returned coordinates would place the bottom right of snapper at the top left corner of target.
    target can be passed as either a Canvas or 4-element Array giving the top, left, width and height of the target.
    
    Parameters:
    
    target - canvas to snap to
    
    snapTo - edge against which to snap
    
    snapper - canvas being snapped
    
    snapEdge - optional edge to snapTo. Default is the opposite edge or corner from snapTo
    
    Returns:
    
    the position for snapper to be placed in order to "snap to" an edge or corner of target
  - registerFontScaledPaddingStyles
```
public static void registerFontScaledPaddingStyles(java.lang.String[] scaledStyles,
                                                   java.lang.String[] baselineStyles,
                                                   int targetSizeChange)
```
    Registers one or more CSS classes to have their padding adjusted (independently on all edges) according to the padding size change applied to the page. Each class to be registered is provided along with a corresponding baseline class, and a single targetSizeChange is specified for all the classes. The padding in each registered class is adjusted downward towards the baseline as the padding size change approaches 0 (no resizing), and upward as it increases, so that it exactly equals the declared style's padding at a padding size change of targetSizeChange.
    Note that each call to this method replaces the registration of the previous call (if any), and will have no effect until resizePadding() is called.
    For example:
```
     isc.Canvas.registerFontScaledPaddingStyles(
         [        "tabButtonTop",         "tabButtonBottom"], 
         ["iconOnlyTabButtonTop", "iconOnlyTabButtonBottom"],
         3
     );
  
```
    In this case, the CSS style "tabButtonTop" will have its padding adjusted downward to the padding from the baseline CSS style "iconOnlyTabButtonTop" style at a sizeChange of 0, and be left unchanged at a sizeChange of 3.
    Parameters:
    
    scaledStyles - styles whose padding should be adjusted
    
    baselineStyles - corresponding baseline reference styles
    
    targetSizeChange - sizeChange at which scaledStyles are unchanged
    
    See Also:
    
    resizeFonts(int), resizePadding(int), resizeControls(int), com.smartgwt.client.widgets.Canvas#registerIconSizingAttributes
  - resizeAutoChildAttributes
```
public static void resizeAutoChildAttributes(java.lang.String policy,
                                             int delta)
```
    Change the value of attributes registered via registerAutoChildSizingAttributes() by some number of pixels. This method may be invoked automatically from resizeControls() or resizeFonts()
    Must be called after the skin has been loaded, but before any components are created.
    
    Parameters:
    
    policy - Which set of attributes should be resized? This should correspond to the sizing policy argument applied when registering the icon sizing attributes.
    
    delta - number of pixels to increase or decrease from current size
  - resizeControls
```
public static void resizeControls(int delta)
```
    Change the basic size of UI components in the current skin by "delta" pixels. Must be called after the skin has been loaded, but before any components are created.
    The size of a text input control implies the size of most other controls:
    - all other FormItems (eg selects) need to be the same size or mixed controls will look odd. This includes Buttons
    - anything that potentially contains a FormItem needs to be as tall or slightly taller: this includes grid row (inline editing), Window headers, TabBar and SectionHeaders
    Because of this necessary uniformity, just specifying a single pixel value is enough for the framework to resize all core controls, with several caveats:
    - skins that make extensive use of images (eg TreeFrog) will stretch those images, which may result in ugly artifacts in some combinations of operating system and browser, for which no workaround is possible. For this reason, resizeControls() is only officially supported for Tahoe, Enterprise, EnterpriseBlue and Graphite skins, and only in CSS3 Mode
    - even in Enterprise-series skins, tree connector lines vertically stretch, becoming obviously blurry and misshapen with an increase of 4-5px. To avoid this, replace the tree connector media (see TreeGrid.connectorImage).
    - FormItemIcons are not resized by default, because stretched icons generally look worse than non-scaled icons that are a bit smaller than the input field
    - images that use spriting will not be stretched because the sizes for these controls are embedded in CSS. In most cases, this is desirable; for example, the downward chevron shape used for SelectItem controls doesn't stretch, and looks better that way.
    Parameters:
    
    delta - number of pixels to increase or decrease from current size
  - resizeFonts
```
public static void resizeFonts(int sizeChange)
```
    Modify the size of fonts for some or all stylesheets defined in the page.
    This method can be used to dynamically increase or decrease font size for all of the fonts in your application, or just fonts defined in your chosen Smart GWT skin (the latter can be achieved by passing styleSheets as "skin_styles.css" - the default name for the CSS file used in each Smart GWT skin).
    resizeFonts() must be called after the skin has been loaded, and before any components have been created. Calling resizeFonts() at a later time is not supported (you will notice that font sizes still increase, however, this approach is not supported).
    Some browsers will disallow access or modification of styleSheets if they are loaded from a domain that is different from the loading page. In this case resizeFonts() cannot be used.
    This method has a small performance penalty which depends on the browser, number of stylesheets being modified, and age of your machine. With modern browsers on modern machines resizing just skin fonts, the impact is basically negligible (<5ms).
    Certain controls such as icons are resized when fonts are resized (see setAutoResizeIcons() and setAutoResizeAutoChildAttributes()) so you might want to set resizeRelatedControls to false where you are just trying to make fonts in a dynamically loaded stylesheet match previously loaded fonts, but controls such as icons should not be resized upwards again.
    
    Parameters:
    
    sizeChange - size to change fonts by. Can be negative to shrink fonts
  - resizeFonts
```
public static void resizeFonts(int sizeChange,
                               java.lang.String styleSheets)
```
    See Also:
    
    resizeFonts(int)
  - resizeFonts
```
public static void resizeFonts(int sizeChange,
                               java.lang.String styleSheets,
                               java.lang.Boolean resizeRelatedControls)
```
    Modify the size of fonts for some or all stylesheets defined in the page.
    This method can be used to dynamically increase or decrease font size for all of the fonts in your application, or just fonts defined in your chosen Smart GWT skin (the latter can be achieved by passing styleSheets as "skin_styles.css" - the default name for the CSS file used in each Smart GWT skin).
    resizeFonts() must be called after the skin has been loaded, and before any components have been created. Calling resizeFonts() at a later time is not supported (you will notice that font sizes still increase, however, this approach is not supported).
    Some browsers will disallow access or modification of styleSheets if they are loaded from a domain that is different from the loading page. In this case resizeFonts() cannot be used.
    This method has a small performance penalty which depends on the browser, number of stylesheets being modified, and age of your machine. With modern browsers on modern machines resizing just skin fonts, the impact is basically negligible (<5ms).
    Certain controls such as icons are resized when fonts are resized (see setAutoResizeIcons() and setAutoResizeAutoChildAttributes()) so you might want to set resizeRelatedControls to false where you are just trying to make fonts in a dynamically loaded stylesheet match previously loaded fonts, but controls such as icons should not be resized upwards again.
    
    Parameters:
    
    sizeChange - size to change fonts by. Can be negative to shrink fonts
    
    styleSheets - optional regular expression pattern for matching stylesheets
    
    resizeRelatedControls - resize icons and autoChild attributes? Set to false to suppress default behavior.
  - resizeIcons
```
public static void resizeIcons(java.lang.String policy,
                               int delta)
```
    Change the basic size of icons in the current skin by "delta" pixels. This method may be invoked automatically from resizeControls().
    Must be called after the skin has been loaded, but before any components are created.
    
    Parameters:
    
    policy - Which set of icons should be resized? This should correspond to the iconSizingPolicy argument applied when registering the icon sizing attributes.
    
    delta - number of pixels to increase or decrease from current size
  - resizePadding
```
public static void resizePadding(int fontSizeChange)
```
    Modify the amount of padding for some CSS styles defined for the page. Only CSS styles registered by registerFontScaledPaddingStyles() are modified.
    resizePadding() must be called after the skin has been loaded, and before any components have been created. Calling resizePadding() at a later time is not supported (you will notice that padding is modified, however, this approach is not supported).
    This method has similar browser security limitations as resizeFonts().
    The intent is that the same font size change be passed to this method as is passed to resizeFonts(), so that the targetSizeChange in the call to registerFontScaledPaddingStyles() represents the right font size for the unadjusted styles being registered.
    
    Parameters:
    
    fontSizeChange - size change to apply to the padding of registered styles, so that they aren't changed at all at the size change passed to registerFontScaledPaddingStyles(), and the padding is reduced to baseline style levels at a zero size change.
    
    See Also:
    
    resizeFonts(int), resizeControls(int)
  - resizePadding
```
public static void resizePadding(int fontSizeChange,
                                 java.lang.String styleSheets)
```
    Modify the amount of padding for some CSS styles defined for the page. Only CSS styles registered by registerFontScaledPaddingStyles() are modified.
    resizePadding() must be called after the skin has been loaded, and before any components have been created. Calling resizePadding() at a later time is not supported (you will notice that padding is modified, however, this approach is not supported).
    This method has similar browser security limitations as resizeFonts().
    The intent is that the same font size change be passed to this method as is passed to resizeFonts(), so that the targetSizeChange in the call to registerFontScaledPaddingStyles() represents the right font size for the unadjusted styles being registered.
    
    Parameters:
    
    fontSizeChange - size change to apply to the padding of registered styles, so that they aren't changed at all at the size change passed to registerFontScaledPaddingStyles(), and the padding is reduced to baseline style levels at a zero size change.
    
    styleSheets - optional regular expression pattern for matching stylesheets
    
    See Also:
    
    resizeFonts(int), resizeControls(int)
  - setAllowExternalFilters
```
public static void setAllowExternalFilters(boolean allExternalFilters)
```
    Changes the system-wide allowExternalFilters setting.
    
    Parameters:
    
    allExternalFilters - new setting
  - setAutoResizeAutoChildAttributes
```
public static void setAutoResizeAutoChildAttributes(boolean autoResize)
```
    Should registered autoChild attributes be automatically resized with controls and text?
    If true, attributes registered for resize with policy "controls" will be resized when resizeControls() runs, and icons registered with policy "fonts" will resize when resizeFonts() runs.
    To resize autoChild attributes with other policies, developers should call resizeAutoChildAttributes() directly
    
    Parameters:
    
    autoResize - true if attributes should be auto-resized
  - setAutoResizeIcons
```
public static void setAutoResizeIcons(boolean autoResizeIcons)
```
    Should icons be automatically resized with controls and text?
    If true, icon attributes registered for resize with policy "controls" will be resized when resizeControls() runs, and icons registered with policy "fonts" will resize when resizeFonts() runs.
    To resize icons with other policies, developers should call resizeIcons() directly
    
    Parameters:
    
    autoResizeIcons - true if icons should be auto-resized
  - setDefaultPageSpace
```
public static void setDefaultPageSpace(int newDefaultPageSpace)
```
    Changes the global defaultPageSpace.
    
    Parameters:
    
    newDefaultPageSpace - the new value for defaultPageSpace.
  - setNeverUseFilters
```
public static void setNeverUseFilters(boolean neverUseFilters)
```
    Changes the system-wide neverUseFilters setting.
    
    Parameters:
    
    neverUseFilters - new setting
  - setDefaultProperties
```
public static void setDefaultProperties(Canvas canvasProperties)
```
    Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. 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.
    Note: This method is intended for setting default attributes only and will affect 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. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
    
    Parameters:
    
    canvasProperties - properties that should be used as new defaults when instances of this class are created
    
    See Also:
    
    SGWTProperties
  - getTestInstance
```
protected Canvas getTestInstance()
```
  - getById
```
public static Canvas getById(java.lang.String ID)
```
    Retrieve a Canvas by its global ID.
    
    Parameters:
    
    ID - global ID of the Canvas
    
    Returns:
    
    the Canvas, or null if not found or not a Canvas
  - getByJSObject
```
public static Canvas getByJSObject(com.google.gwt.core.client.JavaScriptObject jsObj)
```
    Retrieve a Canvas from its JavaScriptObject.
    
    Parameters:
    
    jsObj - SmartClient object associated with Canvas
    
    Returns:
    
    the Canvas, or null if not found or not a Canvas
  - setElement
```
protected void setElement(com.google.gwt.user.client.Element elem)
```
    Normal usage of SmartGWT is to call draw() on SmartGWT widgets, not to use use RootPanel.add(). Developers will not typically need to call getElement() or setElement() for SmartGWT canvas instances. If developers do need to access the DOM elements created by a drawn SmartGWT component, they should use getOuterElement() and getContentElement(). See the javadoc for those methods for more information. Note particularly that these elements should not be directly manipulated in the DOM - instead standard SmartGWT APIs such as draw(), clear(), setContents(), addChild(), redraw() should be used. See also setHtmlElement(Element) for how to embed a SmartGWT component into an existing DOM element.
    getElement() and setEleent() exist solely to support adding SmartGWT widgets to a core GWT layout manager. This usage has limitations and caveats - see this list of Frequently Asked Questions.
    The mechanism that getElement() uses to integrate with core GWT is the same as that described for com.smartgwt.client.widgets.Canvas#setHTMLElement(Element) and has the same caveats
    
    Overrides:
    
    setElement in class com.google.gwt.user.client.ui.UIObject
  - getElement
```
public com.google.gwt.user.client.Element getElement()
```
    Normal usage of SmartGWT is to call draw() on SmartGWT widgets, not to use use RootPanel.add(). Developers will not typically need to call getElement() or setElement() for SmartGWT canvas instances. If developers do need to access the DOM elements created by a drawn SmartGWT component, they should use getOuterElement() and getContentElement(). See the javadoc for those methods for more information. Note particularly that these elements should not be directly manipulated in the DOM - instead standard SmartGWT APIs such as draw(), clear(), setContents(), addChild(), redraw() should be used. See also setHtmlElement(Element) for how to embed a SmartGWT component into an existing DOM element.
    getElement() and setEleent() exist solely to support adding SmartGWT widgets to a core GWT layout manager. This usage has limitations and caveats - see this list of Frequently Asked Questions.
    The mechanism that getElement() uses to integrate with core GWT is the same as that described for com.smartgwt.client.widgets.Canvas#setHTMLElement(Element) and has the same caveats
    
    Overrides:
    
    getElement in class com.google.gwt.user.client.ui.UIObject
  - getElement
```
public com.google.gwt.user.client.Element getElement(boolean allowPreRender)
```
    Parameters:
    
    allowPreRender -
    
    Returns:
    
    See Also:
    
    UIObject.getElement()
  - asSGWTComponent
```
public static <T extends Canvas> T asSGWTComponent(com.google.gwt.core.client.JavaScriptObject jsObj)
```
    Returns the existing SGWT widget, or creates and returns one if none exist, associated with the supplied JavaScriptObject. If the supplied object is not a SmartClient Canvas, a warning will be logged and null returned; otherwise the widget will be returned as the appropriate subtype of SGWT Canvas.
    
    Parameters:
    
    jsObj - SmartClient Canvas whose wrapper is wanted
    
    Returns:
    
    wrapping SGWT Canvas, appropriately subtyped, or null
  - getByLocalId
```
public Canvas getByLocalId(java.lang.String ID)
```
    Retrieve a child of this Canvas by it's local ID.
    A "local ID" is name for a child widget which is unique only for this parent, and not globally unique as is required for ID. Widgets receive local IDs when loaded via com.smartgwt.client.client.rpc.RPCManager#loadScreen() or com.smartgwt.client.rpc.RPCManager#cacheScreens() and com.smartgwt.client.rpc.RPCManager#createScreen().
    
    Parameters:
    
    ID - global ID of the Canvas
    
    Returns:
    
    the Canvas, or null if not found
  - getClassName
```
public java.lang.String getClassName()
```
    Returns the JavaScript class name.
    
    Overrides:
    
    getClassName in class BaseWidget
    
    Returns:
    
    the JavaScript class name.
  - setInitHandler
```
public void setInitHandler(CanvasInitHandler initHandler)
```
    Specify a notification method to fire when this Canvas is initialized in JavaScript. This allows developers to set up form item state dynamically when the item is created.
    
    Parameters:
    
    initHandler -
  - onInit
```
protected void onInit()
```
    Overrides:
    
    onInit in class BaseWidget
  - onDetach
```
protected void onDetach()
```
    Overrides:
    
    onDetach in class com.google.gwt.user.client.ui.Widget
  - onAttach
```
protected void onAttach()
```
    Overrides:
    
    onAttach in class com.google.gwt.user.client.ui.Widget
  - addStyleName
```
public void addStyleName(java.lang.String style)
```
    Multiple styles are currently not supported. This method essentially calls setStyleName(String)
    
    Overrides:
    
    addStyleName in class com.google.gwt.user.client.ui.UIObject
    
    Parameters:
    
    style - the style name
    
    See Also:
    
    setStyleName(String)
  - setVisible
```
public void setVisible(boolean visible)
```
    Specified by:
    
    setVisible in interface com.google.gwt.user.client.ui.HasVisibility
    
    Overrides:
    
    setVisible in class com.google.gwt.user.client.ui.UIObject
  - setHeight
```
public void setHeight(int height)
```
    See Also:
    
    setHeight(Integer)
  - setHeight100
```
public void setHeight100()
```
    Convenience method that sets the height to 100%.
  - getHeightAsString
```
public java.lang.String getHeightAsString()
```
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Synonym for setPrompt(String)
    
    Overrides:
    
    setTitle in class BaseWidget
    
    Parameters:
    
    title - the title
  - getTitle
```
public java.lang.String getTitle()
```
    Synonym for getPrompt()
    
    Overrides:
    
    getTitle in class BaseWidget
    
    Returns:
    
    the title
  - setTooltip
```
public void setTooltip(java.lang.String tooltip)
```
    Synonym for setPrompt(String)
    
    Parameters:
    
    tooltip - the tooltip
  - getTooltip
```
public java.lang.String getTooltip()
```
    Synonym for getPrompt()
    
    Returns:
    
    the tooltip
  - setWidth
```
public void setWidth(int width)
```
    See Also:
    
    setWidth(Integer)
  - setWidth100
```
public void setWidth100()
```
    Convenience method that sets the width to 100%.
  - getWidthAsString
```
public java.lang.String getWidthAsString()
```
  - getLeftAsString
```
public java.lang.String getLeftAsString()
```
    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 position property).
    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 'parent'.
    
    Returns:
    
    Return the left coordinate of this object, relative to its enclosing context, in pixels.
  - getFacetId
```
public java.lang.String getFacetId()
```
    If a Canvas is dropped onto a CubeGrid, and it has a facetId property specified then the Cube treats this as adding that facetId at the drop location.
    
    Returns:
    
    the facet id
  - setFacetId
```
public void setFacetId(java.lang.String facetId)
```
    If a Canvas is dropped onto a CubeGrid, and it has a facetId property specified then the Cube treats this as adding that facetId at the drop location.
    
    Parameters:
    
    facetId - the facet id
  - getTopAsString
```
public java.lang.String getTopAsString()
```
    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 position property).
    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 'parent'.
    
    Returns:
    
    Return the top coordinate of this object, relative to its enclosing context, in pixels.
  - setAlign
```
public void setAlign(Alignment align)
```
  - getAbsoluteLeft
```
public int getAbsoluteLeft()
```
    This method is similar to getPageLeft().
    
    Overrides:
    
    getAbsoluteLeft in class com.google.gwt.user.client.ui.UIObject
    
    Returns:
  - getAbsoluteTop
```
public int getAbsoluteTop()
```
    This method is similar to getPageTop().
    
    Overrides:
    
    getAbsoluteTop in class com.google.gwt.user.client.ui.UIObject
    
    Returns:
  - setAnimateShowEffect
```
public void setAnimateShowEffect(AnimationEffect animateShowEffect)
```
    Default animation effect to use if animateShow() is called without an explicit effect parameter.
    
    Parameters:
    
    animateShowEffect - the animate show effect. Default is "wipe"
  - getAnimateShowEffect
```
public AnimationEffect getAnimateShowEffect()
```
    Default animation effect to use if animateShow() is called without an explicit effect parameter.
    
    Returns:
    
    animation effect. Default value is "wipe"
  - getAnimateHideEffect
```
public AnimationEffect getAnimateHideEffect()
```
    Default animation effect to use if animateHide() is called without an explicit effect parameter.
    
    Returns:
    
    animation effect. Default value is "wipe"
  - setAnimateHideEffect
```
public void setAnimateHideEffect(AnimationEffect animateHideEffect)
```
    Default animation effect to use if animateHide() is called without an explicit effect parameter.
    
    Parameters:
    
    animateHideEffect - the animate show effect. Default is "wipe"
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    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
    Note : This is an advanced setting
    
    Parameters:
    
    disabled - new disabled state of this object - pass true to disable the widget. Default value is false
  - getDisabled
```
public boolean getDisabled()
```
    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.
    
    Returns:
    
    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.
  - setDragTarget
```
public void setDragTarget(Canvas dragTarget)
```
    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.
    Valid dragTarget values are:
    - null (default) [this widget is its own drag target]
    - Pointer to another widget, or widget ID
    - "parent" drag target is this widget's parentCanvas
    - "top" drag target is this widget's topElement
    
    Note : This is an advanced setting
    
    Parameters:
    
    dragTarget - dragTarget Default value is null
  - getDragTarget
```
public Canvas getDragTarget()
```
    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.
    Valid dragTarget values are:
    - null (default) [this widget is its own drag target]
    - Pointer to another widget, or widget ID
    - "parent" drag target is this widget's parentCanvas
    - "top" drag target is this widget's topElement
    
    Returns:
    
    Canvas
  - willAcceptDrop
```
public java.lang.Boolean willAcceptDrop()
```
    Returns true if the widget object being dragged can be dropped on this widget, and false or null otherwise. The default implementation of this method simply compares the dragType of the dragTarget (the component being dragged from) with the list of dropTypes on this Canvas. If the dropTypes list contains the dragType value, then this method returns true. Otherwise it returns false.
    No matter what you return, the onDropOver and onDropMove handlers will still be called, and their return value will control whether those events are bubbled to parent elements.
    However, what you return from willAcceptDrop() does determine whether the onDrop handler will be called.
    - If you return true, then onDrop() will be called, and its return value will determine whether the event is bubbled to parent elements.
    - If you return false, then onDrop() will not be called, and the event will not be bubbled.
    - If you return null, then onDrop() will not be called, but the event will be bubbled to parent elements (giving them a chance to handle the drop).
    So, you should return false to definitively deny a drop, and return null if it could make sense to allow a parent element (such as a Layout) to handle the drop.
    Note: This is an override point
    Returns:
    
    true if the widget object being dragged can be dropped on this widget, false if it cannot (and a drop event should not be bubbled), and null to permit a drop event to bubble to parent elements.
  - parentResized
```
protected void parentResized()
```
    Fires when the interior size of the parent changes, including parent resize and scrollbar introduction or removal.
    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 snapTo property.
    Make sure you call super.parentResized() if you'd like the default behavior to apply.
    Note: This is an override point
  - getHoverComponent
```
public Canvas getHoverComponent()
```
    When 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.
    By default, components returned by getHoverComponent() will not be automatically destroyed when the hover is hidden. To enforce this, set hoverAutoDestroy to true on the returned component.
    Note: this is an override point
    
    Returns:
    
    the component to show as a hover
  - setSmoothFade
```
public void setSmoothFade(java.lang.Boolean smoothFade)
                   throws java.lang.IllegalStateException
```
    Throws:
    
    java.lang.IllegalStateException
  - setKeepInParentRect
```
public void setKeepInParentRect(Rectangle rectangle)
```
  - setPrefix
```
public void setPrefix(java.lang.String prefix)
```
  - getPrefix
```
public java.lang.String getPrefix()
```
  - setResizeFrom
```
public void setResizeFrom(java.lang.String... resizeFrom)
```
    Deprecated. use #setResizeFrom(EdgeName) instead.
    
    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:
    T top edge
    B bottom edge
    L left edge
    R right edge
    TL top-left corner
    TR top-right corner
    BL bottom-left corner
    BR bottom-right corner
    
    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
    
    Parameters:
    
    resizeFrom - resizeFrom values
  - resizeTo
```
public java.lang.Boolean resizeTo(java.lang.String width,
                                  java.lang.String height)
```
    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.
    
    Parameters:
    
    width - new width for canvas
    
    height - new height for canvas
    
    Returns:
    
    whether the size actually changed
  - setProportionalResizeModifiers
```
public void setProportionalResizeModifiers(java.lang.String... proportionalResizeModifiers)
                                    throws java.lang.IllegalStateException
```
    If proportionalResizing is set to ProportionalResizeMode.MODIFIER or ProportionalResizeMode.MODIFIER_OFF then proportional resizing of the DrawItem is activated or deactivated, respectively, whenever at least one key in this set of modifier keys is pressed.
    The keys allowed in this set are: "Alt", "Ctrl", and "Shift". If this set of keys is empty then proportional resizing is always used if proportionalResizing is MODIFIER and is never used if proportionalResizing is MODIFIER_OFF.
    
    Parameters:
    
    proportionalResizeModifiers - Default value is ["Shift"]
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created
  - getProportionalResizeModifiers
```
public java.lang.String[] getProportionalResizeModifiers()
```
    If proportionalResizing is set to ProportionalResizeMode.MODIFIER or ProportionalResizeMode.MODIFIER_OFF then proportional resizing of the DrawItem is activated or deactivated, respectively, whenever at least one key in this set of modifier keys is pressed.
    The keys allowed in this set are: "Alt", "Ctrl", and "Shift". If this set of keys is empty then proportional resizing is always used if proportionalResizing is MODIFIER and is never used if proportionalResizing is MODIFIER_OFF.
    
    Returns:
    
    String...
  - isVisible
```
public boolean isVisible()
```
    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.
    NOTE: Undrawn widgets will report themselves as visible if they would be visible if drawn.
    
    Specified by:
    
    isVisible in interface com.google.gwt.user.client.ui.HasVisibility
    
    Overrides:
    
    isVisible in class com.google.gwt.user.client.ui.UIObject
    
    Returns:
    
    true if the widget is visible, false otherwise
  - animateScroll
```
public void animateScroll(int scrollLeft,
                          int scrollTop,
                          AnimationCallback callback)
```
    Animate a scroll from the current scroll position to the specified position.
    
    Parameters:
    
    scrollLeft - desired final left scroll postion
    
    scrollTop - desired final top scroll postion
    
    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
  - animateScroll
```
public void animateScroll(int scrollLeft,
                          int scrollTop,
                          AnimationCallback callback,
                          int duration)
```
    Animate a scroll from the current scroll position to the specified position.
    
    Parameters:
    
    scrollLeft - desired final left scroll postion
    
    scrollTop - desired final top scroll postion
    
    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
    
    duration - Duration in ms of the animated scroll
  - animateFade
```
public void animateFade(int opacity)
```
    Animate a change in opacity from the widget's current opacity to the specified opacity.
    
    Parameters:
    
    opacity - desired final opacity
  - animateFade
```
public void animateFade(int opacity,
                        AnimationCallback callback)
```
    Animate a change in opacity from the widget's current opacity to the specified opacity.
    
    Parameters:
    
    opacity - desired final opacity
    
    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
  - animateFade
```
public void animateFade(int opacity,
                        AnimationCallback callback,
                        int duration)
```
    Animate a change in opacity from the widget's current opacity to the specified opacity.
    
    Parameters:
    
    opacity - desired final opacity
    
    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
    
    duration - Duration in ms of the animated fade
  - animateFade
```
public void animateFade(int opacity,
                        AnimationCallback callback,
                        int duration,
                        AnimationAcceleration acceleration)
```
    Animate a change in opacity from the widget's current opacity to the specified opacity.
    
    Parameters:
    
    opacity - desired final opacity
    
    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
    
    duration - Duration in ms of the animated fade
    
    acceleration - Animation acceleration to bias the ratios
  - animateHide
```
public void animateHide()
```
    Hide a canvas by shrinking it with default effect specified by animateHideEffect. This method will not fire if the widget is already drawn and visible, or has overflow other than "visible" or "hidden".
  - animateHide
```
public void animateHide(AnimationEffect effect)
```
    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 "visible" or "hidden".
    
    Parameters:
    
    effect - How should the content of the window be hidden during the hide? If omitted, default behavior can be configured via animateHideEffect
  - animateHide
```
public void animateHide(AnimateShowEffect effect)
```
    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 "visible" or "hidden".
    
    Parameters:
    
    effect - How should the content of the window be hidden during the hide? If omitted, default behavior can be configured via animateHideEffect
  - animateHide
```
public void animateHide(AnimationEffect effect,
                        AnimationCallback callback)
```
    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 "visible" or "hidden".
    
    Parameters:
    
    effect - How should the content of the window be hidden during the hide? If omitted, default behavior can be configured via animateHideEffect
    
    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.
  - animateHide
```
public void animateHide(AnimateShowEffect effect,
                        AnimationCallback callback)
```
    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 "visible" or "hidden".
    
    Parameters:
    
    effect - How should the content of the window be hidden during the hide? If omitted, default behavior can be configured via animateHideEffect
    
    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.
  - animateHide
```
public void animateHide(AnimationEffect effect,
                        AnimationCallback callback,
                        int 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 "visible" or "hidden".
    
    Parameters:
    
    effect - How should the content of the window be hidden during the hide? If omitted, default behavior can be configured via animateHideEffect
    
    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.
    
    duration - Duration in ms of the animated hide. If unset, duration will be picked up from animateHideTime
  - animateHide
```
public void animateHide(AnimateShowEffect effect,
                        AnimationCallback callback,
                        int 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 "visible" or "hidden".
    
    Parameters:
    
    effect - How should the content of the window be hidden during the hide? If omitted, default behavior can be configured via animateHideEffect
    
    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.
    
    duration - Duration in ms of the animated hide. If unset, duration will be picked up from animateHideTime
  - animateShow
```
public void animateShow()
```
    Show a canvas by growing it with default effect specified by animateShowEffect. This method will not fire if the widget is already drawn and visible, or has overflow other than "visible" or "hidden".
  - animateShow
```
public void animateShow(AnimationEffect effect)
```
    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 "visible" or "hidden".
    
    Parameters:
    
    effect - Animation effect to use when revealing the widget. If omitted, default behavior can be configured via animateShowEffect
  - animateShow
```
public void animateShow(AnimateShowEffect effect)
```
    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 "visible" or "hidden".
    
    Parameters:
    
    effect - AnimateShowEffect effect to use when revealing the widget. If omitted, default behavior can be configured via animateShowEffect
  - animateShow
```
public void animateShow(AnimationEffect effect,
                        AnimationCallback callback)
```
    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 "visible" or "hidden".
    
    Parameters:
    
    effect - Animation effect to use when revealing the widget. If omitted, default behavior can be configured via animateShowEffect
    
    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.
  - animateShow
```
public void animateShow(AnimateShowEffect effect,
                        AnimationCallback callback)
```
    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 "visible" or "hidden".
    
    Parameters:
    
    effect - AnimateShowEffect effect to use when revealing the widget. If omitted, default behavior can be configured via animateShowEffect
    
    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.
  - animateShow
```
public void animateShow(AnimationEffect effect,
                        AnimationCallback callback,
                        int 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 "visible" or "hidden".
    
    Parameters:
    
    effect - Animation effect to use when revealing the widget. If omitted, default behavior can be configured via animateShowEffect
    
    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.
    
    duration - Duration in ms of the animated show. If unset, duration will be picked up from animateShowTime
  - animateShow
```
public void animateShow(AnimateShowEffect effect,
                        AnimationCallback callback,
                        int 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 "visible" or "hidden".
    
    Parameters:
    
    effect - AnimateShowEffect effect to use when revealing the widget. If omitted, default behavior can be configured via animateShowEffect
    
    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.
    
    duration - Duration in ms of the animated show. If unset, duration will be picked up from animateShowTime
  - updateShadow
```
public void updateShadow()
```
    Update the canvas shadow.
  - getZIndex
```
public int getZIndex()
```
    Get the z-Index of this canvas.
    
    Returns:
    
    the zIndex
  - getNextZIndex
```
public int getNextZIndex()
```
    get the next zIndex for the next item to be drawn. see setZIndex() for notes
    
    Returns:
    
    the next zIndex
  - setZIndex
```
public void setZIndex(int newIndex)
```
    Set the z-Index of the canvas.
    
    Parameters:
    
    newIndex - the new zIndex to set to
  - getPageRect
```
public Rectangle getPageRect()
```
  - setRect
```
public void setRect(Rectangle rectangle)
```
    Set all four coordinates, relative to the enclosing context, at once.
    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.
    
    Parameters:
    
    rectangle - new coordinates
  - setRect
```
public void setRect(int left,
                    int top,
                    int width,
                    int height)
```
    Set all four coordinates, relative to the enclosing context, at once.
    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.
    
    Parameters:
    
    left - new left coordinate
    
    top - new top coordinate
    
    width - new width
    
    height - new height
  - getRect
```
public Rectangle getRect()
```
    Get all four coordinates, relative to the enclosing context, at one.
    
    Returns:
    
    the Rectangle
  - getImgURL
```
public static java.lang.String getImgURL(java.lang.String URL)
```
    Return the full URL for an image to be drawn in this canvas.
    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.
    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.//
    
    Parameters:
    
    URL - URL local to skin or application image directory
    
    Returns:
    
    URL to use
  - getImgURL
```
public static java.lang.String getImgURL(java.lang.String URL,
                                         java.lang.String imgDir)
```
    Return the full URL for an image to be drawn in this canvas.
    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.
    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.//
    
    Parameters:
    
    URL - URL local to skin or application image directory
    
    imgDir - optional image directory to override the default for this Canvas
    
    Returns:
    
    URL to use
  - imgHTML
```
public static java.lang.String imgHTML(java.lang.String src)
```
    Generates the HTML for an image unique to this Canvas.
    The full URL for the image will be formed according to the rules documented for getImgURL(java.lang.String).
    The created image will have an identifier unique to this Canvas, and subsequent calls to getImage(java.lang.String) and setImage(java.lang.String, java.lang.String) with the name passed to this function will act on the image object produced by the HTML returned from this call.
    
    Parameters:
    
    src - URL local to the skin or application directory.
    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:
    canvas.imgHTML( {src:"foo", width:10, height:10} );
    
    Returns:
    
    HTML to draw the image.
  - imgHTML
```
public static java.lang.String imgHTML(java.lang.String src,
                                       int width,
                                       int height,
                                       java.lang.String name,
                                       java.lang.String extraStuff,
                                       java.lang.String imgDir)
```
    Generates the HTML for an image unique to this Canvas.
    The full URL for the image will be formed according to the rules documented for getImgURL(java.lang.String).
    The created image will have an identifier unique to this Canvas, and subsequent calls to getImage(java.lang.String) and setImage(java.lang.String, java.lang.String) with the name passed to this function will act on the image object produced by the HTML returned from this call.
    
    Parameters:
    
    src - URL local to the skin or application directory.
    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:
    canvas.imgHTML( {src:"foo", width:10, height:10} );
    
    width - width of the image
    
    height - height of the image
    
    name - name for the image
    
    extraStuff - additional attributes to write in the tag
    
    imgDir - image-specific image directory to override the default for this Canvas
    
    Returns:
    
    HTML to draw the image.
  - imgHTML
```
public static java.lang.String imgHTML(java.lang.String src,
                                       int width,
                                       int height)
```
  - showPrintPreview
```
public static void showPrintPreview(Canvas component)
```
    Show a PrintWindow containing a printable view of the component passed in containing print HTML.
    
    Parameters:
    
    component - to get printable HTML for.
  - showPrintPreview
```
public static void showPrintPreview(java.lang.Object[] components)
```
    Show a Print containing a printable view of the components passed in.
    
    Parameters:
    
    components - components to get the print HTML for. May also include raw HTML strings which will be folded into the generated print output
  - showPrintPreview
```
public static void showPrintPreview(java.lang.Object[] components,
                                    PrintProperties printProperties,
                                    java.lang.String title,
                                    PrintPreviewCallback callback)
```
    Show a Print containing a printable view of the components passed in.
    
    Parameters:
    
    components - components to get the print HTML for. May also include raw HTML strings which will be folded into the generated print output
    
    printProperties - for customizing the print HTML output. If this parameter is passed as null, it will be ignored.
    
    title - for the print window
    
    callback - to fire when the print preview window has been created and shown
  - showPrintPreview
```
public static void showPrintPreview(java.lang.Object[] components,
                                    PrintProperties printProperties,
                                    java.lang.String title,
                                    PrintPreviewCallback callback,
                                    Window printWindowProperties,
                                    java.lang.String printButtonTitle)
```
    Show a Print containing a printable view of the components passed in.
    
    Parameters:
    
    components - components to get the print HTML for. May also include raw HTML strings which will be folded into the generated print output
    
    printProperties - for customizing the print HTML output. If this parameter is passed as null, it will be ignored.
    
    title - for the print window
    
    callback - to fire when the print preview window has been created and shown
    
    printWindowProperties - the print window properties
    
    printButtonTitle - the brint button title
  - getPrintHTML
```
public static void getPrintHTML(java.lang.Object[] components,
                                PrintProperties printProperties,
                                PrintHTMLCallback callback)
```
    Returns print-formatted HTML for the specified list of components.
    
    Parameters:
    
    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. HTML.
    
    printProperties - for customizing the print HTML output. If this parameter is passed as null, it will be ignored.
    
    callback - to fire when the HTML has been generated
    
    See Also:
    
    getPrintHTML(PrintProperties, PrintHTMLCallback)
  - getPrintHTML
```
public java.lang.String getPrintHTML(PrintProperties printProperties,
                                     PrintHTMLCallback callback)
```
    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 is considered printable. If a callback is provided, then null is always returned and the callback is fired asynchronously.
    If overriding this method for a custom component, you should either return a String of printable HTML directly or return null and fire the provided callback using Class.fireCallback().
    To return an empty print representation, return an empty string ("") rather than null.
    The printProperties argument, if passed, must be passed to any subcomponents on which getPrintHTML() is called.
    Default implementation will set flag to true to indicate printing is in* progress, and clear this flag when the printing has completed (possibly via an asynchronous callback).
    NOTE: Expecting a direct return value from the default implementation is deprecated usage. This is because small changes to an application (such as adding a few more data points to a chart or adding another button) or using certain browsers can make it necessary to generate the HTML asynchronously. Thus, application code should not rely on the return value and always pass a callback.
    NOTE: CubeGrid does not support a WYSIWYG print view by default (also used when exporting to pdf). Instead we recommend exporting to excel or csv format.
    
    Parameters:
    
    printProperties - properties to configure printing behavior - may be null.
    
    callback - optional callback. This is required to handle cases where HTML generation is asynchronous - if a method generates HTML asynchronously, it should return null, and fire the specified callback on completion of HTML generation. The first parameter HTML should contain the generated print HTML. The callback is only called if null is returned. Furthermore, the default getPrintHTML() implementation always returns null and fires the callback when a callback is provided. See Callback.
    
    Returns:
    
    null if the print HTML is being generated asynchronously and/or a callback is provided; otherwise, the direct print HTML for this component (but note that returning direct print HTML is a deprecated feature).
    
    See Also:
    
    Printing overview and related methods
  - printComponents
```
public static void printComponents(java.lang.Object[] components)
```
    Generate printable HTML for the designated components and trigger the native print dialog, without ever showing the printable HTML to the user.
    
    Parameters:
    
    components - components to get the print HTML for. May also include raw HTML strings which will be folded into the generated print output
  - setAutoChildConstructor
```
public void setAutoChildConstructor(java.lang.String autoChildName,
                                    java.lang.String className)
```
    Sets the SmartClient constructor for the AutoChild named autoChildName.
    
    Parameters:
    
    autoChildName - the name of the AutoChild
    
    className - the SmartClient class name to use when constructing the AutoChild.
    
    See Also:
    
    AutoChildUsage
  - setAutoChildProperties
```
public void setAutoChildProperties(java.lang.String autoChildName,
                                   Canvas properties)
                            throws java.lang.IllegalStateException
```
    Sets the properties for creating a Canvas AutoChild named autoChildName.
    properties must not have already been created (properties.isCreated() must be false).
    NOTE: Overrides at override points are not applied to AutoChildren created from properties; that is, if the Java Class of properties overrides a Smart GWT override point, the custom method implementation will not be called.
    
    Throws:
    
    java.lang.IllegalStateException - if properties has been created.
    
    See Also:
    
    AutoChildUsage
  - setAutoChildProperties
```
public void setAutoChildProperties(java.lang.String autoChildName,
                                   FormItem properties)
                            throws java.lang.IllegalStateException
```
    Sets the properties for creating a FormItem AutoChild named autoChildName.
    properties must not have already been created (properties.isCreated() must be false).
    NOTE: Overrides at override points are not applied to AutoChildren created from properties; that is, if the Java Class of properties overrides a Smart GWT override point, the custom method implementation will not be called.
    
    Throws:
    
    java.lang.IllegalStateException - if properties has been created.
    
    See Also:
    
    AutoChildUsage
  - setAutoChildProperties
```
public void setAutoChildProperties(java.lang.String autoChildName,
                                   EditProxy properties)
                            throws java.lang.IllegalStateException
```
    Sets the properties for creating an AutoChild named autoChildName.
    properties must not have already been created (properties.isCreated() must be false).
    
    Throws:
    
    java.lang.IllegalStateException - if properties has been created.
    
    See Also:
    
    AutoChildUsage
  - setAutoChildProperties
```
public void setAutoChildProperties(java.lang.String autoChildName,
                                   EditContext properties)
                            throws java.lang.IllegalStateException
```
    Sets the properties for creating an AutoChild named autoChildName.
    properties must not have already been created (properties.isCreated() must be false).
    
    Throws:
    
    java.lang.IllegalStateException - if properties has been created.
    
    See Also:
    
    AutoChildUsage
  - setAutoChildVisibility
```
public void setAutoChildVisibility(java.lang.String autoChildName,
                                   boolean visible)
```
    Sets whether to create and show the AutoChild named autoChildName.
    NOTE: This API is not valid for all AutoChildren because some AutoChildren cannot be hidden without destroying the main functions of the component.
    
    Parameters:
    
    autoChildName - name of an AutoChild
    
    visible - whether to show the AutoChild
  - getCanvasAutoChild
```
public final Canvas getCanvasAutoChild(java.lang.String autoChildName)
```
    Returns the Canvas AutoChild named autoChildName if already created.
    
    Parameters:
    
    autoChildName - name of an AutoChild to return.
    
    Throws:
    
    java.lang.RuntimeException - if the AutoChild is not a SmartClient Canvas object.
    
    See Also:
    
    AutoChildUsage
  - getFormItemAutoChild
```
public final FormItem getFormItemAutoChild(java.lang.String autoChildName)
```
    Returns the FormItem AutoChild named autoChildName if already created.
    
    Parameters:
    
    autoChildName - name of an AutoChild to return.
    
    Throws:
    
    java.lang.RuntimeException - if the AutoChild is not a SmartClient FormItem object.
    
    See Also:
    
    AutoChildUsage
  - addChild
```
public void addChild(com.google.gwt.user.client.ui.Widget widget)
```
    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.
    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.
    
    Parameters:
    
    newChild - new child canvas to add
  - addChild
```
public Canvas addChild(Canvas newChild,
                       java.lang.String name,
                       boolean autoDraw)
```
    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.
    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.
    
    Parameters:
    
    newChild - new child canvas to add
    
    name - name to assign to child (eg: this[name] == child)
    
    autoDraw - if false, child will not automatically be drawn (only for advanced use)
    
    Returns:
    
    the new child, or null if it couldn't be added
    
    See Also:
    
    Containment overview and related methods
  - setChildren
```
public void setChildren(Canvas... children)
```
    Array of all Canvii that are immediate children of this Canvas.
    Note : This is an advanced setting
    
    Parameters:
    
    children - children Default value is null
  - getOffsetHeight
```
public int getOffsetHeight()
```
    Overrides:
    
    getOffsetHeight in class com.google.gwt.user.client.ui.UIObject
  - getOffsetWidth
```
public int getOffsetWidth()
```
    Overrides:
    
    getOffsetWidth in class com.google.gwt.user.client.ui.UIObject
  - setAutoHeight
```
public void setAutoHeight()
```
    Set the minimum value for height.
    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.
  - setAutoWidth
```
public void setAutoWidth()
```
    Set the minimum value for width.
    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.
  - showClickMask
```
public java.lang.String showClickMask(Function clickActionCallback,
                                      ClickMaskMode mode,
                                      Canvas[] unmaskedTargets)
```
    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.
    
    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).
    
    Parameters:
    
    clickActionCallback - action to fire when the user clicks on the mask
    
    mode - whether to automatically hide the clickMask on mouseDown and suppress the mouseDown event from reaching the target under the mouse
    
    unmaskedTargets - initially unmasked targets for this clickMask. Note that if this is a "hard" 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.
    
    Returns:
    
    clickMask ID
  - visibleAtPoint
```
public java.lang.Boolean visibleAtPoint(int x,
                                        int y,
                                        boolean withinViewport,
                                        Canvas ignoreWidgets,
                                        Canvas upToParent)
```
    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.
    
    Parameters:
    
    x - GLOBAL x-coordinate
    
    y - GLOBAL y-coordinate
    
    withinViewport - point lies within our viewport rather than just our drawn area
    
    ignoreWidgets - If passed ignore widget(s), do not check whether those widgets occludes this one
    
    upToParent - If passed, only check for siblings occluding the component up as far as the specified parent widget
    
    Returns:
    
    true if this object contains the specified point; false otherwise
    
    See Also:
    
    Positioning overview and related methods
  - setAriaState
```
public void setAriaState(java.lang.String stateName,
                         java.lang.Object stateValue)
                  throws java.lang.IllegalStateException
```
    Set a specific ARIA state mapping for this component. Usually this does not need to be manually set. See com.smartgwt.docs.Accessibility.
    
    Parameters:
    
    stateName -
    
    stateValue -
    
    Throws:
    
    java.lang.IllegalStateException - ARIA state cannot be changed after the component has been created.
  - updateEditNode
```
public void updateEditNode(EditContext editContext,
                           EditNode editNode)
```
    A callback invoked for each liveObject by EditContext when the EditContext is being serialized. The liveObject may make any updates needed to the EditNode (or the EditContext as a whole) in order to be able to later recreate the objects.
    Note: This is an override point
    
    Parameters:
    
    editContext - the EditContext
    
    editNode - the EditNode
    
    See Also:
    
    EditContext.serializeAllEditNodes(), EditContext.serializeEditNodes(com.smartgwt.client.tools.EditNode[])
  - setAdaptWidthByCustomizer
```
public void setAdaptWidthByCustomizer(AdaptWidthByCustomizer customizer)
```
    Set customizer that defines adaptWidthBy.
    
    Parameters:
    
    AdaptWidthByCustomizer - customizer
    
    See Also:
    
    AdaptWidthByCustomizer, setCanAdaptWidth(java.lang.Boolean)
  - setAdaptHeightByCustomizer
```
public void setAdaptHeightByCustomizer(AdaptHeightByCustomizer customizer)
```
    Set customizer that defines adaptHeightBy.
    
    Parameters:
    
    AdaptHeightByCustomizer - customizer
    
    See Also:
    
    AdaptHeightByCustomizer, setCanAdaptHeight(java.lang.Boolean)
  - provideRuleContext
```
public void provideRuleContext(java.lang.String dataPath,
                               java.lang.Object data)
```
    Provide data to the com.smartgwt.client.widgets.Canvas#ruleScope component, to be made available in the rule context at the specified path.
    path must be one or more valid identifiers with either dot (.) or slash (/) used as a separator.
    data can be any value, including both atomic values like a Boolean or String, or a nested data structure. Pass data as null to remove data from the context at the specified path
    dbc is the DataBoundComponent to be identified as the owner of the rule context contribution. This component is used to handle any conflicts between multiple components contributing to the same base path (i.e. first segment of path). For any collision an editable display (such as a form or editable grid) wins over a static display (such as a non-editable grid with a selection). Hidden components have lowest priority even if editable. For two editable components the first becomes the owner.
    
    Parameters:
    
    path - path where data should be made available
    
    data - data to contribute to rule context
  - provideRuleContext
```
public void provideRuleContext(java.lang.String dataPath,
                               java.lang.Object data,
                               DataBoundComponent dbc)
```
    Provide data to the com.smartgwt.client.widgets.Canvas#ruleScope component, to be made available in the rule context at the specified path.
    path must be one or more valid identifiers with either dot (.) or slash (/) used as a separator.
    data can be any value, including both atomic values like a Boolean or String, or a nested data structure. Pass data as null to remove data from the context at the specified path
    dbc is the DataBoundComponent to be identified as the owner of the rule context contribution. This component is used to handle any conflicts between multiple components contributing to the same base path (i.e. first segment of path). For any collision an editable display (such as a form or editable grid) wins over a static display (such as a non-editable grid with a selection). Hidden components have lowest priority even if editable. For two editable components the first becomes the owner.
    
    Parameters:
    
    path - path where data should be made available
    
    data - data to contribute to rule context
    
    dbc - the DataBoundComponent contributing to ruleContext
  - revealChild
```
public void revealChild(java.lang.String childID)
```
    Reveals the child Canvas passed in by showing it if it is currently hidden (note, this is stub functionality, certain Canvas subclasses such as TabSet have more useful implementations) NOTE: This is an override point.
    
    Parameters:
    
    childID - the global ID of the child Canvas to reveal
  - revealChild
```
public void revealChild(Canvas child)
```
    Reveals the child Canvas passed in by showing it if it is currently hidden (note, this is stub functionality, certain Canvas subclasses such as TabSet have more useful implementations) NOTE: This is an override point.
    
    Parameters:
    
    child - the child Canvas to reveal
  - setDefaultShowCustomScrollbars
```
public static void setDefaultShowCustomScrollbars(boolean showCS)
```
    Whether to use the browser's native scrollbars or SmartClient-based scrollbars by default for all canvases.
    This method changes the default value of com.smartgwt.client.widgets.Canvas#showCustomScrollbars.
    
    Parameters:
    
    showCS - whether to show custom (SmartGWT-based) scrollbars rather than css-scrollbars by default.
  - setLogicalStructure
```
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.CanvasLogicalStructure s)
```
    Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
  - getLogicalStructure
```
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
```
    Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
    
    Specified by:
    
    getLogicalStructure in interface LogicalStructure
    
    Overrides:
    
    getLogicalStructure in class BaseWidget

Class Canvas

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

Fields inherited from class com.google.gwt.user.client.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

Constructor Detail

Canvas

Canvas

Canvas

Method Detail

getOrCreateRef

getPaletteDefaults

changeAutoChildDefaults

changeAutoChildDefaults

create

setAccessKey

getAccessKey

setAdaptiveHeightPriority

getAdaptiveHeightPriority

setAdaptiveWidthPriority

getAdaptiveWidthPriority

setAlwaysShowScrollbars

getAlwaysShowScrollbars

setAnimateAcceleration

getAnimateAcceleration

setAnimateFadeTime

getAnimateFadeTime

setAnimateHideAcceleration

getAnimateHideAcceleration

setAnimateHideTime

getAnimateHideTime

setAnimateMoveAcceleration

getAnimateMoveAcceleration

setAnimateMoveTime

getAnimateMoveTime

setAnimateRectAcceleration

getAnimateRectAcceleration

setAnimateRectTime

getAnimateRectTime

setAnimateResizeAcceleration

getAnimateResizeAcceleration

setAnimateResizeLayoutMode

getAnimateResizeLayoutMode

setAnimateResizeTime

getAnimateResizeTime

setAnimateScrollAcceleration

getAnimateScrollAcceleration

setAnimateScrollTime

getAnimateScrollTime

setAnimateShowAcceleration

getAnimateShowAcceleration

setAnimateShowTime

getAnimateShowTime

setAnimateTime

getAnimateTime

setAppImgDir

getAppImgDir

setAriaRole

getAriaRole

setAutoMaskComponents

getAutoMaskComponents

setAutoParent

getAutoParent

setAutoShowParent

getAutoShowParent

setBackgroundColor

getBackgroundColor

setBackgroundImage

getBackgroundImage

setBackgroundPosition

getBackgroundPosition

setBackgroundRepeat