|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
public class Canvas
Canvas is the base abstraction for cross-browser DHTML drawing. All DHTML widgets inherit from the Canvas class.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
---|
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled |
Field Summary |
---|
Fields inherited from class com.smartgwt.client.widgets.BaseWidget |
---|
config, configOnly, id, isElementSet |
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Constructor Summary | |
---|---|
Canvas()
|
|
Canvas(com.google.gwt.core.client.JavaScriptObject jsObj)
|
|
Canvas(java.lang.String id)
|
Method Summary | |
---|---|
Canvas |
addChild(Canvas newChild)
Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if name argument is provided, and draw the child if this widget has been drawn already. |
Canvas |
addChild(Canvas newChild,
java.lang.String name,
boolean autoDraw)
Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if name argument is provided, and draw the child if this widget has been drawn already. |
void |
addChild(com.google.gwt.user.client.ui.Widget widget)
Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if name argument is provided, and draw the child if this widget has been drawn already. |
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 onDrop 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. |
Canvas |
addPeer(Canvas newPeer)
Adds newPeer as a peer of this widget (also making it a child of this widget's parent, if any), set up a named object reference (i.e., this[name]) to the new widget if name is provided, and draw the peer if this widget has been drawn already. The widget to be added as a peer will be removed from its old master and/or parent, if any, and it will be added as a child to the parent of this canvas (if any) |
Canvas |
addPeer(Canvas newPeer,
java.lang.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. The widget to be added as a peer will be removed from its old master and/or parent, if any, and it will be added as a child to the parent of this canvas (if any) |
HandlerRegistration |
addResizedHandler(ResizedHandler handler)
Add a resized handler. |
HandlerRegistration |
addRightMouseDownHandler(RightMouseDownHandler handler)
Add a rightMouseDown handler. |
HandlerRegistration |
addScrolledHandler(ScrolledHandler handler)
Add a scrolled handler. |
HandlerRegistration |
addShowContextMenuHandler(ShowContextMenuHandler handler)
Add a showContextMenu handler. |
void |
addStyleName(java.lang.String style)
Multiple styles are currently not supported. |
void |
adjustForContent(boolean immediate)
This method tells a component to adjust for size changes made to content by external code. |
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 |
animateHide(AnimationEffect effect)
Hide a canvas by shrinking it vertically to zero height over a period of time. |
void |
animateHide(AnimationEffect effect,
AnimationCallback callback)
Hide a canvas by shrinking it vertically to zero height over a period of time. |
void |
animateHide(AnimationEffect effect,
AnimationCallback callback,
int duration)
Hide a canvas by shrinking it vertically to zero height over a period of time. |
void |
animateMove(int left,
int top)
Animate a reposition of this canvas from its current position to the specified position |
void |
animateMove(int left,
int top,
AnimationCallback callback)
Animate a reposition of this canvas from its current position to the specified position |
void |
animateMove(int left,
int top,
AnimationCallback callback,
int duration)
Animate a reposition of this canvas from its current position to the specified position |
void |
animateMove(int left,
int top,
AnimationCallback callback,
int duration,
AnimationAcceleration acceleration)
Animate a reposition of this canvas from its current position to the specified position |
void |
animateRect(int left,
int top,
int width,
int height)
Animate a reposition / resize of this canvas from its current size and postion. |
void |
animateRect(int left,
int top,
int width,
int height,
AnimationCallback callback)
Animate a reposition / resize of this canvas from its current size and postion. |
void |
animateRect(int left,
int top,
int width,
int height,
AnimationCallback callback,
int duration)
Animate a reposition / resize of this canvas from its current size and postion. |
void |
animateResize(int width,
int height)
Animate a resize of this canvas from its current size to the specified size |
void |
animateResize(int width,
int height,
AnimationCallback callback)
Animate a resize of this canvas from its current size to the specified size |
void |
animateResize(int width,
int height,
AnimationCallback callback,
int duration)
Animate a resize of this canvas from its current size to the specified size |
void |
animateScroll(int scrollLeft,
int scrollTop)
Animate a scroll from the current scroll position to the specified position. |
void |
animateScroll(int scrollLeft,
int scrollTop,
AnimationCallback callback)
Animate a scroll from the current scroll position to the specified position. |
void |
animateScroll(int scrollLeft,
int scrollTop,
AnimationCallback callback,
int duration)
Animate a scroll from the current scroll position to the specified position. |
void |
animateShow(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 |
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. |
void |
clear()
Remove all visual representation of a Canvas. |
void |
clickMaskUp()
Determines whether a clickmask is showing |
void |
clickMaskUp(java.lang.String ID)
Determines whether a clickmask is showing |
java.lang.Boolean |
contains(Canvas canvas)
Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment hierarchy); and false otherwise. |
java.lang.Boolean |
contains(Canvas canvas,
boolean testSelf)
Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment hierarchy); and false otherwise. |
java.lang.Boolean |
containsEvent()
Return true if the last event's mouse coordinates are within the bounds of this component. NOTE: Z-ordering is not considered for the purposes of this test. |
java.lang.Boolean |
containsFocus()
Returns true if the keyboard focus is in this Canvas or any child of this Canvas. |
java.lang.Boolean |
containsPoint(int x,
int y)
Return whether or not this object contains the specified global (x,y) coordinates. |
java.lang.Boolean |
containsPoint(int x,
int y,
boolean withinViewport)
Return whether or not this object contains the specified global (x,y) coordinates. |
protected static Canvas[] |
convertToCanvasArray(com.google.gwt.core.client.JavaScriptObject nativeArray)
|
protected com.google.gwt.core.client.JavaScriptObject |
create()
|
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. |
void |
focus()
If this canvas can accept focus, give it keyboard focus. |
int |
getAbsoluteLeft()
|
int |
getAbsoluteTop()
|
java.lang.String |
getAccessKey()
If specified this governs the accessKey for the widget. This should be set to a character - when a user hits Alt+[accessKey], or in Mozilla Firefox 2.0 and above, Shift+Alt+[accessKey], focus will be given to the widget in question. |
AnimationEffect |
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. |
java.lang.Integer |
getAnimateFadeTime()
Default time for performing an animated fade. |
AnimationAcceleration |
getAnimateHideAcceleration()
Default acceleration function for performing an animated hide. |
java.lang.Integer |
getAnimateHideTime()
Default time for performing an animated hide. |
AnimationAcceleration |
getAnimateMoveAcceleration()
Default acceleration effect for performing an animated move. |
java.lang.Integer |
getAnimateMoveTime()
Default time for performing an animated move. |
AnimationAcceleration |
getAnimateRectAcceleration()
Default acceleration function for performing an animated move and resize. |
java.lang.Integer |
getAnimateRectTime()
Default time for performing an animated setRect. |
AnimationAcceleration |
getAnimateResizeAcceleration()
Default acceleration function for performing an animated resize. |
java.lang.Integer |
getAnimateResizeTime()
Default time for performing an animated resize. |
AnimationAcceleration |
getAnimateScrollAcceleration()
Default acceleration function for performing an animated scroll. |
java.lang.Integer |
getAnimateScrollTime()
Default time for performing an animated scroll. |
AnimationAcceleration |
getAnimateShowAcceleration()
Default acceleration function for performing an animated show. |
java.lang.Integer |
getAnimateShowTime()
Default time for performing an animated show. |
int |
getAnimateTime()
Default total duration of animations. |
java.lang.String |
getAppImgDir()
Default directory for app-specific images, relative to the Page-wide Page.getAppImgDir() . |
java.lang.Boolean |
getAutoShowParent()
If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown. |
java.lang.String |
getBackgroundImage()
URL for a background image for this widget (corresponding to the CSS "background-image" attribute). |
java.lang.String |
getBackgroundPosition()
Specifies how the background image should be positioned on the widget. It corresponds to the CSS background-position attribute. |
BkgndRepeat |
getBackgroundRepeat()
Specifies how the background image should be tiled if this widget is larger than the image. |
java.lang.String |
getBorder()
Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid blue"). |
int |
getBottom()
Return the bottom coordinate of this object as rendered, relative to its enclosing context, in pixels. |
static Canvas |
getById(java.lang.String ID)
Retrieve a Canvas by it's global ID .
|
java.lang.Boolean |
getCanAcceptDrop()
Indicates that this object can receive dropped widgets (i.e. |
java.lang.Boolean |
getCanDrag()
Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize). |
java.lang.Boolean |
getCanDragReposition()
Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse. |
java.lang.Boolean |
getCanDragResize()
Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse. |
java.lang.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(). |
java.lang.Boolean |
getCanDrop()
Indicates that this object can be dropped on top of other widgets. |
java.lang.Boolean |
getCanDropBefore()
When explicitly set to false, disallows drop before this member in the Layout. |
java.lang.Boolean |
getCanFocus()
Can this widget be allowed to become the target of keyboard events? |
java.lang.Boolean |
getCanHover()
Will this Canvas fire hover events when the user hovers over it, or one of its children? |
java.lang.Boolean |
getCanSelectText()
Whether native drag selection of contained text is allowed within this Canvas. |
Canvas[] |
getChildren()
Array of all Canvii that are immediate children of this Canvas. |
java.lang.Boolean |
getChildrenSnapResizeToGrid()
If true, causes this canvas's children to snap to its grid when resizing. This behavior can be overridden on a per-child basis by setting the snapToGrid or
snapResizeToGrid value on the child. |
java.lang.Boolean |
getChildrenSnapToGrid()
If true, causes this canvas's children to snap to its grid when dragging. This behavior can be overridden on a per-child basis by setting the snapToGrid value on the child. |
java.lang.String |
getContents()
The contents of a canvas or label widget. |
Menu |
getContextMenu()
Context menu to show for this object, an instance of the Menu widget. |
Cursor |
getCursor()
Specifies the cursor image to display when the mouse pointer is over this widget. |
int |
getDefaultHeight()
For custom components, establishes a default height for the component. |
int |
getDefaultWidth()
For custom components, establishes a default width for the component. |
java.lang.Boolean |
getDestroyed()
If this property is set to true , the BaseWidget.destroy() method
has been called on this canvas. |
java.lang.Boolean |
getDestroying()
This property is set to true when the BaseWidget.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. |
java.lang.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. |
int |
getDoubleClickDelay()
Amount of time (in msec) 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. |
java.lang.Integer |
getDragOpacity()
If this widget has dragAppearance "target" , this value specifies the
opacity to render the target while it is being dragged. |
Cursor |
getDragRepositionCursor()
Cursor to switch to if the mouse is over a widget that is drag repositionable. |
int |
getDragScrollDelay()
If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the drag-scroll threshold before scrolling begins. |
int |
getDragStartDistance()
Number of pixels the cursor needs to move before the EventHandler starts a drag operation. |
Canvas |
getDragTarget()
A different widget that should be actually dragged when dragging initiates on this widget. |
java.lang.String |
getDragType()
The "type" of thing given as a string that can be dragged from this widget. |
java.lang.Boolean |
getDynamicContents()
Dynamic contents allows the contents string to be treated as a simple, but powerful template. |
java.lang.String |
getEdgeBackgroundColor()
Background color for the EdgedCanvas created to decorate this component. |
java.lang.String |
getEdgeCenterBackgroundColor()
Background color for the center section only. |
java.lang.String |
getEdgeImage()
Base name of images for edges. |
java.lang.Integer |
getEdgeOffset()
Amount the contained Canvas should be offset. |
java.lang.Integer |
getEdgeOpacity()
Opacity of the edges. |
java.lang.Boolean |
getEdgeShowCenter()
Whether to show media in the center section, that is, behind the decorated Canvas. |
int |
getEdgeSize()
Size in pixels for corners and edges |
int |
getExtraSpace()
When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a Layout. |
java.lang.String |
getGroupTitle()
Return the groupTitle. |
java.lang.Integer |
getHeight()
|
java.lang.String |
getHeightAsString()
|
Alignment |
getHoverAlign()
If this.showHover is true, this property can be used to customize the
alignment of content in the hover canvas. |
int |
getHoverDelay()
If this.canHover is true, how long should the mouse be kept over this
widget before the hover event is fired |
java.lang.Integer |
getHoverHeight()
If this.showHover is true, this property can be used to customize the
height of the hover canvas shown. |
void |
getHoverHTML()
If this.showHover is true, when the user holds the mouse over this Canvas for
long enough to trigger a hover event, a hover canvas is shown by default. |
java.lang.Boolean |
getHoverMoveWithMouse()
If this.showHover is true, should this widget's hover canvas be moved with
the mouse while visible? |
java.lang.Integer |
getHoverOpacity()
If this.showHover is true, should the hover canvas be shown with opacity
other than 100? |
java.lang.String |
getHoverStyle()
If this.showHover is true, this property can be used to specify the
css style to apply to the hover canvas. |
VerticalAlignment |
getHoverVAlign()
If this.showHover is true, this property can be used to customize the
vertical alignment of content in the hover canvas. |
java.lang.Integer |
getHoverWidth()
If showHover is true, this property can be used to customize the
width of the hover canvas shown. |
java.lang.Boolean |
getHoverWrap()
If this.showHover is true, this property can be used to customize the
whether content in the hover canvas is displayed in a single line, or wraps. |
int |
getHSnapOrigin()
Get an offset to be used when calculating snap positioning. |
int |
getHSnapOrigin(Canvas snapChild)
Get an offset to be used when calculating snap positioning. |
int |
getHSnapPosition(int coordinate)
Override this method to provide a custom snap-to grid. |
int |
getHSnapPosition(int coordinate,
java.lang.String direction)
Override this method to provide a custom snap-to grid. |
DrawPosition |
getHtmlPosition()
If htmlElement is specified, this attribute specifies the position where
the canvas should be inserted relative to the htmlElement in the DOM. |
static java.lang.String |
getImgURL(java.lang.String URL)
Return the full URL for an image to be drawn in this canvas. |
static java.lang.String |
getImgURL(java.lang.String URL,
java.lang.String imgDir)
Return the full URL for an image to be drawn in this canvas. |
int |
getInnerContentHeight()
Returns the amount of space available for interior content (or relatively positioned child widget(s)) without introducing clipping, scrolling or overflow. This is the space within the viewport of the widget (not including padding, and excluding margins, borders or scrollbars) rendered at its specified size. |
int |
getInnerContentWidth()
Returns the amount of space available for interior content (or relatively positioned child widget(s)) without introducing clipping, scrolling or overflow. This is the space within the viewport of the widget (not including padding, and excluding margins, borders or scrollbars) rendered at its specified size. |
int |
getInnerHeight()
Returns the amount of space available for (an) absolutely positioned child widget(s) or HTML content, without introducing clipping, scrolling or overflow. This is the space within the viewport of the widget (including padding, but excluding margins, borders or scrollbars) rendered at its specified size. |
int |
getInnerWidth()
Returns the amount of space available for (an) absolutely positioned child widget(s) or HTML content, without introducing clipping, scrolling or overflow. This is the space within the viewport of the widget (including padding, but excluding margins, borders or scrollbars) rendered at its specified size. |
java.lang.Boolean |
getIsGroup()
Return the isGroup. |
int |
getLeft()
Number of pixels the left side of the widget is offset to the right from its default drawing context (either its parent's topleft corner, or the document flow, depending on the value of the position property). |
java.lang.Integer |
getMargin()
Set the CSS Margin, in pixels, for this component. |
java.lang.Boolean |
getMatchElement()
If htmlElement is specified, should this canvas initially be drawn
at the same dimensions as the htmlElement?Note: setting this property will not force the canvas to resize if the element subsequently resizes (for example due to page reflow). |
int |
getMaxHeight()
Maximum height that this Canvas can be resized to. |
int |
getMaxWidth()
Maximum width that this Canvas can be resized to. |
int |
getMinHeight()
Minimum height that this Canvas can be resized to. |
int |
getMinWidth()
Minimum width that this Canvas can be resized to. |
int |
getMouseStillDownDelay()
Amount of time (in msec) between 'mouseStillDown' events for this object |
int |
getMouseStillDownInitialDelay()
Amount of time (in msec) before mouseStillDown events start to be fired for this object. |
int |
getNextZIndex()
get the next zIndex for the next item to be drawn. |
java.lang.Boolean |
getNoDoubleClicks()
If true, this canvas will recieve all mouse-clicks as single click events rather than doubleClicks. |
int |
getOffsetHeight()
|
int |
getOffsetWidth()
|
int |
getOffsetX()
Return the X-coordinate of the last event relative to the left edge of the content of this Canvas. NOTE: To get a coordinate relative to the viewport of this Canvas, subtract this.getScrollLeft() |
int |
getOffsetY()
Return the Y-coordinate of the last event, relative to the top edge of the content of this Canvas. NOTE: To get a coordinate relative to the viewport of this Canvas, subtract this.getScrollTop() |
java.lang.Integer |
getOpacity()
Renders the widget to be partly transparent. |
static Canvas |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
Overflow |
getOverflow()
Controls what happens when the drawn size of the content of a Canvas is either greater or smaller than the specified size of the Canvas. |
java.lang.Integer |
getPadding()
Set the CSS padding of this component, in pixels. |
int |
getPageBottom()
Return the page-relative bottom coordinate of this object, in pixels. |
int |
getPageLeft()
Returns the page-relative left coordinate of the widget on the page, in pixels. |
Rectangle |
getPageRect()
|
int |
getPageRight()
Return the page-relative right coordinate of this object, in pixels. |
int |
getPageTop()
Returns the page-relative top coordinate of the widget on the page, in pixels |
Canvas |
getParentElement()
This Canvas's immediate parent, if any. |
PercentBoxModel |
getPercentBox()
Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a specified snapTo .
|
Positioning |
getPosition()
Absolute or relative, corresponding to the "absolute" (with respect to parent) or "relative" (with respect to document flow) values for the CSS position attribute. |
java.lang.String |
getPrefix()
|
java.lang.String |
getPrompt()
Prompt displayed in hover canvas if showHover is true. |
Rectangle |
getRect()
Get all four coordinates, relative to the enclosing context, at one. |
java.lang.Boolean |
getRedrawOnResize()
Should this element be redrawn in response to a resize? |
java.lang.String |
getResizeBarTarget()
When this Canvas is included as a member in a Layout, and showResizeBar is set to
true so that a resizeBar is created, resizeBarTarget:"next" can be
set to indicate that the resizeBar should resize the next member of the layout rather than
this one. |
int |
getRight()
Return the right coordinate of this object as rendered, relative to its enclosing context, in pixels. |
int |
getScrollbarSize()
How thick should we make the scrollbars for this canvas. NOTE: has no effect if showCustomScrollbars is false. |
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. |
int |
getShadowDepth()
Depth of the shadow, or the virtual height above the page of the widget throwing the shadow. |
java.lang.String |
getShadowImage()
Base name of the series of images for the sides, corners, and center of the shadow. |
java.lang.Integer |
getShadowOffset()
Offset of the shadow. |
java.lang.Integer |
getShadowSoftness()
Softness, or degree of blurring, of the shadow. |
java.lang.Boolean |
getShowCustomScrollbars()
Whether to use the browser's native scrollbars or SmartGWT-based scrollbars. |
java.lang.Boolean |
getShowDragShadow()
When this widget is dragged, if its dragAppearance is "target" , should
we show a shadow behind the canvas during the drag. |
java.lang.Boolean |
getShowEdges()
Whether an EdgedCanvas should be used to show image-based edges around this
component. |
java.lang.Boolean |
getShowHover()
If this.canHover is true, should we show the global hover canvas by default
when the user hovers over this canvas? |
java.lang.Boolean |
getShowResizeBar()
When this Canvas is included as a member in a Layout, whether a resizeBar should be shown after this member in the layout, to allow it to be resized. |
java.lang.Boolean |
getShowShadow()
Whether to show a drop shadow for this Canvas |
java.lang.String |
getSkinImgDir()
Default directory for skin images (those defined by the class), relative to the Page-wide Page.getSkinDir() . |
java.lang.String |
getSnapAxis()
Describes which axes to apply snap-to-grid to. Valid values are Canvas.HORIZONTAL, Canvas.VERTICAL and Canvas.BOTH |
java.lang.String |
getSnapEdge()
If snapTo is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent
element.
|
java.lang.String |
getSnapHDirection()
The horizontal snap direction. Set this value to Canvas.BEFORE to snap to the nearest gridpoint to the left; set it to Canvas.AFTER to snap to the nearest gridpoint to the right; and set it to Canvas.NEAREST to snap to the nearest gridpoint in either direction. |
int |
getSnapHGap()
The horizontal grid size to use, in pixels, when snap-to-grid is enabled. |
java.lang.Integer |
getSnapOffsetLeft()
If snapTo is defined for this widget, this property can be used to
specify an offset in px or percentage for the left coordinate of this widget.
|
java.lang.Integer |
getSnapOffsetTop()
If snapTo is defined for this widget, this property can be used to
specify an offset in px or percentage for the top coordinate of this widget.
|
java.lang.Boolean |
getSnapOnDrop()
When this canvas is dropped onto an object supporting snap-to-grid, should it snap to the grid (true, the default) or just drop wherever the mouse is (false). |
java.lang.Boolean |
getSnapResizeToGrid()
Causes this canvas to snap to its parent's grid when resizing. Note that this value defaults to the Canvas's snapToGrid value if undefined. |
java.lang.String |
getSnapTo()
Position this widget such that it is aligned with ("snapped to") an edge of its masterElement (if specified), or its
parentElement .
|
java.lang.Boolean |
getSnapToGrid()
Causes this canvas to snap to its parent's grid when dragging. |
java.lang.String |
getSnapVDirection()
The vertical snap direction. Set this value to Canvas.BEFORE to snap to the nearest gridpoint above; set it to Canvas.AFTER to snap to the nearest gridpoint below; and set it to Canvas.NEAREST to snap to the nearest gridpoint in either direction. |
int |
getSnapVGap()
The vertical grid size to use, in pixels, when snap-to-grid is enabled. |
java.lang.String |
getStyleName()
The CSS class applied to this widget as a whole. |
java.lang.Integer |
getTabIndex()
If specified this governs the tabIndex of the widget in the page's tab order. Note that by default SmartGWT auto-assigns tab-indices, ensuring focusable widgets are reachable by tabbing in the order in which they are drawn on the page. canvas.tabIndex cannot be set to greater than
com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR - as we reserve the values above this range for
auto-assigned tab-indices. |
java.lang.String |
getTitle()
Synonmy for getPrompt() |
java.lang.String |
getTooltip()
Synonmy 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). |
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. |
int |
getVisibleWidth()
Return the visible width of the Canvas. |
int |
getVSnapOrigin()
Get an offset to be used when calculating snap positioning. |
int |
getVSnapOrigin(Canvas snapChild)
Get an offset to be used when calculating snap positioning. |
int |
getVSnapPosition(int coordinate)
Override this method to provide a custom snap-to grid. |
int |
getVSnapPosition(int coordinate,
java.lang.String direction)
Override this method to provide a custom snap-to grid. |
java.lang.Integer |
getWidth()
|
java.lang.String |
getWidthAsString()
|
int |
getZIndex()
Get the z-Index of this canvas. |
void |
handleHover()
Handler fired on a delay when the user hovers the mouse over this hover-target. Default implementation will fire this.hover() (if defined), and handle
showing the hover canvas if this.showHover is true.
|
void |
hide()
Sets the widget's CSS visibility attribute to "hidden". |
void |
hideClickMask()
Hides the click mask associated with this canvas. |
void |
hideClickMask(java.lang.String ID)
Hides the click mask associated with this canvas. |
void |
hideContextMenu()
The default implementation of this method hides the contextMenu currently being shown for this component (which occurs when the mouse button that toggles the context menu is released). Override if you want some other behavior. |
static java.lang.String |
imgHTML(java.lang.String src)
Generates the HTML for an image unique to this Canvas. |
static java.lang.String |
imgHTML(java.lang.String src,
int width,
int height)
|
static java.lang.String |
imgHTML(java.lang.String src,
int width,
int height,
java.lang.String name,
java.lang.String extraStuff,
java.lang.String imgDir)
Generates the HTML for an image unique to this Canvas. |
java.lang.Boolean |
intersects(Canvas other)
Returns true if the rectangles of this widget and the specified widget overlap. |
java.lang.Boolean |
isDirty()
Returns whether a canvas is waiting to be redrawn. |
java.lang.Boolean |
isDisabled()
Is this canvas disabled? Note that the disabled state is inherited - this method will return true if this widget, or any of its ancestors are marked disabled. |
java.lang.Boolean |
isDrawn()
Returns the boolean true, if the widget has been completely drawn, and false otherwise. |
boolean |
isVisible()
Returns true if the widget is visible, taking all parents into account, so that a widget which is not hidden might still report itself as not visible if it is within a hidden parent. |
java.lang.Boolean |
keyUp()
Executed when a key is released on a focusable widget ( canFocus : true). |
void |
layoutChildren(java.lang.String reason)
layoutChildren() is where a Canvas should implement a sizing policy for it's
Canvas children. |
java.lang.String |
linkHTML(java.lang.String href)
Generates the HTML for a standard link element |
java.lang.String |
linkHTML(java.lang.String href,
java.lang.String text,
java.lang.String target,
java.lang.String ID,
int tabIndex,
java.lang.String accessKey)
Generates the HTML for a standard link element |
void |
markForDestroy()
BaseWidget.destroy() this canvas on a timeout. |
void |
markForRedraw()
Marks the widget as "dirty" so that it will be added to a queue for redraw. |
void |
markForRedraw(java.lang.String reason)
Marks the widget as "dirty" so that it will be added to a queue for redraw. |
void |
moveAbove(Canvas canvas)
Puts this widget just above the specified widget in the stacking order, so it appears in front of the specified widget if both widgets have the same parent. |
void |
moveBelow(Canvas canvas)
Puts this widget just below the specified widget in the stacking order, so it appears behind the specified widget if both widgets have the same parent. |
java.lang.Boolean |
moveBy(int deltaX,
int deltaY)
Moves the widget deltaX pixels to the right and deltaY pixels down. |
boolean |
moveTo(int left,
int top)
Moves the widget so that its top-left corner is at the specified coordinates. |
void |
parentResized()
Fires when the interior size of the parent changes, including parent resize and scrollbar introduction or removal. |
void |
redraw()
Redraws the widget immediately with its current property values. |
void |
redraw(java.lang.String reason)
Redraws the widget immediately with its current property values. |
void |
removeChild(Canvas child)
Remove a child from its parent if it has one. |
void |
removeChild(Canvas child,
java.lang.String name)
Remove a child from its parent if it has one. |
java.lang.Boolean |
resizeBy()
Resizes the widget, adding deltaX to its width and deltaY to its height (moves the right and/or bottom sides of the widget). |
java.lang.Boolean |
resizeBy(int deltaX,
int deltaY)
Resizes the widget, adding deltaX to its width and deltaY to its height (moves the right and/or bottom sides of the widget). |
java.lang.Boolean |
resizeTo()
Resizes the widget to the specified width and height (moves the right and/ or bottom sides of the widget). |
java.lang.Boolean |
resizeTo(int width,
int height)
Resizes the widget to the specified width and height (moves the right and/ or bottom sides of the widget). |
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(int left,
int top)
Scrolls the content of the widget so that the origin (top-left corner) of the content is left pixels to the left and top pixels above the widget's top-left corner (but still clipped by the widget's dimensions). |
void |
scrollToBottom()
Vertically scrolls the content of the widget to the end of its content |
void |
scrollToLeft()
Horizontally scrolls the content of the widget to 0 |
void |
scrollToPercent(int left,
int top)
Scroll this widget to some position specified as a percentage of scroll size in either (or both) direction(s). |
void |
scrollToRight()
Horizontally scrolls the content of the widget to the end of its content |
void |
scrollToTop()
Vertically scrolls the content of the widget to 0 |
void |
sendToBack()
Puts this widget at the bottom of the stacking order, so it appears behind all other widgets in the same parent. |
void |
setAccessKey(java.lang.String accessKey)
If specified this governs the accessKey for the widget. This should be set to a character - when a user hits Alt+[accessKey], or in Mozilla Firefox 2.0 and above, Shift+Alt+[accessKey], focus will be given to the widget in question. |
void |
setAlign(Alignment align)
|
void |
setAnimateAcceleration(AnimationEffect 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. |
void |
setAnimateFadeTime(java.lang.Integer animateFadeTime)
Default time for performing an animated fade. |
void |
setAnimateHideAcceleration(AnimationAcceleration animateHideAcceleration)
Default acceleration function for performing an animated hide. |
void |
setAnimateHideTime(java.lang.Integer animateHideTime)
Default time for performing an animated hide. |
void |
setAnimateMoveAcceleration(AnimationAcceleration animateMoveAcceleration)
Default acceleration effect for performing an animated move. |
void |
setAnimateMoveTime(java.lang.Integer animateMoveTime)
Default time for performing an animated move. |
void |
setAnimateRectAcceleration(AnimationAcceleration animateRectAcceleration)
Default acceleration function for performing an animated move and resize. |
void |
setAnimateRectTime(java.lang.Integer animateRectTime)
Default time for performing an animated setRect. |
void |
setAnimateResizeAcceleration(AnimationAcceleration animateResizeAcceleration)
Default acceleration function for performing an animated resize. |
void |
setAnimateResizeTime(java.lang.Integer animateResizeTime)
Default time for performing an animated resize. |
void |
setAnimateScrollAcceleration(AnimationAcceleration animateScrollAcceleration)
Default acceleration function for performing an animated scroll. |
void |
setAnimateScrollTime(java.lang.Integer animateScrollTime)
Default time for performing an animated scroll. |
void |
setAnimateShowAcceleration(AnimationAcceleration animateShowAcceleration)
Default acceleration function for performing an animated show. |
void |
setAnimateShowTime(java.lang.Integer animateShowTime)
Default time for performing an animated show. |
void |
setAnimateTime(int animateTime)
Default total duration of animations. |
void |
setAppImgDir(java.lang.String appImgDir)
Default directory for app-specific images, relative to the Page-wide Page.getAppImgDir() . |
void |
setAutoHeight()
|
void |
setAutoShowParent(java.lang.Boolean autoShowParent)
If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown. |
void |
setAutoWidth()
|
void |
setBackgroundColor(java.lang.String backgroundColor)
The background color for this widget. |
void |
setBackgroundImage(java.lang.String backgroundImage)
URL for a background image for this widget (corresponding to the CSS "background-image" attribute). |
void |
setBackgroundPosition(java.lang.String backgroundPosition)
Specifies how the background image should be positioned on the widget. It corresponds to the CSS background-position attribute. |
void |
setBackgroundRepeat(BkgndRepeat backgroundRepeat)
Specifies how the background image should be tiled if this widget is larger than the image. |
void |
setBorder(java.lang.String border)
Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid blue"). |
void |
setBottom(int bottom)
Resizes the widget vertically to position its bottom edge at the specified coordinate. |
void |
setCanAcceptDrop(java.lang.Boolean canAcceptDrop)
Indicates that this object can receive dropped widgets (i.e. |
void |
setCanDrag(java.lang.Boolean canDrag)
Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize). |
void |
setCanDragReposition(java.lang.Boolean canDragReposition)
Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse. |
void |
setCanDragResize(java.lang.Boolean canDragResize)
Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse. |
void |
setCanDragScroll(java.lang.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(). |
void |
setCanDrop(java.lang.Boolean canDrop)
Indicates that this object can be dropped on top of other widgets. |
void |
setCanDropBefore(java.lang.Boolean canDropBefore)
When explicitly set to false, disallows drop before this member in the Layout. |
void |
setCanFocus(java.lang.Boolean canFocus)
Can this widget be allowed to become the target of keyboard events? |
void |
setCanHover(java.lang.Boolean canHover)
Will this Canvas fire hover events when the user hovers over it, or one of its children? |
void |
setCanSelectText(java.lang.Boolean canSelectText)
Whether native drag selection of contained text is allowed within this Canvas. |
void |
setChildren(Canvas... children)
Array of all Canvii that are immediate children of this Canvas. |
void |
setChildrenSnapResizeToGrid(java.lang.Boolean childrenSnapResizeToGrid)
If true, causes this canvas's children to snap to its grid when resizing. This behavior can be overridden on a per-child basis by setting the snapToGrid or
snapResizeToGrid value on the child. |
void |
setChildrenSnapToGrid(java.lang.Boolean childrenSnapToGrid)
If true, causes this canvas's children to snap to its grid when dragging. This behavior can be overridden on a per-child basis by setting the snapToGrid value on the child. |
void |
setContents(java.lang.String contents)
The contents of a canvas or label widget. |
void |
setContextMenu(Menu contextMenu)
Context menu to show for this object, an instance of the Menu widget. |
void |
setCursor(Cursor cursor)
Specifies the cursor image to display when the mouse pointer is over this widget. |
void |
setDefaultHeight(int defaultHeight)
For custom components, establishes a default height for the component. |
void |
setDefaultWidth(int defaultWidth)
For custom components, establishes a default width for the component. |
void |
setDisabled(java.lang.Boolean disabled)
If set to true, the widget will be disabled. |
void |
setDisabledCursor(Cursor disabledCursor)
Specifies the cursor image to display when the mouse pointer is over this widget if this widget is disabled. |
void |
setDoubleClickDelay(int doubleClickDelay)
Amount of time (in msec) between which two clicks are considered a single click |
void |
setDragAppearance(DragAppearance dragAppearance)
Visual appearance to show when the object is being dragged. |
void |
setDragIntersectStyle(DragIntersectStyle dragIntersectStyle)
This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection with the rectangle of the dragMoveTarget. |
void |
setDragOpacity(java.lang.Integer dragOpacity)
If this widget has dragAppearance "target" , this value specifies the
opacity to render the target while it is being dragged. |
void |
setDragRepositionCursor(Cursor dragRepositionCursor)
Cursor to switch to if the mouse is over a widget that is drag repositionable. |
void |
setDragScrollDelay(int dragScrollDelay)
If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the drag-scroll threshold before scrolling begins. |
void |
setDragStartDistance(int dragStartDistance)
Number of pixels the cursor needs to move before the EventHandler starts a drag operation. |
void |
setDragTarget(Canvas dragTarget)
A different widget that should be actually dragged when dragging initiates on this widget. |
void |
setDragType(java.lang.String dragType)
The "type" of thing given as a string that can be dragged from this widget. |
void |
setDropTypes(java.lang.String... dropTypes)
The "type" of thing(s) that can be dropped on this widget specified as a string or an array of strings (indicating multiple types). |
void |
setDynamicContents(java.lang.Boolean dynamicContents)
Dynamic contents allows the contents string to be treated as a simple, but powerful template. |
void |
setEdgeBackgroundColor(java.lang.String edgeBackgroundColor)
Background color for the EdgedCanvas created to decorate this component. |
void |
setEdgeCenterBackgroundColor(java.lang.String edgeCenterBackgroundColor)
Background color for the center section only. |
void |
setEdgeImage(java.lang.String edgeImage)
Base name of images for edges. |
void |
setEdgeMarginSize(int edgeMarginSize)
|
void |
setEdgeOffset(java.lang.Integer edgeOffset)
Amount the contained Canvas should be offset. |
void |
setEdgeOpacity(java.lang.Integer edgeOpacity)
Opacity of the edges. |
void |
setEdgeShowCenter(java.lang.Boolean edgeShowCenter)
Whether to show media in the center section, that is, behind the decorated Canvas. |
void |
setEdgeSize(int edgeSize)
Size in pixels for corners and edges |
void |
setExtraSpace(int extraSpace)
When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a Layout. |
void |
setGroupTitle(java.lang.String groupTitle)
Set the groupTitle. |
void |
setHeight(int height)
Size for this component's vertical dimension. |
void |
setHeight(java.lang.String height)
|
void |
setHeight100()
Convenience method that sets the height to 100%. |
void |
setHoverAlign(Alignment hoverAlign)
If this.showHover is true, this property can be used to customize the
alignment of content in the hover canvas. |
void |
setHoverDelay(int hoverDelay)
If this.canHover is true, how long should the mouse be kept over this
widget before the hover event is fired |
void |
setHoverHeight(java.lang.Integer hoverHeight)
If this.showHover is true, this property can be used to customize the
height of the hover canvas shown. |
void |
setHoverMoveWithMouse(java.lang.Boolean hoverMoveWithMouse)
If this.showHover is true, should this widget's hover canvas be moved with
the mouse while visible? |
void |
setHoverOpacity(java.lang.Integer hoverOpacity)
If this.showHover is true, should the hover canvas be shown with opacity
other than 100? |
void |
setHoverStyle(java.lang.String hoverStyle)
If this.showHover is true, this property can be used to specify the
css style to apply to the hover canvas. |
void |
setHoverVAlign(VerticalAlignment hoverVAlign)
If this.showHover is true, this property can be used to customize the
vertical alignment of content in the hover canvas. |
void |
setHoverWidth(java.lang.Integer hoverWidth)
If showHover is true, this property can be used to customize the
width of the hover canvas shown. |
void |
setHoverWrap(java.lang.Boolean hoverWrap)
If this.showHover is true, this property can be used to customize the
whether content in the hover canvas is displayed in a single line, or wraps. |
void |
setHtmlPosition(DrawPosition htmlPosition)
If htmlElement is specified, this attribute specifies the position where
the canvas should be inserted relative to the htmlElement in the DOM. |
void |
setImage(java.lang.String identifier,
java.lang.String URL)
Set the URL of an image element by name. |
void |
setImage(java.lang.String identifier,
java.lang.String URL,
java.lang.String imgDir)
Set the URL of an image element by name. |
void |
setIsGroup(java.lang.Boolean isGroup)
Set the isGroup. |
void |
setKeepInParentRect(java.lang.Boolean keepInParentRect)
|
void |
setKeepInParentRect(Rectangle rectangle)
|
void |
setLayoutAlign(Alignment layoutAlign)
When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout. |
void |
setLayoutAlign(VerticalAlignment layoutAlign)
When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout. |
void |
setLeft(int left)
Number of pixels the left side of the widget is offset to the right from its default drawing context (either its parent's topleft corner, or the document flow, depending on the value of the position property). |
void |
setMargin(java.lang.Integer margin)
Set the CSS Margin, in pixels, for this component. |
void |
setMatchElement(java.lang.Boolean matchElement)
If htmlElement is specified, should this canvas initially be drawn
at the same dimensions as the htmlElement?Note: setting this property will not force the canvas to resize if the element subsequently resizes (for example due to page reflow). |
void |
setMaxHeight(int maxHeight)
Maximum height that this Canvas can be resized to. |
void |
setMaxWidth(int maxWidth)
Maximum width that this Canvas can be resized to. |
void |
setMinHeight(int minHeight)
Minimum height that this Canvas can be resized to. |
void |
setMinWidth(int minWidth)
Minimum width that this Canvas can be resized to. |
void |
setMouseStillDownDelay(int mouseStillDownDelay)
Amount of time (in msec) between 'mouseStillDown' events for this object |
void |
setMouseStillDownInitialDelay(int mouseStillDownInitialDelay)
Amount of time (in msec) before mouseStillDown events start to be fired for this object. |
void |
setNoDoubleClicks(java.lang.Boolean noDoubleClicks)
If true, this canvas will recieve all mouse-clicks as single click events rather than doubleClicks. |
void |
setOpacity(java.lang.Integer opacity)
Renders the widget to be partly transparent. |
void |
setOverflow(Overflow overflow)
Controls what happens when the drawn size of the content of a Canvas is either greater or smaller than the specified size of the Canvas. |
void |
setPadding(java.lang.Integer padding)
Set the CSS padding of this component, in pixels. |
void |
setPageLeft(int left)
Set the page-relative left coordinate of this widget. |
void |
setPageTop(int top)
Set the page-relative top coordinate of this widget. |
void |
setParentElement(Canvas parentElement)
This Canvas's immediate parent, if any. |
void |
setPercentBox(PercentBoxModel percentBox)
Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a specified snapTo .
|
void |
setPosition(Positioning position)
Absolute or relative, corresponding to the "absolute" (with respect to parent) or "relative" (with respect to document flow) values for the CSS position attribute. |
void |
setPrefix(java.lang.String prefix)
|
void |
setPrompt(java.lang.String prompt)
Prompt displayed in hover canvas if showHover is true. |
void |
setRect(int left,
int top,
int width,
int height)
Set all four coordinates, relative to the enclosing context, at once. |
void |
setRect(Rectangle rectangle)
Set all four coordinates, relative to the enclosing context, at once. |
void |
setRedrawOnResize(java.lang.Boolean redrawOnResize)
Should this element be redrawn in response to a resize? |
void |
setResizeBarTarget(java.lang.String resizeBarTarget)
When this Canvas is included as a member in a Layout, and showResizeBar is set to
true so that a resizeBar is created, resizeBarTarget:"next" can be
set to indicate that the resizeBar should resize the next member of the layout rather than
this one. |
void |
setResizeFrom(java.lang.String... resizeFrom)
|
void |
setRight(int right)
Resizes the widget horizontally to position its right side at the specified coordinate. |
void |
setScrollbarSize(int scrollbarSize)
How thick should we make the scrollbars for this canvas. NOTE: has no effect if showCustomScrollbars is false. |
void |
setShadowDepth(int shadowDepth)
Depth of the shadow, or the virtual height above the page of the widget throwing the shadow. |
void |
setShadowImage(java.lang.String shadowImage)
Base name of the series of images for the sides, corners, and center of the shadow. |
void |
setShadowOffset(java.lang.Integer shadowOffset)
Offset of the shadow. |
void |
setShadowSoftness(java.lang.Integer shadowSoftness)
Softness, or degree of blurring, of the shadow. |
void |
setShowCustomScrollbars(java.lang.Boolean showCustomScrollbars)
Whether to use the browser's native scrollbars or SmartGWT-based scrollbars. |
void |
setShowDragShadow(java.lang.Boolean showDragShadow)
When this widget is dragged, if its dragAppearance is "target" , should
we show a shadow behind the canvas during the drag. |
void |
setShowEdges(java.lang.Boolean showEdges)
Whether an EdgedCanvas should be used to show image-based edges around this
component. |
void |
setShowHover(java.lang.Boolean showHover)
If this.canHover is true, should we show the global hover canvas by default
when the user hovers over this canvas? |
void |
setShowResizeBar(java.lang.Boolean showResizeBar)
When this Canvas is included as a member in a Layout, whether a resizeBar should be shown after this member in the layout, to allow it to be resized. |
void |
setShowShadow(java.lang.Boolean showShadow)
Whether to show a drop shadow for this Canvas Method to update showShadow .
|
void |
setSkinImgDir(java.lang.String skinImgDir)
Default directory for skin images (those defined by the class), relative to the Page-wide Page.getSkinDir() . |
void |
setSmoothFade(java.lang.Boolean smoothFade)
|
void |
setSnapAxis(java.lang.String snapAxis)
Describes which axes to apply snap-to-grid to. Valid values are Canvas.HORIZONTAL, Canvas.VERTICAL and Canvas.BOTH |
void |
setSnapEdge(java.lang.String snapEdge)
If snapTo is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent
element.
|
void |
setSnapHDirection(java.lang.String snapHDirection)
The horizontal snap direction. Set this value to Canvas.BEFORE to snap to the nearest gridpoint to the left; set it to Canvas.AFTER to snap to the nearest gridpoint to the right; and set it to Canvas.NEAREST to snap to the nearest gridpoint in either direction. |
void |
setSnapHGap(int snapHGap)
The horizontal grid size to use, in pixels, when snap-to-grid is enabled. |
void |
setSnapOffsetLeft(java.lang.Integer snapOffsetLeft)
If snapTo is defined for this widget, this property can be used to
specify an offset in px or percentage for the left coordinate of this widget.
|
void |
setSnapOffsetTop(java.lang.Integer snapOffsetTop)
If snapTo is defined for this widget, this property can be used to
specify an offset in px or percentage for the top coordinate of this widget.
|
void |
setSnapOnDrop(java.lang.Boolean snapOnDrop)
When this canvas is dropped onto an object supporting snap-to-grid, should it snap to the grid (true, the default) or just drop wherever the mouse is (false). |
void |
setSnapResizeToGrid(java.lang.Boolean snapResizeToGrid)
Causes this canvas to snap to its parent's grid when resizing. Note that this value defaults to the Canvas's snapToGrid value if undefined. |
void |
setSnapTo(java.lang.String snapTo)
Position this widget such that it is aligned with ("snapped to") an edge of its masterElement (if specified), or its
parentElement .
|
void |
setSnapToGrid(java.lang.Boolean snapToGrid)
Causes this canvas to snap to its parent's grid when dragging. |
void |
setSnapVDirection(java.lang.String snapVDirection)
The vertical snap direction. Set this value to Canvas.BEFORE to snap to the nearest gridpoint above; set it to Canvas.AFTER to snap to the nearest gridpoint below; and set it to Canvas.NEAREST to snap to the nearest gridpoint in either direction. |
void |
setSnapVGap(int snapVGap)
The vertical grid size to use, in pixels, when snap-to-grid is enabled. |
void |
setStyleName(java.lang.String styleName)
The CSS class applied to this widget as a whole. |
void |
setTabIndex(java.lang.Integer tabIndex)
If specified this governs the tabIndex of the widget in the page's tab order. Note that by default SmartGWT auto-assigns tab-indices, ensuring focusable widgets are reachable by tabbing in the order in which they are drawn on the page. canvas.tabIndex cannot be set to greater than
com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR - as we reserve the values above this range for
auto-assigned tab-indices. |
void |
setTitle(java.lang.String title)
Synonmy for setPrompt(String) |
void |
setTooltip(java.lang.String tooltip)
Synonmy for setPrompt(String) |
void |
setTop(int top)
Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left corner, or the document flow, depending on the value of the position property). |
void |
setVisibility(Visibility visibility)
Controls widget visibility when the widget is initialized. |
void |
setVisible(boolean visible)
|
void |
setWidth(int width)
Size for this component's horizontal dimension. |
void |
setWidth(java.lang.String width)
Size for this component's horizontal dimension. |
void |
setWidth100()
Convenience method that sets the width to 100%. |
void |
setZIndex(int newIndex)
Set the z-Index of the canvas. |
void |
shouldDragScroll()
If this widget is showing scrollbars, and a user drags close to the edge of the viewport, should we scroll the viewport in the appropriate direction? Returns this.canDragScroll by default. |
void |
show()
Sets this widget's visibility to "inherit", so that it becomes visible if all it's parents are visible or it has no parents. |
void |
showNextTo(Canvas otherWidget)
Show this widget next to another widget. |
void |
showNextTo(Canvas otherWidget,
java.lang.String side)
Show this widget next to another widget. |
static void |
showPrintPreview(Canvas component)
Show a PrintWindow containing a printable view of the components passed in components to get the print HTML for. |
void |
updateHover()
If this canvas is currently showing a hover (see handleHover() ), this method
can be called to update the contents of the hover. |
void |
updateHover(java.lang.String hoverHTML)
If this canvas is currently showing a hover (see handleHover() ), this method
can be called to update the contents of the hover. |
void |
updateShadow()
Update teh canvas shadow. |
java.lang.Boolean |
visibleAtPoint(int x,
int y)
Does this widget contain the specified global (x,y) coordinates, and have no other widgets also at the specified position, obscuring this one? This is commonly used for (for example) drag and drop interactions. |
java.lang.Boolean |
visibleAtPoint(int x,
int y,
boolean withinViewport,
Canvas ignoreWidgets)
Does this widget contain the specified global (x,y) coordinates, and have no other widgets also at the specified position, obscuring this one? This is commonly used for (for example) drag and drop interactions. |
java.lang.Boolean |
willAcceptDrop()
Returns true if the widget object being dragged can be dropped on this widget, and false otherwise. |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent |
Methods inherited from class com.google.gwt.user.client.ui.UIObject |
---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents |
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 |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Constructor Detail |
---|
public Canvas()
public Canvas(com.google.gwt.core.client.JavaScriptObject jsObj)
public Canvas(java.lang.String id)
Method Detail |
---|
public static Canvas getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
protected com.google.gwt.core.client.JavaScriptObject create()
create
in class BaseWidget
public void setAnimateTime(int animateTime)
duration
parameter into the appropriate
animate...() method.
Note : This is an advanced setting
animateTime
- animateTime Default value is 300public int getAnimateTime()
duration
parameter into the appropriate
animate...() method.
public void setAnimateAcceleration(AnimationEffect animateAcceleration)
Note : This is an advanced setting
animateAcceleration
- animateAcceleration Default value is "smoothEnd"public AnimationEffect getAnimateAcceleration()
public void setAnimateMoveTime(java.lang.Integer animateMoveTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateMoveTime
- animateMoveTime Default value is nullpublic java.lang.Integer getAnimateMoveTime()
this.animateTime
will be used by default instead
public void setAnimateResizeTime(java.lang.Integer animateResizeTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateResizeTime
- animateResizeTime Default value is nullpublic java.lang.Integer getAnimateResizeTime()
this.animateTime
will be used by default instead
public void setAnimateRectTime(java.lang.Integer animateRectTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateRectTime
- animateRectTime Default value is nullpublic java.lang.Integer getAnimateRectTime()
this.animateTime
will be used by default instead
public void setAnimateFadeTime(java.lang.Integer animateFadeTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateFadeTime
- animateFadeTime Default value is nullpublic java.lang.Integer getAnimateFadeTime()
this.animateTime
will be used by default instead
public void setAnimateScrollTime(java.lang.Integer animateScrollTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateScrollTime
- animateScrollTime Default value is nullpublic java.lang.Integer getAnimateScrollTime()
this.animateTime
will be used by default instead
public void setAnimateShowTime(java.lang.Integer animateShowTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateShowTime
- animateShowTime Default value is nullpublic java.lang.Integer getAnimateShowTime()
this.animateTime
will be used by default instead
public void setAnimateHideTime(java.lang.Integer animateHideTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateHideTime
- animateHideTime Default value is nullpublic java.lang.Integer getAnimateHideTime()
this.animateTime
will be used by default instead
public void setAnimateMoveAcceleration(AnimationAcceleration animateMoveAcceleration)
this.animateAcceleration
will be used by default instead
Note : This is an advanced setting
animateMoveAcceleration
- animateMoveAcceleration Default value is nullpublic AnimationAcceleration getAnimateMoveAcceleration()
this.animateAcceleration
will be used by default instead
public void setAnimateResizeAcceleration(AnimationAcceleration animateResizeAcceleration)
this.animateAcceleration
will be used by default instead
Note : This is an advanced setting
animateResizeAcceleration
- animateResizeAcceleration Default value is nullpublic AnimationAcceleration getAnimateResizeAcceleration()
this.animateAcceleration
will be used by default instead
public void setAnimateRectAcceleration(AnimationAcceleration animateRectAcceleration)
this.animateAcceleration
will be used by default instead
Note : This is an advanced setting
animateRectAcceleration
- animateRectAcceleration Default value is nullpublic AnimationAcceleration getAnimateRectAcceleration()
this.animateAcceleration
will be used by default instead
public void setAnimateScrollAcceleration(AnimationAcceleration animateScrollAcceleration)
this.animateAcceleration
will be used by default instead
Note : This is an advanced setting
animateScrollAcceleration
- animateScrollAcceleration Default value is nullpublic AnimationAcceleration getAnimateScrollAcceleration()
this.animateAcceleration
will be used by default instead
public void setAnimateShowAcceleration(AnimationAcceleration animateShowAcceleration)
this.animateAcceleration
will be used by default instead
Note : This is an advanced setting
animateShowAcceleration
- animateShowAcceleration Default value is nullpublic AnimationAcceleration getAnimateShowAcceleration()
this.animateAcceleration
will be used by default instead
public void setAnimateHideAcceleration(AnimationAcceleration animateHideAcceleration)
this.animateAcceleration
will be used by default instead
Note : This is an advanced setting
animateHideAcceleration
- animateHideAcceleration Default value is nullpublic AnimationAcceleration getAnimateHideAcceleration()
this.animateAcceleration
will be used by default instead
public void setShowResizeBar(java.lang.Boolean showResizeBar) throws java.lang.IllegalStateException
By default the resize bar acts on the Canvas that it is declared on. If you want the resize
bar to instead act on the next member of the Layout (e.g. to collapse down or to the right),
set resizeBarTarget
as well.
When this Canvas is included as a member in a Layout, dynamically updates whether a
resizeBar should be shown after this member in the layout, to allow it to be resized.
showResizeBar
- setting for this.showResizeBar. Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowResizeBar()
By default the resize bar acts on the Canvas that it is declared on. If you want the resize
bar to instead act on the next member of the Layout (e.g. to collapse down or to the right),
set resizeBarTarget
as well.
public void setResizeBarTarget(java.lang.String resizeBarTarget) throws java.lang.IllegalStateException
showResizeBar
is set to
true
so that a resizeBar is created, resizeBarTarget:"next"
can be
set to indicate that the resizeBar should resize the next member of the layout rather than
this one. For resizeBars that support hiding their target member when clicked on,
resizeBarTarget:"next"
also means that the next member will be the one hidden.
This is typically used to create a 3-way split pane, where left and right-hand sections can be resized or hidden to allow a center section to expand.
NOTE: as with any Layout, to ensure all available space is used, one or more members must maintain a flexible size (eg 75%, or *). In a two pane Layout with a normal resize bar, to fill all space after a user resizes, the member on the right should have flexible size. With resizeBarTarget:"next", the member on the left should have flexible size.
resizeBarTarget
- resizeBarTarget Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getResizeBarTarget()
showResizeBar
is set to
true
so that a resizeBar is created, resizeBarTarget:"next"
can be
set to indicate that the resizeBar should resize the next member of the layout rather than
this one. For resizeBars that support hiding their target member when clicked on,
resizeBarTarget:"next"
also means that the next member will be the one hidden.
This is typically used to create a 3-way split pane, where left and right-hand sections can be resized or hidden to allow a center section to expand.
NOTE: as with any Layout, to ensure all available space is used, one or more members must maintain a flexible size (eg 75%, or *). In a two pane Layout with a normal resize bar, to fill all space after a user resizes, the member on the right should have flexible size. With resizeBarTarget:"next", the member on the left should have flexible size.
public void setExtraSpace(int extraSpace) throws java.lang.IllegalStateException
extraSpace
- extraSpace Default value is 0
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getExtraSpace()
public void setHtmlPosition(DrawPosition htmlPosition)
htmlElement
is specified, this attribute specifies the position where
the canvas should be inserted relative to the htmlElement
in the DOM.
Setter for the htmlPosition
.
Note : This is an advanced setting
htmlPosition
- New htmlPosition for this canvas. Default value is "afterBegin"public DrawPosition getHtmlPosition()
htmlElement
is specified, this attribute specifies the position where
the canvas should be inserted relative to the htmlElement
in the DOM.
public void setMatchElement(java.lang.Boolean matchElement)
htmlElement
is specified, should this canvas initially be drawn
at the same dimensions as the htmlElement?Note : This is an advanced setting
matchElement
- matchElement Default value is nullpublic java.lang.Boolean getMatchElement()
htmlElement
is specified, should this canvas initially be drawn
at the same dimensions as the htmlElement?
public void setPosition(Positioning position)
Setting position:"relative"
enables SmartGWT components to be embedded
directly into the native HTML flow of a page, causing the component to be rendered
within an existing DOM structure.
This attribute should only be set to "relative"
on a top level component
(a component with no parentElement
).
There are 2 ways to embed relatively positioned canvases in the DOM - by default the
component will be written out inline when it gets BaseWidget.draw()
. For example
to embed a canvas in an HTML table you could use this code:
<table> <tr> <td> <script> isc.Canvas.create({autoDraw:true, backgroundColor:"red", position:"relative"}); </script> <td> </tr> </table>Alternatively you can make use of the
htmlElement
attribute.
Relative positioning is intended as a short-term integration scenario while incrementally
upgrading existing applications.
Note that relative positioning is not used to manage layout within SmartGWT components -
instead the Layout
class would typically be used.
For best consistency and flexibility across browsers, all SmartGWT layout managers
use absolute positioning.
For canvases with a specified htmlElement
, this attribute defaults to
"relative"
. In all other cases the default value will be
"aboslute"
.
Note : This is an advanced setting
position
- position Default value is nullpublic Positioning getPosition()
Setting position:"relative"
enables SmartGWT components to be embedded
directly into the native HTML flow of a page, causing the component to be rendered
within an existing DOM structure.
This attribute should only be set to "relative"
on a top level component
(a component with no parentElement
).
There are 2 ways to embed relatively positioned canvases in the DOM - by default the
component will be written out inline when it gets BaseWidget.draw()
. For example
to embed a canvas in an HTML table you could use this code:
<table> <tr> <td> <script> isc.Canvas.create({autoDraw:true, backgroundColor:"red", position:"relative"}); </script> <td> </tr> </table>Alternatively you can make use of the
htmlElement
attribute.
Relative positioning is intended as a short-term integration scenario while incrementally
upgrading existing applications.
Note that relative positioning is not used to manage layout within SmartGWT components -
instead the Layout
class would typically be used.
For best consistency and flexibility across browsers, all SmartGWT layout managers
use absolute positioning.
For canvases with a specified htmlElement
, this attribute defaults to
"relative"
. In all other cases the default value will be
"aboslute"
.
public void setLeft(int left)
position
property).
Set the left coordinate of this object, relative to its enclosing context, in pixels.
NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo()
instead
left
- new left coordinate. Default value is 0public int getLeft()
position
property).
public void setTop(int top)
position
property).
Set the top coordinate of this object, relative to its enclosing context, in pixels.
NOTE: if you're setting multiple coordinates, use setRect() or moveTo() instead
top
- new top coordinate. Default value is 0public int getTop()
position
property).
public void setDefaultWidth(int defaultWidth)
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
defaultWidth
- defaultWidth Default value is 100public int getDefaultWidth()
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.
public void setDefaultHeight(int defaultHeight)
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
defaultHeight
- defaultHeight Default value is 100public int getDefaultHeight()
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.
public void setMinWidth(int minWidth)
Note that a Canvas with overflow:"visible" has an implicit minimize size based on it's contents.
Note : This is an advanced setting
minWidth
- minWidth Default value is 10public int getMinWidth()
Note that a Canvas with overflow:"visible" has an implicit minimize size based on it's contents.
public void setMaxWidth(int maxWidth)
Note : This is an advanced setting
maxWidth
- maxWidth Default value is 10000public int getMaxWidth()
public void setMinHeight(int minHeight)
Note that a Canvas with overflow:"visible" has an implicit minimize size based on it's contents.
Note : This is an advanced setting
minHeight
- minHeight Default value is 10public int getMinHeight()
Note that a Canvas with overflow:"visible" has an implicit minimize size based on it's contents.
public void setMaxHeight(int maxHeight)
Note : This is an advanced setting
maxHeight
- maxHeight Default value is 10000public int getMaxHeight()
public void setAutoShowParent(java.lang.Boolean autoShowParent)
Note : This is an advanced setting
autoShowParent
- autoShowParent Default value is falsepublic java.lang.Boolean getAutoShowParent()
public void setVisibility(Visibility visibility)
If the widget has not yet been drawn (and doesn't have a parent or master), this method calls the draw method as well.
visibility
- visibility Default value is Canvas.INHERITpublic Visibility getVisibility()
NOTE: Undrawn widgets will report themselves as visible if they would be visible if drawn.
public void setCanSelectText(java.lang.Boolean canSelectText)
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
canSelectText
- canSelectText Default value is falsepublic java.lang.Boolean getCanSelectText()
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.
public void setStyleName(java.lang.String styleName)
setStyleName
in class com.google.gwt.user.client.ui.UIObject
styleName
- new CSS class name (must be defined previously). Default value is "normal"public java.lang.String getStyleName()
getStyleName
in class com.google.gwt.user.client.ui.UIObject
public void setContents(java.lang.String contents)
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
contents
- an HTML string to be set as the contents of this widget. Default value is " "public java.lang.String getContents()
public void setDynamicContents(java.lang.Boolean dynamicContents)
You can use this feature to build some simple custom components. For example, let's say you want to show the value of a Slider in a Canvas somewhere on the screen. You can do this by observing the valueChanged() method on the slider and calling setContents() on your canvas with the new string or you can set the contents of the canvas to something like:
"The slider value is \${sliderInstance.getValue()}."
Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider and call canvas.markForRedraw() in that observation. This approach is cleaner than setContents() when the Canvas is aggregating several values or dynamic expressions. Like so:
Slider.create({ ID: "mySlider" }); Canvas.create({ ID: "myCanvas", dynamicContents: true, contents: "The slider value is \${mySlider.getValue()}." }); myCanvas.observe(mySlider, "valueChanged", "observer.markForRedraw()");You can embed an arbitrary number of dynamic expressions in the contents string. The search and replace is optimized for speed.
If an error occurs during the evaluation of one of the expressions, a warning is logged to the ISC Developer Console and the error string is embedded in place of the expected value in the Canvas.
The value of a function is its return value. The value of any variable is the same as that returned by its toString() representation.
Inside the evalution contentext, this
points to the canvas instance that
has the dynamicContents string as its contents - in other words the canvas instance on
which the template is declared.
Note : This is an advanced setting
dynamicContents
- dynamicContents Default value is falsepublic java.lang.Boolean getDynamicContents()
You can use this feature to build some simple custom components. For example, let's say you want to show the value of a Slider in a Canvas somewhere on the screen. You can do this by observing the valueChanged() method on the slider and calling setContents() on your canvas with the new string or you can set the contents of the canvas to something like:
"The slider value is \${sliderInstance.getValue()}."
Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider and call canvas.markForRedraw() in that observation. This approach is cleaner than setContents() when the Canvas is aggregating several values or dynamic expressions. Like so:
Slider.create({ ID: "mySlider" }); Canvas.create({ ID: "myCanvas", dynamicContents: true, contents: "The slider value is \${mySlider.getValue()}." }); myCanvas.observe(mySlider, "valueChanged", "observer.markForRedraw()");You can embed an arbitrary number of dynamic expressions in the contents string. The search and replace is optimized for speed.
If an error occurs during the evaluation of one of the expressions, a warning is logged to the ISC Developer Console and the error string is embedded in place of the expected value in the Canvas.
The value of a function is its return value. The value of any variable is the same as that returned by its toString() representation.
Inside the evalution contentext, this
points to the canvas instance that
has the dynamicContents string as its contents - in other words the canvas instance on
which the template is declared.
public void setMargin(java.lang.Integer margin)
This property sets the same thickness of margin on every side. Differing per-side
margins can be set in a CSS style and applied via styleName
.
Note that the specified size of the widget will be the size including the margin thickness on each side. Set the CSS Margin, in pixels, for this component. Margin provides blank space outside of the border.
This property sets the same thickness of margin on every side. Differing per-side
margins can be set in a CSS style and applied via styleName
.
Note that the specified size of the widget will be the size including the margin thickness on each side.
margin
- new margin in pixels. Default value is nullpublic java.lang.Integer getMargin()
This property sets the same thickness of margin on every side. Differing per-side
margins can be set in a CSS style and applied via styleName
.
Note that the specified size of the widget will be the size including the margin thickness on each side.
public void setPadding(java.lang.Integer padding)
This property sets the same thickness of padding on every side. Differing per-side
padding can be set in a CSS style and applied via styleName
.
Note that CSS padding does not affect the placement of children
. To
provide a blank area around children, either use margin
or use
a Layout
as the parent instead, and use properties such as
layoutMargin
to create blank space.
Set the CSS padding of this component, in pixels. Padding provides space between the border
and the component's contents.
This property sets the same thickness of padding on every side. Differing per-side
padding can be set in a CSS style and applied via styleName
.
padding
- new padding in pixels. Default value is nullpublic java.lang.Integer getPadding()
This property sets the same thickness of padding on every side. Differing per-side
padding can be set in a CSS style and applied via styleName
.
Note that CSS padding does not affect the placement of children
. To
provide a blank area around children, either use margin
or use
a Layout
as the parent instead, and use properties such as
layoutMargin
to create blank space.
public void setBorder(java.lang.String border)
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
.
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
.
border
- new border to set to (eg: "2px solid black"). Default value is nullpublic java.lang.String getBorder()
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
.
public void setBackgroundImage(java.lang.String backgroundImage) throws java.lang.IllegalStateException
backgroundImage
- new URL (local to Page image directory) for background image. Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getBackgroundImage()
public void setBackgroundRepeat(BkgndRepeat backgroundRepeat)
backgroundRepeat
- backgroundRepeat Default value is Canvas.REPEATpublic BkgndRepeat getBackgroundRepeat()
public void setBackgroundPosition(java.lang.String backgroundPosition)
backgroundPosition
- backgroundPosition Default value is nullpublic java.lang.String getBackgroundPosition()
public void setAppImgDir(java.lang.String appImgDir)
Page.getAppImgDir()
.
Note : This is an advanced setting
appImgDir
- appImgDir Default value is ""public java.lang.String getAppImgDir()
Page.getAppImgDir()
.
public void setSkinImgDir(java.lang.String skinImgDir)
Page.getSkinDir()
.
Note : This is an advanced setting
skinImgDir
- skinImgDir Default value is "images/"public java.lang.String getSkinImgDir()
Page.getSkinDir()
.
public void setCursor(Cursor cursor)
Note : This is an advanced setting
cursor
- new cursor. Default value is Canvas.DEFAULTpublic Cursor getCursor()
public void setDisabledCursor(Cursor disabledCursor)
Note : This is an advanced setting
disabledCursor
- disabledCursor Default value is Canvas.DEFAULTpublic Cursor getDisabledCursor()
public void setOpacity(java.lang.Integer opacity)
Note : This is an advanced setting
opacity
- new opacity level. Default value is nullpublic java.lang.Integer getOpacity()
public void setOverflow(Overflow overflow)
overflow
of a Canvas after it has been created.
overflow
- New overflow value.. Default value is Canvas.VISIBLEpublic Overflow getOverflow()
public void setShowCustomScrollbars(java.lang.Boolean showCustomScrollbars)
SmartGWT-based scrollbars are skinnable, giving you complete control over look and
feel. SmartGWT-based scrollbars also enable some interactions not possible with
native scrollbars, such as fixedRecordHeights
in grids in combination with dataPageSize
.
Native browser scrollbars are slightly faster simply because there are less SmartGWT components that need to be created, drawn and updated. Each visible SmartGWT-based scrollbar on the screen has roughly the impact of two StretchImgButtons.
SmartGWT is always aware of the size of the scrollbar, regardless of whether native
or custom scrollbars are used, and regardless of what operating system and/or operating
system "theme" or "skin" is in use. This means SmartGWT will correctly report the
getViewportHeight()
, that is, the interior area of the
widget excluding space taken by scrollbars, which is key for exactly filling a component
with content without creating unnecessary scrolling.
The showCustomScrollbars
setting is typically overridden in load_skin.js in
order to change the default for all SmartGWT components at once, like so:
isc.Canvas.addProperties({ showCustomScrollbars:false });
Note : This is an advanced setting
showCustomScrollbars
- showCustomScrollbars Default value is truepublic java.lang.Boolean getShowCustomScrollbars()
SmartGWT-based scrollbars are skinnable, giving you complete control over look and
feel. SmartGWT-based scrollbars also enable some interactions not possible with
native scrollbars, such as fixedRecordHeights
in grids in combination with dataPageSize
.
Native browser scrollbars are slightly faster simply because there are less SmartGWT components that need to be created, drawn and updated. Each visible SmartGWT-based scrollbar on the screen has roughly the impact of two StretchImgButtons.
SmartGWT is always aware of the size of the scrollbar, regardless of whether native
or custom scrollbars are used, and regardless of what operating system and/or operating
system "theme" or "skin" is in use. This means SmartGWT will correctly report the
getViewportHeight()
, that is, the interior area of the
widget excluding space taken by scrollbars, which is key for exactly filling a component
with content without creating unnecessary scrolling.
The showCustomScrollbars
setting is typically overridden in load_skin.js in
order to change the default for all SmartGWT components at once, like so:
isc.Canvas.addProperties({ showCustomScrollbars:false });
public void setScrollbarSize(int scrollbarSize)
Note : This is an advanced setting
scrollbarSize
- scrollbarSize Default value is 16public int getScrollbarSize()
this.scrollbarSize
public void setDisabled(java.lang.Boolean disabled)
Note : This is an advanced setting
disabled
- new disabled state of this object - pass true
to disable the widget. Default value is falsepublic java.lang.Boolean getDisabled()
public void setRedrawOnResize(java.lang.Boolean redrawOnResize)
Should be set to true for components whose BaseWidget.getInnerHTML()
will not
automatically reflow to fit the component's new size.
Note : This is an advanced setting
redrawOnResize
- redrawOnResize Default value is truepublic java.lang.Boolean getRedrawOnResize()
Should be set to true for components whose BaseWidget.getInnerHTML()
will not
automatically reflow to fit the component's new size.
public void setCanFocus(java.lang.Boolean canFocus)
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. Change whether a widget can accept keyboard focus.
Note : This is an advanced setting
canFocus
- whether the widget should now accept focus. Default value is nullpublic java.lang.Boolean getCanFocus()
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.
public void setTabIndex(java.lang.Integer tabIndex)
canvas.tabIndex
cannot be set to greater than
com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR
- as we reserve the values above this range for
auto-assigned tab-indices.
Assign an explicit tabIndex to this widget.
Note : This is an advanced setting
tabIndex
- New tabIndex for this widget. Must be less than com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR
to avoid interfering with auto-assigned
tab indices on the page.. Default value is nullpublic java.lang.Integer getTabIndex()
canvas.tabIndex
cannot be set to greater than
com.smartgwt.client.widgets.Canvas#TAB_INDEX_FLOOR
- as we reserve the values above this range for
auto-assigned tab-indices.
public void setAccessKey(java.lang.String accessKey)
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
accessKey
- Character to use as an accessKey for this widget. Case Insensitive.. Default value is nullpublic java.lang.String getAccessKey()
public void setContextMenu(Menu contextMenu)
Note : This is an advanced setting
contextMenu
- contextMenu Default value is nullpublic Menu getContextMenu()
public void setPrompt(java.lang.String prompt)
showHover
is true.
prompt
- prompt Default value is nullpublic java.lang.String getPrompt()
showHover
is true.
public void setCanDrag(java.lang.Boolean canDrag)
Note : This is an advanced setting
canDrag
- canDrag Default value is falsepublic java.lang.Boolean getCanDrag()
public void setDragStartDistance(int dragStartDistance)
Note : This is an advanced setting
dragStartDistance
- dragStartDistance Default value is 5public int getDragStartDistance()
public void setCanDragScroll(java.lang.Boolean canDragScroll)
Note : This is an advanced setting
canDragScroll
- canDragScroll Default value is truepublic java.lang.Boolean getCanDragScroll()
public void setDragScrollDelay(int dragScrollDelay)
Note : This is an advanced setting
dragScrollDelay
- dragScrollDelay Default value is 100public int getDragScrollDelay()
public void setDragIntersectStyle(DragIntersectStyle dragIntersectStyle)
Note : This is an advanced setting
dragIntersectStyle
- dragIntersectStyle Default value is "mouse"public DragIntersectStyle getDragIntersectStyle()
public void setCanDragReposition(java.lang.Boolean canDragReposition)
Note : This is an advanced setting
canDragReposition
- canDragReposition Default value is falsepublic java.lang.Boolean getCanDragReposition()
public void setDragRepositionCursor(Cursor dragRepositionCursor)
Note : This is an advanced setting
dragRepositionCursor
- dragRepositionCursor Default value is Canvas.MOVEpublic Cursor getDragRepositionCursor()
public void setCanDragResize(java.lang.Boolean canDragResize)
Note : This is an advanced setting
canDragResize
- canDragResize Default value is falsepublic java.lang.Boolean getCanDragResize()
public void setCanHover(java.lang.Boolean canHover)
canHover
- canHover Default value is nullpublic java.lang.Boolean getCanHover()
public void setHoverDelay(int hoverDelay)
this.canHover
is true, how long should the mouse be kept over this
widget before the hover event is fired
hoverDelay
- hoverDelay Default value is 300public int getHoverDelay()
this.canHover
is true, how long should the mouse be kept over this
widget before the hover event is fired
public void setShowHover(java.lang.Boolean showHover)
this.canHover
is true, should we show the global hover canvas by default
when the user hovers over this canvas?
showHover
- showHover Default value is truepublic java.lang.Boolean getShowHover()
this.canHover
is true, should we show the global hover canvas by default
when the user hovers over this canvas?
public void setHoverWidth(java.lang.Integer hoverWidth)
showHover
is true, this property can be used to customize the
width of the hover canvas shown.
hoverWidth
- hoverWidth Default value is nullpublic java.lang.Integer getHoverWidth()
showHover
is true, this property can be used to customize the
width of the hover canvas shown.
public void setHoverHeight(java.lang.Integer hoverHeight)
this.showHover
is true, this property can be used to customize the
height of the hover canvas shown.
hoverHeight
- hoverHeight Default value is nullpublic java.lang.Integer getHoverHeight()
this.showHover
is true, this property can be used to customize the
height of the hover canvas shown.
public void setHoverAlign(Alignment hoverAlign)
this.showHover
is true, this property can be used to customize the
alignment of content in the hover canvas.
hoverAlign
- hoverAlign Default value is nullpublic Alignment getHoverAlign()
this.showHover
is true, this property can be used to customize the
alignment of content in the hover canvas.
public void setHoverVAlign(VerticalAlignment hoverVAlign)
this.showHover
is true, this property can be used to customize the
vertical alignment of content in the hover canvas.
hoverVAlign
- hoverVAlign Default value is nullpublic VerticalAlignment getHoverVAlign()
this.showHover
is true, this property can be used to customize the
vertical alignment of content in the hover canvas.
public void setHoverWrap(java.lang.Boolean hoverWrap)
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.
hoverWrap
- hoverWrap Default value is nullpublic java.lang.Boolean getHoverWrap()
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.
public void setHoverStyle(java.lang.String hoverStyle)
this.showHover
is true, this property can be used to specify the
css style to apply to the hover canvas.
hoverStyle
- hoverStyle Default value is nullpublic java.lang.String getHoverStyle()
this.showHover
is true, this property can be used to specify the
css style to apply to the hover canvas.
public void setHoverOpacity(java.lang.Integer hoverOpacity)
this.showHover
is true, should the hover canvas be shown with opacity
other than 100?
hoverOpacity
- hoverOpacity Default value is nullpublic java.lang.Integer getHoverOpacity()
this.showHover
is true, should the hover canvas be shown with opacity
other than 100?
public void setHoverMoveWithMouse(java.lang.Boolean hoverMoveWithMouse)
this.showHover
is true, should this widget's hover canvas be moved with
the mouse while visible?
hoverMoveWithMouse
- hoverMoveWithMouse Default value is nullpublic java.lang.Boolean getHoverMoveWithMouse()
this.showHover
is true, should this widget's hover canvas be moved with
the mouse while visible?
public void setDragAppearance(DragAppearance dragAppearance)
Note : This is an advanced setting
dragAppearance
- dragAppearance Default value is EventHandler.OUTLINEpublic DragAppearance getDragAppearance()
public void setDragType(java.lang.String dragType)
Note : This is an advanced setting
dragType
- dragType Default value is nullpublic java.lang.String getDragType()
public void setShowDragShadow(java.lang.Boolean showDragShadow)
"target"
, should
we show a shadow behind the canvas during the drag.
Note : This is an advanced setting
showDragShadow
- showDragShadow Default value is nullpublic java.lang.Boolean getShowDragShadow()
"target"
, should
we show a shadow behind the canvas during the drag.
public void setDragOpacity(java.lang.Integer dragOpacity)
"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
dragOpacity
- dragOpacity Default value is nullpublic java.lang.Integer getDragOpacity()
"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.
public void setCanDrop(java.lang.Boolean canDrop)
Note : This is an advanced setting
canDrop
- canDrop Default value is falsepublic java.lang.Boolean getCanDrop()
public void setCanAcceptDrop(java.lang.Boolean canAcceptDrop)
Note : This is an advanced setting
canAcceptDrop
- canAcceptDrop Default value is falsepublic java.lang.Boolean getCanAcceptDrop()
public void setCanDropBefore(java.lang.Boolean canDropBefore)
Note : This is an advanced setting
canDropBefore
- canDropBefore Default value is nullpublic java.lang.Boolean getCanDropBefore()
public void setMouseStillDownInitialDelay(int mouseStillDownInitialDelay)
Note : This is an advanced setting
mouseStillDownInitialDelay
- mouseStillDownInitialDelay Default value is 400public int getMouseStillDownInitialDelay()
public void setMouseStillDownDelay(int mouseStillDownDelay)
Note : This is an advanced setting
mouseStillDownDelay
- mouseStillDownDelay Default value is 100public int getMouseStillDownDelay()
public void setDoubleClickDelay(int doubleClickDelay)
Note : This is an advanced setting
doubleClickDelay
- doubleClickDelay Default value is 250public int getDoubleClickDelay()
public void setNoDoubleClicks(java.lang.Boolean noDoubleClicks)
Note : This is an advanced setting
noDoubleClicks
- noDoubleClicks Default value is nullpublic java.lang.Boolean getNoDoubleClicks()
public void setPercentBox(PercentBoxModel percentBox) throws java.lang.IllegalStateException
snapTo
.
Only affects widgets with a a specified percentSource
, or
widgets that have snapTo
set and are peers of some
masterElement
.
Determines whether the coordinates used for sizing (for percentage sized widgets) and
positioning (if snapTo
is set) should be relative to the visible size or the
viewport size of the percentSource or masterElement widget.
Note : This is an advanced setting
percentBox
- percentBox Default value is "visible"
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic PercentBoxModel getPercentBox()
snapTo
.
Only affects widgets with a a specified percentSource
, or
widgets that have snapTo
set and are peers of some
masterElement
.
Determines whether the coordinates used for sizing (for percentage sized widgets) and
positioning (if snapTo
is set) should be relative to the visible size or the
viewport size of the percentSource or masterElement widget.
public void setSnapTo(java.lang.String snapTo)
masterElement
(if specified), or its
parentElement
.
Note that this property also impacts the sizing of this widget. If this widgets size
is specifed as a percent value, and has no explicit
percentSource
, sizing will be calculated based on the size of the
masterElement when snapTo is set.
Possible values: BR, BL, TR, TL, R, L, B, T, C where B=Bottom, T=Top, L=Left, R=right and C=center Set the snapTo property of this canvas, and handle repositioning.
snapTo
- new snapTo value. Default value is nullpublic java.lang.String getSnapTo()
masterElement
(if specified), or its
parentElement
.
Note that this property also impacts the sizing of this widget. If this widgets size
is specifed as a percent value, and has no explicit
percentSource
, sizing will be calculated based on the size of the
masterElement when snapTo is set.
Possible values: BR, BL, TR, TL, R, L, B, T, C where B=Bottom, T=Top, L=Left, R=right and C=center
public void setSnapEdge(java.lang.String snapEdge)
snapTo
is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent
element.
If unspecified the, default snapTo behavior is set up to align the "snapTo" edge of this widget with the snapTo edge of the master or parent. Set the snapEdge property of this canvas, and handle repositioning.
snapEdge
- new snapEdge value. Default value is nullpublic java.lang.String getSnapEdge()
snapTo
is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent
element.
If unspecified the, default snapTo behavior is set up to align the "snapTo" edge of this widget with the snapTo edge of the master or parent.
public void setSnapOffsetLeft(java.lang.Integer snapOffsetLeft)
snapTo
is defined for this widget, this property can be used to
specify an offset in px or percentage for the left coordinate of this widget.
For example if snapTo
is specifed as "L"
and
snapOffsetLeft
is set to 6, this widget will be rendered 6px inside the left
edge of its parent or master element.
snapOffsetLeft
- snapOffsetLeft Default value is nullpublic java.lang.Integer getSnapOffsetLeft()
snapTo
is defined for this widget, this property can be used to
specify an offset in px or percentage for the left coordinate of this widget.
For example if snapTo
is specifed as "L"
and
snapOffsetLeft
is set to 6, this widget will be rendered 6px inside the left
edge of its parent or master element.
public void setSnapOffsetTop(java.lang.Integer snapOffsetTop)
snapTo
is defined for this widget, this property can be used to
specify an offset in px or percentage for the top coordinate of this widget.
For example if snapTo
is specifed as "T"
and
snapOffsetTop
is set to 6, this widget will be rendered 6px below the top
edge of its parent or master element.
snapOffsetTop
- snapOffsetTop Default value is nullpublic java.lang.Integer getSnapOffsetTop()
snapTo
is defined for this widget, this property can be used to
specify an offset in px or percentage for the top coordinate of this widget.
For example if snapTo
is specifed as "T"
and
snapOffsetTop
is set to 6, this widget will be rendered 6px below the top
edge of its parent or master element.
public void setSnapToGrid(java.lang.Boolean snapToGrid)
snapToGrid
- snapToGrid Default value is nullpublic java.lang.Boolean getSnapToGrid()
public void setSnapResizeToGrid(java.lang.Boolean snapResizeToGrid)
snapToGrid
value if undefined.
snapResizeToGrid
- snapResizeToGrid Default value is nullpublic java.lang.Boolean getSnapResizeToGrid()
snapToGrid
value if undefined.
public void setChildrenSnapToGrid(java.lang.Boolean childrenSnapToGrid)
snapToGrid
value on the child.
childrenSnapToGrid
- childrenSnapToGrid Default value is nullpublic java.lang.Boolean getChildrenSnapToGrid()
snapToGrid
value on the child.
public void setChildrenSnapResizeToGrid(java.lang.Boolean childrenSnapResizeToGrid)
snapToGrid
or
snapResizeToGrid
value on the child.
childrenSnapResizeToGrid
- childrenSnapResizeToGrid Default value is nullpublic java.lang.Boolean getChildrenSnapResizeToGrid()
snapToGrid
or
snapResizeToGrid
value on the child.
public void setSnapHGap(int snapHGap)
snapHGap
- snapHGap Default value is 20public int getSnapHGap()
public void setSnapVGap(int snapVGap)
snapVGap
- snapVGap Default value is 20public int getSnapVGap()
public void setSnapHDirection(java.lang.String snapHDirection)
snapHDirection
- snapHDirection Default value is Canvas.AFTERpublic java.lang.String getSnapHDirection()
public void setSnapVDirection(java.lang.String snapVDirection)
snapVDirection
- snapVDirection Default value is Canvas.AFTERpublic java.lang.String getSnapVDirection()
public void setSnapAxis(java.lang.String snapAxis)
snapAxis
- snapAxis Default value is Canvas.BOTHpublic java.lang.String getSnapAxis()
public void setSnapOnDrop(java.lang.Boolean snapOnDrop)
Note : This is an advanced setting
snapOnDrop
- snapOnDrop Default value is truepublic java.lang.Boolean getSnapOnDrop()
public java.lang.Boolean getDestroyed() throws java.lang.IllegalStateException
true
, the BaseWidget.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.
java.lang.IllegalStateException
- if widget has not yet been rendered.public java.lang.Boolean getDestroying() throws java.lang.IllegalStateException
BaseWidget.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.
java.lang.IllegalStateException
- if widget has not yet been rendered.public void setShowEdges(java.lang.Boolean showEdges) throws java.lang.IllegalStateException
EdgedCanvas
should be used to show image-based edges around this
component.
showEdges
- showEdges Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowEdges()
EdgedCanvas
should be used to show image-based edges around this
component.
public void setEdgeSize(int edgeSize) throws java.lang.IllegalStateException
edgeSize
- edgeSize Default value is 10
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getEdgeSize()
public void setEdgeOffset(java.lang.Integer edgeOffset) throws java.lang.IllegalStateException
edgeOffset
- edgeOffset Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getEdgeOffset()
public void setEdgeImage(java.lang.String edgeImage) throws java.lang.IllegalStateException
The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".
edgeImage
- edgeImage Default value is "[SKIN]edge.gif"
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getEdgeImage()
The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".
public void setEdgeBackgroundColor(java.lang.String edgeBackgroundColor) throws java.lang.IllegalStateException
edgeBackgroundColor
- edgeBackgroundColor Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getEdgeBackgroundColor()
public void setEdgeOpacity(java.lang.Integer edgeOpacity) throws java.lang.IllegalStateException
setOpacity(java.lang.Integer)
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)
Set the edgeOpacity
and mark the canvas for redraw
edgeOpacity
- new edge-opacity level. Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getEdgeOpacity()
setOpacity(java.lang.Integer)
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)
public void setEdgeShowCenter(java.lang.Boolean edgeShowCenter) throws java.lang.IllegalStateException
edgeShowCenter
- edgeShowCenter Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getEdgeShowCenter()
public void setEdgeCenterBackgroundColor(java.lang.String edgeCenterBackgroundColor) throws java.lang.IllegalStateException
edgeCenterBackgroundColor
- edgeCenterBackgroundColor Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getEdgeCenterBackgroundColor()
public void setShowShadow(java.lang.Boolean showShadow) throws java.lang.IllegalStateException
showShadow
.
showShadow
- true if the shadow should be visible false if not. Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowShadow()
public void setShadowDepth(int shadowDepth) throws java.lang.IllegalStateException
This is a single parameter that can be used to control both shadowSoftness
and
shadowOffset
.
shadowDepth
- shadowDepth Default value is 4
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getShadowDepth()
This is a single parameter that can be used to control both shadowSoftness
and
shadowOffset
.
public void setShadowImage(java.lang.String shadowImage) throws java.lang.IllegalStateException
The actual image names fetched for the dropShadow combine the segment name and the
shadowDepth
setting. For example, given "ds.png" as the base name, a depth of
4, and the top-left segment of the shadow, we'd use "ds4_TL.png".
The names for segments are the same as those given for controlling resizable edges; see
resizeFrom
. The center segment has the name "center". The center segment is
the only segment that doesn't include the depth in the URL, so the final image name for the
center given a baseName of "ds.png" would be just "ds_center.png".
Note : This is an advanced setting
shadowImage
- shadowImage Default value is "[SKIN]ds.png"
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getShadowImage()
The actual image names fetched for the dropShadow combine the segment name and the
shadowDepth
setting. For example, given "ds.png" as the base name, a depth of
4, and the top-left segment of the shadow, we'd use "ds4_TL.png".
The names for segments are the same as those given for controlling resizable edges; see
resizeFrom
. The center segment has the name "center". The center segment is
the only segment that doesn't include the depth in the URL, so the final image name for the
center given a baseName of "ds.png" would be just "ds_center.png".
public java.lang.Boolean isDrawn()
isDrawn
in class BaseWidget
public java.lang.Boolean isDirty()
markForRedraw()
has been called, but this canvas has not yet been
redrawn.
public void markForRedraw()
markForRedraw()
instead of calling redraw()
directly. Since this method queues the redraw, multiple
calls to markForRedraw() within a single thread of excecution will only lead to a single DOM
manipulation which greatly improves application performance.
public void markForRedraw(java.lang.String reason)
markForRedraw()
instead of calling redraw()
directly. Since this method queues the redraw, multiple
calls to markForRedraw() within a single thread of excecution will only lead to a single DOM
manipulation which greatly improves application performance.
reason
- reason for performing the redrawpublic void redraw()
public void redraw(java.lang.String reason)
reason
- reason for performing the redrawpublic void clear()
This is far more expensive than hide(), because in order to become visible again, the Canvas must be draw()n again. Generally, application code has no reason to call clear(); if you want to temporarily hide a Canvas, use hide() and show(), and if you want to permanently destroy a Canvas, use destroy().
Note: a clear() will happen as part of moving a Canvas to a different parent. See addChild().
public void markForDestroy()
BaseWidget.destroy()
this canvas on a timeout. This method should be used instead of
calling canvas.destroy()
directly unless there's a reason a the canvas needs to be
destroyed synchronously. By using a timeout, this method ensures the destroy()
will
occur after the current thread of execution completes. This allows you to easily mark canvases
for destruction while they're handling events, which must complete before the canvas can be
destroyed.
public Canvas addChild(Canvas newChild)
If newChild has a parent it will be removed from it. If it has a master, it will be detached from it if the master is a child of a different parent. If newChild has peers, they'll be added to this widget as children as well.
newChild
- new child canvas to add
public Canvas addChild(Canvas newChild, java.lang.String name, boolean autoDraw)
If newChild has a parent it will be removed from it. If it has a master, it will be detached from it if the master is a child of a different parent. If newChild has peers, they'll be added to this widget as children as well.
newChild
- new child canvas to addname
- name to assign to child (eg: this[name] == child)autoDraw
- if false, child will not automatically be drawn (only for advanced use)
public Canvas addPeer(Canvas newPeer)
newPeer
- new peer widget to add
public Canvas addPeer(Canvas newPeer, java.lang.String name, boolean autoDraw, boolean preDraw)
newPeer
- new peer widget to addname
- name to assign to peer (eg: this[peer] == child)autoDraw
- if true, peer will not automatically be drawn (only for advanced use)preDraw
- if true, when draw is called on the master widget, the peer
will be drawn before the master
public java.lang.Boolean contains(Canvas canvas)
canvas
- the canvas to be tested
public java.lang.Boolean contains(Canvas canvas, boolean testSelf)
canvas
- the canvas to be testedtestSelf
- If passed this method will return true if the the canvas parameter is a pointer to this widget.
public void hideClickMask()
public void hideClickMask(java.lang.String ID)
ID
- optional ID of specific clickMask to hide. If not passed, defaults to hiding the click mask associated with this widget only.public void clickMaskUp()
public void clickMaskUp(java.lang.String ID)
ID
- optional ID of specific clickMask to check. If not passed, checks for the click mask associated with this widget only.public int getRight()
public void setRight(int right)
NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo() instead
right
- new right coordinatepublic int getBottom()
public void setBottom(int bottom)
NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo() instead
bottom
- new bottom coordinatepublic int getScrollWidth()
public int getScrollHeight()
public int getScrollLeft()
public int getScrollTop()
public void setPageLeft(int left)
left
- new left coordinate in pixelspublic void setPageTop(int top)
top
- new top coordinate in pixelspublic int getPageLeft()
public int getPageTop()
public int getPageRight()
public int getPageBottom()
public java.lang.Boolean containsPoint(int x, int y)
Will return false if any parentElement does not contain the specified point, (EG: you're hovering over an element's absolute location, but it is scrolled out of view in a parent element)
x
- GLOBAL x-coordinatey
- GLOBAL y-coordinate
public java.lang.Boolean containsPoint(int x, int y, boolean withinViewport)
Will return false if any parentElement does not contain the specified point, (EG: you're hovering over an element's absolute location, but it is scrolled out of view in a parent element)
x
- GLOBAL x-coordinatey
- GLOBAL y-coordinatewithinViewport
- point lies specificly within our viewport (drawn area excluding margins and scrollbars if
present)
public java.lang.Boolean visibleAtPoint(int x, int y)
x
- GLOBAL x-coordinatey
- GLOBAL y-coordinate
public java.lang.Boolean visibleAtPoint(int x, int y, boolean withinViewport, Canvas ignoreWidgets)
x
- GLOBAL x-coordinatey
- GLOBAL y-coordinatewithinViewport
- point lies within our viewport rather than just our drawn areaignoreWidgets
- If passed ignore widget(s), do not check whether those widgets occludes this one.
public java.lang.Boolean intersects(Canvas other)
other
- other canvas to test for intersection
public java.lang.Boolean containsEvent()
public int getOffsetX()
public int getOffsetY()
public int getViewportWidth()
public int getViewportHeight()
public int getInnerHeight()
public int getInnerWidth()
public int getInnerContentHeight()
public int getInnerContentWidth()
public int getVisibleWidth()
public int getVisibleHeight()
public java.lang.Boolean moveBy(int deltaX, int deltaY)
deltaX
- amount to move horizontally (may be negative)deltaY
- amount to move vertically (may be negative)
public int getVSnapOrigin()
public int getVSnapOrigin(Canvas snapChild)
snapChild
- the child that is being snapped
public int getHSnapOrigin()
public int getHSnapOrigin(Canvas snapChild)
snapChild
- the child that is being snapped
public void showNextTo(Canvas otherWidget)
otherWidget
- Canvas to show next topublic void showNextTo(Canvas otherWidget, java.lang.String side)
otherWidget
- Canvas to show next toside
- which side to show on, defaults to "right"public java.lang.Boolean resizeBy()
public java.lang.Boolean resizeBy(int deltaX, int deltaY)
deltaX
- amount to resize horizontally (may be negative)deltaY
- amount to resize vertically (may be negative)
public HandlerRegistration addResizedHandler(ResizedHandler handler)
Observable method called whenever a Canvas changes size. Note that if this canvas is
overflow
, and is waiting for a queued redraw (see
isDirty()
), the value for getVisibleWidth()
and
getVisibleHeight()
will be unreliable until redraw()
fires.
addResizedHandler
in interface HasResizedHandlers
handler
- the resized handler
HandlerRegistration
used to remove this handlerpublic void layoutChildren(java.lang.String reason)
layoutChildren()
is where a Canvas should implement a sizing policy for it's
Canvas children. Since layoutChildren
calls parentResized() on its children,
parentResized()
is a good place for a child to implement a layout policy that
can be used within any parent.
Recommended practice for a Canvas that manages Canvas children is to create those children without any initial coordinate or size settings and do all sizing when layoutChildren() is called.
layoutChildren() is always called at least once before children are drawn, and is called automatically whenever the viewport size changes (which includes both resizing and introduction/removal of scrolling). layoutChildren() can also be manually invoked in any other component-specific situation which changes the layout.
NOTE: layoutChildren() may be called before draw() if a widget is resized before draw(), so be sure to avoid errors such as assuming that any children you automatically create have already been created.
NOTE: auto-sizing: layoutChildren() is also called once during the initial draw(), before children are drawn, with a "reason" of "initial draw". During this invocation of layoutChildren() it is legal to directly draw children (call child.draw()), which is otherwise never allowed. This allows a Canvas to implement an auto-sizing layout policy by drawing some children before deciding on the sizes of remaining children, which is far more efficient than drawing all children and resizing some of them after they are drawn.
reason
- reason why layoutChildren() is being called, passed when framework code invokes layoutChildren()public java.lang.Boolean resizeTo()
public java.lang.Boolean resizeTo(int width, int height)
width
- new width for canvasheight
- new height for canvas
public void parentResized()
This method allows a child to implement a layout policy that can be used within any
parent, such as a Resizer component that always snaps to the parent's
bottom-right corner. The default implementation of this method applies a child's
percent sizes, if any, or implements layout based on the snapTo
property
public void shouldDragScroll()
public void adjustForContent(boolean immediate)
This is for very advanced use in which the contents of a Canvas are being directly updated by Ajax techniques, which is required for integration with some third-party libraries. Calling this method is required because browsers do not provide consistent events by which SmartGWT can be notified of external content changes.
Only contents supplied to a widget via contents
or via an override of
BaseWidget.getInnerHTML()
should be manipulated directly. Contents automatically
generated by SmartGWT components (such as the basic structure of a Button) should never be
manipulated: these structures are considered internal, differ by platform, and will change
without notice.
immediate
- By default the adjustment will occur on a small delay for performance reasons.
Pass in this parameter to force immediate adjustment.public void scrollToTop()
public void scrollToBottom()
public void scrollToLeft()
public void scrollToRight()
public void scrollBy(int dX, int dY)
dX
- Number of pixels to scroll horizontallydY
- Number of pixels to scroll verticallypublic void scrollTo()
This is guaranteed to be called whenever this Canvas is scrolled, whether scrolling is initiated programmatically, by custom scrollbars, or a by a native scrollbar.
public void scrollTo(int left, int top)
This is guaranteed to be called whenever this Canvas is scrolled, whether scrolling is initiated programmatically, by custom scrollbars, or a by a native scrollbar.
left
- the left coordinatetop
- the top coordiantepublic HandlerRegistration addScrolledHandler(ScrolledHandler handler)
Notification that this component has just scrolled. Use with
com.smartgwt.client..Class#observe
.
Fires for both CSS and Scrollbar
.
addScrolledHandler
in interface HasScrolledHandlers
handler
- the scrolled handler
HandlerRegistration
used to remove this handlerpublic void show()
If the widget has not yet been drawn (and doesn't have a parent or master), this method calls the draw method as well.
public void hide()
public void enable()
public void disable()
public java.lang.Boolean isDisabled()
public void focus()
public void blur()
public java.lang.Boolean containsFocus()
public void bringToFront()
public void sendToBack()
public void moveAbove(Canvas canvas)
canvas
- canvas to move abovepublic void moveBelow(Canvas canvas)
canvas
- canvas to move belowpublic void handleHover()
this.hover()
(if defined), and handle
showing the hover canvas if this.showHover
is true.
public void updateHover()
handleHover()
), this method
can be called to update the contents of the hover. Has no effect if the hover canvas is not
showing for this widget.
public void updateHover(java.lang.String hoverHTML)
handleHover()
), this method
can be called to update the contents of the hover. Has no effect if the hover canvas is not
showing for this widget.
hoverHTML
- Option to specify new HTML for the hover. If not passed, the result of getHoverHTML()
will be used instead. Note that if the
hover HTML is empty the hover will be hidden.public HandlerRegistration addHoverHiddenHandler(HoverHiddenHandler handler)
If showHover
is true for this canvas, this notification method will be
fired whenever the hover shown in response to handleHover()
is
hidden. This method may be observed or overridden.
addHoverHiddenHandler
in interface HasHoverHiddenHandlers
handler
- the hoverHidden handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addHoverHandler(HoverHandler handler)
If canHover
is true for this widget, the hover
string method will
be fired when the user hovers over this canvas. If this method returns false, it will
suppress the default behavior of showing a hover canvas if this.showHover
is true.
addHoverHandler
in interface HasHoverHandlers
handler
- the hover handler
HandlerRegistration
used to remove this handlerpublic void getHoverHTML()
this.showHover
is true, when the user holds the mouse over this Canvas for
long enough to trigger a hover event, a hover canvas is shown by default. This method returns
the contents of that hover canvas. Default implementation returns this.prompt
-
override for custom hover HTML. Note that returning null
or an empty string will
suppress the hover canvas altogether.
public HandlerRegistration addShowContextMenuHandler(ShowContextMenuHandler handler)
Executed when the right mouse button is clicked. The default implementation of
this method auto-creates a Menu
from the contextMenu
property on
this component and then calls Menu.showContextMenu()
on it to show it.
If you want to show a standard context menu, you can simply define your Menu and set it as the contextMenu property on your component - you do not need to override this method.
If you want to do some other processing before showing a menu or do something else entirely, then you should override this method. Note that the return value from this method controls whether or not the native browser context menu is shown.
addShowContextMenuHandler
in interface HasShowContextMenuHandlers
handler
- the showContextMenu handler
HandlerRegistration
used to remove this handlerpublic void hideContextMenu()
public HandlerRegistration addMouseOverHandler(MouseOverHandler handler)
Executed when mouse enters this widget. No default implementation.
addMouseOverHandler
in interface HasMouseOverHandlers
handler
- the mouseOver handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addMouseDownHandler(MouseDownHandler handler)
Executed when the left mouse down is pressed on this widget. No default implementation.
addMouseDownHandler
in interface HasMouseDownHandlers
handler
- the mouseDown handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addRightMouseDownHandler(RightMouseDownHandler handler)
Executed when the right mouse down is pressed on this widget. No default implementation.
addRightMouseDownHandler
in interface HasRightMouseDownHandlers
handler
- the rightMouseDown handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addMouseStillDownHandler(MouseStillDownHandler handler)
Executed repeatedly (every mouseStillDownDelay
by default) when the system is idle -
i.e. not busy running other scripts - and the left mouse button is held down after having been
pressed in the object. This event is not native to JavaScript, but is provided by the ISC system.
Note: The event handling system waits mouseStillDownInitialDelay
before
calling mouseStillDown for the first time on the widget. Subsequently the method is called every
mouseStillDownDelay
. Both attributes are configurable per widget instance.
This method is called only when the left mouse is held down.
addMouseStillDownHandler
in interface HasMouseStillDownHandlers
handler
- the mouseStillDown handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler)
Executed when the mouse moves within this widget. No default implementation.
addMouseMoveHandler
in interface HasMouseMoveHandlers
handler
- the mouseMove handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addMouseOutHandler(MouseOutHandler handler)
Executed when the mouse leaves this widget. No default implementation.
addMouseOutHandler
in interface HasMouseOutHandlers
handler
- the mouseOut handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addMouseUpHandler(MouseUpHandler handler)
Executed when the left mouse is released on this widget. No default implementation.
addMouseUpHandler
in interface HasMouseUpHandlers
handler
- the mouseUp handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addClickHandler(ClickHandler handler)
Executed when the left mouse is clicked (pressed and then released) on this widget. No default implementation.
addClickHandler
in interface HasClickHandlers
handler
- the click handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDoubleClickHandler(DoubleClickHandler handler)
Executed when the left mouse button is clicked twice in rapid succession (within
doubleClickDelay
by default) in this object.
addDoubleClickHandler
in interface HasDoubleClickHandlers
handler
- the doubleClick handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addMouseWheelHandler(MouseWheelHandler handler)
Executed when the mouse wheel is actuated.
addMouseWheelHandler
in interface HasMouseWheelHandlers
handler
- the mouseWheel handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragRepositionStartHandler(DragRepositionStartHandler handler)
Executed when dragging first starts. No default implementation. Create this handler to set things up for the drag reposition.
addDragRepositionStartHandler
in interface HasDragRepositionStartHandlers
handler
- the dragRepositionStart handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragRepositionMoveHandler(DragRepositionMoveHandler handler)
Executed every time the mouse moves while drag-repositioning. If this method
does not return false, the dragTarget
(or outline if
dragAppearance
is set to "outline" will automatically be moved as appropriate
whenever the mouse moves.
addDragRepositionMoveHandler
in interface HasDragRepositionMoveHandlers
handler
- the dragRepositionMove handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragRepositionStopHandler(DragRepositionStopHandler handler)
Executed when the mouse button is released at the end of the drag. Your widget can use this opportunity to fire custom code based upon where the mouse button was released, etc.
Returning true from this handler will cause the dragTarget
(or outline if
dragAppearance
is set to "outline") to be left in its current
location. Returning false from this handler will cause it to snap back to its
original location.
addDragRepositionStopHandler
in interface HasDragRepositionStopHandlers
handler
- the dragRepositionStop handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragResizeStartHandler(DragResizeStartHandler handler)
Executed when resize dragging first starts. No default implementation. Create this handler to set things up for the drag resize.
addDragResizeStartHandler
in interface HasDragResizeStartHandlers
handler
- the dragResizeStart handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragResizeMoveHandler(DragResizeMoveHandler handler)
Executed every time the mouse moves while drag-resizing. If this method
does not return false, the dragTarget
(or outline if
dragAppearance
is set to "outline" will automatically be moved as appropriate
whenever the mouse moves.
addDragResizeMoveHandler
in interface HasDragResizeMoveHandlers
handler
- the dragResizeMove handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragResizeStopHandler(DragResizeStopHandler handler)
Executed when the mouse button is released at the end of the drag resize. Your widget can use this opportunity to fire custom code based upon where the mouse button was released, etc.
Returning true from this handler will cause the dragTarget
(or outline if
dragAppearance
is set to "outline") to be left at its current size. Returning
false from this handler will cause it to snap back to its original location size
addDragResizeStopHandler
in interface HasDragResizeStopHandlers
handler
- the dragResizeStop handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragStartHandler(DragStartHandler handler)
Executed when dragging first starts. Your widget can use this opportunity to set things up for the drag, such as setting the drag tracker. Returning false from this event handler will cancel the drag action entirely.
A drag action is considered to be begin when the mouse has moved
dragStartDistance
with the left mouse down.
addDragStartHandler
in interface HasDragStartHandlers
handler
- the dragStart handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragMoveHandler(DragMoveHandler handler)
Executed every time the mouse moves while dragging this canvas.
addDragMoveHandler
in interface HasDragMoveHandlers
handler
- the dragMove handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDragStopHandler(DragStopHandler handler)
Executed when the mouse button is released at the end of the drag. Your widget can use this opportunity to fire code based on the last location of the drag or reset any visual state that was sent.
addDragStopHandler
in interface HasDragStopHandlers
handler
- the dragStop handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDropOverHandler(DropOverHandler handler)
Executed when the compatible dragged object is first moved over this drop target. Your implementation can use this to show a custom visual indication that the object can be dropped here.
addDropOverHandler
in interface HasDropOverHandlers
handler
- the dropOver handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDropMoveHandler(DropMoveHandler handler)
Executed whenever the compatible dragged object is moved over this drop target. You can use this to show a custom visual indication of where the drop would occur within the widget.
addDropMoveHandler
in interface HasDropMoveHandlers
handler
- the dropMove handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addDropOutHandler(DropOutHandler handler)
Executed when the dragged object is moved out of the rectangle of this drop target. If you have set a visual indication in dropOver or dropMove, you should reset it to its normal state in dropOut.
addDropOutHandler
in interface HasDropOutHandlers
handler
- the dropOut handler
HandlerRegistration
used to remove this handlerpublic HandlerRegistration addKeyDownHandler(KeyDownHandler handler)
Executed when a key is pressed on a focusable widget (canFocus
: true).
Use EventHandler.getKey()
to find out the com.smartgwt.client..KeyName
of the key that
was pressed, and use EventHandler.shiftKeyDown()
and related functions to determine
whether modifier keys were down.
addKeyDownHandler
in interface HasKeyDownHandlers
handler
- the keyDown handler
HandlerRegistration
used to remove this handlerpublic java.lang.Boolean keyUp()
canFocus
: true).
Use EventHandler.getKey()
to find out the com.smartgwt.client..KeyName
of the key that
was pressed, and use EventHandler.shiftKeyDown()
and related functions to determine
whether modifier keys were down.
public HandlerRegistration addKeyPressHandler(KeyPressHandler handler)
Executed when a key is pressed and released on a focusable widget (canFocus
:
true).
Use EventHandler.getKey()
to find out the com.smartgwt.client..KeyName
of the key that
was pressed, and use EventHandler.shiftKeyDown()
and related functions to determine
whether modifier keys were down.
addKeyPressHandler
in interface HasKeyPressHandlers
handler
- the keyPress handler
HandlerRegistration
used to remove this handlerpublic java.lang.Boolean willAcceptDrop()
dragType
of the dragTarget
(the component being dragged from)
with the list of dropTypes
on this Canvas. If the dropTypes
list contains the dragType
value, then this method returns true. Otherwise it
returns false.
public int getHSnapPosition(int coordinate)
snapHGap
and snapVGap
.
You should only override this method if you want to provide support for a grid of
irregularly-placed points
coordinate
- x-coordinate of the drag event relative to the inside of this widget
public int getHSnapPosition(int coordinate, java.lang.String direction)
snapHGap
and snapVGap
.
You should only override this method if you want to provide support for a grid of
irregularly-placed points
coordinate
- x-coordinate of the drag event relative to the inside of this widgetdirection
- "before" or "after" denoting whether the returned coordinate should match the left or right edge of the current square. If unset snapHDirection
will
be used by default
public int getVSnapPosition(int coordinate)
snapHGap
and snapVGap
.
You should only override this method if you want to provide support for a grid of
irregularly-placed points
coordinate
- y-coordinate of the drag event relative to the inside of this widget
public int getVSnapPosition(int coordinate, java.lang.String direction)
snapHGap
and snapVGap
.
You should only override this method if you want to provide support for a grid of
irregularly-placed points
coordinate
- y-coordinate of the drag event relative to the inside of this widgetdirection
- "before" or "after" denoting whether the returned coordinate should match the top or bottom edge of the current square. If unset snapHDirection
will
be used by default
public void setImage(java.lang.String identifier, java.lang.String URL)
The image element must have been created from HTML generated by calling
canvas.imgHTML()
on this particular Canvas.
identifier
- name of the image to change, as originally passed to imgHTML
URL
- URL for the imagepublic void setImage(java.lang.String identifier, java.lang.String URL, java.lang.String imgDir)
The image element must have been created from HTML generated by calling
canvas.imgHTML()
on this particular Canvas.
identifier
- name of the image to change, as originally passed to imgHTML
URL
- URL for the imageimgDir
- optional image directory, overrides the default for this Canvaspublic java.lang.String linkHTML(java.lang.String href)
href
- URL for the link to point to
public java.lang.String linkHTML(java.lang.String href, java.lang.String text, java.lang.String target, java.lang.String ID, int tabIndex, java.lang.String accessKey)
href
- URL for the link to point totext
- Text to for the link (defaults to the href)target
- Target window for the link (defaults to opening in a new, unnamed window)ID
- optional ID for the link element to be written outtabIndex
- optional tabIndex for the linkaccessKey
- optional accessKey for the link
public HandlerRegistration addFocusChangedHandler(FocusChangedHandler handler)
Notification function fired when this widget recieves or loses keyboard focus.
addFocusChangedHandler
in interface HasFocusChangedHandlers
handler
- the focusChanged handler
HandlerRegistration
used to remove this handlerpublic static Canvas getById(java.lang.String ID)
ID
.
ID
- global ID of the Canvas
public void addStyleName(java.lang.String style)
setStyleName(String)
addStyleName
in class com.google.gwt.user.client.ui.UIObject
style
- the style namesetStyleName(String)
public void setVisible(boolean visible)
setVisible
in class com.google.gwt.user.client.ui.UIObject
public void setHeight(int height)
Can be a number of pixels, or a percentage like "50%". See
documentation for width
for details on who percentage values
are resolved actual size.
Note that if overflow
is set
to "visible", this size is a minimum, and the component may overflow to show all content and/or children.
If
trying to establish a default height for a custom component, set defaultHeight
instead. Resizes the widget vertically to the specified height (moves the bottom side of the
widget). The height parameter can be expressed as a percentage of viewport size or as the number of pixels.
NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
height
- new height. Default value is nullpublic void setHeight100()
public void setWidth100()
public void setHeight(java.lang.String height)
setHeight
in class com.google.gwt.user.client.ui.UIObject
public java.lang.Integer getHeight()
public java.lang.String getHeightAsString()
public void setTitle(java.lang.String title)
setPrompt(String)
setTitle
in class BaseWidget
title
- the titlepublic java.lang.String getTitle()
getPrompt()
getTitle
in class BaseWidget
public void setTooltip(java.lang.String tooltip)
setPrompt(String)
tooltip
- the tooltippublic java.lang.String getTooltip()
getPrompt()
public void setWidth(int width)
Can be a number of pixels, or a percentage like "50%". Percentage sizes are resolved to pixel values as follows:
percentSource
, sizing will be a percentage of the size
of that widget (see also percentBox
).masterElement
, and
snapTo
is set for the widget, sizing will be a percentage
of the size of that widget (see also percentBox
).parentElement
's viewport. Layout
may specially interpret percentage sizes on their children, and also
allow "*" as a size.
Note that if overflow
is set to
"visible", this size is a minimum, and the component may overflow to show all content and/or children.
If
trying to establish a default width for a custom component, set defaultWidth
instead. Resizes the widget horizontally to the specified width (moves the right side of the
widget). The width parameter can be expressed as a percentage of viewport size or as the number of pixels.
NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
width
- new width. Default value is nullpublic void setWidth(java.lang.String width)
Can be a number of pixels, or a percentage like "50%". Percentage sizes are resolved to pixel values as follows:
percentSource
, sizing will be a percentage of the size
of that widget (see also percentBox
).masterElement
, and
snapTo
is set for the widget, sizing will be a percentage
of the size of that widget (see also percentBox
).parentElement
's viewport. Layout
may specially interpret percentage sizes on their children, and also
allow "*" as a size.
Note that if overflow
is set to
"visible", this size is a minimum, and the component may overflow to show all content and/or children.
If
trying to establish a default width for a custom component, set defaultWidth
instead. Resizes the widget horizontally to the specified width (moves the right side of the
widget). The width parameter can be expressed as a percentage of viewport size or as the number of pixels.
NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
setWidth
in class com.google.gwt.user.client.ui.UIObject
width
- new width. Default value is nullpublic java.lang.Integer getWidth()
public java.lang.String getWidthAsString()
public void setAlign(Alignment align)
public int getAbsoluteLeft()
getAbsoluteLeft
in class com.google.gwt.user.client.ui.UIObject
public int getAbsoluteTop()
getAbsoluteTop
in class com.google.gwt.user.client.ui.UIObject
public void setDragTarget(Canvas dragTarget)
null
(default) [this widget is its own drag target]"parent"
drag target is this widget's
parentElement
"top"
drag target is this widget's
topElement
Note : This is an advanced setting
dragTarget
- dragTarget Default value is nullpublic Canvas getDragTarget()
null
(default) [this widget is its own drag target]"parent"
drag target is this widget's
parentElement
"top"
drag target is this widget's
topElement
public void setShadowOffset(java.lang.Integer shadowOffset)
shadowDepth
if unset. Because of the blurred edges, a
shadow is larger than the originating component by 2xsoftness. An shadowOffset
of 0 means that the
shadow will extend around the originating component equally in all directions.
Note : This is an advanced setting
shadowOffset
- shadowOffset Default value is nullpublic java.lang.Integer getShadowOffset()
shadowDepth
if unset. Because of the blurred edges, a
shadow is larger than the originating component by 2xsoftness. An shadowOffset
of 0 means that the
shadow will extend around the originating component equally in all directions.
public void setShadowSoftness(java.lang.Integer shadowSoftness)
A shadow with softness:x
is 2x pixels larger in
each direction than the element throwing the shadow, and the media for each edge should be x pixels wide/tall.
Defaults to shadowDepth
if unset.
Note : This is an advanced setting
shadowSoftness
- shadowSoftness Default value is nullpublic java.lang.Integer getShadowSoftness()
A shadow with softness:x
is 2x pixels larger in
each direction than the element throwing the shadow, and the media for each edge should be x pixels wide/tall.
Defaults to shadowDepth
if unset.
public void setGroupTitle(java.lang.String groupTitle)
groupTitle
- the groupTitlepublic java.lang.String getGroupTitle()
public void setIsGroup(java.lang.Boolean isGroup)
isGroup
- the isGrouppublic java.lang.Boolean getIsGroup()
public void setSmoothFade(java.lang.Boolean smoothFade) throws java.lang.IllegalStateException
java.lang.IllegalStateException
public void setKeepInParentRect(java.lang.Boolean keepInParentRect)
public void setKeepInParentRect(Rectangle rectangle)
public void setPrefix(java.lang.String prefix)
public java.lang.String getPrefix()
public void setResizeFrom(java.lang.String... resizeFrom)
public void setEdgeMarginSize(int edgeMarginSize)
public void setLayoutAlign(Alignment layoutAlign) throws java.lang.IllegalStateException
layoutAlign
- layoutAlign Default valaue is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been renderedpublic void setLayoutAlign(VerticalAlignment layoutAlign) throws java.lang.IllegalStateException
layoutAlign
- layoutAlign Default valaue is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been renderedpublic void setDropTypes(java.lang.String... dropTypes)
Note : This is an advanced setting
dropTypes
- dropTypes Default value is Canvas.ANYTHINGpublic boolean moveTo(int left, int top)
left
- x-coordinate to move to in LOCAL coordinatestop
- y-coordinate to move to in LOCAL coordinates
public void scrollByPercent(int dX, int dY)
dX
- Percentage to scroll horizontally.dY
- Percentage to scroll vertically.public void scrollToPercent(int left, int top)
left
- left Percentage position to scroll totop
- top Percentage position to scroll topublic boolean isVisible()
NOTE: Undrawn widgets will report themselves as visible if they would be visible if drawn.
isVisible
in class com.google.gwt.user.client.ui.UIObject
public void animateMove(int left, int top)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)public void animateMove(int left, int top, AnimationCallback callback)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)callback
- When the move completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationpublic void animateMove(int left, int top, AnimationCallback callback, int duration)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)callback
- When the move completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationduration
- Duration in ms of the animated movepublic void animateMove(int left, int top, AnimationCallback callback, int duration, AnimationAcceleration acceleration)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)callback
- When the move completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationduration
- Duration in ms of the animated moveacceleration
- Optional acceleration effect to bias the ratiospublic void animateScroll(int scrollLeft, int scrollTop)
scrollLeft
- desired final left scroll postionscrollTop
- desired final top scroll postionpublic void animateScroll(int scrollLeft, int scrollTop, AnimationCallback callback)
scrollLeft
- desired final left scroll postionscrollTop
- desired final top scroll postioncallback
- When the scroll completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationpublic void animateScroll(int scrollLeft, int scrollTop, AnimationCallback callback, int duration)
scrollLeft
- desired final left scroll postionscrollTop
- desired final top scroll postioncallback
- When the scroll completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationduration
- Duration in ms of the animated scrollpublic void animateRect(int left, int top, int width, int height)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)width
- new width (or null for unchanged)height
- new height (or null for unchanged)public void animateRect(int left, int top, int width, int height, AnimationCallback callback)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)width
- new width (or null for unchanged)height
- new height (or null for unchanged)callback
- When the setRect completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationpublic void animateRect(int left, int top, int width, int height, AnimationCallback callback, int duration)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)width
- new width (or null for unchanged)height
- new height (or null for unchanged)callback
- When the setRect completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationduration
- Duration in ms of the animated setRectpublic void animateResize(int width, int height)
width
- new width (or null for unchanged)height
- new height (or null for unchanged)public void animateResize(int width, int height, AnimationCallback callback)
width
- new width (or null for unchanged)height
- new height (or null for unchanged)callback
- When the resize completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationpublic void animateResize(int width, int height, AnimationCallback callback, int duration)
width
- new width (or null for unchanged)height
- new height (or null for unchanged)callback
- When the resize completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationduration
- Duration in ms of the animated resizepublic void animateFade(int opacity)
opacity
- desired final opacitypublic void animateFade(int opacity, AnimationCallback callback)
opacity
- desired final opacitycallback
- When the fade completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationpublic void animateFade(int opacity, AnimationCallback callback, int duration)
opacity
- desired final opacitycallback
- When the fade completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimationduration
- Duration in ms of the animated fadepublic void animateHide(AnimationEffect effect)
"visible"
or "hidden"
.
effect
- How should the content of the window be hidden during the hide? If ommitted, default behavior can
be configured via animateHideEffect
public void animateHide(AnimationEffect effect, AnimationCallback callback)
"visible"
or "hidden"
.
effect
- How should the content of the window be hidden during the hide? If ommitted, default behavior
can be configured via animateHideEffect
callback
- When the hide completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimation.public void animateHide(AnimationEffect effect, AnimationCallback callback, int duration)
"visible"
or "hidden"
.
effect
- How should the content of the window be hidden during the hide? If ommitted, default behavior
can be configured via animateHideEffect
callback
- When the hide completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimation.duration
- Duration in ms of the animated hide. If unset, duration will be picked up from animateHideTime
public void animateShow(AnimationEffect effect)
"visible"
or
"hidden"
.
effect
- Animation effect to use when revealing the widget. If ommitted, default behavior can be
configured via animateShowEffect
public void animateShow(AnimationEffect effect, AnimationCallback callback)
"visible"
or
"hidden"
.
effect
- Animation effect to use when revealing the widget. If ommitted, default behavior can be
configured via animateShowEffect
callback
- When the show completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimation.public void animateShow(AnimationEffect effect, AnimationCallback callback, int duration)
"visible"
or
"hidden"
.
effect
- Animation effect to use when revealing the widget. If ommitted, default behavior can be
configured via animateShowEffect
callback
- When the show completes this callback will be fired. Single
'earlyFinish' parameter will be passed if the animation was cut
short by a call to finishAnimation.duration
- Duration in ms of the animated show. If unset, duration will be picked up from animateShowTime
public void updateShadow()
public int getZIndex()
public int getNextZIndex()
public void setZIndex(int newIndex)
newIndex
- the new zIndex to set topublic void setBackgroundColor(java.lang.String backgroundColor)
backgroundColor
- new color to set the widget's background to. Default value is nullpublic Rectangle getPageRect()
public void setRect(Rectangle rectangle)
Moves the widget so that its top-left corner is at the specified top-left coordinates, then resizes it to the specified width and height.
rectangle
- new coordinatespublic void setRect(int left, int top, int width, int height)
Moves the widget so that its top-left corner is at the specified top-left coordinates, then resizes it to the specified width and height.
left
- new left coordinate, Array of coordinates in
parameter order, or Object with left, top, width,
height properties. If an Array or Object is
passed, the remaining parameters are ignoredtop
- new top coordinatewidth
- new widthheight
- new heightpublic Rectangle getRect()
public static java.lang.String getImgURL(java.lang.String URL)
If the passed URL begins with the special prefix "[SKIN]", it will have the widget.skinImgDir and Page.skinImgDir prepended. Otherwise the image is assumed to be application-specific, and will have the widget.appImgDir and Page.appImgDir automatically prepended.
Note that if passed an absolute path (starting with "/" or "http://" for example), no extra image directory information will be prepended to the generated URL.//
URL
- URL local to skin or application image directory
public static java.lang.String getImgURL(java.lang.String URL, java.lang.String imgDir)
If the passed URL begins with the special prefix "[SKIN]", it will have the widget.skinImgDir and Page.skinImgDir prepended. Otherwise the image is assumed to be application-specific, and will have the widget.appImgDir and Page.appImgDir automatically prepended.
Note that if passed an absolute path (starting with "/" or "http://" for example), no extra image directory information will be prepended to the generated URL.//
URL
- URL local to skin or application image directoryimgDir
- optional image directory to override the default for this Canvas
public static java.lang.String imgHTML(java.lang.String src)
The full URL for the image will be formed
according to the rules documented for
. getImgURL(java.lang.String)
The created image will have an identifier unique to this Canvas, and subsequent calls to
and com.smartgwt.client.widgets.Canvas#getImage
with the name passed to this function will act on the image object produced by the HTML returned from this
call.
setImage(java.lang.String, java.lang.String)
src
- URL local to the skin or application directory.public static java.lang.String imgHTML(java.lang.String src, int width, int height, java.lang.String name, java.lang.String extraStuff, java.lang.String imgDir)
The full URL for the image will be formed
according to the rules documented for
. getImgURL(java.lang.String)
The created image will have an identifier unique to this Canvas, and subsequent calls to
and com.smartgwt.client.widgets.Canvas#getImage
with the name passed to this function will act on the image object produced by the HTML returned from this
call.
setImage(java.lang.String, java.lang.String)
src
- URL local to the skin or application directory.width
- width of the imageheight
- height of the imagename
- name for the imageextraStuff
- additional attributes to write in the tagimgDir
- image-specific image directory to override the default for
this Canvas
public static java.lang.String imgHTML(java.lang.String src, int width, int height)
public int getScrollBottom()
public int getScrollRight()
public static void showPrintPreview(Canvas component)
component
- public void setParentElement(Canvas parentElement) throws java.lang.IllegalStateException
addChild(com.smartgwt.client.widgets.Canvas)
and removeChild(com.smartgwt.client.widgets.Canvas)
calls on the parent. Note : This is an advanced setting
parentElement
- parentElement Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic Canvas getParentElement()
addChild(com.smartgwt.client.widgets.Canvas)
and removeChild(com.smartgwt.client.widgets.Canvas)
calls on the parent.
public void addChild(com.google.gwt.user.client.ui.Widget widget)
If newChild has a parent it will be removed from it. If it has a master, it will be detached from it if the master is a child of a different parent. If newChild has peers, they'll be added to this widget as children as well.
newChild
- new child canvas to addpublic void setChildren(Canvas... children)
Note : This is an advanced setting
children
- children Default value is nullpublic Canvas[] getChildren()
Note : This is an advanced setting
protected static Canvas[] convertToCanvasArray(com.google.gwt.core.client.JavaScriptObject nativeArray)
public void removeChild(Canvas child)
child
- Child canvas to remove from this parent.public void removeChild(Canvas child, java.lang.String name)
child
- Child canvas to remove from this parent.name
- If the child canvas was assigned a name, it should be passed in here to
ensure this[name] is clearedpublic int getOffsetHeight()
getOffsetHeight
in class com.google.gwt.user.client.ui.UIObject
public int getOffsetWidth()
getOffsetWidth
in class com.google.gwt.user.client.ui.UIObject
public void setAutoHeight()
public void setAutoWidth()
public HandlerRegistration addDropHandler(DropHandler handler)
Notification method fired when the user drops another canvas onto this one. Returning
false
from this method will prevent any default drop behavior from occurring
addDropHandler
in interface HasDropHandlers
handler
- the onDrop handler
HandlerRegistration
used to remove this handler
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |