Package com.smartgwt.client.widgets

Class Canvas

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:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, 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, RowRangeDisplay, 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

UIObject.DebugIdImpl, 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	Description
Canvas()
Canvas(JavaScriptObject jsObj)
Canvas(String id)

Method Summary

Modifier and Type	Method	Description
void	addChild(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.
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, String name)
Canvas	addChild(Canvas newChild, 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, 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.
HandlerRegistration	addClearHandler(ClearHandler handler)	Add a clear handler.
HandlerRegistration	addClickHandler(ClickHandler handler)	Add a click handler.
HandlerRegistration	addDoubleClickHandler(DoubleClickHandler handler)	Add a doubleClick handler.
HandlerRegistration	addDragMoveHandler(DragMoveHandler handler)	Add a dragMove handler.
HandlerRegistration	addDragRepositionMoveHandler(DragRepositionMoveHandler handler)	Add a dragRepositionMove handler.
HandlerRegistration	addDragRepositionStartHandler(DragRepositionStartHandler handler)	Add a dragRepositionStart handler.
HandlerRegistration	addDragRepositionStopHandler(DragRepositionStopHandler handler)	Add a dragRepositionStop handler.
HandlerRegistration	addDragResizeMoveHandler(DragResizeMoveHandler handler)	Add a dragResizeMove handler.
HandlerRegistration	addDragResizeStartHandler(DragResizeStartHandler handler)	Add a dragResizeStart handler.
HandlerRegistration	addDragResizeStopHandler(DragResizeStopHandler handler)	Add a dragResizeStop handler.
HandlerRegistration	addDragStartHandler(DragStartHandler handler)	Add a dragStart handler.
HandlerRegistration	addDragStopHandler(DragStopHandler handler)	Add a dragStop handler.
HandlerRegistration	addDropHandler(DropHandler handler)	Add a drop handler.
HandlerRegistration	addDropMoveHandler(DropMoveHandler handler)	Add a dropMove handler.
HandlerRegistration	addDropOutHandler(DropOutHandler handler)	Add a dropOut handler.
HandlerRegistration	addDropOverHandler(DropOverHandler handler)	Add a dropOver handler.
HandlerRegistration	addFocusChangedHandler(FocusChangedHandler handler)	Add a focusChanged handler.
HandlerRegistration	addHoverHandler(HoverHandler handler)	Add a hover handler.
HandlerRegistration	addHoverHiddenHandler(HoverHiddenHandler handler)	Add a hoverHidden handler.
HandlerRegistration	addKeyDownHandler(KeyDownHandler handler)	Add a keyDown handler.
HandlerRegistration	addKeyPressHandler(KeyPressHandler handler)	Add a keyPress handler.
HandlerRegistration	addMouseDownHandler(MouseDownHandler handler)	Add a mouseDown handler.
HandlerRegistration	addMouseMoveHandler(MouseMoveHandler handler)	Add a mouseMove handler.
HandlerRegistration	addMouseOutHandler(MouseOutHandler handler)	Add a mouseOut handler.
HandlerRegistration	addMouseOverHandler(MouseOverHandler handler)	Add a mouseOver handler.
HandlerRegistration	addMouseStillDownHandler(MouseStillDownHandler handler)	Add a mouseStillDown handler.
HandlerRegistration	addMouseUpHandler(MouseUpHandler handler)	Add a mouseUp handler.
HandlerRegistration	addMouseWheelHandler(MouseWheelHandler handler)	Add a mouseWheel handler.
HandlerRegistration	addMovedHandler(MovedHandler handler)	Add a moved handler.
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, String name)
Canvas	addPeer(Canvas newPeer, String name, Boolean autoDraw)
Canvas	addPeer(Canvas newPeer, String name, Boolean autoDraw, 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.
HandlerRegistration	addResizedHandler(ResizedHandler handler)	Add a resized handler.
HandlerRegistration	addRightMouseDownHandler(RightMouseDownHandler handler)	Add a rightMouseDown handler.
HandlerRegistration	addRuleContextChangedHandler(RuleContextChangedHandler handler)	Add a ruleContextChanged handler.
HandlerRegistration	addScrolledHandler(ScrolledHandler handler)	Add a scrolled handler.
HandlerRegistration	addShowContextMenuHandler(ShowContextMenuHandler handler)	Add a showContextMenu handler.
void	addSnapAlignCandidate(Canvas newCandidate)	Add a candidate to snapAlignCandidates.
void	addStyleName(String style)	Multiple styles are currently not supported.
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(Integer opacity)	Animate a change in opacity from the widget's current opacity to the specified opacity.
void	animateFade(Integer opacity, AnimationCallback callback)
void	animateFade(Integer opacity, AnimationCallback callback, Integer duration)
void	animateFade(Integer opacity, AnimationCallback callback, 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(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	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	animateMove(Integer left, Integer top)	Animate a reposition of this canvas from its current position to the specified position
void	animateMove(Integer left, Integer top, AnimationCallback callback)
void	animateMove(Integer left, Integer top, AnimationCallback callback, Integer duration)
void	animateMove(Integer left, Integer top, AnimationCallback callback, Integer duration, AnimationAcceleration acceleration)	Animate a reposition of this canvas from its current position to the specified position
void	animateRect(Integer left, Integer top, Integer width, Integer height)	Animate a reposition / resize of this canvas from its current size and position.
void	animateRect(Integer left, Integer top, Integer width, Integer height, AnimationCallback callback)
void	animateRect(Integer left, Integer top, Integer width, Integer height, AnimationCallback callback, Integer duration)
void	animateRect(Integer left, Integer top, Integer width, Integer height, AnimationCallback callback, Integer duration, AnimationAcceleration acceleration)	Animate a reposition / resize of this canvas from its current size and position.
void	animateResize(Integer width, Integer height)	Animate a resize of this canvas from its current size to the specified size
void	animateResize(Integer width, Integer height, AnimationCallback callback)
void	animateResize(Integer width, Integer height, AnimationCallback callback, Integer duration)
void	animateResize(Integer width, Integer height, AnimationCallback callback, Integer duration, AnimationAcceleration acceleration)	Animate a resize of this canvas from its current size to the specified size
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	animateScroll(Integer scrollLeft, Integer scrollTop)	Animate a scroll from the current scroll position to the specified position.
void	animateScroll(Integer scrollLeft, Integer scrollTop, AnimationCallback callback)
void	animateScroll(Integer scrollLeft, Integer scrollTop, AnimationCallback callback, Integer duration)
void	animateScroll(Integer scrollLeft, Integer scrollTop, AnimationCallback callback, Integer duration, AnimationAcceleration acceleration)	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(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.
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.
static <T extends Canvas> T	asSGWTComponent(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(String autoChildName, Canvas defaults)	Changes the defaults for Canvas AutoChildren named autoChildName.
static void	changeAutoChildDefaults(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.
Boolean	clickMaskUp()	Determines whether a clickmask is showing
Boolean	clickMaskUp(String ID)	Determines whether a clickmask is showing
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.
Boolean	contains(Canvas canvas, 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.
Boolean	containsEvent()	Return true if the last event's mouse coordinates are within the bounds of this component.
Boolean	containsEventTarget()	Returns true if the current mouse event target is this component or a descendent of this component.
Boolean	containsFocus()	Returns true if the keyboard focus is in this Canvas or any child of this Canvas.
Boolean	containsPoint(int x, int y)	Return whether or not this object contains the specified global (x,y) coordinates.
Boolean	containsPoint(int x, int y, Boolean withinViewport)	Return whether or not this object contains the specified global (x,y) coordinates.
protected JavaScriptObject	create()
void	dataContextChanged()	Notification method fired when DataContext is bound.
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.
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().
String	getAccessKey()	If specified this governs the HTML accessKey for the widget.
Integer	getAdaptiveHeightPriority()	See adaptiveWidthPriority.
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.
Boolean	getAlwaysManageFocusNavigation()	Should focus navigation for this canvas and its descendents be handled explicitly by intercepting "Tab" key events and calling the TabIndexManager.shiftFocus() API?
Boolean	getAlwaysShowScrollbars()	Should this browser always show custom scrollbars if showCustomScrollbars is true?
AnimationAcceleration	getAnimateAcceleration()	Default acceleration effect to apply to all animations on this Canvas.
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.
Integer	getAnimateHideTime()	Default time for performing an animated hide.
AnimationAcceleration	getAnimateMoveAcceleration()	Default acceleration effect for performing an animated move.
Integer	getAnimateMoveTime()	Default time for performing an animated move.
AnimationAcceleration	getAnimateRectAcceleration()	Default acceleration function for performing an animated move and resize.
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.
Integer	getAnimateResizeTime()	Default time for performing an animated resize.
AnimationAcceleration	getAnimateScrollAcceleration()	Default acceleration function for performing an animated scroll.
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.
Integer	getAnimateShowTime()	Default time for performing an animated show.
int	getAnimateTime()	Default total duration of animations.
String	getAppImgDir()	Default directory for app-specific images, relative to the Page-wide appImgDir.
String	getAriaHandleID()	Returns the DOM ID for the main element for this canvas which will have ARIA role and attributes applied to it.
String	getAriaRole()	ARIA role of this component.
Map	getAriaStateDefaults()	Retrieves dynamically calculated default ARIA state properties for this canvas.
Boolean	getAutoMaskComponents()	Deprecated. As of Smart GWT version 10.0, deprecated in favor of EditProxy.autoMaskChildren
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.
Boolean	getAutoPopulateData()	If a dataContext is provided, should subcomponents automatically bind to the data?
Boolean	getAutoShowParent()	If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
String	getBackgroundColor()	The background color for this widget.
String	getBackgroundImage()	URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
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.
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").
String	getBorderRadius()	The CSS border-radius for this widget.
int	getBottom()	Return the bottom coordinate of this object as rendered, relative to its enclosing context, in pixels.
static Canvas	getById(String ID)	Retrieve a Canvas by its global ID.
static Canvas	getByJSObject(JavaScriptObject jsObj)	Retrieve a Canvas from its JavaScriptObject.
Canvas	getByLocalId(String ID)	Retrieve a child of this Canvas by it's local ID.
Boolean	getCanAcceptDrop()	Indicates that this object can receive dropped widgets (i.e.
Boolean	getCanAdaptHeight()	See canAdaptWidth.
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.
Boolean	getCanDrag()	Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize).
Boolean	getCanDragReposition()	Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
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.
Boolean	getCanDrop()	Indicates that this object can be dropped on top of other widgets.
Boolean	getCanDropBefore()	When explicitly set to false, disallows drop before this member in the Layout.
Boolean	getCanFocus()	Can this widget be allowed to become the target of keyboard events?
Boolean	getCanHover()	Will this Canvas fire hover events when the user hovers over it, or one of its children?
Boolean	getCanSelectText()	Whether native drag selection of contained text is allowed within this Canvas.
final Canvas	getCanvasAutoChild(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.
Boolean	getChildrenResizeSnapAlign()	Flag to disable snapping to alignment when children of this Canvas are resized
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.
Boolean	getChildrenSnapCenterAlign()	See childrenSnapAlign.
Boolean	getChildrenSnapEdgeAlign()	See childrenSnapAlign.
Boolean	getChildrenSnapResizeToGrid()	If true, causes this canvas's children to snap to its grid when resizing.
Boolean	getChildrenSnapToGrid()	If true, causes this canvas's children to snap to its grid when dragging.
Integer	getChildTabPosition(Canvas child)	For a given child widget where updateTabPositionOnReparent is true, return the expected tab position within this parent.
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.
Element	getContentElement()	Returns the DOM element for this Canvas which contains the contents, or for parent components, the DOM elements for any drawn children.
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.
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 css cursor image to display when the mouse pointer is over this component.
DataContext	getDataContext()	A mapping from DataSource IDs to specific Records from those DataSources, that DataBoundComponents contained within this Canvas should automatically bind to if a DataSource is provided but data is not provided (directly or indirectly, for example, indirectly via setting ListGrid.autoFetchData.
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.
String	getDefiningProperty()	This attribute denotes the name of a property to use as a getDefiningPropertyName() for this property when generating and resolving AutoTest locators with search segments.
String	getDefiningPropertyName()	This method returns the name of an attribute for the AutoTest system to use as the definingProperty when generating locators.
String[]	getDefiningPropertyNameOptions()	If no explicit definingProperty was specified for this component, this array denotes a list of options to use as a defining property when generating and resolving AutoTest locators with search segments.
Boolean	getDestroyed()	If this property is set to true, the destroy() method has been called on this canvas.
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.
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.
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 attribute 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 attribute 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.
String	getDragTargetAsString()	A different widget that should be actually dragged when dragging initiates on this widget.
String	getDragType()	Sets a dragType for this widget used, to be compared to dropTypes on possible drop target widgets.
Canvas	getDropTarget()	Delegates a different widget that should actually be dropped on if the cursor is over this widget when the drop completes.
String	getDropTargetAsString()	Delegates a different widget that should actually be dropped on if the cursor is over this widget when the drop completes.
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.
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.
Boolean	getDynamicContents()	Dynamic contents allows the contents string to be treated as a simple but powerful template.
String	getEdgeBackgroundColor()	Background color for the EdgedCanvas created to decorate this component.
String	getEdgeCenterBackgroundColor()	Background color for the center section only.
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?
Integer	getEdgeOffset()	Amount the contained Canvas should be offset.
Integer	getEdgeOpacity()	Opacity of the edges.
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.
String	getEditProxyConstructor()	Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
Element	getElement()	Normal usage of SmartGWT is to call draw() on SmartGWT widgets, not to use use RootPanel.add().
Element	getElement(boolean allowPreRender)
AdvancedCriteria	getEnableWhen()	Criteria to be evaluated to determine whether this Canvas should be enabled.
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.
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.
boolean	getFloatingScrollbars()	If showCustomScrollbars is true, should the scrollbars be drawn floating over the component handle, or should the handle shrink to accommodate them?
final FormItem	getFormItemAutoChild(String autoChildName)	Returns the FormItem AutoChild named autoChildName if already created.
Boolean	getForwardSVGeventsToObject()	If true, events sent to the SVG inside an object tag are forwarded to the object itself by Framework handlers.
String	getFullDataPath()	Returns a fully qualified DataPath for this canvas.
String	getGroupBorderCSS()	Sets the style for the grouping frame around the canvas.
String	getGroupLabelBackgroundColor()	If set, the background color of the grouping label.
String	getGroupLabelStyleName()	Sets the style for the grouping label.
Integer	getGroupPadding()	Padding to apply inside the border when this canvas is showing a group border and label.
String	getGroupTitle()	The title/label for the grouping.
Integer	getHeight()	The canvas.width attribute specifies the size for a component's horizontal dimension; canvas.height specifies the size for the vertical dimension.
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.
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.
String	getHoverAutoFitMaxWidthAsString()	Maximum auto-fit width for a hover if hoverAutoFitWidth is enabled.
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
String	getHoverFocusKey()	For canvases showing a hover, this attribute gives users a way to pin the hover in place so they can interact with it (scroll it, click embedded links, etc).
Integer	getHoverHeight()	If this.showHover is true, this property can be used to customize the height of the hover canvas shown.
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.
Boolean	getHoverMoveWithMouse()	If this.showHover is true, should this widget's hover canvas be moved with the mouse while visible?
Integer	getHoverOpacity()	If this.showHover is true, should the hover canvas be shown with opacity other than 100?
HoverPersistMode	getHoverPersist()	Allows interaction with hovers when the cursor is positioned over them.
String	getHoverScreen()	Screen to create (via createScreen()) in lieu of calling getHoverComponent().
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.
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	getHSnapPosition(int coordinate)	Override this method to provide a custom snap-to grid.
int	getHSnapPosition(int coordinate, String direction)	Override this method to provide a custom snap-to grid.
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().
String	getHtmlElementAsString()	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.
Element	getImage(String identifier)	Retrieve a native image, SVG object element or the container for an SVG symbol or font-icon, by name.
static String	getImgURL(String URL)	Return the full URL for an image to be drawn in this canvas.
static String	getImgURL(String URL, 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 if a non-empty string has been specified for groupTitle.
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()).
Boolean	getIsRuleScope()	Marks this Canvas as the ruleScope that will be discovered by any contained DataBoundComponents which do not specify an explicit ruleScope.
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.
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.
Boolean	getLeaveGroupLabelSpace()	When showing this widget in a group, should any content be shifted down so that the group-label doesn't sit in front of it?
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).
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).
String	getLocalId()	Retrieve the local ID of this canvas.
boolean	getLocateByIDOnly()	If true, when retrieving a locator for this component always return a reference directly to this component by widget ID, using the compact format "///canvasID", ignoring any parent elements and ignoring any configured testRoot.
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.
String	getLocatorName()	Local name for referencing this canvas from an autoTest locator string.
LogicalStructureObject	getLogicalStructure()	Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
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
Boolean	getMatchElement()	If htmlElement is specified, should this canvas be drawn at the same dimensions as the htmlElement? See also matchElementWidth and matchElementHeight
MatchElementSizeMode	getMatchElementHeight()	For canvases with a specified htmlElement where persistentMatchElement is set to true, how should the canvas match the element's height?
MatchElementSizeMode	getMatchElementWidth()	For canvases with a specified htmlElement where persistentMatchElement is set to true, how should the canvas match the element's width?
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.
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.
String	getName()	Optional name for the canvas, which can later be used to reference it.
Boolean	getNativeAutoHideScrollbars()	In some platform/browser configurations, scrollable regions do not show visible scrollbars until the user attempts to interact with the region.
int	getNextZIndex()	get the next zIndex for the next item to be drawn.
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()
Integer	getOpacity()	Renders the widget to be partly transparent.
static Canvas	getOrCreateRef(JavaScriptObject jsObj)
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.
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
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.
String	getPendingMarkerStyle()	CSS class used to apply additional styles to this canvas when showPendingMarker() is called, or when pendingMarkerVisible has been set.
Boolean	getPendingMarkerVisible()	This attribute indicates whether the pending marker class should be appended to the list of CSS classes applied to 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.
Boolean	getPersistentMatchElement()	If this canvas has a specified htmlElement and matchElement is set to true, should the canvas perform a one time resize to fit the target element on draw, or should it continue to match the target element as its size changes due to page reflows?
PointerSettings	getPointerSettings()	Detail settings of the pointer such as where it should be located along the outside of the canvas.
String	getPointerTarget()	This property in conjunction with the pointerSettings.snapTo places the canvas in relation to the target canvas.
String	getPointerTargetAsString()	This property in conjunction with the pointerSettings.snapTo places the canvas in relation to the target canvas.
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.
String	getPrefix()
Boolean	getPrintChildrenAbsolutelyPositioned()	Should this canvas print its children absolutely positioned when generating printable HTML.
String	getPrintHTML(PrintProperties printProperties, PrintHTMLCallback callback)	Retrieves printable HTML for this component and all printable subcomponents.
static void	getPrintHTML(Object[] components, PrintProperties printProperties, PrintHTMLCallback callback)	Returns print-formatted HTML for the specified list of components.
String	getPrintStyleName()	The CSS class to apply when printing this widget.
String	getPrompt()	Prompt displayed in hover canvas if showHover is true.
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.
Boolean	getRedrawOnResize()	Should this element be redrawn in response to a resize?
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.
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).
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).
String	getRuleScope()	ID of the component that gathers the context for evaluation of criteria-based rules specified by properties such as FormItem.visibleWhen, Dynamic Properties, and DynamicCriteria such as ListGrid.initialCriteria.
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.
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.
Integer	getShadowHOffset()	Horizontal offset for the shadow.
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.
Integer	getShadowOffset()	Offset of the shadow.
Integer	getShadowSoftness()	Softness, or degree of blurring, of the shadow.
Integer	getShadowSpread()	Explicit spread for the css-based drop shadow shown if useCSSShadow is true and showShadow is true.
Integer	getShadowVOffset()	Vertical offset for the shadow.
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.
Boolean	getShowDragShadow()	When this widget is dragged, if its dragAppearance is "target", should we show a shadow behind the canvas during the drag.
Boolean	getShowEdges()	Whether an EdgedCanvas should be used to show image-based edges around this component.
Boolean	getShowHover()	If this.canHover is true, should we show the global hover canvas by default when the user hovers over this canvas?
Boolean	getShowHoverComponents()	When set to true, shows a widget hovering at the mouse point instead of the builtin hover label.
Boolean	getShowPointer()	Should a pointer be shown? A pointer can be placed on the border to identify the target of the canvas contents.
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.
Boolean	getShowShadow()	Whether to show a drop shadow for this Canvas.
Boolean	getShowSnapGrid()	Whether to show a snap grid for this Canvas.
boolean	getShrinkElementOnHide()	This is an advanced setting.
Boolean	getSizeMayChangeOnRedraw()	Is it possible that a call to redraw() on this widget will change its size?
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.
String	getSnapAlignCenterLineStyle()	CSS border declaration used for the line shown to indicate snapping to a center line when childrenSnapAlign is set.
String	getSnapAlignEdgeLineStyle()	CSS border declaration used for the line shown to indicate snapping to a edge line when childrenSnapAlign is set.
String	getSnapAxis()	Describes which axes to apply snap-to-grid to.
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.
DrawLine	getSnapGridLineProperties()	Specifies line styling to use when drawing the grid of lines for SnapGridStyle: "lines".
SnapGridStyle	getSnapGridStyle()	Specifies indication style to use for snap points, either a grid of lines or an array of crosses.
String	getSnapHDirection()	The horizontal snap direction.
int	getSnapHGap()	The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
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.
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.
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, 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, String snapTo, Canvas snapper, 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.
Boolean	getSnapResizeToAlign()	Flag to disable snapping to alignment when this Canvas is resized.
Boolean	getSnapResizeToGrid()	Causes this canvas to snap to its parent's grid when resizing.
String	getSnapTo()	Position this widget such that it is aligned with ("snapped to") an edge of its master (if specified), or its parent canvas.
Boolean	getSnapToAlign()	Flag to disable snapping to alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
Boolean	getSnapToCenterAlign()	Flag to disable snapping to center alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
Boolean	getSnapToEdgeAlign()	Flag to disable snapping to edge alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
Boolean	getSnapToGrid()	Causes this canvas to snap to its parent's grid when dragging.
String	getSnapVDirection()	The vertical snap direction.
int	getSnapVGap()	The vertical grid size to use, in pixels, when snap-to-grid is enabled.
Boolean	getStartLine()	Whether this canvas should always start a new line when used as a tile in a FlowLayout.
String	getStyleName()	The CSS class applied to this widget as a whole.
Integer	getTabIndex()	If specified this governs the tabIndex of the widget in the page's tab order.
DataContext	getTestDataContext()	A DataContext to be used if no dataContext is provided (directly or indirectly via a parent).
protected Canvas	getTestInstance()
String	getTitle()	Synonym for getPrompt()
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).
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.
Map	getUISummary(String[] heirarchyExcluded, String[] thisCanvasExcluded)	Returns a summary of this canvas and its child canvii and/or fields that is useful to an AI in understanding the 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()?
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.
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), and native HTML5 drop events occurring over this widget will be processed.
Boolean	getUseOpacityFilter()	Configures where the Opacity filter is used for IE6-8.
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.
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	getVSnapPosition(int coordinate)	Override this method to provide a custom snap-to grid.
int	getVSnapPosition(int coordinate, String direction)	Override this method to provide a custom snap-to grid.
Integer	getWidth()	The canvas.width attribute specifies the size for a component's horizontal dimension; canvas.height specifies the size for the vertical dimension.
String	getWidthAsString()
Process[]	getWorkflows()	List of screen-global workflows that can be shared by event handler workflows using a StartProcessTask.
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(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 String	imgHTML(String src)	Generates the HTML for an image unique to this Canvas.
static String	imgHTML(String src, int width, int height)
static String	imgHTML(String src, int width, int height, String name, String extraStuff, String imgDir)	Generates the HTML for an image unique to this Canvas.
void	initComplete()	Notification method fired after initWidget(), when canvas initialization is complete.
Boolean	intersects(Canvas other)	Returns true if the rectangles of this widget and the specified widget overlap.
Boolean	isDirty()	Returns whether a canvas is waiting to be redrawn.
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.
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.
Boolean	keyUp()	Executed when a key is released on a focusable widget (canFocus: true).
void	layoutChildren(String reason)	layoutChildren() is where a Canvas should implement a sizing policy for it's Canvas children.
String	linkHTML(String href)	Generates the HTML for a standard link (anchor) element.
String	linkHTML(String href, String text)
String	linkHTML(String href, String text, String target)
String	linkHTML(String href, String text, String target, String ID)
String	linkHTML(String href, String text, String target, String ID, Integer tabIndex)
String	linkHTML(String href, String text, String target, String ID, Integer tabIndex, 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(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.
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.
void	print()	Generate and show a PrintWindow containing a PrintCanvas showing a printable view of this component.
void	print(PrintProperties printProperties)
void	print(PrintProperties printProperties, PrintWindow printWindowProperties)
void	print(PrintProperties printProperties, PrintWindow printWindowProperties, String callback)	Generate and show a PrintWindow containing a PrintCanvas showing a printable view of this component.
static void	printComponents(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(String dataPath, 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(String dataPath, 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(String reason)	Redraws the widget immediately with its current property values.
static void	registerFontScaledPaddingStyles(String[] scaledStyles, 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, String name)	Remove a child from this parent.
void	removePeer(Canvas peer)	Remove a peer from this Canvas
void	removePeer(Canvas peer, String name)	Remove a peer from this Canvas
void	removeRuleContext(String path)	Remove data in the rule context at the specified path along with any user-provided schema.
void	removeSnapAlignCandidate(Canvas candidate)	Remove a candidate from snapAlignCandidates.
static void	resizeAutoChildAttributes(String policy, int delta)	Change the value of attributes registered via registerAutoChildSizingAttributes() by some number of pixels.
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	resizeControlsTo(int targetDelta)	Resizes controls as if calling resizeControls(), but takes a final target size instead of a delta representing the change from a current size.
static void	resizeFonts(int sizeChange)	Modify the size of fonts for some or all stylesheets defined in the page.
static void	resizeFonts(int sizeChange, String styleSheets)
static void	resizeFonts(int sizeChange, String styleSheets, Boolean resizeRelatedControls)	Modify the size of fonts for some or all stylesheets defined in the page.
static void	resizeFontsTo(int targetDelta)	Resizes fonts as if calling resizeFonts(), but takes a final target size instead of a delta representing the change from a current size.
static void	resizeIcons(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, String styleSheets)	Modify the amount of padding for some CSS styles defined for the page.
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).
Boolean	resizeTo(String width, 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(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(Integer left)
void	scrollTo(Integer left, 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.
Canvas	setAccessKey(String accessKey)	If specified this governs the HTML accessKey for the widget.
Canvas	setAdaptHeightByCustomizer(AdaptHeightByCustomizer customizer)	Set customizer that defines adaptHeightBy.
Canvas	setAdaptiveHeightPriority(Integer adaptiveHeightPriority)	See adaptiveWidthPriority.
Canvas	setAdaptiveWidthPriority(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.
Canvas	setAdaptWidthByCustomizer(AdaptWidthByCustomizer customizer)	Set customizer that defines adaptWidthBy.
Canvas	setAlign(Alignment align)
static void	setAllowExternalFilters(boolean allExternalFilters)	Changes the system-wide allowExternalFilters setting.
Canvas	setAlwaysManageFocusNavigation(Boolean alwaysManageFocusNavigation)	Should focus navigation for this canvas and its descendents be handled explicitly by intercepting "Tab" key events and calling the TabIndexManager.shiftFocus() API?
Canvas	setAlwaysShowScrollbars(Boolean alwaysShowScrollbars)	Should this browser always show custom scrollbars if showCustomScrollbars is true?
Canvas	setAnimateAcceleration(AnimationAcceleration animateAcceleration)	Default acceleration effect to apply to all animations on this Canvas.
Canvas	setAnimateFadeTime(Integer animateFadeTime)	Default time for performing an animated fade.
Canvas	setAnimateHideAcceleration(AnimationAcceleration animateHideAcceleration)	Default acceleration function for performing an animated hide.
Canvas	setAnimateHideEffect(AnimationEffect animateHideEffect)	Default animation effect to use if animateHide() is called without an explicit effect parameter.
Canvas	setAnimateHideTime(Integer animateHideTime)	Default time for performing an animated hide.
Canvas	setAnimateMoveAcceleration(AnimationAcceleration animateMoveAcceleration)	Default acceleration effect for performing an animated move.
Canvas	setAnimateMoveTime(Integer animateMoveTime)	Default time for performing an animated move.
Canvas	setAnimateRectAcceleration(AnimationAcceleration animateRectAcceleration)	Default acceleration function for performing an animated move and resize.
Canvas	setAnimateRectTime(Integer animateRectTime)	Default time for performing an animated setRect.
Canvas	setAnimateResizeAcceleration(AnimationAcceleration animateResizeAcceleration)	Default acceleration function for performing an animated resize.
Canvas	setAnimateResizeLayoutMode(AnimationLayoutMode animateResizeLayoutMode)	When to update the child layout for a size animation.
Canvas	setAnimateResizeTime(Integer animateResizeTime)	Default time for performing an animated resize.
Canvas	setAnimateScrollAcceleration(AnimationAcceleration animateScrollAcceleration)	Default acceleration function for performing an animated scroll.
Canvas	setAnimateScrollTime(Integer animateScrollTime)	Default time for performing an animated scroll.
Canvas	setAnimateShowAcceleration(AnimationAcceleration animateShowAcceleration)	Default acceleration function for performing an animated show.
Canvas	setAnimateShowEffect(AnimationEffect animateShowEffect)	Default animation effect to use if animateShow() is called without an explicit effect parameter.
Canvas	setAnimateShowTime(Integer animateShowTime)	Default time for performing an animated show.
Canvas	setAnimateTime(int animateTime)	Default total duration of animations.
Canvas	setAppImgDir(String appImgDir)	Default directory for app-specific images, relative to the Page-wide appImgDir.
Canvas	setAriaRole(String ariaRole)	ARIA role of this component.
Canvas	setAriaState(String stateName, Object stateValue)	Set a specific ARIA state mapping for this component.
Canvas	setAutoChildConstructor(String autoChildName, String className)	Sets the SmartClient constructor for the AutoChild named autoChildName.
Canvas	setAutoChildProperties(String autoChildName, EditContext properties)	Sets the properties for creating an AutoChild named autoChildName.
Canvas	setAutoChildProperties(String autoChildName, EditProxy properties)	Sets the properties for creating an AutoChild named autoChildName.
Canvas	setAutoChildProperties(String autoChildName, Canvas properties)	Sets the properties for creating a Canvas AutoChild named autoChildName.
Canvas	setAutoChildProperties(String autoChildName, FormItem properties)	Sets the properties for creating a FormItem AutoChild named autoChildName.
Canvas	setAutoChildVisibility(String autoChildName, boolean visible)	Sets whether to create and show the AutoChild named autoChildName.
Canvas	setAutoHeight()	Set the minimum value for height.
Canvas	setAutoMaskComponents(Boolean autoMaskComponents)	Deprecated. As of Smart GWT version 10.0, deprecated in favor of EditProxy.autoMaskChildren
Canvas	setAutoParent(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.
Canvas	setAutoPopulateData(Boolean autoPopulateData)	If a dataContext is provided, should subcomponents automatically bind to the data?
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?
Canvas	setAutoShowParent(Boolean autoShowParent)	If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
Canvas	setAutoWidth()	Set the minimum value for width.
Canvas	setBackgroundColor(String backgroundColor)	The background color for this widget.
Canvas	setBackgroundImage(String backgroundImage)	URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
Canvas	setBackgroundPosition(String backgroundPosition)	Specifies how the background image should be positioned on the widget.
Canvas	setBackgroundRepeat(BackgroundRepeat backgroundRepeat)	Specifies how the background image should be tiled if this widget is larger than the image.
Canvas	setBorder(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").
Canvas	setBorderRadius(String borderRadius)	The CSS border-radius for this widget.
void	setBottom(int bottom)	Resizes the widget vertically to position its bottom edge at the specified coordinate.
Canvas	setCanAcceptDrop(Boolean canAcceptDrop)	Indicates that this object can receive dropped widgets (i.e.
Canvas	setCanAdaptHeight(Boolean canAdaptHeight)	See canAdaptWidth.
Canvas	setCanAdaptWidth(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.
Canvas	setCanDrag(Boolean canDrag)	Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize).
Canvas	setCanDragReposition(Boolean canDragReposition)	Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
Canvas	setCanDragResize(Boolean canDragResize)	Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
Canvas	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.
Canvas	setCanDrop(Boolean canDrop)	Indicates that this object can be dropped on top of other widgets.
Canvas	setCanDropBefore(Boolean canDropBefore)	When explicitly set to false, disallows drop before this member in the Layout.
Canvas	setCanFocus(Boolean canFocus)	Can this widget be allowed to become the target of keyboard events?
Canvas	setCanHover(Boolean canHover)	Will this Canvas fire hover events when the user hovers over it, or one of its children?
Canvas	setCanSelectText(Boolean canSelectText)	Whether native drag selection of contained text is allowed within this Canvas.
Canvas	setChildren(Canvas... children)	Array of all Canvii that are immediate children of this Canvas.
Canvas	setChildrenResizeSnapAlign(Boolean childrenResizeSnapAlign)	Flag to disable snapping to alignment when children of this Canvas are resized
Canvas	setChildrenSnapAlign(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.
Canvas	setChildrenSnapCenterAlign(Boolean childrenSnapCenterAlign)	See childrenSnapAlign.
Canvas	setChildrenSnapEdgeAlign(Boolean childrenSnapEdgeAlign)	See childrenSnapAlign.
Canvas	setChildrenSnapResizeToGrid(Boolean childrenSnapResizeToGrid)	If true, causes this canvas's children to snap to its grid when resizing.
Canvas	setChildrenSnapToGrid(Boolean childrenSnapToGrid)	If true, causes this canvas's children to snap to its grid when dragging.
Canvas	setComponentMaskDefaults(Canvas componentMaskDefaults)	Defaults for the componentMask autoChild.
Canvas	setContents(String contents)	The contents of a canvas or label widget.
Canvas	setContextMenu(Menu contextMenu)	Context menu to show for this object, an instance of the Menu widget.
Canvas	setCorrectZoomOverflow(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.
Canvas	setCursor(Cursor cursor)	Specifies the css cursor image to display when the mouse pointer is over this component.
Canvas	setDataContext(DataContext dataContext)	A mapping from DataSource IDs to specific Records from those DataSources, that DataBoundComponents contained within this Canvas should automatically bind to if a DataSource is provided but data is not provided (directly or indirectly, for example, indirectly via setting ListGrid.autoFetchData.
Canvas	setDataPath(String dataPath)	A dataPath may be specified on any canvas.
Canvas	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 Canvas	setDefaultShowCustomScrollbars(boolean showCS)	Whether to use the browser's native scrollbars or SmartClient-based scrollbars by default for all canvases.
Canvas	setDefaultWidth(int defaultWidth)	For custom components, establishes a default width for the component.
Canvas	setDefiningProperty(String definingProperty)	This attribute denotes the name of a property to use as a getDefiningPropertyName() for this property when generating and resolving AutoTest locators with search segments.
Canvas	setDefiningPropertyNameOptions(String... definingPropertyNameOptions)	If no explicit definingProperty was specified for this component, this array denotes a list of options to use as a defining property when generating and resolving AutoTest locators with search segments.
Canvas	setDisabled(boolean disabled)	If set to true, the widget will be disabled.
Canvas	setDisabledCursor(Cursor disabledCursor)	Specifies the cursor image to display when the mouse pointer is over this widget if this widget is disabled.
Canvas	setDisableTouchScrollingForDrag(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.
Canvas	setDoubleClickDelay(int doubleClickDelay)	Amount of time (in milliseconds) between which two clicks are considered a single click
Canvas	setDragAppearance(DragAppearance dragAppearance)	Visual appearance to show when the object is being dragged.
Canvas	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.
Canvas	setDragMaskType(DragMaskType dragMaskType)	This property controls what kind of mask is used in case useDragMask is enabled.
Canvas	setDragMaxHeight(int dragMaxHeight)	Sets maximum height that this Canvas can be resized to by a user.
Canvas	setDragMaxWidth(int dragMaxWidth)	Maximum width that this Canvas can be resized to by a user.
Canvas	setDragMinHeight(int dragMinHeight)	Minimum height that this Canvas can be resized to by a user.
Canvas	setDragMinWidth(int dragMinWidth)	Minimum width that this Canvas can be resized to by a user.
Canvas	setDragOpacity(Integer dragOpacity)	If this widget has dragAppearance "target", this value specifies the opacity to render the target while it is being dragged.
Canvas	setDragRepositionAppearance(DragAppearance dragRepositionAppearance)	If canDragReposition is true, this attribute specifies the visual appearance to show during drag reposition.
Canvas	setDragRepositionCursor(Cursor dragRepositionCursor)	Cursor to switch to if the mouse is over a widget that is drag repositionable.
Canvas	setDragResizeAppearance(DragAppearance dragResizeAppearance)	If canDragResize is true, this attribute specifies the visual appearance to show during drag resize.
Canvas	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.
Canvas	setDragStartDistance(int dragStartDistance)	Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
Canvas	setDragTarget(Canvas dragTarget)	A different widget that should be actually dragged when dragging initiates on this widget.
Canvas	setDragTarget(String dragTarget)	A different widget that should be actually dragged when dragging initiates on this widget.
Canvas	setDragType(String dragType)	Sets a dragType for this widget used, to be compared to dropTypes on possible drop target widgets.
Canvas	setDropTarget(Canvas dropTarget)	Delegates a different widget that should actually be dropped on if the cursor is over this widget when the drop completes.
Canvas	setDropTarget(String dropTarget)	Delegates a different widget that should actually be dropped on if the cursor is over this widget when the drop completes.
Canvas	setDropTypes(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.
Canvas	setDropTypes(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.
Canvas	setDynamicContents(Boolean dynamicContents)	Dynamic contents allows the contents string to be treated as a simple but powerful template.
Canvas	setEdgeBackgroundColor(String edgeBackgroundColor)	Background color for the EdgedCanvas created to decorate this component.
Canvas	setEdgeCenterBackgroundColor(String edgeCenterBackgroundColor)	Background color for the center section only.
Canvas	setEdgeImage(String edgeImage)	Base name of images for edges.
Canvas	setEdgeMarginSize(int edgeMarginSize)	How far into the edge of an object do we consider the "edge" for drag resize purposes?
Canvas	setEdgeOffset(Integer edgeOffset)	Amount the contained Canvas should be offset.
Canvas	setEdgeOpacity(Integer edgeOpacity)	Opacity of the edges.
Canvas	setEdgeShowCenter(Boolean edgeShowCenter)	Whether to show media in the center section, that is, behind the decorated Canvas.
Canvas	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.
Canvas	setEditProxyConstructor(String editProxyConstructor)	Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
protected void	setElement(Element elem)	Normal usage of SmartGWT is to call draw() on SmartGWT widgets, not to use use RootPanel.add().
Canvas	setEnableWhen(AdvancedCriteria enableWhen)	Criteria to be evaluated to determine whether this Canvas should be enabled.
Canvas	setEndLine(Boolean endLine)	Whether this canvas should end the line it's in when used as a tile in a FlowLayout.
Canvas	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.
Canvas	setFacetId(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.
Canvas	setFloatingScrollbars(boolean floatingScrollbars)	If showCustomScrollbars is true, should the scrollbars be drawn floating over the component handle, or should the handle shrink to accommodate them?
Canvas	setForwardSVGeventsToObject(Boolean forwardSVGeventsToObject)	If true, events sent to the SVG inside an object tag are forwarded to the object itself by Framework handlers.
Canvas	setGroupBorderCSS(String groupBorderCSS)	Sets the style for the grouping frame around the canvas.
Canvas	setGroupLabelBackgroundColor(String groupLabelBackgroundColor)	If set, the background color of the grouping label.
Canvas	setGroupLabelStyleName(String groupLabelStyleName)	Sets the style for the grouping label.
Canvas	setGroupPadding(Integer groupPadding)	Padding to apply inside the border when this canvas is showing a group border and label.
Canvas	setGroupTitle(String groupTitle)	The title/label for the grouping.
Canvas	setHeight(int height)
Canvas	setHeight(Integer height)	The canvas.width attribute specifies the size for a component's horizontal dimension; canvas.height specifies the size for the vertical dimension.
void	setHeight(String height)	The canvas.width attribute specifies the size for a component's horizontal dimension; canvas.height specifies the size for the vertical dimension.
Canvas	setHeight100()	Convenience method that sets the height to 100%.
Canvas	setHideUsingDisplayNone(boolean hideUsingDisplayNone)	When this widget is hidden (see visibility and hide()), should display:none be applied to the outer element?
Canvas	setHoverAlign(Alignment hoverAlign)	If this.showHover is true, this property can be used to customize the alignment of content in the hover canvas.
Canvas	setHoverAutoDestroy(Boolean hoverAutoDestroy)	If this.showHover is true and getHoverComponent() is implemented, should the hoverCanvas returned from it be automatically destroyed when it is hidden?
Canvas	setHoverAutoFitMaxWidth(int hoverAutoFitMaxWidth)	Maximum auto-fit width for a hover if hoverAutoFitWidth is enabled.
Canvas	setHoverAutoFitMaxWidth(String hoverAutoFitMaxWidth)	Maximum auto-fit width for a hover if hoverAutoFitWidth is enabled.
Canvas	setHoverAutoFitWidth(Boolean hoverAutoFitWidth)	if showHover is true, this property will cause the specified hoverWidth to be treated as a minimum width for the hover.
Canvas	setHoverDelay(int hoverDelay)	If this.canHover is true, how long should the mouse be kept over this widget before the hover event is fired
Canvas	setHoverFocusKey(String hoverFocusKey)	For canvases showing a hover, this attribute gives users a way to pin the hover in place so they can interact with it (scroll it, click embedded links, etc).
Canvas	setHoverHeight(Integer hoverHeight)	If this.showHover is true, this property can be used to customize the height of the hover canvas shown.
Canvas	setHoverMoveWithMouse(Boolean hoverMoveWithMouse)	If this.showHover is true, should this widget's hover canvas be moved with the mouse while visible?
Canvas	setHoverOpacity(Integer hoverOpacity)	If this.showHover is true, should the hover canvas be shown with opacity other than 100?
Canvas	setHoverPersist(HoverPersistMode hoverPersist)	Allows interaction with hovers when the cursor is positioned over them.
Canvas	setHoverScreen(String hoverScreen)	Screen to create (via createScreen()) in lieu of calling getHoverComponent().
Canvas	setHoverStyle(String hoverStyle)	If this.showHover is true, this property can be used to specify the css style to apply to the hover canvas.
Canvas	setHoverVAlign(VerticalAlignment hoverVAlign)	If this.showHover is true, this property can be used to customize the vertical alignment of content in the hover canvas.
Canvas	setHoverWidth(int hoverWidth)	If this.showHover is true, this property can be used to customize the width of the hover canvas shown.
Canvas	setHoverWrap(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.
Canvas	setHtmlElement(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().
Canvas	setHtmlElement(String htmlElement)	If specified as a pointer to an HTML element present in the DOM, this canvas will be rendered inside that element on draw().
Canvas	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(String identifier, String URL)	Set the URL of an image or SVG object element by name.
void	setImage(String identifier, String URL, 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.
Canvas	setIsGroup(boolean isGroup)	Should a grouping frame be shown around this canvas if a non-empty string has been specified for groupTitle.
Canvas	setIsRuleScope(Boolean isRuleScope)	Marks this Canvas as the ruleScope that will be discovered by any contained DataBoundComponents which do not specify an explicit ruleScope.
Canvas	setIsSnapAlignCandidate(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.
Canvas	setKeepInParentRect(Rectangle rectangle)
Canvas	setKeepInParentRect(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).
Canvas	setKeepInParentRect(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).
Canvas	setLayoutAlign(Alignment layoutAlign)	When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout.
Canvas	setLayoutAlign(VerticalAlignment layoutAlign)	When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout.
Canvas	setLeaveGroupLabelSpace(Boolean leaveGroupLabelSpace)	When showing this widget in a group, should any content be shifted down so that the group-label doesn't sit in front of it?
Canvas	setLeavePageSpace(Integer leavePageSpace)	If set, overrides the global defaultPageSpace.
Canvas	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).
Canvas	setLeft(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).
Canvas	setLocateByIDOnly(boolean locateByIDOnly)	If true, when retrieving a locator for this component always return a reference directly to this component by widget ID, using the compact format "///canvasID", ignoring any parent elements and ignoring any configured testRoot.
Canvas	setLocateChildrenBy(LocatorStrategy locateChildrenBy)	Strategy to use when locating children in this canvas from an autoTest locator string.
Canvas	setLocateChildrenType(LocatorTypeStrategy locateChildrenType)	LocatorTypeStrategy to use when finding children within this canvas.
Canvas	setLocatePeersBy(LocatorStrategy locatePeersBy)	Strategy to use when locating peers of this canvas from an autoTest locator string.
Canvas	setLocatePeersType(LocatorTypeStrategy locatePeersType)	LocatorTypeStrategy to use when finding peers of this canvas.
Canvas	setLocatorName(String locatorName)	Local name for referencing this canvas from an autoTest locator string.
boolean	setLocatorParent(Canvas locatorParent, String childName)	This method will set mark the target canvas as the "locator parent" for this canvas, using the specified child name.
boolean	setLocatorParent(Canvas locatorParent, String childName, String attributeName)	This method will set mark the target canvas as the "locator parent" for this canvas, using the specified child name.
LogicalStructureObject	setLogicalStructure(CanvasLogicalStructure s)	Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
Canvas	setMargin(Integer margin)	Set the CSS Margin, in pixels, for this component.
Canvas	setMatchElement(Boolean matchElement)	If htmlElement is specified, should this canvas be drawn at the same dimensions as the htmlElement? See also matchElementWidth and matchElementHeight
Canvas	setMatchElementHeight(MatchElementSizeMode matchElementHeight)	For canvases with a specified htmlElement where persistentMatchElement is set to true, how should the canvas match the element's height?
Canvas	setMatchElementWidth(MatchElementSizeMode matchElementWidth)	For canvases with a specified htmlElement where persistentMatchElement is set to true, how should the canvas match the element's width?
Canvas	setMaxHeight(int maxHeight)	Maximum height available to this Canvas.
Canvas	setMaxWidth(int maxWidth)	Maximum width available to this Canvas.
Canvas	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.
Canvas	setMenuConstructor(String menuConstructor)	Default class used to construct menus created by this component, including context menus.
Canvas	setMinHeight(int minHeight)	Minimum height available to this Canvas.
Canvas	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).
Canvas	setMinWidth(int minWidth)	Minimum width available to this Canvas.
Canvas	setMomentumScrollMinSpeed(double momentumScrollMinSpeed)	The minimum speed in pixels per second that must be reached for momentum scrolling to kick in.
Canvas	setMouseStillDownDelay(int mouseStillDownDelay)	Amount of time (in milliseconds) between repeated 'mouseStillDown' events for this canvas.
Canvas	setMouseStillDownInitialDelay(int mouseStillDownInitialDelay)	Amount of time (in milliseconds) before mouseStillDown events start to be fired repeatedly for this canvas.
Canvas	setName(String name)	Optional name for the canvas, which can later be used to reference it.
Canvas	setNativeAutoHideScrollbars(Boolean nativeAutoHideScrollbars)	In some platform/browser configurations, scrollable regions do not show visible scrollbars until the user attempts to interact with the region.
static void	setNeverUseFilters(boolean neverUseFilters)	Changes the system-wide neverUseFilters setting.
Canvas	setNoDoubleClicks(Boolean noDoubleClicks)	If true, this canvas will receive all mouse-clicks as single click events rather than as doubleClick events.
Canvas	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.
Canvas	setOpacity(Integer opacity)	Renders the widget to be partly transparent.
Canvas	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.
Canvas	setPadding(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".
Canvas	setParentCanvas(Canvas parentCanvas)	This Canvas's immediate parent, if any.
Canvas	setParentElement(Canvas parentElement)	Deprecated. As of Smartclient version 9.1, deprecated in favor of parentCanvas and getParentCanvas()
Canvas	setPeers(Canvas... peers)	Array of all Canvii that are peers of this Canvas.
Canvas	setPendingMarkerStyle(String pendingMarkerStyle)	CSS class used to apply additional styles to this canvas when showPendingMarker() is called, or when pendingMarkerVisible has been set.
Canvas	setPendingMarkerVisible(Boolean pendingMarkerVisible)	This attribute indicates whether the pending marker class should be appended to the list of CSS classes applied to this canvas.
Canvas	setPercentBox(PercentBoxModel percentBox)	Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a specified snapTo.
Canvas	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.
Canvas	setPersistentMatchElement(Boolean persistentMatchElement)	If this canvas has a specified htmlElement and matchElement is set to true, should the canvas perform a one time resize to fit the target element on draw, or should it continue to match the target element as its size changes due to page reflows?
Canvas	setPointerSettings(PointerSettings pointerSettings)	Detail settings of the pointer such as where it should be located along the outside of the canvas.
Canvas	setPointerTarget(String pointerTarget)	This property in conjunction with the pointerSettings.snapTo places the canvas in relation to the target canvas.
Canvas	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.
Canvas	setPrefix(String prefix)
Canvas	setPrintChildrenAbsolutelyPositioned(Boolean printChildrenAbsolutelyPositioned)	Should this canvas print its children absolutely positioned when generating printable HTML.
Canvas	setPrintStyleName(String printStyleName)	The CSS class to apply when printing this widget.
Canvas	setPrompt(String prompt)	Prompt displayed in hover canvas if showHover is true.
Canvas	setProportionalResizeModifiers(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.
Canvas	setProportionalResizing(ProportionalResizeMode proportionalResizing)	If canDragResize is true, this property specifies the conditions for when proportional resizing is used.
Canvas	setReceiveScrollbarEvents(boolean receiveScrollbarEvents)	Whether this canvas should receive events from its scrollbars, which are peers.
Canvas	setRect(int left, int top, int width, int height)	Set all four coordinates, relative to the enclosing context, at once.
Canvas	setRect(Rectangle rectangle)	Set all four coordinates, relative to the enclosing context, at once.
Canvas	setRedrawOnResize(Boolean redrawOnResize)	Should this element be redrawn in response to a resize?
void	setRelativeTabPosition(Integer position)	Assign a relative tab position for this canvas.
Canvas	setResizeBarTarget(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.
Canvas	setResizeFrom(EdgeName... resizeFrom)	When drag resizing is enabled via canDragResize, restricts resizes to only certain edges or corners.
Canvas	setResizeFrom(String... resizeFrom)	Deprecated. use #setResizeFrom(EdgeName) instead.
void	setRight(int right)	Resizes the widget horizontally to position its right side at the specified coordinate.
Canvas	setRuleScope(String ruleScope)	ID of the component that gathers the context for evaluation of criteria-based rules specified by properties such as FormItem.visibleWhen, Dynamic Properties, and DynamicCriteria such as ListGrid.initialCriteria.
Canvas	setScrollbarConstructor(String scrollbarConstructor)	The class that will be used to create custom scrollbars for this component.
Canvas	setScrollbarSize(int scrollbarSize)	How thick should we make the scrollbars for this canvas.
Canvas	setShadowColor(String shadowColor)	Color for the css-based drop shadow shown if useCSSShadow is true and showShadow is true.
Canvas	setShadowDepth(int shadowDepth)	Depth of the shadow, or the virtual height above the page of the widget throwing the shadow.
Canvas	setShadowHOffset(Integer shadowHOffset)	Horizontal offset for the shadow.
Canvas	setShadowImage(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.
Canvas	setShadowOffset(Integer shadowOffset)	Offset of the shadow.
Canvas	setShadowSoftness(Integer shadowSoftness)	Softness, or degree of blurring, of the shadow.
Canvas	setShadowSpread(Integer shadowSpread)	Explicit spread for the css-based drop shadow shown if useCSSShadow is true and showShadow is true.
Canvas	setShadowVOffset(Integer shadowVOffset)	Vertical offset for the shadow.
Canvas	setShouldPrint(Boolean shouldPrint)	Whether this canvas should be included in a printable view.
Canvas	setShowCustomScrollbars(boolean showCustomScrollbars)	Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
Canvas	setShowDragShadow(Boolean showDragShadow)	When this widget is dragged, if its dragAppearance is "target", should we show a shadow behind the canvas during the drag.
Canvas	setShowEdges(Boolean showEdges)	Whether an EdgedCanvas should be used to show image-based edges around this component.
Canvas	setShowHover(Boolean showHover)	If this.canHover is true, should we show the global hover canvas by default when the user hovers over this canvas?
Canvas	setShowHoverComponents(Boolean showHoverComponents)	When set to true, shows a widget hovering at the mouse point instead of the builtin hover label.
Canvas	setShowPointer(Boolean showPointer)	Should a pointer be shown? A pointer can be placed on the border to identify the target of the canvas contents.
Canvas	setShowResizeBar(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.
Canvas	setShowShadow(Boolean showShadow)	Whether to show a drop shadow for this Canvas.
Canvas	setShowSnapGrid(Boolean showSnapGrid)	Whether to show a snap grid for this Canvas.
Canvas	setShrinkElementOnHide(boolean shrinkElementOnHide)	This is an advanced setting.
Canvas	setSizeMayChangeOnRedraw(Boolean sizeMayChangeOnRedraw)	Is it possible that a call to redraw() on this widget will change its size?
Canvas	setSkinImgDir(String skinImgDir)	Default directory for skin images (those defined by the class), relative to the Page-wide skinDir.
Canvas	setSmoothFade(Boolean smoothFade)
Canvas	setSnapAlignCandidates(Canvas... snapAlignCandidates)	When childrenSnapAlign is enabled, list of candidates to check for alignment.
Canvas	setSnapAlignCenterLineStyle(String snapAlignCenterLineStyle)	CSS border declaration used for the line shown to indicate snapping to a center line when childrenSnapAlign is set.
Canvas	setSnapAlignEdgeLineStyle(String snapAlignEdgeLineStyle)	CSS border declaration used for the line shown to indicate snapping to a edge line when childrenSnapAlign is set.
Canvas	setSnapAxis(String snapAxis)	Describes which axes to apply snap-to-grid to.
Canvas	setSnapEdge(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.
Canvas	setSnapGridLineProperties(DrawLine snapGridLineProperties)	Specifies line styling to use when drawing the grid of lines for SnapGridStyle: "lines".
Canvas	setSnapGridStyle(SnapGridStyle snapGridStyle)	Specifies indication style to use for snap points, either a grid of lines or an array of crosses.
Canvas	setSnapHDirection(String snapHDirection)	The horizontal snap direction.
Canvas	setSnapHGap(int snapHGap)	The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
Canvas	setSnapOffsetLeft(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.
Canvas	setSnapOffsetTop(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.
Canvas	setSnapOnDrop(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).
Canvas	setSnapResizeToAlign(Boolean snapResizeToAlign)	Flag to disable snapping to alignment when this Canvas is resized.
Canvas	setSnapResizeToGrid(Boolean snapResizeToGrid)	Causes this canvas to snap to its parent's grid when resizing.
Canvas	setSnapTo(String snapTo)	Position this widget such that it is aligned with ("snapped to") an edge of its master (if specified), or its parent canvas.
Canvas	setSnapToAlign(Boolean snapToAlign)	Flag to disable snapping to alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
Canvas	setSnapToCenterAlign(Boolean snapToCenterAlign)	Flag to disable snapping to center alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
Canvas	setSnapToEdgeAlign(Boolean snapToEdgeAlign)	Flag to disable snapping to edge alignment when this Canvas is dragged when childrenSnapAlign is enabled on this Canvas' parent.
Canvas	setSnapToGrid(Boolean snapToGrid)	Causes this canvas to snap to its parent's grid when dragging.
Canvas	setSnapVDirection(String snapVDirection)	The vertical snap direction.
Canvas	setSnapVGap(int snapVGap)	The vertical grid size to use, in pixels, when snap-to-grid is enabled.
Canvas	setStartLine(Boolean startLine)	Whether this canvas should always start a new line when used as a tile in a FlowLayout.
void	setStyleName(String styleName)	The CSS class applied to this widget as a whole.
Canvas	setTabIndex(Integer tabIndex)	If specified this governs the tabIndex of the widget in the page's tab order.
Canvas	setTestDataContext(DataContext testDataContext)	A DataContext to be used if no dataContext is provided (directly or indirectly via a parent).
void	setTitle(String title)	Synonym for setPrompt(String)
Canvas	setTooltip(String tooltip)	Synonym for setPrompt(String)
Canvas	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).
Canvas	setTop(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).
Canvas	setUpdateTabPositionOnDraw(boolean updateTabPositionOnDraw)	Should canvases with no parent canvas be moved to the end of the TabIndexManager tree on draw()?
Canvas	setUpdateTabPositionOnReparent(boolean updateTabPositionOnReparent)	Should canvases with a parent canvas be added to the TabIndexManager under the parent as described in updateChildTabPositions() and updateChildTabPosition()?
Canvas	setUseBackMask(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.
Canvas	setUseCSSShadow(boolean useCSSShadow)	If showShadow is true, should we use the css box-shadow property (where supported) to achieve the shadow?
Canvas	setUseDragMask(boolean useDragMask)	This flag controls whether we register the component as a maskable item with the EventHandler.
Canvas	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.
Canvas	setUseNativeDrag(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), and native HTML5 drop events occurring over this widget will be processed.
Canvas	setUseOpacityFilter(Boolean useOpacityFilter)	Configures where the Opacity filter is used for IE6-8.
Canvas	setUseTouchScrolling(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.
Canvas	setValuesManager(ValuesManager valuesManager)	ValuesManager for managing values displayed in this component.
Canvas	setValuesManager(String valuesManager)	ValuesManager for managing values displayed in this component.
Canvas	setVisibility(Visibility visibility)	Controls widget visibility when the widget is initialized.
void	setVisible(boolean visible)
Canvas	setVisibleWhen(AdvancedCriteria visibleWhen)	Criteria to be evaluated to determine whether this Canvas should be visible.
Canvas	setWidth(int width)
Canvas	setWidth(Integer width)	The canvas.width attribute specifies the size for a component's horizontal dimension; canvas.height specifies the size for the vertical dimension.
void	setWidth(String width)	The canvas.width attribute specifies the size for a component's horizontal dimension; canvas.height specifies the size for the vertical dimension.
Canvas	setWidth100()	Convenience method that sets the width to 100%.
Canvas	setWorkflows(Process... workflows)	List of screen-global workflows that can be shared by event handler workflows using a StartProcessTask.
Canvas	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.
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, String side)
void	showNextTo(Canvas otherWidget, String side, boolean canOcclude)
void	showNextTo(Canvas otherWidget, 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.
void	showPendingMarker()	Manually move this component into the "pending changes" visual state (based on the pendingMarker style, or the Pending suffix in stateful components).
static void	showPrintPreview(Canvas component)	Show a PrintWindow containing a printable view of the component passed in containing print HTML.
static void	showPrintPreview(Object[] components)	Show a Print containing a printable view of the components passed in.
static void	showPrintPreview(Object[] components, PrintProperties printProperties, String title, PrintPreviewCallback callback)	Show a Print containing a printable view of the components passed in.
static void	showPrintPreview(Object[] components, PrintProperties printProperties, String title, PrintPreviewCallback callback, Window printWindowProperties, 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.
static void	startDebuggingOverflow(DebugOverflowSettings settings)	Start to track and report excessive overflow per the supplied settings.
static void	stopDebuggingOverflow()	Stop tracking and reporting excessive overflow.
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 HTML contents of the hover.
void	updateHover(String hoverHTML)	If this canvas is currently showing a hover (see handleHover()), this method can be called to update the HTML contents of the hover.
void	updateShadow()	Update the canvas shadow.
void	updateTabPositionForDraw()	This method is executed on draw.
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.
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, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, 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 Details

Canvas

public Canvas()

Canvas

public Canvas(JavaScriptObject jsObj)

Canvas

public Canvas(String id)

Method Details

getOrCreateRef

public static Canvas getOrCreateRef(JavaScriptObject jsObj)

getPaletteDefaults

public 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(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(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 JavaScriptObject create()

Overrides:

create in class BaseWidget

setAccessKey

public Canvas setAccessKey(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Focus

getAccessKey

public 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

setAdaptiveHeightPriority

public Canvas setAdaptiveHeightPriority(Integer adaptiveHeightPriority)
                                 throws IllegalStateException

See adaptiveWidthPriority.

Parameters:

adaptiveHeightPriority - New adaptiveHeightPriority value. Default value is null

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getAdaptiveHeightPriority

public Integer getAdaptiveHeightPriority()

See adaptiveWidthPriority.

Returns:

Current adaptiveHeightPriority value. Default value is null

setAdaptiveWidthPriority

public Canvas setAdaptiveWidthPriority(Integer adaptiveWidthPriority)
                                throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• setCanAdaptWidth(java.lang.Boolean)

getAdaptiveWidthPriority

public 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()

setAlwaysManageFocusNavigation

public Canvas setAlwaysManageFocusNavigation(Boolean alwaysManageFocusNavigation)
                                      throws IllegalStateException

Should focus navigation for this canvas and its descendents be handled explicitly by intercepting "Tab" key events and calling the TabIndexManager.shiftFocus() API?

Setting this property to true will cause the registered TabIndexManager entry for this canvas to be marked as useExplicitFocusNavigation:true, and will cause standard event handling for the canvas and its descendents to intercept Tab keystrokes and explicitly call TabIndexManager.shiftFocus() rather than relying on native browser Tab navigation

Parameters:

alwaysManageFocusNavigation - New alwaysManageFocusNavigation value. Default value is null

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getAlwaysManageFocusNavigation

public Boolean getAlwaysManageFocusNavigation()

Should focus navigation for this canvas and its descendents be handled explicitly by intercepting "Tab" key events and calling the TabIndexManager.shiftFocus() API?

Setting this property to true will cause the registered TabIndexManager entry for this canvas to be marked as useExplicitFocusNavigation:true, and will cause standard event handling for the canvas and its descendents to intercept Tab keystrokes and explicitly call TabIndexManager.shiftFocus() rather than relying on native browser Tab navigation

Returns:

Current alwaysManageFocusNavigation value. Default value is null

setAlwaysShowScrollbars

public Canvas setAlwaysShowScrollbars(Boolean alwaysShowScrollbars)
                               throws IllegalStateException

Should this browser always show custom scrollbars if showCustomScrollbars is true?

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.

For non-touch devices, setting this property to true will override nativeAutoHideScrollbars, and ensure custom scrollbars are shown for the component

Note : This is an advanced setting

Parameters:

alwaysShowScrollbars - New alwaysShowScrollbars value. Default value is null

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Scrolling overview and related methods

getAlwaysShowScrollbars

public Boolean getAlwaysShowScrollbars()

Should this browser always show custom scrollbars if showCustomScrollbars is true?

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.

For non-touch devices, setting this property to true will override nativeAutoHideScrollbars, and ensure custom scrollbars are shown for the component

Returns:

Current alwaysShowScrollbars value. Default value is null

See Also:

• Scrolling overview and related methods

setAnimateAcceleration

public Canvas 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"

Returns:

Canvas instance, for chaining setter calls

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 Canvas setAnimateFadeTime(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

Returns:

Canvas instance, for chaining setter calls

getAnimateFadeTime

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setAnimateHideTime(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

Returns:

Canvas instance, for chaining setter calls

getAnimateHideTime

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setAnimateMoveTime(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

Returns:

Canvas instance, for chaining setter calls

getAnimateMoveTime

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setAnimateRectTime(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

Returns:

Canvas instance, for chaining setter calls

getAnimateRectTime

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas 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"

Returns:

Canvas instance, for chaining setter calls

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 Canvas setAnimateResizeTime(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

Returns:

Canvas instance, for chaining setter calls

getAnimateResizeTime

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setAnimateScrollTime(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

Returns:

Canvas instance, for chaining setter calls

getAnimateScrollTime

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setAnimateShowTime(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

Returns:

Canvas instance, for chaining setter calls

getAnimateShowTime

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setAppImgDir(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 ""

Returns:

Canvas instance, for chaining setter calls

See Also:

• URL
• Images overview and related methods

getAppImgDir

public 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 Canvas setAriaRole(String ariaRole)
                   throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Accessibility / Section 508 compliance

getAriaRole

public 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 / Section 508 compliance

setAutoMaskComponents

public Canvas setAutoMaskComponents(Boolean autoMaskComponents)
                             throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getAutoMaskComponents

public 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 Canvas setAutoParent(String autoParent)
                     throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getAutoParent

public 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

setAutoPopulateData

public Canvas setAutoPopulateData(Boolean autoPopulateData)
                           throws IllegalStateException

If a dataContext is provided, should subcomponents automatically bind to the data?

In general, if you provide a primaryKey value for a record, that specific record will be shown or edited, or have its related records loaded. If you provide other field values without the primaryKey value, those values will be treated as either criteria (for a grid) or as initial values (for a form).

Components will respond to dataContext differently depending on whether they typically work with just a single record (such as form or a DetailViewer), or whether they usually work with lists of records (such as ListGrid or TileGrid, which have component.dataArity set to multipe by default).

Specifically, the following rules are used:

1. for a singular component (eg forms, detailViewers):
   • if only the PK (primary key) value is provided, the component will fetch the singular record and display or edit it
   • if the PK is provided along with other values, the component will assume it has a complete record, and display or edit it
   • if only non-PK values are provided, the component will assume these are initial values
2. for a multiple component (eg listGrid, tileGrid):
   • if only non-PK values are provided, the component will use these as criteria. For example, a grid bound to an Orders DataSource with dataContext of Status:"In Process" would fetch records with that status
   • if the PK is provided, and the component's DataSource is related to one of the DataSources in the dataContext, related records will be fetched, using the PK value (similarly to if fetchRelatedData() had been called. For example, if an orderNumber value was provided, a grid bound to OrderDetail would fetch line items for that orderNumber.
   • if an array of multiple records is provided, that data is used as if setData() had been called on the component

If any of these behaviors is not desired, you can just set autoPopulateData to false on the specific component that should not be auto-populated.

Specific examples, using the Order and OrderDetail sample DataSources, where OrderDetail records are associated (many-to-1) with Order records, and the PK of Order is orderNumber:

1. a form or DetailViewer bound to Order and a ListGrid bound to OrderDetail:
   • if an orderNumber is provided, the form or DetailViewer would show that order, and the grid would show related OrderDetail records
   • if only orderNumber is provided (no additional fields), the full Order record is automatically fetched for the form or DetailViewer

   This fulfills a common use case of viewing or editing an Order and its related OrderDetail records.

2. a grid bound to Order and a second grid bound to OrderDetail
   • if values such as orderStatus : "On Hold" were provided, the Order grid uses those as criteria
   • the OrderDetail grid does nothing

   This fulfills a common use case of viewing Order records that match certain criteria. The OrderDetail grid would generally be populated only by an event handler installed on the Order grid, which would call fetchRelatedData.

3. a grid and form both bound to Order
   • if values such as orderStatus : "On Hold" were provided, the Order grid uses those as criteria, and the form uses those as initial values

   This fulfills two possible use cases:

   • the form is a SearchForm for searching the grid, so it should show the same criteria as are applied to the grid
   • the form is for editing the selected record in the grid, or adding new ones. It is ready to either add a new record, or for the user to select a record to show in the form, typically via logic added to the grid (e.g. recordClick -> form.editSelectedData().

By default, autoPopulateData is true for any component that is contained with a "screen" RPCManager.createScreen() and false for any component that is an com.smartgwt.client.types.AutoChild.

Note that, if there is a non-DBC in your screen that wants to access fields in the expected dataContext, the DynamicProperty can refer to properties that auto-populated DBCs will place into the ruleContext. For example, with a DynamicForm "itemEditor" bound to "supplyItem", a header above could use itemEditor.values.itemName to display the name of the item. The header will then show the expected value as soon as the DynamicForm is auto-populated.

Similarly, the DataView.drawn() StringMethod fires after auto-population has occurred, so any startup actions in a screen will likewise be able to utilize data from the dataContext by just referring to it via ruleScope.

Parameters:

autoPopulateData - New autoPopulateData value. Default value is null

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getAutoPopulateData

public Boolean getAutoPopulateData()

If a dataContext is provided, should subcomponents automatically bind to the data?

In general, if you provide a primaryKey value for a record, that specific record will be shown or edited, or have its related records loaded. If you provide other field values without the primaryKey value, those values will be treated as either criteria (for a grid) or as initial values (for a form).

Components will respond to dataContext differently depending on whether they typically work with just a single record (such as form or a DetailViewer), or whether they usually work with lists of records (such as ListGrid or TileGrid, which have component.dataArity set to multipe by default).

Specifically, the following rules are used:

1. for a singular component (eg forms, detailViewers):
   • if only the PK (primary key) value is provided, the component will fetch the singular record and display or edit it
   • if the PK is provided along with other values, the component will assume it has a complete record, and display or edit it
   • if only non-PK values are provided, the component will assume these are initial values
2. for a multiple component (eg listGrid, tileGrid):
   • if only non-PK values are provided, the component will use these as criteria. For example, a grid bound to an Orders DataSource with dataContext of Status:"In Process" would fetch records with that status
   • if the PK is provided, and the component's DataSource is related to one of the DataSources in the dataContext, related records will be fetched, using the PK value (similarly to if fetchRelatedData() had been called. For example, if an orderNumber value was provided, a grid bound to OrderDetail would fetch line items for that orderNumber.
   • if an array of multiple records is provided, that data is used as if setData() had been called on the component

If any of these behaviors is not desired, you can just set autoPopulateData to false on the specific component that should not be auto-populated.

Specific examples, using the Order and OrderDetail sample DataSources, where OrderDetail records are associated (many-to-1) with Order records, and the PK of Order is orderNumber:

1. a form or DetailViewer bound to Order and a ListGrid bound to OrderDetail:
   • if an orderNumber is provided, the form or DetailViewer would show that order, and the grid would show related OrderDetail records
   • if only orderNumber is provided (no additional fields), the full Order record is automatically fetched for the form or DetailViewer

   This fulfills a common use case of viewing or editing an Order and its related OrderDetail records.

2. a grid bound to Order and a second grid bound to OrderDetail
   • if values such as orderStatus : "On Hold" were provided, the Order grid uses those as criteria
   • the OrderDetail grid does nothing

   This fulfills a common use case of viewing Order records that match certain criteria. The OrderDetail grid would generally be populated only by an event handler installed on the Order grid, which would call fetchRelatedData.

3. a grid and form both bound to Order
   • if values such as orderStatus : "On Hold" were provided, the Order grid uses those as criteria, and the form uses those as initial values

   This fulfills two possible use cases:

   • the form is a SearchForm for searching the grid, so it should show the same criteria as are applied to the grid
   • the form is for editing the selected record in the grid, or adding new ones. It is ready to either add a new record, or for the user to select a record to show in the form, typically via logic added to the grid (e.g. recordClick -> form.editSelectedData().

By default, autoPopulateData is true for any component that is contained with a "screen" RPCManager.createScreen() and false for any component that is an com.smartgwt.client.types.AutoChild.

Note that, if there is a non-DBC in your screen that wants to access fields in the expected dataContext, the DynamicProperty can refer to properties that auto-populated DBCs will place into the ruleContext. For example, with a DynamicForm "itemEditor" bound to "supplyItem", a header above could use itemEditor.values.itemName to display the name of the item. The header will then show the expected value as soon as the DynamicForm is auto-populated.

Similarly, the DataView.drawn() StringMethod fires after auto-population has occurred, so any startup actions in a screen will likewise be able to utilize data from the dataContext by just referring to it via ruleScope.

Returns:

Current autoPopulateData value. Default value is null

setAutoShowParent

public Canvas setAutoShowParent(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Appearance overview and related methods

getAutoShowParent

public 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 Canvas setBackgroundColor(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• CSSColor
• Appearance overview and related methods

getBackgroundColor

public 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 Canvas setBackgroundImage(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• SCImgURL
• Appearance overview and related methods

getBackgroundImage

public 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 Canvas setBackgroundPosition(String backgroundPosition)
                             throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Appearance overview and related methods

getBackgroundPosition

public 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 Canvas setBackgroundRepeat(BackgroundRepeat backgroundRepeat)

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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setBorder(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 a grouping frame is being shown 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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Appearance overview and related methods

getBorder

public 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 a grouping frame is being shown 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

setBorderRadius

public Canvas setBorderRadius(String borderRadius)

The CSS border-radius for this widget. The value can be any variant of a CSS border-radius value - that is, from 1 to 4 space-separated px values, where one value affects all corners and 4 values affects individual corners. For example "10px" applies a 10px radius to all corners, where "5px 10px 15px 20px" applies a different radius to each corner, clockwise from Top-Left: "TL TR BR BL".

Parameters:

borderRadius - New borderRadius value. Default value is null

Returns:

Canvas instance, for chaining setter calls

See Also:

• Appearance overview and related methods

getBorderRadius

public String getBorderRadius()

The CSS border-radius for this widget. The value can be any variant of a CSS border-radius value - that is, from 1 to 4 space-separated px values, where one value affects all corners and 4 values affects individual corners. For example "10px" applies a 10px radius to all corners, where "5px 10px 15px 20px" applies a different radius to each corner, clockwise from Top-Left: "TL TR BR BL".

Returns:

Current borderRadius value. Default value is null

See Also:

• Appearance overview and related methods

setCanAcceptDrop

public Canvas setCanAcceptDrop(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop
• Drag create Example

getCanAcceptDrop

public 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:

• Drag and Drop
• Drag create Example

setCanAdaptHeight

public Canvas setCanAdaptHeight(Boolean canAdaptHeight)

See canAdaptWidth.

Parameters:

canAdaptHeight - New canAdaptHeight value. Default value is null

Returns:

Canvas instance, for chaining setter calls

getCanAdaptHeight

public Boolean getCanAdaptHeight()

See canAdaptWidth.

Returns:

Current canAdaptHeight value. Default value is null

setCanAdaptWidth

public Canvas setCanAdaptWidth(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• setCanAdaptHeight(java.lang.Boolean)
• AdaptWidthByCustomizer.adaptWidthBy(int, int)
• AdaptHeightByCustomizer.adaptHeightBy(int, int)
• Inlined Menu Example

getCanAdaptWidth

public 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 Canvas setCanDrag(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop
• Drag create Example

getCanDrag

public 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:

• Drag and Drop
• Drag create Example

setCanDragReposition

public Canvas setCanDragReposition(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop
• Drag effects Example

getCanDragReposition

public 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:

• Drag and Drop
• Drag effects Example

setCanDragResize

public Canvas setCanDragResize(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop
• Drag resize Example

getCanDragResize

public 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:

• Drag and Drop
• Drag resize Example

setCanDragScroll

public Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setCanDrop(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop
• Drag create Example

getCanDrop

public 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:

• Drag and Drop
• Drag create Example

setCanDropBefore

public Canvas setCanDropBefore(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Layout
• LayoutMember overview and related methods

getCanDropBefore

public 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 Canvas setCanFocus(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Focus
• Focus & Tabbing Example

getCanFocus

public 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
• Focus & Tabbing Example

setCanHover

public Canvas setCanHover(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• setShowHover(java.lang.Boolean)
• HoverEvent

getCanHover

public 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 Canvas setCanSelectText(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

Returns:

Canvas instance, for chaining setter calls

getCanSelectText

public 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 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:

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.

See Containment for an overview of parent/child relationships.

Returns:

Current children value. Default value is null

See Also:

• Component Containment and Hierarchy

setChildrenResizeSnapAlign

public Canvas setChildrenResizeSnapAlign(Boolean childrenResizeSnapAlign)

Flag to disable snapping to alignment when children of this Canvas are resized

Parameters:

childrenResizeSnapAlign - New childrenResizeSnapAlign value. Default value is null

Returns:

Canvas instance, for chaining setter calls

See Also:

• SnapGridDragging overview and related methods

getChildrenResizeSnapAlign

public Boolean getChildrenResizeSnapAlign()

Flag to disable snapping to alignment when children of this Canvas are resized

Returns:

Current childrenResizeSnapAlign value. Default value is null

See Also:

• SnapGridDragging overview and related methods

setChildrenSnapAlign

public Canvas setChildrenSnapAlign(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• SnapGridDragging overview and related methods

getChildrenSnapAlign

public 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

See Also:

• SnapGridDragging overview and related methods

setChildrenSnapCenterAlign

public Canvas setChildrenSnapCenterAlign(Boolean childrenSnapCenterAlign)

See childrenSnapAlign. This setting enables or disables snapping on center alignment only.

Parameters:

childrenSnapCenterAlign - New childrenSnapCenterAlign value. Default value is null

Returns:

Canvas instance, for chaining setter calls

See Also:

• SnapGridDragging overview and related methods

getChildrenSnapCenterAlign

public Boolean getChildrenSnapCenterAlign()

See childrenSnapAlign. This setting enables or disables snapping on center alignment only.

Returns:

Current childrenSnapCenterAlign value. Default value is null

See Also:

• SnapGridDragging overview and related methods

setChildrenSnapEdgeAlign

public Canvas setChildrenSnapEdgeAlign(Boolean childrenSnapEdgeAlign)

See childrenSnapAlign. This setting enables or disables snapping on edge alignment only.

Parameters:

childrenSnapEdgeAlign - New childrenSnapEdgeAlign value. Default value is null

Returns:

Canvas instance, for chaining setter calls

See Also:

• SnapGridDragging overview and related methods

getChildrenSnapEdgeAlign

public Boolean getChildrenSnapEdgeAlign()

See childrenSnapAlign. This setting enables or disables snapping on edge alignment only.

Returns:

Current childrenSnapEdgeAlign value. Default value is null

See Also:

• SnapGridDragging overview and related methods

setChildrenSnapResizeToGrid

public Canvas setChildrenSnapResizeToGrid(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• SnapGridDragging overview and related methods

getChildrenSnapResizeToGrid

public 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:

• SnapGridDragging overview and related methods

setChildrenSnapToGrid

public Canvas setChildrenSnapToGrid(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• SnapGridDragging overview and related methods

getChildrenSnapToGrid

public 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:

• SnapGridDragging overview and related methods

getComponentMask

public Canvas getComponentMask()
                        throws 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:

IllegalStateException - if this widget has not yet been rendered.

See Also:

• getComponentMaskDefaults()

setComponentMaskDefaults

public Canvas setComponentMaskDefaults(Canvas componentMaskDefaults)
                                throws 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 {...}

Returns:

Canvas instance, for chaining setter calls

Throws:

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 Canvas setContents(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 " "

Returns:

Canvas instance, for chaining setter calls

See Also:

• setDynamicContents(java.lang.Boolean)
• HTMLString

getContents

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setCorrectZoomOverflow(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

Returns:

Canvas instance, for chaining setter calls

getCorrectZoomOverflow

public 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 Canvas setCursor(Cursor cursor)

Specifies the css cursor image to display when the mouse pointer is over this component. See Cursor for valid values.

Note that the cursor may also be controlled by the following attributes in various cases:

• disabledCursor
• noDropCursor
• dragRepositionCursor
• edgeCursorMap

If no cursor is explicitly specified for a component, the cursor will be derived from the component's ancestors. If cursor is not explicitly set in the ancestor chain, "default" will be used.

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 null

Returns:

Canvas instance, for chaining setter calls

See Also:

• Cues overview and related methods
• Drag create Example
• Cursors Example

getCursor

public Cursor getCursor()

Specifies the css cursor image to display when the mouse pointer is over this component. See Cursor for valid values.

Note that the cursor may also be controlled by the following attributes in various cases:

• disabledCursor
• noDropCursor
• dragRepositionCursor
• edgeCursorMap

If no cursor is explicitly specified for a component, the cursor will be derived from the component's ancestors. If cursor is not explicitly set in the ancestor chain, "default" will be used.

Returns:

Current cursor value. Default value is null

See Also:

• Cues overview and related methods
• Drag create Example
• Cursors Example

setDataContext

public Canvas setDataContext(DataContext dataContext)

A mapping from DataSource IDs to specific Records from those DataSources, that DataBoundComponents contained within this Canvas should automatically bind to if a DataSource is provided but data is not provided (directly or indirectly, for example, indirectly via setting ListGrid.autoFetchData.

See autoPopulateData for details on how this is done.

DataSources included in the dataContext are immediately provided to rule context when used if no other component has done so already. These records are found in rule context 'dataContext' section (ex. dataContext.Customer for a Customer record in dataContext) so they do not conflict with normal DataSource records.

If this method is called after the component has been drawn/initialized: Provides a new DataContext to the Canvas. If the DataContext is new, DataBoundComponents contained within this Canvas will be automatically bound as described in dataContext. If the DataContext replaces an existing one, any contained components that were originally bound against the DataContext will be re-bound.

Parameters:

dataContext - dataContext to use for automatic binding. Default value is null

Returns:

Canvas instance, for chaining setter calls

getDataContext

public DataContext getDataContext()

A mapping from DataSource IDs to specific Records from those DataSources, that DataBoundComponents contained within this Canvas should automatically bind to if a DataSource is provided but data is not provided (directly or indirectly, for example, indirectly via setting ListGrid.autoFetchData.

See autoPopulateData for details on how this is done.

DataSources included in the dataContext are immediately provided to rule context when used if no other component has done so already. These records are found in rule context 'dataContext' section (ex. dataContext.Customer for a Customer record in dataContext) so they do not conflict with normal DataSource records.

Returns:

Current dataContext value. Default value is null

setDataPath

public Canvas setDataPath(String dataPath)

A dataPath may be specified on any canvas. This provides a straightforward way to display or edit complex nested data.

NOTE: the dataPath feature is intended to help certain legacy architectures, such as systems that work in terms of exchanging large messages with several different entity types in one message, and are incapable of providing separate access to each entity type.
See the DataPath overview for more information.

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

Returns:

Canvas instance, for chaining setter calls

See Also:

• setRuleScope(java.lang.String)
• DataPath

getDataPath

public String getDataPath()

A dataPath may be specified on any canvas. This provides a straightforward way to display or edit complex nested data.

NOTE: the dataPath feature is intended to help certain legacy architectures, such as systems that work in terms of exchanging large messages with several different entity types in one message, and are incapable of providing separate access to each entity type.
See the DataPath overview for more information.

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:

• getRuleScope()
• DataPath

setDefaultHeight

public Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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

setDefiningProperty

public Canvas setDefiningProperty(String definingProperty)

This attribute denotes the name of a property to use as a getDefiningPropertyName() for this property when generating and resolving AutoTest locators with search segments.

Note : This is an advanced setting

Parameters:

definingProperty - New definingProperty value. Default value is null

Returns:

Canvas instance, for chaining setter calls

getDefiningProperty

public String getDefiningProperty()

This attribute denotes the name of a property to use as a getDefiningPropertyName() for this property when generating and resolving AutoTest locators with search segments.

Returns:

Current definingProperty value. Default value is null

setDefiningPropertyNameOptions

public Canvas setDefiningPropertyNameOptions(String... definingPropertyNameOptions)

If no explicit definingProperty was specified for this component, this array denotes a list of options to use as a defining property when generating and resolving AutoTest locators with search segments. The first attribute in this array that is non-null for this component will be used as the defining property for locator search segments.

The default set of options are as follows:

  [
   "locatorName",
   "dataSource"
  ]
  

Note : This is an advanced setting

Parameters:

definingPropertyNameOptions - New definingPropertyNameOptions value. Default value is [...]

Returns:

Canvas instance, for chaining setter calls

getDefiningPropertyNameOptions

public String[] getDefiningPropertyNameOptions()

If no explicit definingProperty was specified for this component, this array denotes a list of options to use as a defining property when generating and resolving AutoTest locators with search segments. The first attribute in this array that is non-null for this component will be used as the defining property for locator search segments.

The default set of options are as follows:

  [
   "locatorName",
   "dataSource"
  ]
  

Returns:

Current definingPropertyNameOptions value. Default value is [...]

getDestroyed

public Boolean getDestroyed()
                     throws 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:

IllegalStateException - if this widget has not yet been rendered.

See Also:

• BaseWidget.destroy()

getDestroying

public Boolean getDestroying()
                      throws 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:

IllegalStateException - if this widget has not yet been rendered.

See Also:

• BaseWidget.destroy()

setDisabledCursor

public Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setDisableTouchScrollingForDrag(Boolean disableTouchScrollingForDrag)
                                       throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Scrolling overview and related methods

getDisableTouchScrollingForDrag

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

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:

• Drag and Drop

setDragIntersectStyle

public Canvas 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"

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

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:

• Drag and Drop

setDragMaskType

public Canvas 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"

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

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:

• Drag and Drop

setDragMaxHeight

public Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas setDragOpacity(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop
• Drag effects Example

getDragOpacity

public 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:

• Drag and Drop
• Drag effects Example

setDragRepositionAppearance

public Canvas setDragRepositionAppearance(DragAppearance dragRepositionAppearance)

If canDragReposition is true, this attribute 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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

getDragRepositionAppearance

public DragAppearance getDragRepositionAppearance()

If canDragReposition is true, this attribute 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:

• Drag and Drop

setDragRepositionCursor

public Canvas 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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

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:

• Drag and Drop

setDragResizeAppearance

public Canvas setDragResizeAppearance(DragAppearance dragResizeAppearance)

If canDragResize is true, this attribute 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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

getDragResizeAppearance

public DragAppearance getDragResizeAppearance()

If canDragResize is true, this attribute 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:

• Drag and Drop

setDragScrollDelay

public Canvas 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

Returns:

Canvas instance, for chaining setter calls

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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

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:

• Drag and Drop

setDragTarget

public Canvas 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]
• another widget, or widget ID
• "parent" drag target is this widget's parentCanvas
• "top" drag target is this widget's topElement

Note that for dragging to work as intended, the resizeFrom setting on the dragTarget must be null or a superset of the resizeFrom on this canvas.

Note : This is an advanced setting

Parameters:

dragTarget - New dragTarget value. Default value is null

Returns:

Canvas instance, for chaining setter calls

See Also:

• EventHandler.getDragTarget()
• Drag and Drop

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]
• another widget, or widget ID
• "parent" drag target is this widget's parentCanvas
• "top" drag target is this widget's topElement

Note that for dragging to work as intended, the resizeFrom setting on the dragTarget must be null or a superset of the resizeFrom on this canvas.

Returns:

Current dragTarget value. Default value is null

See Also:

• EventHandler.getDragTarget()
• Drag and Drop

setDragTarget

public Canvas setDragTarget(String 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]
• another widget, or widget ID
• "parent" drag target is this widget's parentCanvas
• "top" drag target is this widget's topElement

Note that for dragging to work as intended, the resizeFrom setting on the dragTarget must be null or a superset of the resizeFrom on this canvas.

Note : This is an advanced setting

Parameters:

dragTarget - New dragTarget value. Default value is null

Returns:

Canvas instance, for chaining setter calls

See Also:

• EventHandler.getDragTarget()
• Drag and Drop

getDragTargetAsString

public String getDragTargetAsString()

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]
• another widget, or widget ID
• "parent" drag target is this widget's parentCanvas
• "top" drag target is this widget's topElement

Note that for dragging to work as intended, the resizeFrom setting on the dragTarget must be null or a superset of the resizeFrom on this canvas.

Returns:

Current dragTarget value. Default value is null

See Also:

• EventHandler.getDragTarget()
• Drag and Drop

setDragType

public Canvas setDragType(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

getDragType

public 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:

• Drag and Drop

setDropTarget

public Canvas setDropTarget(Canvas dropTarget)

Delegates a different widget that should actually be dropped on if the cursor is over this widget when the drop completes. If you're building your own "drop indicator" widget, it may need this property set to the main canvas (receiving the drop) to avoid itself being considered a drop target (causing the indicator to flicker).

Note : This is an advanced setting

Parameters:

dropTarget - New dropTarget value. Default value is null

Returns:

Canvas instance, for chaining setter calls

See Also:

• EventHandler.getDragTarget()
• setDragTarget(com.smartgwt.client.widgets.Canvas)
• Drag and Drop

getDropTarget

public Canvas getDropTarget()

Delegates a different widget that should actually be dropped on if the cursor is over this widget when the drop completes. If you're building your own "drop indicator" widget, it may need this property set to the main canvas (receiving the drop) to avoid itself being considered a drop target (causing the indicator to flicker).

Returns:

Current dropTarget value. Default value is null

See Also:

• EventHandler.getDragTarget()
• getDragTarget()
• Drag and Drop

setDropTarget

public Canvas setDropTarget(String dropTarget)

Delegates a different widget that should actually be dropped on if the cursor is over this widget when the drop completes. If you're building your own "drop indicator" widget, it may need this property set to the main canvas (receiving the drop) to avoid itself being considered a drop target (causing the indicator to flicker).

Note : This is an advanced setting

Parameters:

dropTarget - New dropTarget value. Default value is null

Returns:

Canvas instance, for chaining setter calls

See Also:

• EventHandler.getDragTarget()
• setDragTarget(com.smartgwt.client.widgets.Canvas)
• Drag and Drop

getDropTargetAsString

public String getDropTargetAsString()

Delegates a different widget that should actually be dropped on if the cursor is over this widget when the drop completes. If you're building your own "drop indicator" widget, it may need this property set to the main canvas (receiving the drop) to avoid itself being considered a drop target (causing the indicator to flicker).

Returns:

Current dropTarget value. Default value is null

See Also:

• EventHandler.getDragTarget()
• getDragTarget()
• Drag and Drop

setDropTypes

public Canvas setDropTypes(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

getDropTypes

public 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:

• Drag and Drop

setDropTypes

public Canvas setDropTypes(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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop

getDropTypesAsString

public 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:

• Drag and Drop

setDynamicContents

public Canvas setDynamicContents(Boolean dynamicContents)

Dynamic contents allows the contents string to be treated as a simple but powerful template. When this attribute is set to true, JavaScript expressions may be embedded within the contents string, using the format: ${[JavaScript to evaluate]}.

For example, to include the current date in a templated message, canvas.contents could be set to:
"Today's date is <b>${new Date().toUSShortDate()}</b>"

Embedded expressions will be evaluated when the canvas is drawn or redrawn, and the result of the evaluated expression will be displayed to the user. If the expression does not evaluate to a String, the toString() representation of the returned object will be displayed automatically

Dynamic expressions are evaluated in the scope of the canvas displaying the content, so the this keyword may be used within your expression to refer to the canvas. Developers may also explicitly supply values for variables to be used within the evaluation via the dynamicContentsVars property.

Notes:

• Calling markForRedraw() on the canvas will evaluate any embedded expressions.
• Multiple such expressions may be embedded within the contents string for a component.
• If an error occurs during evaluation, a warning is logged to the Developer Console and the error string will be embedded in place of the expected value in the Canvas.

Note : This is an advanced setting

Parameters:

dynamicContents - New dynamicContents value. Default value is false

Returns:

Canvas instance, for chaining setter calls

See Also:

• setContents(java.lang.String)
• com.smartgwt.client.widgets.Canvas#setDynamicContentsVars

getDynamicContents

public Boolean getDynamicContents()

Dynamic contents allows the contents string to be treated as a simple but powerful template. When this attribute is set to true, JavaScript expressions may be embedded within the contents string, using the format: ${[JavaScript to evaluate]}.

For example, to include the current date in a templated message, canvas.contents could be set to:
"Today's date is <b>${new Date().toUSShortDate()}</b>"

Embedded expressions will be evaluated when the canvas is drawn or redrawn, and the result of the evaluated expression will be displayed to the user. If the expression does not evaluate to a String, the toString() representation of the returned object will be displayed automatically

Dynamic expressions are evaluated in the scope of the canvas displaying the content, so the this keyword may be used within your expression to refer to the canvas. Developers may also explicitly supply values for variables to be used within the evaluation via the dynamicContentsVars property.

Notes:

• Calling markForRedraw() on the canvas will evaluate any embedded expressions.
• Multiple such expressions may be embedded within the contents string for a component.
• If an error occurs during evaluation, a warning is logged to the Developer Console and the error string will be embedded in place of the expected value in the Canvas.

Returns:

Current dynamicContents value. Default value is false

See Also:

• getContents()
• com.smartgwt.client.widgets.Canvas#getDynamicContentsVars

setEdgeBackgroundColor

public Canvas setEdgeBackgroundColor(String edgeBackgroundColor)
                              throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CSSColor

getEdgeBackgroundColor

public 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 Canvas setEdgeCenterBackgroundColor(String edgeCenterBackgroundColor)
                                    throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CSSColor

getEdgeCenterBackgroundColor

public 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 Canvas setEdgeImage(String edgeImage)
                    throws 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"

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• SCImgURL
• Edges Example

getEdgeImage

public 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 Canvas 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

Returns:

Canvas instance, for chaining setter calls

See Also:

• Drag and Drop
• 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:

• Drag and Drop
• Drag resize Example

setEdgeOffset

public Canvas setEdgeOffset(Integer edgeOffset)
                     throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Corners Example

getEdgeOffset

public 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 Canvas setEdgeOpacity(Integer edgeOpacity)
                      throws 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

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Edges Example

getEdgeOpacity

public 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 Canvas setEdgeShowCenter(Boolean edgeShowCenter)
                         throws IllegalStateException

Whether to show media in the center section, that is, behind the decorated Canvas.

Parameters:

edgeShowCenter - New edgeShowCenter value. Default value is false

Returns:

Canvas instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Corners Example

getEdgeShowCenter

public 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