public class Canvas extends BaseWidget implements HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasClearHandlers, HasDropHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers
FormItems
). Canvas provides:
draw()
and clear()
,
visibility via show()
and hide()
, z-layering via bringToFront()
and sendToBack()
. positioning
, sizing
and size
detection
, with automatic compensation for browser CSS behavior
differences
. overflow
key
and mouse
events, including mapping touch events
to mouse events moving
, resizing
, drag scrolling
and snap-to-grid
behavior. HTML content
or contain other Canvases
, including an edge-based positioning
and percent sizing system
for children. For more advanced layout
capabilities, see Layout
. cursors
, modal masking
, animation
, accessibility properties
, and settings
for automated testing
. config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
Canvas() |
Canvas(com.google.gwt.core.client.JavaScriptObject jsObj) |
Canvas(java.lang.String id) |
Modifier and Type | Method and Description |
---|---|
Canvas |
addChild(Canvas newChild)
Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if name
argument is provided, and draw the child if this widget has been drawn already.
|
Canvas |
addChild(Canvas newChild,
java.lang.String name) |
Canvas |
addChild(Canvas newChild,
java.lang.String name,
boolean autoDraw)
Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if name
argument is provided, and draw the child if this widget has been drawn already.
|
Canvas |
addChild(Canvas newChild,
java.lang.String name,
java.lang.Boolean autoDraw)
Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if name
argument is provided, and draw the child if this widget has been drawn already.
|
void |
addChild(com.google.gwt.user.client.ui.Widget widget)
Adds newChild as a child of this widget, set up a named object reference (i.e., this[name]) to the new widget if
name argument is provided, and draw the child if this widget has been drawn already.
|
com.google.gwt.event.shared.HandlerRegistration |
addClearHandler(ClearHandler handler)
Add a clear handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addClickHandler(ClickHandler handler)
Add a click handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDoubleClickHandler(DoubleClickHandler handler)
Add a doubleClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragMoveHandler(DragMoveHandler handler)
Add a dragMove handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragRepositionMoveHandler(DragRepositionMoveHandler handler)
Add a dragRepositionMove handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragRepositionStartHandler(DragRepositionStartHandler handler)
Add a dragRepositionStart handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragRepositionStopHandler(DragRepositionStopHandler handler)
Add a dragRepositionStop handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragResizeMoveHandler(DragResizeMoveHandler handler)
Add a dragResizeMove handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragResizeStartHandler(DragResizeStartHandler handler)
Add a dragResizeStart handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragResizeStopHandler(DragResizeStopHandler handler)
Add a dragResizeStop handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragStartHandler(DragStartHandler handler)
Add a dragStart handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDragStopHandler(DragStopHandler handler)
Add a dragStop handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDropHandler(DropHandler handler)
Add a drop handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDropMoveHandler(DropMoveHandler handler)
Add a dropMove handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDropOutHandler(DropOutHandler handler)
Add a dropOut handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addDropOverHandler(DropOverHandler handler)
Add a dropOver handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFocusChangedHandler(FocusChangedHandler handler)
Add a focusChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addHoverHandler(HoverHandler handler)
Add a hover handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addHoverHiddenHandler(HoverHiddenHandler handler)
Add a hoverHidden handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addKeyDownHandler(KeyDownHandler handler)
Add a keyDown handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addKeyPressHandler(KeyPressHandler handler)
Add a keyPress handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addMouseDownHandler(MouseDownHandler handler)
Add a mouseDown handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addMouseMoveHandler(MouseMoveHandler handler)
Add a mouseMove handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addMouseOutHandler(MouseOutHandler handler)
Add a mouseOut handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addMouseOverHandler(MouseOverHandler handler)
Add a mouseOver handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addMouseStillDownHandler(MouseStillDownHandler handler)
Add a mouseStillDown handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addMouseUpHandler(MouseUpHandler handler)
Add a mouseUp handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addMouseWheelHandler(MouseWheelHandler handler)
Add a mouseWheel handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addMovedHandler(MovedHandler handler)
Add a moved handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addParentMovedHandler(ParentMovedHandler handler)
Add a parentMoved handler.
|
Canvas |
addPeer(Canvas newPeer)
Adds newPeer as a peer of this widget (also making it a child of this widget's parent, if any), set up a named object
reference (i.e., this[name]) to the new widget if name is provided, and draw the peer if this widget has been drawn
already.
|
Canvas |
addPeer(Canvas newPeer,
java.lang.String name) |
Canvas |
addPeer(Canvas newPeer,
java.lang.String name,
java.lang.Boolean autoDraw) |
Canvas |
addPeer(Canvas newPeer,
java.lang.String name,
java.lang.Boolean autoDraw,
java.lang.Boolean preDraw)
Adds newPeer as a peer of this widget (also making it a child of this widget's parent, if any), set up a named object
reference (i.e., this[name]) to the new widget if name is provided, and draw the peer if this widget has been drawn
already.
|
com.google.gwt.event.shared.HandlerRegistration |
addResizedHandler(ResizedHandler handler)
Add a resized handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRightMouseDownHandler(RightMouseDownHandler handler)
Add a rightMouseDown handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRuleContextChangedHandler(RuleContextChangedHandler handler)
Add a ruleContextChanged handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addScrolledHandler(ScrolledHandler handler)
Add a scrolled handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addShowContextMenuHandler(ShowContextMenuHandler handler)
Add a showContextMenu handler.
|
void |
addSnapAlignCandidate(Canvas newCandidate)
Add a candidate to
snapAlignCandidates . |
void |
addStyleName(java.lang.String style)
Multiple styles are currently not supported.
|
com.google.gwt.event.shared.HandlerRegistration |
addVisibilityChangedHandler(VisibilityChangedHandler handler)
Add a visibilityChanged handler.
|
void |
adjustForContent(boolean immediate)
This method tells a component to adjust for changes in the size of its content that happen outside of Smart GWT APIs.
|
void |
animateFade(int opacity)
Animate a change in opacity from the widget's current opacity to the specified opacity.
|
void |
animateFade(int opacity,
AnimationCallback callback)
Animate a change in opacity from the widget's current opacity to the specified opacity.
|
void |
animateFade(int opacity,
AnimationCallback callback,
int duration)
Animate a change in opacity from the widget's current opacity to the specified opacity.
|
void |
animateFade(int opacity,
AnimationCallback callback,
int duration,
AnimationAcceleration acceleration)
Animate a change in opacity from the widget's current opacity to the specified opacity.
|
void |
animateFade(java.lang.Integer opacity)
Animate a change in opacity from the widget's current opacity to the specified opacity.
|
void |
animateFade(java.lang.Integer opacity,
AnimationCallback callback) |
void |
animateFade(java.lang.Integer opacity,
AnimationCallback callback,
java.lang.Integer duration) |
void |
animateFade(java.lang.Integer opacity,
AnimationCallback callback,
java.lang.Integer duration,
AnimationAcceleration acceleration)
Animate a change in opacity from the widget's current opacity to the specified opacity.
|
void |
animateHide()
Hide a canvas by shrinking it with default effect specified by
animateHideEffect . |
void |
animateHide(AnimateShowEffect effect)
Hide a canvas by shrinking it vertically to zero height over a period of time.
|
void |
animateHide(AnimateShowEffect effect,
AnimationCallback callback)
Hide a canvas by shrinking it vertically to zero height over a period of time.
|
void |
animateHide(AnimateShowEffect effect,
AnimationCallback callback,
int duration)
Hide a canvas by shrinking it vertically to zero height over a period of time.
|
void |
animateHide(AnimationEffect effect)
Hide a canvas by shrinking it vertically to zero height over a period of time.
|
void |
animateHide(AnimationEffect effect,
AnimationCallback callback)
Hide a canvas by shrinking it vertically to zero height over a period of time.
|
void |
animateHide(AnimationEffect effect,
AnimationCallback callback,
int duration)
Hide a canvas by shrinking it vertically to zero height over a period of time.
|
void |
animateMove(java.lang.Integer left,
java.lang.Integer top)
Animate a reposition of this canvas from its current position to the specified position
|
void |
animateMove(java.lang.Integer left,
java.lang.Integer top,
AnimationCallback callback) |
void |
animateMove(java.lang.Integer left,
java.lang.Integer top,
AnimationCallback callback,
java.lang.Integer duration) |
void |
animateMove(java.lang.Integer left,
java.lang.Integer top,
AnimationCallback callback,
java.lang.Integer duration,
AnimationAcceleration acceleration)
Animate a reposition of this canvas from its current position to the specified position
|
void |
animateRect(java.lang.Integer left,
java.lang.Integer top,
java.lang.Integer width,
java.lang.Integer height)
Animate a reposition / resize of this canvas from its current size and position.
|
void |
animateRect(java.lang.Integer left,
java.lang.Integer top,
java.lang.Integer width,
java.lang.Integer height,
AnimationCallback callback) |
void |
animateRect(java.lang.Integer left,
java.lang.Integer top,
java.lang.Integer width,
java.lang.Integer height,
AnimationCallback callback,
java.lang.Integer duration) |
void |
animateRect(java.lang.Integer left,
java.lang.Integer top,
java.lang.Integer width,
java.lang.Integer height,
AnimationCallback callback,
java.lang.Integer duration,
AnimationAcceleration acceleration)
Animate a reposition / resize of this canvas from its current size and position.
|
void |
animateResize(java.lang.Integer width,
java.lang.Integer height)
Animate a resize of this canvas from its current size to the specified size
|
void |
animateResize(java.lang.Integer width,
java.lang.Integer height,
AnimationCallback callback) |
void |
animateResize(java.lang.Integer width,
java.lang.Integer height,
AnimationCallback callback,
java.lang.Integer duration) |
void |
animateResize(java.lang.Integer width,
java.lang.Integer height,
AnimationCallback callback,
java.lang.Integer duration,
AnimationAcceleration acceleration)
Animate a resize of this canvas from its current size to the specified size
|
void |
animateScroll(java.lang.Integer scrollLeft,
java.lang.Integer scrollTop)
Animate a scroll from the current scroll position to the specified position.
|
void |
animateScroll(java.lang.Integer scrollLeft,
java.lang.Integer scrollTop,
AnimationCallback callback) |
void |
animateScroll(java.lang.Integer scrollLeft,
java.lang.Integer scrollTop,
AnimationCallback callback,
java.lang.Integer duration) |
void |
animateScroll(java.lang.Integer scrollLeft,
java.lang.Integer scrollTop,
AnimationCallback callback,
java.lang.Integer duration,
AnimationAcceleration acceleration)
Animate a scroll from the current scroll position to the specified position.
|
void |
animateScroll(int scrollLeft,
int scrollTop,
AnimationCallback callback)
Animate a scroll from the current scroll position to the specified position.
|
void |
animateScroll(int scrollLeft,
int scrollTop,
AnimationCallback callback,
int duration)
Animate a scroll from the current scroll position to the specified position.
|
void |
animateShow()
Show a canvas by growing it with default effect specified by
animateShowEffect . |
void |
animateShow(AnimateShowEffect effect)
Show a canvas by growing it vertically to its fully drawn height over a period of time.
|
void |
animateShow(AnimateShowEffect effect,
AnimationCallback callback)
Show a canvas by growing it vertically to its fully drawn height over a period of time.
|
void |
animateShow(AnimateShowEffect effect,
AnimationCallback callback,
int duration)
Show a canvas by growing it vertically to its fully drawn height over a period of time.
|
void |
animateShow(AnimationEffect effect)
Show a canvas by growing it vertically to its fully drawn height over a period of time.
|
void |
animateShow(AnimationEffect effect,
AnimationCallback callback)
Show a canvas by growing it vertically to its fully drawn height over a period of time.
|
void |
animateShow(AnimationEffect effect,
AnimationCallback callback,
int duration)
Show a canvas by growing it vertically to its fully drawn height over a period of time.
|
static <T extends Canvas> |
asSGWTComponent(com.google.gwt.core.client.JavaScriptObject jsObj)
Returns the existing SGWT widget, or creates and returns one if none exist,
associated with the supplied
JavaScriptObject . |
void |
blur()
If this canvas has keyboard focus, blur it.
|
void |
bringToFront()
Puts this widget at the top of the stacking order, so it appears in front of all other widgets in the same parent.
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
void |
clear()
Remove all visual representation of a Canvas, including all child or member Canvases, or managed top-level components
such as the ListGrid drop location indicator.
|
void |
clearExplicitTabIndex()
If an explicit
tabIndex was assigned to this widget, clear it. |
java.lang.Boolean |
clickMaskUp()
Determines whether a clickmask is showing
|
java.lang.Boolean |
clickMaskUp(java.lang.String ID)
Determines whether a clickmask is showing
|
java.lang.Boolean |
contains(Canvas canvas)
Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment
hierarchy); and false otherwise.
|
java.lang.Boolean |
contains(Canvas canvas,
java.lang.Boolean testSelf)
Returns true if element is a descendant of this widget (i.e., exists below this widget in the containment
hierarchy); and false otherwise.
|
java.lang.Boolean |
containsEvent()
Return true if the last event's mouse coordinates are within the bounds of this component.
|
java.lang.Boolean |
containsFocus()
Returns true if the keyboard focus is in this Canvas or any child of this Canvas.
|
java.lang.Boolean |
containsPoint(int x,
int y)
Return whether or not this object contains the specified global (x,y) coordinates.
|
java.lang.Boolean |
containsPoint(int x,
int y,
java.lang.Boolean withinViewport)
Return whether or not this object contains the specified global (x,y) coordinates.
|
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
deparent()
Remove this canvas from its parent if it has one.
|
void |
depeer()
Make this Canvas no longer a peer of its master
|
void |
disable()
Disables this widget and any children and peers of this widget.
|
void |
enable()
Enables this widget and any children / peers of this widget.
|
java.lang.Boolean |
encloses(Canvas other)
Returns true if the rectangle of this widget encloses the rectangle of the specified widget.
|
void |
focus()
If this canvas can accept focus, give it keyboard focus.
|
void |
focusAfterGroup()
Shifts focus to the next focusable element after this one, skipping any elements nested inside the tabbing group for
this canvas, such as focusable children.
|
void |
focusAtEnd(boolean start)
Shifts focus to the start or end of this canvas and its descendants.
|
void |
focusInNextTabElement()
Shifts focus to the next focusable element after this one.
|
void |
focusInPreviousTabElement()
Shifts focus to the previous focusable element before this one.
|
int |
getAbsoluteLeft()
This method is similar to
getPageLeft() . |
int |
getAbsoluteTop()
This method is similar to
getPageTop() . |
java.lang.String |
getAccessKey()
If specified this governs the HTML accessKey for the widget.
|
java.lang.Integer |
getAdaptiveHeightPriority()
|
java.lang.Integer |
getAdaptiveWidthPriority()
If multiple widgets in the same Layout have
adaptive width ,
adaptiveWidthPriority can be set to indicate which of the components should be given priority access to
space. |
java.lang.Boolean |
getAlwaysShowScrollbars()
On
touch devices that support native touch scrolling, if showCustomScrollbars is true and touch
scrolling has not been disabled by the useTouchScrolling
and/or disableTouchScrollingForDrag settings,
should custom scrollbars and native touch scrolling be enabled for this component? If false or
unset, then only native touch scrolling will be enabled. |
AnimationAcceleration |
getAnimateAcceleration()
Default acceleration effect to apply to all animations on this Canvas.
|
java.lang.Integer |
getAnimateFadeTime()
Default time for performing an animated fade.
|
AnimationAcceleration |
getAnimateHideAcceleration()
Default acceleration function for performing an animated hide.
|
AnimationEffect |
getAnimateHideEffect()
Default animation effect to use if
animateHide() is called without an explicit effect parameter. |
java.lang.Integer |
getAnimateHideTime()
Default time for performing an animated hide.
|
AnimationAcceleration |
getAnimateMoveAcceleration()
Default acceleration effect for performing an animated move.
|
java.lang.Integer |
getAnimateMoveTime()
Default time for performing an animated move.
|
AnimationAcceleration |
getAnimateRectAcceleration()
Default acceleration function for performing an animated move and resize.
|
java.lang.Integer |
getAnimateRectTime()
Default time for performing an animated setRect.
|
AnimationAcceleration |
getAnimateResizeAcceleration()
Default acceleration function for performing an animated resize.
|
AnimationLayoutMode |
getAnimateResizeLayoutMode()
When to update the
child layout for a size animation . |
java.lang.Integer |
getAnimateResizeTime()
Default time for performing an animated resize.
|
AnimationAcceleration |
getAnimateScrollAcceleration()
Default acceleration function for performing an animated scroll.
|
java.lang.Integer |
getAnimateScrollTime()
Default time for performing an animated scroll.
|
AnimationAcceleration |
getAnimateShowAcceleration()
Default acceleration function for performing an animated show.
|
AnimationEffect |
getAnimateShowEffect()
Default animation effect to use if
animateShow() is called without an explicit effect parameter. |
java.lang.Integer |
getAnimateShowTime()
Default time for performing an animated show.
|
int |
getAnimateTime()
Default total duration of animations.
|
java.lang.String |
getAppImgDir()
Default directory for app-specific images, relative to the Page-wide
appImgDir . |
java.lang.String |
getAriaRole()
ARIA role of this component.
|
java.lang.Boolean |
getAutoMaskComponents()
Deprecated.
As of Smart GWT version 10.0, deprecated in favor of
EditProxy.autoMaskChildren |
java.lang.String |
getAutoParent()
This initialization property allows developers to create a canvas using the Class.addAutoChild() method, and have it
added as a child to some other component.
|
java.lang.Boolean |
getAutoShowParent()
If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
|
java.lang.String |
getBackgroundColor()
The background color for this widget.
|
java.lang.String |
getBackgroundImage()
URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
|
java.lang.String |
getBackgroundPosition()
Specifies how the background image should be positioned on the widget.
|
BackgroundRepeat |
getBackgroundRepeat()
Specifies how the background image should be tiled if this widget is larger than the image.
|
java.lang.String |
getBorder()
Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid
blue").
|
int |
getBottom()
Return the bottom coordinate of this object as rendered, relative to its enclosing context, in pixels.
|
static Canvas |
getById(java.lang.String ID)
Retrieve a Canvas by its global
ID . |
static Canvas |
getByJSObject(com.google.gwt.core.client.JavaScriptObject jsObj)
Retrieve a Canvas from its
JavaScriptObject . |
Canvas |
getByLocalId(java.lang.String ID)
Retrieve a child of this Canvas by it's local ID.
|
java.lang.Boolean |
getCanAcceptDrop()
Indicates that this object can receive dropped widgets (i.e.
|
java.lang.Boolean |
getCanAdaptHeight()
See
canAdaptWidth . |
java.lang.Boolean |
getCanAdaptWidth()
Indicates that this component is able to render itself at multiple possible sizes, in order to fit into less space when
very little space is available, or to display more information or provide more immediate access to functionality when
more space is available.
|
java.lang.Boolean |
getCanDrag()
Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize).
|
java.lang.Boolean |
getCanDragReposition()
Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
|
java.lang.Boolean |
getCanDragResize()
Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
|
boolean |
getCanDragScroll()
If this Canvas is canAcceptDrop:true, when the user drags a droppable widget over an edge of the widget, should we
scroll to show the rest of the widget's content? Returned from canvas.shouldDragScroll() if there are scrollbars.
|
java.lang.Boolean |
getCanDrop()
Indicates that this object can be dropped on top of other widgets.
|
java.lang.Boolean |
getCanDropBefore()
When explicitly set to false, disallows drop before this member in the Layout.
|
java.lang.Boolean |
getCanFocus()
Can this widget be allowed to become the target of keyboard events?
|
java.lang.Boolean |
getCanHover()
Will this Canvas fire hover events when the user hovers over it, or one of its children?
|
java.lang.Boolean |
getCanSelectText()
Whether native drag selection of contained text is allowed within this Canvas.
|
Canvas |
getCanvasAutoChild(java.lang.String autoChildName)
Returns the
Canvas AutoChild named autoChildName if already created. |
CanvasItem |
getCanvasItem()
If this canvas is being displayed in a
CanvasItem , this property will be
set to point at the item. |
Canvas[] |
getChildren()
Array of all Canvii that are immediate children of this Canvas.
|
java.lang.Boolean |
getChildrenResizeSnapAlign()
Flag to disable snapping to alignment when children of this Canvas are resized
|
java.lang.Boolean |
getChildrenSnapAlign()
If enabled while
childrenSnapToGrid is enabled,
children dragged within this Canvas will also snap to positions where their edges or center lines would be aligned with
the edges or centers of other components, and lines will be shown to point out the possible alignment (with appearance
controlled by snapAlignCenterLineStyle and snapAlignEdgeLineStyle respectively. |
java.lang.Boolean |
getChildrenSnapCenterAlign()
See
childrenSnapAlign . |
java.lang.Boolean |
getChildrenSnapEdgeAlign()
See
childrenSnapAlign . |
java.lang.Boolean |
getChildrenSnapResizeToGrid()
If true, causes this canvas's children to snap to its grid when resizing.
|
java.lang.Boolean |
getChildrenSnapToGrid()
If true, causes this canvas's children to snap to its grid when dragging.
|
java.lang.Integer |
getChildTabPosition(Canvas child)
For a given child widget where
updateTabPositionOnReparent is true, return the expected tab position within this parent. |
java.lang.String |
getClassName()
Returns the JavaScript class name.
|
Canvas |
getComponentMask()
Automatically generated mask canvas displayed when
showComponentMask() is called. |
Canvas |
getComponentMaskDefaults()
Defaults for the
componentMask autoChild. |
com.google.gwt.user.client.Element |
getContentElement()
Returns the DOM element for this Canvas which contains the
contents , or for parent components , the DOM elements for any
drawn children. |
java.lang.String |
getContents()
The contents of a canvas or label widget.
|
Menu |
getContextMenu()
Context menu to show for this object, an instance of the Menu widget.
|
java.lang.Boolean |
getCorrectZoomOverflow()
Whether the Framework should correct for erroneous scrollHeight and scrollWidth values reported by the browser when
zoomed (via browser or OS-level zoom) by allowing
maxZoomOverflowError of overflow before enabling scrolling and displaying custom scrollbars. |
Cursor |
getCursor()
Specifies the cursor image to display when the mouse pointer is over this widget.
|
java.lang.String |
getDataPath()
A dataPath may be specified on any canvas.
|
int |
getDefaultHeight()
For custom components, establishes a default height for the component.
|
int |
getDefaultWidth()
For custom components, establishes a default width for the component.
|
java.lang.Boolean |
getDestroyed()
If this property is set to
true , the destroy() method
has been called on this canvas. |
java.lang.Boolean |
getDestroying()
This property is set to true when the
destroy() method is called on a
widget. |
boolean |
getDisabled()
If set to true, the widget will be disabled.
|
Cursor |
getDisabledCursor()
Specifies the cursor image to display when the mouse pointer is over this widget if this widget is disabled.
|
java.lang.Boolean |
getDisableTouchScrollingForDrag()
Disables
useTouchScrolling whenever a built-in drag
operation has been enabled which is known to be non-functional if touch scrolling is enabled. |
int |
getDoubleClickDelay()
Amount of time (in milliseconds) between which two clicks are considered a single click
|
DragAppearance |
getDragAppearance()
Visual appearance to show when the object is being dragged.
|
DragIntersectStyle |
getDragIntersectStyle()
This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection
with the rectangle of the dragMoveTarget.
|
DragMaskType |
getDragMaskType()
This property controls what kind of mask is used in case
useDragMask is enabled. |
int |
getDragMaxHeight()
Sets maximum height that this Canvas can be resized to by a user.
|
int |
getDragMaxWidth()
Maximum width that this Canvas can be resized to by a user.
|
int |
getDragMinHeight()
Minimum height that this Canvas can be resized to by a user.
|
int |
getDragMinWidth()
Minimum width that this Canvas can be resized to by a user.
|
java.lang.Integer |
getDragOpacity()
If this widget has dragAppearance
"target" , this value specifies the opacity to render the target while it
is being dragged. |
DragAppearance |
getDragRepositionAppearance()
If
canDragReposition is true, this attributes specifies
the visual appearance to show during drag reposition. |
Cursor |
getDragRepositionCursor()
Cursor to switch to if the mouse is over a widget that is drag repositionable.
|
DragAppearance |
getDragResizeAppearance()
If
canDragResize is true, this attributes specifies the
visual appearance to show during drag resize. |
int |
getDragScrollDelay()
If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the
drag-scroll threshold before scrolling begins.
|
int |
getDragStartDistance()
Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
|
Canvas |
getDragTarget()
A different widget that should be actually dragged when dragging initiates on this
widget.
|
java.lang.String |
getDragType()
Sets a
dragType for this widget used, to be compared to dropTypes on possible drop target widgets. |
java.lang.String[] |
getDropTypes()
When a drag and drop interaction occurs, if a
dragType is
configured on the source widget, it is compared to the dropTypes configured on the target widget, and a
drop is only allowed if the dragType is listed in the target widget's dropTypes array. |
java.lang.String |
getDropTypesAsString()
When a drag and drop interaction occurs, if a
dragType is
configured on the source widget, it is compared to the dropTypes configured on the target widget, and a
drop is only allowed if the dragType is listed in the target widget's dropTypes array. |
java.lang.Boolean |
getDynamicContents()
Dynamic contents allows the contents string to be treated as a simple, but powerful
template.
|
java.lang.String |
getEdgeBackgroundColor()
Background color for the EdgedCanvas created to decorate this component.
|
java.lang.String |
getEdgeCenterBackgroundColor()
Background color for the center section only.
|
java.lang.String |
getEdgeImage()
Base name of images for edges.
|
int |
getEdgeMarginSize()
How far into the edge of an object do we consider the "edge" for drag resize purposes?
|
java.lang.Integer |
getEdgeOffset()
Amount the contained Canvas should be offset.
|
java.lang.Integer |
getEdgeOpacity()
Opacity of the edges.
|
java.lang.Boolean |
getEdgeShowCenter()
Whether to show media in the center section, that is, behind the decorated Canvas.
|
int |
getEdgeSize()
Size in pixels for corners and edges
|
EditNode |
getEditNode()
|
EditProxy |
getEditProxy()
An
EditProxy controls the behaviors of a component when it is placed into editing mode . |
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
com.google.gwt.user.client.Element |
getElement()
Normal usage of SmartGWT is to call draw() on SmartGWT widgets, not to use use RootPanel.add().
|
com.google.gwt.user.client.Element |
getElement(boolean allowPreRender) |
AdvancedCriteria |
getEnableWhen()
Criteria to be evaluated to determine whether this Canvas should be enabled.
|
java.lang.Boolean |
getEndLine()
Whether this canvas should end the line it's in when used as a tile in a
FlowLayout . |
static EdgeName |
getEventEdge()
Check if an event is within an "edge" of this canvas.
|
static EdgeName |
getEventEdge(EdgeName... edgeMask)
Check if an event is within an "edge" of this canvas.
|
int |
getExtraSpace()
When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a
Layout.
|
java.lang.String |
getFacetId()
|
FormItem |
getFormItemAutoChild(java.lang.String autoChildName)
Returns the
FormItem AutoChild named autoChildName if already created. |
java.lang.String |
getFullDataPath()
Returns a fully qualified
DataPath for this canvas. |
java.lang.String |
getGroupBorderCSS()
Sets the style for the grouping frame around the canvas.
|
java.lang.String |
getGroupLabelBackgroundColor()
If set, the background color of the grouping label.
|
java.lang.String |
getGroupLabelStyleName()
Sets the style for the grouping label.
|
java.lang.String |
getGroupTitle()
The title/label for the grouping.
|
java.lang.Integer |
getHeight()
Size for this component's vertical dimension.
|
java.lang.String |
getHeightAsString() |
boolean |
getHideUsingDisplayNone()
When this widget is hidden (see
visibility and hide() ), should display:none be applied to the outer element ? |
Alignment |
getHoverAlign()
If
this.showHover is true, this property can be used to customize the alignment of content in the hover
canvas. |
java.lang.Boolean |
getHoverAutoDestroy()
If
this.showHover is true and getHoverComponent() is implemented, should the hoverCanvas returned from it be automatically destroyed when it is
hidden? |
int |
getHoverAutoFitMaxWidth()
Maximum auto-fit width for a hover if
hoverAutoFitWidth
is enabled. |
java.lang.String |
getHoverAutoFitMaxWidthAsString()
Maximum auto-fit width for a hover if
hoverAutoFitWidth
is enabled. |
java.lang.Boolean |
getHoverAutoFitWidth()
if
showHover is true, this property will cause the specified
hoverWidth to be treated as a minimum width for the hover. |
Canvas |
getHoverComponent()
When
showHoverComponents is true, this method is
called to get the component to show as a hover for this Canvas. |
int |
getHoverDelay()
If
this.canHover is true, how long should the mouse be kept over this widget before the hover event is
fired |
java.lang.Integer |
getHoverHeight()
If
this.showHover is true, this property can be used to customize the height of the hover canvas shown. |
java.lang.String |
getHoverHTML()
If
this.showHover is true, when the user holds the mouse over this Canvas for long enough to trigger a
hover event, a hover canvas is shown by default. |
java.lang.Boolean |
getHoverMoveWithMouse()
If
this.showHover is true, should this widget's hover canvas be moved with the mouse while visible? |
java.lang.Integer |
getHoverOpacity()
If
this.showHover is true, should the hover canvas be shown with opacity other than 100? |
java.lang.String |
getHoverStyle()
If
this.showHover is true, this property can be used to specify the css style to apply to the hover canvas. |
VerticalAlignment |
getHoverVAlign()
If
this.showHover is true, this property can be used to customize the vertical alignment of content in the
hover canvas. |
int |
getHoverWidth()
If
this.showHover is true, this property can be used to
customize the width of the hover canvas shown. |
java.lang.Boolean |
getHoverWrap()
If
this.showHover is true, this property can be used to customize the whether content in the hover canvas
is displayed in a single line, or wraps. |
int |
getHSnapOrigin()
Get an offset to be used when calculating snap positioning.
|
int |
getHSnapOrigin(Canvas snapChild)
Get an offset to be used when calculating snap positioning.
|
int |
getHSnapPosition(int coordinate)
Override this method to provide a custom snap-to grid.
|
int |
getHSnapPosition(int coordinate,
java.lang.String direction)
Override this method to provide a custom snap-to grid.
|
com.google.gwt.user.client.Element |
getHtmlElement()
If specified as a pointer to an HTML element present in the DOM, this canvas will be rendered inside that element on
draw() . |
DrawPosition |
getHtmlPosition()
If
htmlElement is specified, this attribute specifies the
position where the canvas should be inserted relative to the htmlElement in the DOM. |
com.google.gwt.user.client.Element |
getImage(java.lang.String identifier)
Retrieve a native image or SVG object element by name.
|
static java.lang.String |
getImgURL(java.lang.String URL)
Return the full URL for an image to be drawn in this canvas.
|
static java.lang.String |
getImgURL(java.lang.String URL,
java.lang.String imgDir)
Return the full URL for an image to be drawn in this canvas.
|
int |
getInnerContentHeight()
Returns the amount of space available for interior content (or relatively positioned child widget(s)) without
introducing clipping, scrolling or overflow.
This is the space within the viewport of the widget (not including padding, and excluding margins, borders or scrollbars) rendered at its specified size. |
int |
getInnerContentWidth()
Returns the amount of space available for interior content (or relatively positioned child widget(s)) without
introducing clipping, scrolling or overflow.
This is the space within the viewport of the widget (not including padding, and excluding margins, borders or scrollbars) rendered at its specified size. |
int |
getInnerHeight()
Returns the amount of space available for (an) absolutely positioned child widget(s) or absolutely positioned HTML
content, without introducing clipping, scrolling or overflow.
|
int |
getInnerWidth()
Returns the amount of space available for absolutely positioned child widget(s) or absolutely positioned HTML content,
without introducing clipping, scrolling or overflow.
|
boolean |
getIsGroup()
Should a grouping frame be shown around this canvas.
|
java.lang.Boolean |
getIsPrinting()
This boolean flag will be set to true by framework logic while generating print HTML for this widget as a result to a
call to
showPrintPreview() (or just getPrintHTML() ). |
java.lang.Boolean |
getIsRuleScope()
Marks this Canvas as the
ruleScope that will be discovered by
any contained DataBoundComponent s which do not specify an explicit
ruleScope . |
java.lang.Boolean |
getIsSnapAlignCandidate()
Flag to disable snapping to alignment against this Canvas when other Canvases dragged into the same parent when
childrenSnapAlign is enabled on this Canvas' parent. |
java.lang.Boolean |
getKeepInParentRect()
Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an
arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array).
|
Alignment |
getLayoutAlign()
When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout.
|
java.lang.Integer |
getLeavePageSpace()
If set, overrides the global
defaultPageSpace . |
int |
getLeft()
Number of pixels the left side of the widget is offset to the right from its default drawing context (either its
parent's topleft corner, or the document flow, depending on the value of the
position property). |
java.lang.String |
getLeftAsString()
Number of pixels the left side of the widget is offset to the right from its default drawing context (either its
parent's topleft corner, or the document flow, depending on the value of the
position property). |
java.lang.String |
getLocalId()
Retrieve the local ID of this canvas.
|
LocatorStrategy |
getLocateChildrenBy()
Strategy to use when locating children in this canvas from an autoTest locator string.
|
LocatorTypeStrategy |
getLocateChildrenType()
LocatorTypeStrategy to use when finding children within this canvas. |
LocatorStrategy |
getLocatePeersBy()
Strategy to use when locating peers of this canvas from an autoTest locator string.
|
LocatorTypeStrategy |
getLocatePeersType()
LocatorTypeStrategy to use when finding peers of this canvas. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
java.lang.Integer |
getMargin()
Set the CSS Margin, in pixels, for this component.
|
Canvas |
getMasterCanvas()
Returns this canvas's "master" (the canvas to which it was added as a peer), if any.
|
Canvas |
getMasterElement()
Deprecated.
In favor or
getMasterCanvas() as of Smart GWT release 9.1 |
java.lang.Boolean |
getMatchElement()
If
htmlElement is specified, should this canvas initially be
drawn at the same dimensions as the htmlElement?Note: setting this property will not force the canvas to resize if the element subsequently resizes (for example due to page reflow). |
int |
getMaxHeight()
Maximum height available to this Canvas.
|
int |
getMaxWidth()
Maximum width available to this Canvas.
|
int |
getMaxZoomOverflowError()
When
correctZoomOverflow is true and browser or
OS-level zoom is active, determines how much overflow must occur before the Framework enables scrolling for this canvas. |
java.lang.String |
getMenuConstructor()
Default class used to construct menus created by this component, including context menus.
|
int |
getMinHeight()
Minimum height available to this Canvas.
|
int |
getMinNonEdgeSize()
If the widget has drag resize configured on one or more of it's edges, and the edgeMarginSize is large enough that the
remaining space is less than
minNonEdgeSize , the edgeMarginSize will be reduced such that the non-edge part
of the widget is at least 1/3 of the total space (with two draggable edges) or half of it (with one draggable edge). |
int |
getMinWidth()
Minimum width available to this Canvas.
|
double |
getMomentumScrollMinSpeed()
The minimum speed in pixels per second that must be reached for momentum scrolling to kick in.
|
int |
getMouseStillDownDelay()
Amount of time (in milliseconds) between repeated 'mouseStillDown' events for this canvas.
|
int |
getMouseStillDownInitialDelay()
Amount of time (in milliseconds) before mouseStillDown events start to be fired repeatedly for this canvas.
|
java.lang.String |
getName()
Optional name for the canvas, which can later be used to reference it.
|
int |
getNextZIndex()
get the next zIndex for the next item to be drawn.
|
java.lang.Boolean |
getNoDoubleClicks()
If true, this canvas will receive all mouse-clicks as single
click events rather than as doubleClick events. |
Cursor |
getNoDropCursor()
Specifies the cursor image to display when the user drags a droppable canvas over this if it is not a valid drop
target for the event and
showNoDropIndicator is
true. |
int |
getOffsetHeight() |
int |
getOffsetWidth() |
int |
getOffsetX()
Return the X-coordinate of the last event relative to the left edge of the content of this Canvas.
NOTE: To get a coordinate relative to the viewport of this Canvas, subtract this.getScrollLeft() |
int |
getOffsetY()
Return the Y-coordinate of the last event, relative to the top edge of the content of this Canvas.
NOTE: To get a coordinate relative to the viewport of this Canvas, subtract this.getScrollTop() |
java.lang.Integer |
getOpacity()
Renders the widget to be partly transparent.
|
static Canvas |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
com.google.gwt.user.client.Element |
getOuterElement()
Returns the outer DOM element of this Canvas.
|
Overflow |
getOverflow()
Controls what happens when the drawn size of the content of a Canvas is either greater or smaller than the
specified size of the Canvas.
|
java.lang.Integer |
getPadding()
Set the CSS padding of this component, in pixels.
|
int |
getPageBottom()
Return the page-relative bottom coordinate of this object, in pixels.
|
int |
getPageLeft()
Returns the page-relative left coordinate of the widget on the page, in pixels.
|
Rectangle |
getPageRect() |
int |
getPageRight()
Return the page-relative right coordinate of this object, in pixels.
|
int |
getPageTop()
Returns the page-relative top coordinate of the widget on the page, in pixels
|
java.util.Map |
getPaletteDefaults()
This method returns a Map of config properties suitable for use as the "defaults"
attribute of a
PaletteNode . |
Canvas |
getPanelContainer()
Returns this Canvas's "panel container".
|
Canvas |
getParentCanvas()
This Canvas's immediate parent, if any.
|
Canvas |
getParentElement()
Deprecated.
As of Smartclient version 9.1, deprecated in favor of
parentCanvas and getParentCanvas() |
Canvas[] |
getPeers()
Array of all Canvii that are peers of this Canvas.
|
PercentBoxModel |
getPercentBox()
Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a
specified
snapTo . |
Canvas |
getPercentSource()
If this canvas has its size specified as a percentage, this property allows the user to explicitly designate another
canvas upon which sizing will be based.
|
Positioning |
getPosition()
Absolute or relative, corresponding to the "absolute" (with respect to parent) or
"relative" (with respect to document flow) values for the CSS position attribute.
|
java.lang.String |
getPrefix() |
java.lang.Boolean |
getPrintChildrenAbsolutelyPositioned()
Should this canvas print its children absolutely positioned when generating
printable HTML . |
static void |
getPrintHTML(java.lang.Object[] components,
PrintProperties printProperties,
PrintHTMLCallback callback)
Returns print-formatted HTML for the specified list of components.
|
java.lang.String |
getPrintHTML(PrintProperties printProperties,
PrintHTMLCallback callback)
Retrieves printable HTML for this component and all printable subcomponents.
|
java.lang.String |
getPrompt()
Prompt displayed in hover canvas if
showHover is true. |
java.lang.String[] |
getProportionalResizeModifiers()
If
proportionalResizing is set to
ProportionalResizeMode.MODIFIER or
ProportionalResizeMode.MODIFIER_OFF then proportional resizing of the DrawItem
is activated or deactivated, respectively, whenever at least one key in this set of modifier keys is pressed. |
ProportionalResizeMode |
getProportionalResizing()
If
canDragResize is true, this property specifies the
conditions for when proportional resizing is used. |
boolean |
getReceiveScrollbarEvents()
Whether this canvas should receive
events from its scrollbars, which are peers . |
Rectangle |
getRect()
Get all four coordinates, relative to the enclosing context, at one.
|
java.lang.Boolean |
getRedrawOnResize()
Should this element be redrawn in response to a resize?
|
java.lang.String |
getResizeBarTarget()
When this Canvas is included as a member in a Layout, and
showResizeBar is set to true so that a resizeBar is created, resizeBarTarget:"next" can be
set to indicate that the resizeBar should resize the next member of the layout rather than this one. |
EdgeName[] |
getResizeFrom()
When drag resizing is enabled via
canDragResize , restricts
resizes to only certain edges or corners. |
int |
getRight()
Return the right coordinate of this object as rendered, relative to its enclosing context, in pixels.
|
java.util.Map |
getRuleContext()
Get the current value of the rule context collected by the
ruleScope of this component (which may be this component itself or whatever component is managing the
ruleScope for this component). |
java.util.Map |
getRuleContext(boolean databoundOnly)
Get the current value of the rule context collected by the
ruleScope of this component (which may be this component itself or whatever component is managing the
ruleScope for this component). |
java.lang.String |
getRuleScope()
ID of the component that gathers the context for evaluation of
criteria-based
rules specified by properties such as FormItem.visibleWhen . |
int |
getScrollbarSize()
How thick should we make the scrollbars for this canvas.
|
int |
getScrollBottom()
Returns the scrollTop required to scroll vertically to the end of this widget's content.
|
int |
getScrollHeight()
Returns the scrollable height of the widget's contents, including children, ignoring clipping.
|
int |
getScrollLeft()
Get the number of pixels this Canvas is scrolled from its left edge.
|
int |
getScrollRight()
Returns the scrollLeft required to scroll horizontally to the end of this widget's content.
|
int |
getScrollTop()
Get the number of pixels this Canvas is scrolled from its top edge.
|
int |
getScrollWidth()
Returns the scrollable width of the widget's contents, including children, ignoring clipping.
|
java.lang.String |
getShadowColor()
Color for the css-based drop shadow shown if
useCSSShadow is
true and showShadow is true. |
int |
getShadowDepth()
Depth of the shadow, or the virtual height above the page of the widget throwing the shadow.
|
java.lang.Integer |
getShadowHOffset()
Horizontal offset for the
shadow . |
java.lang.String |
getShadowImage()
If
useCSSShadow is false, (or for browsers that do not
support css3), this property supplies the base name of the series of images for the sides, corners, and center of the
shadow. |
java.lang.Integer |
getShadowOffset()
Offset of the shadow.
|
java.lang.Integer |
getShadowSoftness()
Softness, or degree of blurring, of the shadow.
|
java.lang.Integer |
getShadowSpread()
Explicit spread for the css-based drop shadow shown if
useCSSShadow is true and showShadow is true. |
java.lang.Integer |
getShadowVOffset()
Vertical offset for the
shadow . |
java.lang.Boolean |
getShouldPrint()
Whether this canvas should be included in a printable view.
|
boolean |
getShowCustomScrollbars()
Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
|
java.lang.Boolean |
getShowDragShadow()
When this widget is dragged, if its dragAppearance is
"target" , should we show a shadow behind the canvas
during the drag. |
java.lang.Boolean |
getShowEdges()
Whether an
EdgedCanvas should be used to show image-based edges around this
component. |
java.lang.Boolean |
getShowHover()
If
this.canHover is true, should we show the global hover canvas by default when the user hovers over this
canvas? |
java.lang.Boolean |
getShowHoverComponents()
When set to true, shows a widget hovering at the mouse point instead of the builtin hover label.
|
java.lang.Boolean |
getShowResizeBar()
When this Canvas is included as a member in a
Layout , whether a resizeBar
should be shown after this member in the layout, to allow it to be resized. |
java.lang.Boolean |
getShowShadow()
Whether to show a drop shadow for this Canvas.
|
java.lang.Boolean |
getShowSnapGrid()
Whether to show a snap grid for this Canvas.
|
boolean |
getShrinkElementOnHide()
This is an advanced setting.
|
java.lang.Boolean |
getSizeMayChangeOnRedraw()
Is it possible that a call to
redraw() on this widget will change its
size? |
java.lang.String |
getSkinImgDir()
Default directory for skin images (those defined by the class), relative to the Page-wide
skinDir . |
Canvas[] |
getSnapAlignCandidates()
When
childrenSnapAlign is enabled, list of candidates to
check for alignment. |
java.lang.String |
getSnapAlignCenterLineStyle()
CSS border declaration used for the line shown to indicate snapping to a center line when
childrenSnapAlign is set. |
java.lang.String |
getSnapAlignEdgeLineStyle()
CSS border declaration used for the line shown to indicate snapping to a edge line when
childrenSnapAlign is set. |
java.lang.String |
getSnapAxis()
Describes which axes to apply snap-to-grid to.
|
java.lang.String |
getSnapEdge()
If
snapTo is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent element. |
java.lang.String |
getSnapHDirection()
The horizontal snap direction.
|
int |
getSnapHGap()
The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
|
java.lang.Integer |
getSnapOffsetLeft()
If
snapTo is defined for this widget, this property can be used to
specify an offset in px or percentage for the left coordinate of this widget. |
java.lang.Integer |
getSnapOffsetTop()
If
snapTo is defined for this widget, this property can be used to
specify an offset in px or percentage for the top coordinate of this widget. |
java.lang.Boolean |
getSnapOnDrop()
When this canvas is dropped onto an object supporting snap-to-grid, should it snap to the grid (true, the default) or
just drop wherever the mouse is (false).
|
static Point |
getSnapPosition(Canvas target,
java.lang.String snapTo,
Canvas snapper)
Return the position for
snapper to be placed in order to "snap to" an edge or corner of
target , in the same sense as snapTo . |
static Point |
getSnapPosition(Canvas target,
java.lang.String snapTo,
Canvas snapper,
java.lang.String snapEdge)
Return the position for
snapper to be placed in order to "snap to" an edge or corner of
target , in the same sense as snapTo . |
java.lang.Boolean |
getSnapResizeToAlign()
Flag to disable snapping to alignment when this Canvas is resized.
|
java.lang.Boolean |
getSnapResizeToGrid()
Causes this canvas to snap to its parent's grid when resizing.
|
java.lang.String |
getSnapTo()
Position this widget such that it is aligned with ("snapped to") an edge of its
master (if specified), or its parent canvas . |
java.lang.Boolean |
getSnapToAlign()
Flag to disable snapping to alignment when this Canvas is dragged when
childrenSnapAlign is enabled on this Canvas' parent. |
java.lang.Boolean |
getSnapToCenterAlign()
Flag to disable snapping to center alignment when this Canvas is dragged when
childrenSnapAlign is enabled on this Canvas' parent. |
java.lang.Boolean |
getSnapToEdgeAlign()
Flag to disable snapping to edge alignment when this Canvas is dragged when
childrenSnapAlign is enabled on this Canvas' parent. |
java.lang.Boolean |
getSnapToGrid()
Causes this canvas to snap to its parent's grid when dragging.
|
java.lang.String |
getSnapVDirection()
The vertical snap direction.
|
int |
getSnapVGap()
The vertical grid size to use, in pixels, when snap-to-grid is enabled.
|
java.lang.Boolean |
getStartLine()
Whether this canvas should always start a new line when used as a tile in a
FlowLayout . |
java.lang.String |
getStyleName()
The CSS class applied to this widget as a whole.
|
java.lang.Integer |
getTabIndex()
If specified this governs the tabIndex of the widget in the page's tab order.
|
protected Canvas |
getTestInstance() |
java.lang.String |
getTitle()
Synonym for
getPrompt() |
java.lang.String |
getTooltip()
Synonym for
getPrompt() |
int |
getTop()
Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left
corner, or the document flow, depending on the value of the
position property). |
java.lang.String |
getTopAsString()
Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left
corner, or the document flow, depending on the value of the
position property). |
Canvas |
getTopElement()
The top-most Canvas (i.e., not a child of any other Canvas), if any, in this widget's containment hierarchy.
|
boolean |
getUpdateTabPositionOnDraw()
Should canvases with no
parent canvas be moved to the end of
the TabIndexManager tree on draw()? |
boolean |
getUpdateTabPositionOnReparent()
Should canvases with a
parent canvas be added to the
TabIndexManager under the parent as described in updateChildTabPositions() and updateChildTabPosition() ? |
java.lang.Boolean |
getUseBackMask()
In earlier versions of Internet Explorer (pre IE9), a native limitation exists whereby if HTML elements are overlapping
on the page, certain elements can appear to "burn through" elements in the same position with a higher z-index.
|
boolean |
getUseCSSShadow()
If
showShadow is true, should we use the css
box-shadow property (where supported) to achieve the shadow? |
boolean |
getUseDragMask()
This flag controls whether we register the component as a maskable item with the EventHandler.
|
boolean |
getUseImageForSVG()
If set, forces the main SVG image or icon in the canvas to be rendered in an <image> tag rather than an
<object> tag, the default.
|
java.lang.Boolean |
getUseNativeDrag()
If set, native HTML5 drag and drop will be used for all drags initiated on this widget (on browsers where this is
supported).
|
java.lang.Boolean |
getUseOpacityFilter()
Configures where the Opacity filter is used for IE6-8.
|
java.lang.Boolean |
getUseTouchScrolling()
On
touch devices , if this Canvas can be scrolled, should
touch-dragging the content area result in scrolling? Set to false if touch-dragging should not cause
scrolling. |
ValuesManager |
getValuesManager()
ValuesManager for managing values displayed in this component. |
java.lang.String |
getValuesManagerAsString()
ValuesManager for managing values displayed in this component. |
int |
getViewportHeight()
Returns the height of the viewport onto the scrollable content.
|
int |
getViewportWidth()
Returns the width of the viewport onto the scrollable content.
|
Visibility |
getVisibility()
Controls widget visibility when the widget is initialized.
|
int |
getVisibleHeight()
Return the visible height of the Canvas.
|
AdvancedCriteria |
getVisibleWhen()
Criteria to be evaluated to determine whether this Canvas should be visible.
|
int |
getVisibleWidth()
Return the visible width of the Canvas.
|
int |
getVSnapOrigin()
Get an offset to be used when calculating snap positioning.
|
int |
getVSnapOrigin(Canvas snapChild)
Get an offset to be used when calculating snap positioning.
|
int |
getVSnapPosition(int coordinate)
Override this method to provide a custom snap-to grid.
|
int |
getVSnapPosition(int coordinate,
java.lang.String direction)
Override this method to provide a custom snap-to grid.
|
java.lang.Integer |
getWidth()
Size for this component's horizontal dimension.
|
java.lang.String |
getWidthAsString() |
int |
getZIndex()
Get the z-Index of this canvas.
|
int |
getZIndex(boolean resolveToNumber)
Get the z-Index of this canvas.
|
void |
handleHover()
Handler fired on a delay when the user hovers the mouse over this hover-target.
|
void |
hide()
Sets the widget's CSS visibility attribute to "hidden".
|
void |
hideClickMask()
Hides the click mask associated with this canvas.
|
void |
hideClickMask(java.lang.String ID)
Hides the click mask associated with this canvas.
|
void |
hideComponentMask()
Hide the
component level clickMask for this widget |
void |
hideComponentMask(boolean suppressFocusReset)
Hide the
component level clickMask for this widget |
void |
hideContextMenu()
The default implementation of this method hides the contextMenu currently being shown for this component (which occurs
when the mouse button that toggles the context menu is released).
|
static java.lang.String |
imgHTML(java.lang.String src)
Generates the HTML for an image unique to this Canvas.
|
static java.lang.String |
imgHTML(java.lang.String src,
int width,
int height) |
static java.lang.String |
imgHTML(java.lang.String src,
int width,
int height,
java.lang.String name,
java.lang.String extraStuff,
java.lang.String imgDir)
Generates the HTML for an image unique to this Canvas.
|
java.lang.Boolean |
intersects(Canvas other)
Returns true if the rectangles of this widget and the specified widget overlap.
|
java.lang.Boolean |
isDirty()
Returns whether a canvas is waiting to be redrawn.
|
java.lang.Boolean |
isDisabled()
Is this canvas disabled? Note that the disabled state is inherited - this method will return true if this widget, or any
of its ancestors are marked disabled.
|
java.lang.Boolean |
isFocused()
Returns true if this Canvas has the keyboard focus.
|
boolean |
isVisible()
Returns true if the widget is visible, taking all parents into account, so that a widget which is not hidden
might still report itself as not visible if it is within a hidden parent.
|
java.lang.Boolean |
keyUp()
Executed when a key is released on a focusable widget (
canFocus :
true). |
void |
layoutChildren(java.lang.String reason)
layoutChildren() is where a Canvas should implement a sizing policy for it's Canvas children. |
java.lang.String |
linkHTML(java.lang.String href)
Generates the HTML for a standard link (anchor) element.
|
java.lang.String |
linkHTML(java.lang.String href,
java.lang.String text) |
java.lang.String |
linkHTML(java.lang.String href,
java.lang.String text,
java.lang.String target) |
java.lang.String |
linkHTML(java.lang.String href,
java.lang.String text,
java.lang.String target,
java.lang.String ID) |
java.lang.String |
linkHTML(java.lang.String href,
java.lang.String text,
java.lang.String target,
java.lang.String ID,
java.lang.Integer tabIndex) |
java.lang.String |
linkHTML(java.lang.String href,
java.lang.String text,
java.lang.String target,
java.lang.String ID,
java.lang.Integer tabIndex,
java.lang.String accessKey)
Generates the HTML for a standard link (anchor) element.
|
void |
markForDestroy()
destroy() this canvas on a timeout. |
void |
markForRedraw()
Marks the widget as "dirty" so that it will be added to a queue for redraw.
|
void |
markForRedraw(java.lang.String reason)
Marks the widget as "dirty" so that it will be added to a queue for redraw.
|
void |
moveAbove(Canvas canvas)
Puts this widget just above the specified widget in the stacking order, so it appears in front of the specified widget
if both widgets have the same parent.
|
void |
moveBelow(Canvas canvas)
Puts this widget just below the specified widget in the stacking order, so it appears behind the specified widget if
both widgets have the same parent.
|
java.lang.Boolean |
moveBy(int deltaX,
int deltaY)
Moves the widget deltaX pixels to the right and deltaY pixels down.
|
boolean |
moveTo(int left,
int top)
Moves the widget so that its top-left corner is at the specified coordinates.
|
protected void |
onAttach() |
protected void |
onDetach() |
protected void |
onInit() |
void |
pageScrollDown()
This method is the programmatic equivalent of the user pressing the "Page Down" key while this widget has the focus.
|
void |
pageScrollUp()
This method is the programmatic equivalent of the user pressing the "Page Up" key while this widget has the focus.
|
protected void |
parentResized()
Fires when the interior size of the parent changes, including parent resize and scrollbar introduction or removal.
|
void |
placeNear()
Move this canvas to the specified point, or as close to the specified point as possible without this widget extending
beyond the edge of the browser viewport on any side.
|
void |
placeNear(int left) |
void |
placeNear(int left,
int top)
Move this canvas to the specified point, or as close to the specified point as possible without this widget extending
beyond the edge of the browser viewport on any side.
|
static void |
printComponents(java.lang.Object[] components)
Generate printable HTML for the designated components and trigger the native print dialog, without ever showing the
printable HTML to the user.
|
void |
provideRuleContext(java.lang.String dataPath,
java.lang.Object data)
Provide data to the
com.smartgwt.client.widgets.Canvas#ruleScope component,
to be made available in the rule context at the specified path . |
void |
provideRuleContext(java.lang.String dataPath,
java.lang.Object data,
DataBoundComponent dbc)
Provide data to the
com.smartgwt.client.widgets.Canvas#ruleScope component,
to be made available in the rule context at the specified path . |
void |
redraw()
Redraws the widget immediately with its current property values.
|
void |
redraw(java.lang.String reason)
Redraws the widget immediately with its current property values.
|
static void |
registerFontScaledPaddingStyles(java.lang.String[] scaledStyles,
java.lang.String[] baselineStyles,
int targetSizeChange)
Registers one or more CSS classes to have their padding adjusted (independently on all edges)
according to the
padding size change applied to the page. |
void |
removeChild(Canvas child)
Remove a child from this parent.
|
void |
removeChild(Canvas child,
java.lang.String name)
Remove a child from this parent.
|
void |
removePeer(Canvas peer)
Remove a peer from this Canvas
|
void |
removePeer(Canvas peer,
java.lang.String name)
Remove a peer from this Canvas
|
void |
removeSnapAlignCandidate(Canvas candidate)
Remove a candidate from
snapAlignCandidates . |
static void |
resizeAutoChildAttributes(java.lang.String policy,
int delta)
Change the value of attributes registered via
registerAutoChildSizingAttributes() by some number
of pixels. |
java.lang.Boolean |
resizeBy(int deltaX,
int deltaY)
Resizes the widget, adding deltaX to its width and deltaY to its height (moves the right and/or bottom sides of
the widget).
|
static void |
resizeControls(int delta)
Change the basic size of UI components in the current skin by "delta" pixels.
|
static void |
resizeFonts(int sizeChange)
Modify the size of fonts for some or all stylesheets defined in the page.
|
static void |
resizeFonts(int sizeChange,
java.lang.String styleSheets) |
static void |
resizeFonts(int sizeChange,
java.lang.String styleSheets,
java.lang.Boolean resizeRelatedControls)
Modify the size of fonts for some or all stylesheets defined in the page.
|
static void |
resizeIcons(java.lang.String policy,
int delta)
Change the basic size of icons in the current skin by "delta" pixels.
|
static void |
resizePadding(int fontSizeChange)
Modify the amount of padding for some CSS styles defined for the page.
|
static void |
resizePadding(int fontSizeChange,
java.lang.String styleSheets)
Modify the amount of padding for some CSS styles defined for the page.
|
java.lang.Boolean |
resizeTo(int width,
int height)
Resizes the widget to the specified width and height (moves the right and/ or bottom sides of the widget).
|
java.lang.Boolean |
resizeTo(java.lang.String width,
java.lang.String height)
Resizes the widget to the specified width and height (moves the right and/ or bottom sides of the widget).
|
void |
revealChild(Canvas child)
Reveals the child Canvas passed in by showing it if it is currently hidden (note, this is stub functionality,
certain Canvas subclasses such as
TabSet have more useful implementations)
NOTE: This is an override point. |
void |
revealChild(java.lang.String childID)
Reveals the child Canvas passed in by showing it if it is currently hidden (note, this is stub functionality,
certain Canvas subclasses such as
TabSet have more useful implementations)
NOTE: This is an override point. |
void |
scrollBy(int dX,
int dY)
Scroll this widget by some pixel increment in either (or both) direction(s).
|
void |
scrollByPercent(int dX,
int dY)
Scroll this widget by some percentage of scroll size in either (or both) direction(s).
|
void |
scrollTo()
Scrolls the content of the widget so that the origin (top-left corner) of the content is left pixels to the left and top
pixels above the widget's top-left corner (but still clipped by the widget's dimensions).
|
void |
scrollTo(java.lang.Integer left) |
void |
scrollTo(java.lang.Integer left,
java.lang.Integer top)
Scrolls the content of the widget so that the origin (top-left corner) of the content is left pixels to the left and top
pixels above the widget's top-left corner (but still clipped by the widget's dimensions).
|
void |
scrollToBottom()
Vertically scrolls the content of the widget to the end of its content
|
void |
scrollToLeft()
Horizontally scrolls the content of the widget to 0
|
void |
scrollToPercent(int left,
int top)
Scroll this widget to some position specified as a percentage of scroll size in either (or both) direction(s).
|
void |
scrollToRight()
Horizontally scrolls the content of the widget to the end of its content
|
void |
scrollToTop()
Vertically scrolls the content of the widget to 0
|
void |
sendToBack()
Puts this widget at the bottom of the stacking order, so it appears behind all other widgets in the same parent.
|
void |
setAccessKey(java.lang.String accessKey)
If specified this governs the HTML accessKey for the widget.
|
void |
setAdaptHeightByCustomizer(AdaptHeightByCustomizer customizer)
Set customizer that defines
adaptHeightBy . |
void |
setAdaptiveHeightPriority(java.lang.Integer adaptiveHeightPriority)
|
void |
setAdaptiveWidthPriority(java.lang.Integer adaptiveWidthPriority)
If multiple widgets in the same Layout have
adaptive width ,
adaptiveWidthPriority can be set to indicate which of the components should be given priority access to
space. |
void |
setAdaptWidthByCustomizer(AdaptWidthByCustomizer customizer)
Set customizer that defines
adaptWidthBy . |
void |
setAlign(Alignment align) |
static void |
setAllowExternalFilters(boolean allExternalFilters)
Changes the system-wide
allowExternalFilters setting. |
void |
setAlwaysShowScrollbars(java.lang.Boolean alwaysShowScrollbars)
On
touch devices that support native touch scrolling, if showCustomScrollbars is true and touch
scrolling has not been disabled by the useTouchScrolling
and/or disableTouchScrollingForDrag settings,
should custom scrollbars and native touch scrolling be enabled for this component? If false or
unset, then only native touch scrolling will be enabled. |
void |
setAnimateAcceleration(AnimationAcceleration animateAcceleration)
Default acceleration effect to apply to all animations on this Canvas.
|
void |
setAnimateFadeTime(java.lang.Integer animateFadeTime)
Default time for performing an animated fade.
|
void |
setAnimateHideAcceleration(AnimationAcceleration animateHideAcceleration)
Default acceleration function for performing an animated hide.
|
void |
setAnimateHideEffect(AnimationEffect animateHideEffect)
Default animation effect to use if
animateHide() is called without an explicit effect parameter. |
void |
setAnimateHideTime(java.lang.Integer animateHideTime)
Default time for performing an animated hide.
|
void |
setAnimateMoveAcceleration(AnimationAcceleration animateMoveAcceleration)
Default acceleration effect for performing an animated move.
|
void |
setAnimateMoveTime(java.lang.Integer animateMoveTime)
Default time for performing an animated move.
|
void |
setAnimateRectAcceleration(AnimationAcceleration animateRectAcceleration)
Default acceleration function for performing an animated move and resize.
|
void |
setAnimateRectTime(java.lang.Integer animateRectTime)
Default time for performing an animated setRect.
|
void |
setAnimateResizeAcceleration(AnimationAcceleration animateResizeAcceleration)
Default acceleration function for performing an animated resize.
|
void |
setAnimateResizeLayoutMode(AnimationLayoutMode animateResizeLayoutMode)
When to update the
child layout for a size animation . |
void |
setAnimateResizeTime(java.lang.Integer animateResizeTime)
Default time for performing an animated resize.
|
void |
setAnimateScrollAcceleration(AnimationAcceleration animateScrollAcceleration)
Default acceleration function for performing an animated scroll.
|
void |
setAnimateScrollTime(java.lang.Integer animateScrollTime)
Default time for performing an animated scroll.
|
void |
setAnimateShowAcceleration(AnimationAcceleration animateShowAcceleration)
Default acceleration function for performing an animated show.
|
void |
setAnimateShowEffect(AnimationEffect animateShowEffect)
Default animation effect to use if
animateShow() is called without an explicit effect parameter. |
void |
setAnimateShowTime(java.lang.Integer animateShowTime)
Default time for performing an animated show.
|
void |
setAnimateTime(int animateTime)
Default total duration of animations.
|
void |
setAppImgDir(java.lang.String appImgDir)
Default directory for app-specific images, relative to the Page-wide
appImgDir . |
void |
setAriaRole(java.lang.String ariaRole)
ARIA role of this component.
|
void |
setAriaState(java.lang.String stateName,
java.lang.Object stateValue)
Set a specific ARIA state mapping for this component.
|
void |
setAutoChildConstructor(java.lang.String autoChildName,
java.lang.String className)
Sets the SmartClient constructor for the AutoChild named
autoChildName . |
void |
setAutoChildProperties(java.lang.String autoChildName,
Canvas properties)
Sets the properties for creating a
Canvas AutoChild named autoChildName . |
void |
setAutoChildProperties(java.lang.String autoChildName,
EditContext properties)
Sets the properties for creating an AutoChild named
autoChildName . |
void |
setAutoChildProperties(java.lang.String autoChildName,
EditProxy properties)
Sets the properties for creating an AutoChild named
autoChildName . |
void |
setAutoChildProperties(java.lang.String autoChildName,
FormItem properties)
Sets the properties for creating a
FormItem AutoChild named autoChildName . |
void |
setAutoChildVisibility(java.lang.String autoChildName,
boolean visible)
Sets whether to create and show the AutoChild named
autoChildName . |
void |
setAutoHeight()
Set the minimum value for height.
|
void |
setAutoMaskComponents(java.lang.Boolean autoMaskComponents)
Deprecated.
As of Smart GWT version 10.0, deprecated in favor of
EditProxy.autoMaskChildren |
void |
setAutoParent(java.lang.String autoParent)
This initialization property allows developers to create a canvas using the Class.addAutoChild() method, and have it
added as a child to some other component.
|
static void |
setAutoResizeAutoChildAttributes(boolean autoResize)
|
static void |
setAutoResizeIcons(boolean autoResizeIcons)
|
void |
setAutoShowParent(java.lang.Boolean autoShowParent)
If set to true, the widget's parent (if any) will automatically be shown whenever the widget is shown.
|
void |
setAutoWidth()
Set the minimum value for width.
|
void |
setBackgroundColor(java.lang.String backgroundColor)
The background color for this widget.
|
void |
setBackgroundImage(java.lang.String backgroundImage)
URL for a background image for this widget (corresponding to the CSS "background-image" attribute).
|
void |
setBackgroundPosition(java.lang.String backgroundPosition)
Specifies how the background image should be positioned on the widget.
|
void |
setBackgroundRepeat(BackgroundRepeat backgroundRepeat)
Specifies how the background image should be tiled if this widget is larger than the image.
|
void |
setBorder(java.lang.String border)
Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid
blue").
|
void |
setBottom(int bottom)
Resizes the widget vertically to position its bottom edge at the specified coordinate.
|
void |
setCanAcceptDrop(java.lang.Boolean canAcceptDrop)
Indicates that this object can receive dropped widgets (i.e.
|
void |
setCanAdaptHeight(java.lang.Boolean canAdaptHeight)
See
canAdaptWidth . |
void |
setCanAdaptWidth(java.lang.Boolean canAdaptWidth)
Indicates that this component is able to render itself at multiple possible sizes, in order to fit into less space when
very little space is available, or to display more information or provide more immediate access to functionality when
more space is available.
|
void |
setCanDrag(java.lang.Boolean canDrag)
Indicates whether this widget can initiate custom drag-and-drop operations (other than reposition or resize).
|
void |
setCanDragReposition(java.lang.Boolean canDragReposition)
Indicates whether this widget can be moved by a user of your application by simply dragging with the mouse.
|
void |
setCanDragResize(java.lang.Boolean canDragResize)
Indicates whether this widget can be resized by dragging on the edges and/or corners of the widget with the mouse.
|
void |
setCanDragScroll(boolean canDragScroll)
If this Canvas is canAcceptDrop:true, when the user drags a droppable widget over an edge of the widget, should we
scroll to show the rest of the widget's content? Returned from canvas.shouldDragScroll() if there are scrollbars.
|
void |
setCanDrop(java.lang.Boolean canDrop)
Indicates that this object can be dropped on top of other widgets.
|
void |
setCanDropBefore(java.lang.Boolean canDropBefore)
When explicitly set to false, disallows drop before this member in the Layout.
|
void |
setCanFocus(java.lang.Boolean canFocus)
Can this widget be allowed to become the target of keyboard events?
|
void |
setCanHover(java.lang.Boolean canHover)
Will this Canvas fire hover events when the user hovers over it, or one of its children?
|
void |
setCanSelectText(java.lang.Boolean canSelectText)
Whether native drag selection of contained text is allowed within this Canvas.
|
void |
setChildren(Canvas... children)
Array of all Canvii that are immediate children of this Canvas.
|
void |
setChildrenResizeSnapAlign(java.lang.Boolean childrenResizeSnapAlign)
Flag to disable snapping to alignment when children of this Canvas are resized
|
void |
setChildrenSnapAlign(java.lang.Boolean childrenSnapAlign)
If enabled while
childrenSnapToGrid is enabled,
children dragged within this Canvas will also snap to positions where their edges or center lines would be aligned with
the edges or centers of other components, and lines will be shown to point out the possible alignment (with appearance
controlled by snapAlignCenterLineStyle and snapAlignEdgeLineStyle respectively. |
void |
setChildrenSnapCenterAlign(java.lang.Boolean childrenSnapCenterAlign)
See
childrenSnapAlign . |
void |
setChildrenSnapEdgeAlign(java.lang.Boolean childrenSnapEdgeAlign)
See
childrenSnapAlign . |
void |
setChildrenSnapResizeToGrid(java.lang.Boolean childrenSnapResizeToGrid)
If true, causes this canvas's children to snap to its grid when resizing.
|
void |
setChildrenSnapToGrid(java.lang.Boolean childrenSnapToGrid)
If true, causes this canvas's children to snap to its grid when dragging.
|
void |
setComponentMaskDefaults(Canvas componentMaskDefaults)
Defaults for the
componentMask autoChild. |
void |
setContents(java.lang.String contents)
The contents of a canvas or label widget.
|
void |
setContextMenu(Menu contextMenu)
Context menu to show for this object, an instance of the Menu widget.
|
void |
setCorrectZoomOverflow(java.lang.Boolean correctZoomOverflow)
Whether the Framework should correct for erroneous scrollHeight and scrollWidth values reported by the browser when
zoomed (via browser or OS-level zoom) by allowing
maxZoomOverflowError of overflow before enabling scrolling and displaying custom scrollbars. |
void |
setCursor(Cursor cursor)
Specifies the cursor image to display when the mouse pointer is over this widget.
|
void |
setDataPath(java.lang.String dataPath)
A dataPath may be specified on any canvas.
|
void |
setDefaultHeight(int defaultHeight)
For custom components, establishes a default height for the component.
|
static void |
setDefaultPageSpace(int newDefaultPageSpace)
Changes the global
defaultPageSpace . |
static void |
setDefaultProperties(Canvas canvasProperties)
Class level method to set the default properties of this class.
|
static void |
setDefaultShowCustomScrollbars(boolean showCS)
Whether to use the browser's native scrollbars or SmartClient-based scrollbars by default
for all canvases.
|
void |
setDefaultWidth(int defaultWidth)
For custom components, establishes a default width for the component.
|
void |
setDisabled(boolean disabled)
If set to true, the widget will be disabled.
|
void |
setDisabledCursor(Cursor disabledCursor)
Specifies the cursor image to display when the mouse pointer is over this widget if this widget is disabled.
|
void |
setDisableTouchScrollingForDrag(java.lang.Boolean disableTouchScrollingForDrag)
Disables
useTouchScrolling whenever a built-in drag
operation has been enabled which is known to be non-functional if touch scrolling is enabled. |
void |
setDoubleClickDelay(int doubleClickDelay)
Amount of time (in milliseconds) between which two clicks are considered a single click
|
void |
setDragAppearance(DragAppearance dragAppearance)
Visual appearance to show when the object is being dragged.
|
void |
setDragIntersectStyle(DragIntersectStyle dragIntersectStyle)
This indicates how the system will test for droppable targets: either by intersection with the mouse or intersection
with the rectangle of the dragMoveTarget.
|
void |
setDragMaskType(DragMaskType dragMaskType)
This property controls what kind of mask is used in case
useDragMask is enabled. |
void |
setDragMaxHeight(int dragMaxHeight)
Sets maximum height that this Canvas can be resized to by a user.
|
void |
setDragMaxWidth(int dragMaxWidth)
Maximum width that this Canvas can be resized to by a user.
|
void |
setDragMinHeight(int dragMinHeight)
Minimum height that this Canvas can be resized to by a user.
|
void |
setDragMinWidth(int dragMinWidth)
Minimum width that this Canvas can be resized to by a user.
|
void |
setDragOpacity(java.lang.Integer dragOpacity)
If this widget has dragAppearance
"target" , this value specifies the opacity to render the target while it
is being dragged. |
void |
setDragRepositionAppearance(DragAppearance dragRepositionAppearance)
If
canDragReposition is true, this attributes specifies
the visual appearance to show during drag reposition. |
void |
setDragRepositionCursor(Cursor dragRepositionCursor)
Cursor to switch to if the mouse is over a widget that is drag repositionable.
|
void |
setDragResizeAppearance(DragAppearance dragResizeAppearance)
If
canDragResize is true, this attributes specifies the
visual appearance to show during drag resize. |
void |
setDragScrollDelay(int dragScrollDelay)
If this widget supports drag-scrolling, This property specifies how many ms the user must hover over the
drag-scroll threshold before scrolling begins.
|
void |
setDragStartDistance(int dragStartDistance)
Number of pixels the cursor needs to move before the EventHandler starts a drag operation.
|
void |
setDragTarget(Canvas dragTarget)
A different widget that should be actually dragged when dragging initiates on this
widget.
|
void |
setDragType(java.lang.String dragType)
Sets a
dragType for this widget used, to be compared to dropTypes on possible drop target widgets. |
void |
setDropTypes(java.lang.String... dropTypes)
When a drag and drop interaction occurs, if a
dragType is
configured on the source widget, it is compared to the dropTypes configured on the target widget, and a
drop is only allowed if the dragType is listed in the target widget's dropTypes array. |
void |
setDropTypes(java.lang.String dropTypes)
When a drag and drop interaction occurs, if a
dragType is
configured on the source widget, it is compared to the dropTypes configured on the target widget, and a
drop is only allowed if the dragType is listed in the target widget's dropTypes array. |
void |
setDynamicContents(java.lang.Boolean dynamicContents)
Dynamic contents allows the contents string to be treated as a simple, but powerful
template.
|
void |
setEdgeBackgroundColor(java.lang.String edgeBackgroundColor)
Background color for the EdgedCanvas created to decorate this component.
|
void |
setEdgeCenterBackgroundColor(java.lang.String edgeCenterBackgroundColor)
Background color for the center section only.
|
void |
setEdgeImage(java.lang.String edgeImage)
Base name of images for edges.
|
void |
setEdgeMarginSize(int edgeMarginSize)
How far into the edge of an object do we consider the "edge" for drag resize purposes?
|
void |
setEdgeOffset(java.lang.Integer edgeOffset)
Amount the contained Canvas should be offset.
|
void |
setEdgeOpacity(java.lang.Integer edgeOpacity)
Opacity of the edges.
|
void |
setEdgeShowCenter(java.lang.Boolean edgeShowCenter)
Whether to show media in the center section, that is, behind the decorated Canvas.
|
void |
setEdgeSize(int edgeSize)
Size in pixels for corners and edges
|
void |
setEditMode(boolean editingOn)
Enable or disable edit mode for this component.
|
void |
setEditMode(boolean editingOn,
EditContext editContext) |
void |
setEditMode(boolean editingOn,
EditContext editContext,
EditNode editNode)
Enable or disable edit mode for this component.
|
void |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
protected void |
setElement(com.google.gwt.user.client.Element elem)
Normal usage of SmartGWT is to call draw() on SmartGWT widgets, not to use use RootPanel.add().
|
void |
setEnableWhen(AdvancedCriteria enableWhen)
Criteria to be evaluated to determine whether this Canvas should be enabled.
|
void |
setEndLine(java.lang.Boolean endLine)
Whether this canvas should end the line it's in when used as a tile in a
FlowLayout . |
void |
setExtraSpace(int extraSpace)
When this Canvas is included as a member in a Layout, extra blank space that should be left after this member in a
Layout.
|
void |
setFacetId(java.lang.String facetId)
If a Canvas is dropped onto a
CubeGrid , and it has a facetId property specified then
the Cube treats this as adding that facetId at the drop location. |
void |
setGroupBorderCSS(java.lang.String groupBorderCSS)
Sets the style for the grouping frame around the canvas.
|
void |
setGroupLabelBackgroundColor(java.lang.String groupLabelBackgroundColor)
If set, the background color of the grouping label.
|
void |
setGroupLabelStyleName(java.lang.String groupLabelStyleName)
Sets the style for the grouping label.
|
void |
setGroupTitle(java.lang.String groupTitle)
The title/label for the grouping.
|
void |
setHeight(int height) |
void |
setHeight(java.lang.Integer height)
Size for this component's vertical dimension.
|
void |
setHeight(java.lang.String height)
Size for this component's vertical dimension.
|
void |
setHeight100()
Convenience method that sets the height to 100%.
|
void |
setHideUsingDisplayNone(boolean hideUsingDisplayNone)
When this widget is hidden (see
visibility and hide() ), should display:none be applied to the outer element ? |
void |
setHoverAlign(Alignment hoverAlign)
If
this.showHover is true, this property can be used to customize the alignment of content in the hover
canvas. |
void |
setHoverAutoDestroy(java.lang.Boolean hoverAutoDestroy)
If
this.showHover is true and getHoverComponent() is implemented, should the hoverCanvas returned from it be automatically destroyed when it is
hidden? |
void |
setHoverAutoFitMaxWidth(int hoverAutoFitMaxWidth)
Maximum auto-fit width for a hover if
hoverAutoFitWidth
is enabled. |
void |
setHoverAutoFitMaxWidth(java.lang.String hoverAutoFitMaxWidth)
Maximum auto-fit width for a hover if
hoverAutoFitWidth
is enabled. |
void |
setHoverAutoFitWidth(java.lang.Boolean hoverAutoFitWidth)
if
showHover is true, this property will cause the specified
hoverWidth to be treated as a minimum width for the hover. |
void |
setHoverDelay(int hoverDelay)
If
this.canHover is true, how long should the mouse be kept over this widget before the hover event is
fired |
void |
setHoverHeight(java.lang.Integer hoverHeight)
If
this.showHover is true, this property can be used to customize the height of the hover canvas shown. |
void |
setHoverMoveWithMouse(java.lang.Boolean hoverMoveWithMouse)
If
this.showHover is true, should this widget's hover canvas be moved with the mouse while visible? |
void |
setHoverOpacity(java.lang.Integer hoverOpacity)
If
this.showHover is true, should the hover canvas be shown with opacity other than 100? |
void |
setHoverStyle(java.lang.String hoverStyle)
If
this.showHover is true, this property can be used to specify the css style to apply to the hover canvas. |
void |
setHoverVAlign(VerticalAlignment hoverVAlign)
If
this.showHover is true, this property can be used to customize the vertical alignment of content in the
hover canvas. |
void |
setHoverWidth(int hoverWidth)
If
this.showHover is true, this property can be used to
customize the width of the hover canvas shown. |
void |
setHoverWrap(java.lang.Boolean hoverWrap)
If
this.showHover is true, this property can be used to customize the whether content in the hover canvas
is displayed in a single line, or wraps. |
void |
setHtmlElement(com.google.gwt.user.client.Element htmlElement)
If specified as a pointer to an HTML element present in the DOM, this canvas will be rendered inside that element on
draw() . |
void |
setHtmlPosition(DrawPosition htmlPosition)
If
htmlElement is specified, this attribute specifies the
position where the canvas should be inserted relative to the htmlElement in the DOM. |
void |
setImage(java.lang.String identifier,
java.lang.String URL)
Set the URL of an image or SVG object element by name.
|
void |
setImage(java.lang.String identifier,
java.lang.String URL,
java.lang.String imgDir)
Set the URL of an image or SVG object element by name.
|
void |
setInitHandler(CanvasInitHandler initHandler)
Specify a notification method to fire when this Canvas is initialized in JavaScript.
|
void |
setIsGroup(boolean isGroup)
Should a grouping frame be shown around this canvas.
|
void |
setIsRuleScope(java.lang.Boolean isRuleScope)
Marks this Canvas as the
ruleScope that will be discovered by
any contained DataBoundComponent s which do not specify an explicit
ruleScope . |
void |
setIsSnapAlignCandidate(java.lang.Boolean isSnapAlignCandidate)
Flag to disable snapping to alignment against this Canvas when other Canvases dragged into the same parent when
childrenSnapAlign is enabled on this Canvas' parent. |
void |
setKeepInParentRect(java.lang.Boolean keepInParentRect)
Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an
arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array).
|
void |
setKeepInParentRect(java.lang.Integer... keepInParentRect)
Constrains drag-resizing and drag-repositioning of this canvas to either the rect of its parent (if set to true) or an
arbitrary rect based on its parent (if set to a [Left,Top,Width,Height] rect array).
|
void |
setKeepInParentRect(Rectangle rectangle) |
void |
setLayoutAlign(Alignment layoutAlign)
When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout.
|
void |
setLayoutAlign(VerticalAlignment layoutAlign)
When this Canvas is included as a member in a Layout, layoutAlign controls alignment on the breadth axis of the layout.
|
void |
setLeavePageSpace(java.lang.Integer leavePageSpace)
If set, overrides the global
defaultPageSpace . |
void |
setLeft(int left)
Number of pixels the left side of the widget is offset to the right from its default drawing context (either its
parent's topleft corner, or the document flow, depending on the value of the
position property). |
void |
setLeft(java.lang.String left)
Number of pixels the left side of the widget is offset to the right from its default drawing context (either its
parent's topleft corner, or the document flow, depending on the value of the
position property). |
void |
setLocateChildrenBy(LocatorStrategy locateChildrenBy)
Strategy to use when locating children in this canvas from an autoTest locator string.
|
void |
setLocateChildrenType(LocatorTypeStrategy locateChildrenType)
LocatorTypeStrategy to use when finding children within this canvas. |
void |
setLocatePeersBy(LocatorStrategy locatePeersBy)
Strategy to use when locating peers of this canvas from an autoTest locator string.
|
void |
setLocatePeersType(LocatorTypeStrategy locatePeersType)
LocatorTypeStrategy to use when finding peers of this canvas. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.CanvasLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
void |
setMargin(java.lang.Integer margin)
Set the CSS Margin, in pixels, for this component.
|
void |
setMatchElement(java.lang.Boolean matchElement)
If
htmlElement is specified, should this canvas initially be
drawn at the same dimensions as the htmlElement?Note: setting this property will not force the canvas to resize if the element subsequently resizes (for example due to page reflow). |
void |
setMaxHeight(int maxHeight)
Maximum height available to this Canvas.
|
void |
setMaxWidth(int maxWidth)
Maximum width available to this Canvas.
|
void |
setMaxZoomOverflowError(int maxZoomOverflowError)
When
correctZoomOverflow is true and browser or
OS-level zoom is active, determines how much overflow must occur before the Framework enables scrolling for this canvas. |
void |
setMenuConstructor(java.lang.String menuConstructor)
Default class used to construct menus created by this component, including context menus.
|
void |
setMinHeight(int minHeight)
Minimum height available to this Canvas.
|
void |
setMinNonEdgeSize(int minNonEdgeSize)
If the widget has drag resize configured on one or more of it's edges, and the edgeMarginSize is large enough that the
remaining space is less than
minNonEdgeSize , the edgeMarginSize will be reduced such that the non-edge part
of the widget is at least 1/3 of the total space (with two draggable edges) or half of it (with one draggable edge). |
void |
setMinWidth(int minWidth)
Minimum width available to this Canvas.
|
void |
setMomentumScrollMinSpeed(double momentumScrollMinSpeed)
The minimum speed in pixels per second that must be reached for momentum scrolling to kick in.
|
void |
setMouseStillDownDelay(int mouseStillDownDelay)
Amount of time (in milliseconds) between repeated 'mouseStillDown' events for this canvas.
|
void |
setMouseStillDownInitialDelay(int mouseStillDownInitialDelay)
Amount of time (in milliseconds) before mouseStillDown events start to be fired repeatedly for this canvas.
|
void |
setName(java.lang.String name)
Optional name for the canvas, which can later be used to reference it.
|
static void |
setNeverUseFilters(boolean neverUseFilters)
Changes the system-wide
neverUseFilters setting. |
void |
setNoDoubleClicks(java.lang.Boolean noDoubleClicks)
If true, this canvas will receive all mouse-clicks as single
click events rather than as doubleClick events. |
void |
setNoDropCursor(Cursor noDropCursor)
Specifies the cursor image to display when the user drags a droppable canvas over this if it is not a valid drop
target for the event and
showNoDropIndicator is
true. |
void |
setOpacity(java.lang.Integer opacity)
Renders the widget to be partly transparent.
|
void |
setOverflow(Overflow overflow)
Controls what happens when the drawn size of the content of a Canvas is either greater or smaller than the
specified size of the Canvas.
|
void |
setPadding(java.lang.Integer padding)
Set the CSS padding of this component, in pixels.
|
void |
setPageLeft(int left)
Set the page-relative left coordinate of this widget.
|
void |
setPageTop(int top)
Set the page-relative top coordinate of this widget.
|
void |
setPanelContainer(Canvas container)
Sets this Canvas's "panel container".
|
void |
setParentCanvas(Canvas parentCanvas)
This Canvas's immediate parent, if any.
|
void |
setParentElement(Canvas parentElement)
Deprecated.
As of Smartclient version 9.1, deprecated in favor of
parentCanvas and getParentCanvas() |
void |
setPeers(Canvas... peers)
Array of all Canvii that are peers of this Canvas.
|
void |
setPercentBox(PercentBoxModel percentBox)
Governs the model to be used when sizing canvases with percentage width or height, or positioning widgets with a
specified
snapTo . |
void |
setPercentSource(Canvas percentSource)
If this canvas has its size specified as a percentage, this property allows the user to explicitly designate another
canvas upon which sizing will be based.
|
void |
setPosition(Positioning position)
Absolute or relative, corresponding to the "absolute" (with respect to parent) or
"relative" (with respect to document flow) values for the CSS position attribute.
|
void |
setPrefix(java.lang.String prefix) |
void |
setPrintChildrenAbsolutelyPositioned(java.lang.Boolean printChildrenAbsolutelyPositioned)
Should this canvas print its children absolutely positioned when generating
printable HTML . |
void |
setPrompt(java.lang.String prompt)
Prompt displayed in hover canvas if
showHover is true. |
void |
setProportionalResizeModifiers(java.lang.String... proportionalResizeModifiers)
If
proportionalResizing is set to
ProportionalResizeMode.MODIFIER or
ProportionalResizeMode.MODIFIER_OFF then proportional resizing of the DrawItem
is activated or deactivated, respectively, whenever at least one key in this set of modifier keys is pressed. |
void |
setProportionalResizing(ProportionalResizeMode proportionalResizing)
If
canDragResize is true, this property specifies the
conditions for when proportional resizing is used. |
void |
setReceiveScrollbarEvents(boolean receiveScrollbarEvents)
Whether this canvas should receive
events from its scrollbars, which are peers . |
void |
setRect(int left,
int top,
int width,
int height)
Set all four coordinates, relative to the enclosing context, at once.
|
void |
setRect(Rectangle rectangle)
Set all four coordinates, relative to the enclosing context, at once.
|
void |
setRedrawOnResize(java.lang.Boolean redrawOnResize)
Should this element be redrawn in response to a resize?
|
void |
setRelativeTabPosition(java.lang.Integer position)
Assign a relative tab position for this canvas.
|
void |
setResizeBarTarget(java.lang.String resizeBarTarget)
When this Canvas is included as a member in a Layout, and
showResizeBar is set to true so that a resizeBar is created, resizeBarTarget:"next" can be
set to indicate that the resizeBar should resize the next member of the layout rather than this one. |
void |
setResizeFrom(EdgeName... resizeFrom)
When drag resizing is enabled via
canDragResize , restricts
resizes to only certain edges or corners. |
void |
setResizeFrom(java.lang.String... resizeFrom)
Deprecated.
use
#setResizeFrom(EdgeName) instead. |
void |
setRight(int right)
Resizes the widget horizontally to position its right side at the specified coordinate.
|
void |
setRuleScope(java.lang.String ruleScope)
ID of the component that gathers the context for evaluation of
criteria-based
rules specified by properties such as FormItem.visibleWhen . |
void |
setScrollbarConstructor(java.lang.String scrollbarConstructor)
The class that will be used to create custom scrollbars for this component.
|
void |
setScrollbarSize(int scrollbarSize)
How thick should we make the scrollbars for this canvas.
|
void |
setShadowColor(java.lang.String shadowColor)
Color for the css-based drop shadow shown if
useCSSShadow is
true and showShadow is true. |
void |
setShadowDepth(int shadowDepth)
Depth of the shadow, or the virtual height above the page of the widget throwing the shadow.
|
void |
setShadowHOffset(java.lang.Integer shadowHOffset)
Horizontal offset for the
shadow . |
void |
setShadowImage(java.lang.String shadowImage)
If
useCSSShadow is false, (or for browsers that do not
support css3), this property supplies the base name of the series of images for the sides, corners, and center of the
shadow. |
void |
setShadowOffset(java.lang.Integer shadowOffset)
Offset of the shadow.
|
void |
setShadowSoftness(java.lang.Integer shadowSoftness)
Softness, or degree of blurring, of the shadow.
|
void |
setShadowSpread(java.lang.Integer shadowSpread)
Explicit spread for the css-based drop shadow shown if
useCSSShadow is true and showShadow is true. |
void |
setShadowVOffset(java.lang.Integer shadowVOffset)
Vertical offset for the
shadow . |
void |
setShouldPrint(java.lang.Boolean shouldPrint)
Whether this canvas should be included in a printable view.
|
void |
setShowCustomScrollbars(boolean showCustomScrollbars)
Whether to use the browser's native scrollbars or Smart GWT-based scrollbars.
|
void |
setShowDragShadow(java.lang.Boolean showDragShadow)
When this widget is dragged, if its dragAppearance is
"target" , should we show a shadow behind the canvas
during the drag. |
void |
setShowEdges(java.lang.Boolean showEdges)
Whether an
EdgedCanvas should be used to show image-based edges around this
component. |
void |
setShowHover(java.lang.Boolean showHover)
If
this.canHover is true, should we show the global hover canvas by default when the user hovers over this
canvas? |
void |
setShowHoverComponents(java.lang.Boolean showHoverComponents)
When set to true, shows a widget hovering at the mouse point instead of the builtin hover label.
|
void |
setShowResizeBar(java.lang.Boolean showResizeBar)
When this Canvas is included as a member in a
Layout , whether a resizeBar
should be shown after this member in the layout, to allow it to be resized. |
void |
setShowShadow(java.lang.Boolean showShadow)
Whether to show a drop shadow for this Canvas.
|
void |
setShowSnapGrid(java.lang.Boolean showSnapGrid)
Whether to show a snap grid for this Canvas.
|
void |
setShrinkElementOnHide(boolean shrinkElementOnHide)
This is an advanced setting.
|
void |
setSizeMayChangeOnRedraw(java.lang.Boolean sizeMayChangeOnRedraw)
Is it possible that a call to
redraw() on this widget will change its
size? |
void |
setSkinImgDir(java.lang.String skinImgDir)
Default directory for skin images (those defined by the class), relative to the Page-wide
skinDir . |
void |
setSmoothFade(java.lang.Boolean smoothFade) |
void |
setSnapAlignCandidates(Canvas... snapAlignCandidates)
When
childrenSnapAlign is enabled, list of candidates to
check for alignment. |
void |
setSnapAlignCenterLineStyle(java.lang.String snapAlignCenterLineStyle)
CSS border declaration used for the line shown to indicate snapping to a center line when
childrenSnapAlign is set. |
void |
setSnapAlignEdgeLineStyle(java.lang.String snapAlignEdgeLineStyle)
CSS border declaration used for the line shown to indicate snapping to a edge line when
childrenSnapAlign is set. |
void |
setSnapAxis(java.lang.String snapAxis)
Describes which axes to apply snap-to-grid to.
|
void |
setSnapEdge(java.lang.String snapEdge)
If
snapTo is defined to this widget, this property can be used to
define which edge of this widget should be snapped to an edge of the master or parent element. |
void |
setSnapHDirection(java.lang.String snapHDirection)
The horizontal snap direction.
|
void |
setSnapHGap(int snapHGap)
The horizontal grid size to use, in pixels, when snap-to-grid is enabled.
|
void |
setSnapOffsetLeft(java.lang.Integer snapOffsetLeft)
If
snapTo is defined for this widget, this property can be used to
specify an offset in px or percentage for the left coordinate of this widget. |
void |
setSnapOffsetTop(java.lang.Integer snapOffsetTop)
If
snapTo is defined for this widget, this property can be used to
specify an offset in px or percentage for the top coordinate of this widget. |
void |
setSnapOnDrop(java.lang.Boolean snapOnDrop)
When this canvas is dropped onto an object supporting snap-to-grid, should it snap to the grid (true, the default) or
just drop wherever the mouse is (false).
|
void |
setSnapResizeToAlign(java.lang.Boolean snapResizeToAlign)
Flag to disable snapping to alignment when this Canvas is resized.
|
void |
setSnapResizeToGrid(java.lang.Boolean snapResizeToGrid)
Causes this canvas to snap to its parent's grid when resizing.
|
void |
setSnapTo(java.lang.String snapTo)
Position this widget such that it is aligned with ("snapped to") an edge of its
master (if specified), or its parent canvas . |
void |
setSnapToAlign(java.lang.Boolean snapToAlign)
Flag to disable snapping to alignment when this Canvas is dragged when
childrenSnapAlign is enabled on this Canvas' parent. |
void |
setSnapToCenterAlign(java.lang.Boolean snapToCenterAlign)
Flag to disable snapping to center alignment when this Canvas is dragged when
childrenSnapAlign is enabled on this Canvas' parent. |
void |
setSnapToEdgeAlign(java.lang.Boolean snapToEdgeAlign)
Flag to disable snapping to edge alignment when this Canvas is dragged when
childrenSnapAlign is enabled on this Canvas' parent. |
void |
setSnapToGrid(java.lang.Boolean snapToGrid)
Causes this canvas to snap to its parent's grid when dragging.
|
void |
setSnapVDirection(java.lang.String snapVDirection)
The vertical snap direction.
|
void |
setSnapVGap(int snapVGap)
The vertical grid size to use, in pixels, when snap-to-grid is enabled.
|
void |
setStartLine(java.lang.Boolean startLine)
Whether this canvas should always start a new line when used as a tile in a
FlowLayout . |
void |
setStyleName(java.lang.String styleName)
The CSS class applied to this widget as a whole.
|
void |
setTabIndex(java.lang.Integer tabIndex)
If specified this governs the tabIndex of the widget in the page's tab order.
|
void |
setTitle(java.lang.String title)
Synonym for
setPrompt(String) |
void |
setTooltip(java.lang.String tooltip)
Synonym for
setPrompt(String) |
void |
setTop(int top)
Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left
corner, or the document flow, depending on the value of the
position property). |
void |
setTop(java.lang.String top)
Number of pixels the top of the widget is offset down from its default drawing context (either its parent's top-left
corner, or the document flow, depending on the value of the
position property). |
void |
setUpdateTabPositionOnDraw(boolean updateTabPositionOnDraw)
Should canvases with no
parent canvas be moved to the end of
the TabIndexManager tree on draw()? |
void |
setUpdateTabPositionOnReparent(boolean updateTabPositionOnReparent)
Should canvases with a
parent canvas be added to the
TabIndexManager under the parent as described in updateChildTabPositions() and updateChildTabPosition() ? |
void |
setUseBackMask(java.lang.Boolean useBackMask)
In earlier versions of Internet Explorer (pre IE9), a native limitation exists whereby if HTML elements are overlapping
on the page, certain elements can appear to "burn through" elements in the same position with a higher z-index.
|
void |
setUseCSSShadow(boolean useCSSShadow)
If
showShadow is true, should we use the css
box-shadow property (where supported) to achieve the shadow? |
void |
setUseDragMask(boolean useDragMask)
This flag controls whether we register the component as a maskable item with the EventHandler.
|
void |
setUseImageForSVG(boolean useImageForSVG)
If set, forces the main SVG image or icon in the canvas to be rendered in an <image> tag rather than an
<object> tag, the default.
|
void |
setUseNativeDrag(java.lang.Boolean useNativeDrag)
If set, native HTML5 drag and drop will be used for all drags initiated on this widget (on browsers where this is
supported).
|
void |
setUseOpacityFilter(java.lang.Boolean useOpacityFilter)
Configures where the Opacity filter is used for IE6-8.
|
void |
setUseTouchScrolling(java.lang.Boolean useTouchScrolling)
On
touch devices , if this Canvas can be scrolled, should
touch-dragging the content area result in scrolling? Set to false if touch-dragging should not cause
scrolling. |
void |
setValuesManager(java.lang.String valuesManager)
ValuesManager for managing values displayed in this component. |
void |
setValuesManager(ValuesManager valuesManager)
ValuesManager for managing values displayed in this component. |
void |
setVisibility(Visibility visibility)
Controls widget visibility when the widget is initialized.
|
void |
setVisible(boolean visible) |
void |
setVisibleWhen(AdvancedCriteria visibleWhen)
Criteria to be evaluated to determine whether this Canvas should be visible.
|
void |
setWidth(int width) |
void |
setWidth(java.lang.Integer width)
Size for this component's horizontal dimension.
|
void |
setWidth(java.lang.String width)
Size for this component's horizontal dimension.
|
void |
setWidth100()
Convenience method that sets the width to 100%.
|
void |
setZIndex(int newIndex)
Set the z-Index of the canvas.
|
void |
shouldDragScroll()
If this widget is showing scrollbars, and a user drags close to the edge of the viewport, should we scroll the viewport
in the appropriate direction? Returns this.canDragScroll if there are scrollbars, else false.
|
void |
show()
Sets this widget's visibility to "inherit", so that it becomes visible if all of its parents are visible or it has no
parents.
|
java.lang.String |
showClickMask(Function clickActionCallback,
ClickMaskMode mode,
Canvas[] unmaskedTargets)
Show a clickMask over the entire screen that intercepts mouse clicks and fires some action.
|
void |
showComponentMask()
Temporariy block all user interaction with children of this widget, with the exception of those passed in in the
unmaskedChildren parameter. |
void |
showComponentMask(Canvas... unmaskedChildren)
Temporariy block all user interaction with children of this widget, with the exception of those passed in in the
unmaskedChildren parameter. |
void |
showNextTo(Canvas otherWidget)
Show this widget next to another widget on the page, positioned such that it will not extend beyond the browser
viewport.
|
void |
showNextTo(Canvas otherWidget,
java.lang.String side) |
void |
showNextTo(Canvas otherWidget,
java.lang.String side,
boolean canOcclude) |
void |
showNextTo(Canvas otherWidget,
java.lang.String side,
boolean canOcclude,
boolean skipAnimation)
Show this widget next to another widget on the page, positioned such that it will not extend beyond the browser
viewport.
|
static void |
showPrintPreview(Canvas component)
Show a PrintWindow containing a printable view of the component passed in containing print HTML.
|
static void |
showPrintPreview(java.lang.Object[] components)
Show a Print containing a printable view of the components passed in.
|
static void |
showPrintPreview(java.lang.Object[] components,
PrintProperties printProperties,
java.lang.String title,
PrintPreviewCallback callback)
Show a Print containing a printable view of the components passed in.
|
static void |
showPrintPreview(java.lang.Object[] components,
PrintProperties printProperties,
java.lang.String title,
PrintPreviewCallback callback,
Window printWindowProperties,
java.lang.String printButtonTitle)
Show a Print containing a printable view of the components passed in.
|
void |
showRecursively()
Recursively show the canvas and all its parents so the canvas will be visible.
|
void |
updateChildTabPosition(Canvas child)
Ensure that a specific child is slotted correctly into the page's tab order.
|
void |
updateChildTabPositions()
Update the childrens' tab positions, slotting them under this widget in the
TabIndexManager , in the order defined by getChildTabPosition() . |
void |
updateEditNode(EditContext editContext,
EditNode editNode)
A callback invoked for each
liveObject by EditContext when the EditContext is being serialized. |
void |
updateHover()
If this canvas is currently showing a hover (see
handleHover() ),
this method can be called to update the contents of the hover. |
void |
updateHover(java.lang.String hoverHTML)
If this canvas is currently showing a hover (see
handleHover() ),
this method can be called to update the contents of the hover. |
void |
updateShadow()
Update the canvas shadow.
|
void |
updateTabPositionForDraw()
This method is executed on draw.
|
java.lang.Boolean |
visibleAtPoint(int x,
int y,
boolean withinViewport,
Canvas ignoreWidgets,
Canvas upToParent)
Does this widget contain the specified global (x,y) coordinates, and have no other widgets also at the specified
position, obscuring this one? This is commonly used for (for example) drag and drop interactions.
|
java.lang.Boolean |
willAcceptDrop()
Returns true if the widget object being dragged can be dropped on this widget, and false or null otherwise.
|
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
public Canvas()
public Canvas(com.google.gwt.core.client.JavaScriptObject jsObj)
public Canvas(java.lang.String id)
public static Canvas getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public java.util.Map getPaletteDefaults()
PaletteNode
. Use it when you need to
work with PaletteNodes indirectly, such when setting up
TileRecord
s that will be used in a
TilePalette
. See
the dev tools overview
for examples of how to
assemble and acquire a suitable defaults object when you are creating a PaletteNode
indirectlypublic static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
create
in class BaseWidget
public void setAccessKey(java.lang.String accessKey)
This should be set to a character - when a user hits the html accessKey modifier for the browser, plus this character, focus will be given to the widget in question. The accessKey modifier can vary by browser and platform.
The following list of default behavior is for reference only, developers should also consult browser documentation for additional information.
Alt
+ accessKeyAlt+Shift
+ accessKeyCtrl+Opt
+
accessKeyAlt
+ accessKeyCtrl+Opt
+ accessKeyThe 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 nullFocus overview and related methods
public java.lang.String getAccessKey()
This should be set to a character - when a user hits the html accessKey modifier for the browser, plus this character, focus will be given to the widget in question. The accessKey modifier can vary by browser and platform.
The following list of default behavior is for reference only, developers should also consult browser documentation for additional information.
Alt
+ accessKeyAlt+Shift
+ accessKeyCtrl+Opt
+
accessKeyAlt
+ accessKeyCtrl+Opt
+ accessKeyFocus overview and related methods
public void setAdaptiveHeightPriority(java.lang.Integer adaptiveHeightPriority) throws java.lang.IllegalStateException
adaptiveHeightPriority
- New adaptiveHeightPriority value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getAdaptiveHeightPriority()
public void setAdaptiveWidthPriority(java.lang.Integer adaptiveWidthPriority) throws java.lang.IllegalStateException
adaptive width
,
adaptiveWidthPriority
can be set to indicate which of the components should be given priority access to
space. The widget with the highest priority setting will be offered surplus space first, and asked to give up space
last. Lack of a priority setting is treated as zero. Any adaptive widgets with the same priority setting will be asked
to give up or release space according to their order in Layout.members
.
adaptiveWidthPriority
- New adaptiveWidthPriority value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetCanAdaptWidth(java.lang.Boolean)
public java.lang.Integer getAdaptiveWidthPriority()
adaptive width
,
adaptiveWidthPriority
can be set to indicate which of the components should be given priority access to
space. The widget with the highest priority setting will be offered surplus space first, and asked to give up space
last. Lack of a priority setting is treated as zero. Any adaptive widgets with the same priority setting will be asked
to give up or release space according to their order in Layout.members
.
getCanAdaptWidth()
public void setAlwaysShowScrollbars(java.lang.Boolean alwaysShowScrollbars) throws java.lang.IllegalStateException
touch devices
that support native touch scrolling, if showCustomScrollbars
is true
and touch
scrolling has not been disabled by the useTouchScrolling
and/or disableTouchScrollingForDrag
settings,
should custom scrollbars and native touch scrolling be enabled for this component? If false
or
unset, then only native touch scrolling will be enabled. If true
, then both scrolling mechanisms will be
enabled. NOTE: Because native touch scrolling (also called momentum scrolling) is computationally intensive, some mobile browsers implement an optimization where the state of the DOM for the element being scrolled will be frozen or partially frozen during the scroll animation. This results in a delay between when the scroll position reaches a certain point in the animation and when the positions of the custom scrollbar thumbs are updated to reflect that scroll position.
Note : This is an advanced setting
alwaysShowScrollbars
- New alwaysShowScrollbars value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdScrolling overview and related methods
public java.lang.Boolean getAlwaysShowScrollbars()
touch devices
that support native touch scrolling, if showCustomScrollbars
is true
and touch
scrolling has not been disabled by the useTouchScrolling
and/or disableTouchScrollingForDrag
settings,
should custom scrollbars and native touch scrolling be enabled for this component? If false
or
unset, then only native touch scrolling will be enabled. If true
, then both scrolling mechanisms will be
enabled. NOTE: Because native touch scrolling (also called momentum scrolling) is computationally intensive, some mobile browsers implement an optimization where the state of the DOM for the element being scrolled will be frozen or partially frozen during the scroll animation. This results in a delay between when the scroll position reaches a certain point in the animation and when the positions of the custom scrollbar thumbs are updated to reflect that scroll position.
Scrolling overview and related methods
public void setAnimateAcceleration(AnimationAcceleration animateAcceleration)
Note : This is an advanced setting
animateAcceleration
- New animateAcceleration value. Default value is "smoothEnd"public AnimationAcceleration getAnimateAcceleration()
public void setAnimateFadeTime(java.lang.Integer animateFadeTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateFadeTime
- New animateFadeTime value. Default value is nullpublic java.lang.Integer getAnimateFadeTime()
this.animateTime
will be used by default insteadpublic void setAnimateHideAcceleration(AnimationAcceleration animateHideAcceleration)
this.animateAcceleration
will be
used by default instead
Note : This is an advanced setting
animateHideAcceleration
- New animateHideAcceleration value. Default value is nullpublic AnimationAcceleration getAnimateHideAcceleration()
this.animateAcceleration
will be
used by default insteadpublic void setAnimateHideTime(java.lang.Integer animateHideTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateHideTime
- New animateHideTime value. Default value is nullpublic java.lang.Integer getAnimateHideTime()
this.animateTime
will be used by default insteadpublic void setAnimateMoveAcceleration(AnimationAcceleration animateMoveAcceleration)
this.animateAcceleration
will be
used by default instead
Note : This is an advanced setting
animateMoveAcceleration
- New animateMoveAcceleration value. Default value is nullpublic AnimationAcceleration getAnimateMoveAcceleration()
this.animateAcceleration
will be
used by default insteadpublic void setAnimateMoveTime(java.lang.Integer animateMoveTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateMoveTime
- New animateMoveTime value. Default value is nullpublic java.lang.Integer getAnimateMoveTime()
this.animateTime
will be used by default insteadpublic void setAnimateRectAcceleration(AnimationAcceleration animateRectAcceleration)
this.animateAcceleration
will be used by default instead
Note : This is an advanced setting
animateRectAcceleration
- New animateRectAcceleration value. Default value is nullpublic AnimationAcceleration getAnimateRectAcceleration()
this.animateAcceleration
will be used by default insteadpublic void setAnimateRectTime(java.lang.Integer animateRectTime)
this.animateTime
will be used by default
instead
Note : This is an advanced setting
animateRectTime
- New animateRectTime value. Default value is nullpublic java.lang.Integer getAnimateRectTime()
this.animateTime
will be used by default
insteadpublic void setAnimateResizeAcceleration(AnimationAcceleration animateResizeAcceleration)
this.animateAcceleration
will
be used by default instead
Note : This is an advanced setting
animateResizeAcceleration
- New animateResizeAcceleration value. Default value is nullpublic AnimationAcceleration getAnimateResizeAcceleration()
this.animateAcceleration
will
be used by default insteadpublic void setAnimateResizeLayoutMode(AnimationLayoutMode animateResizeLayoutMode)
child layout
for a size animation
. Updating the child layout more often may improve
appearance, but risks prohibitive overhead with more complicated widget hierarchies.
Note : This is an advanced setting
animateResizeLayoutMode
- New animateResizeLayoutMode value. Default value is "atEnd"public AnimationLayoutMode getAnimateResizeLayoutMode()
child layout
for a size animation
. Updating the child layout more often may improve
appearance, but risks prohibitive overhead with more complicated widget hierarchies.public void setAnimateResizeTime(java.lang.Integer animateResizeTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateResizeTime
- New animateResizeTime value. Default value is nullpublic java.lang.Integer getAnimateResizeTime()
this.animateTime
will be used by default insteadpublic void setAnimateScrollAcceleration(AnimationAcceleration animateScrollAcceleration)
this.animateAcceleration
will
be used by default instead
Note : This is an advanced setting
animateScrollAcceleration
- New animateScrollAcceleration value. Default value is nullpublic AnimationAcceleration getAnimateScrollAcceleration()
this.animateAcceleration
will
be used by default insteadpublic void setAnimateScrollTime(java.lang.Integer animateScrollTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateScrollTime
- New animateScrollTime value. Default value is nullpublic java.lang.Integer getAnimateScrollTime()
this.animateTime
will be used by default insteadpublic void setAnimateShowAcceleration(AnimationAcceleration animateShowAcceleration)
this.animateAcceleration
will be
used by default instead
Note : This is an advanced setting
animateShowAcceleration
- New animateShowAcceleration value. Default value is nullpublic AnimationAcceleration getAnimateShowAcceleration()
this.animateAcceleration
will be
used by default insteadpublic void setAnimateShowTime(java.lang.Integer animateShowTime)
this.animateTime
will be used by default instead
Note : This is an advanced setting
animateShowTime
- New animateShowTime value. Default value is nullpublic java.lang.Integer getAnimateShowTime()
this.animateTime
will be used by default insteadpublic void setAnimateTime(int animateTime)
duration
parameter into the appropriate animate...() method.
Note : This is an advanced setting
animateTime
- New animateTime value. Default value is 300public int getAnimateTime()
duration
parameter into the appropriate animate...() method.public void setAppImgDir(java.lang.String appImgDir)
appImgDir
.
Note : This is an advanced setting
appImgDir
- New appImgDir value. Default value is ""URL
,
Images overview and related methods
public java.lang.String getAppImgDir()
appImgDir
.URL
,
Images overview and related methods
public void setAriaRole(java.lang.String ariaRole) throws java.lang.IllegalStateException
Accessibility
.ariaRole
- New ariaRole value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAccessibility overview and related methods
public java.lang.String getAriaRole()
Accessibility
.Accessibility overview and related methods
public void setAutoMaskComponents(java.lang.Boolean autoMaskComponents) throws java.lang.IllegalStateException
EditProxy.autoMaskChildren
EditProxy.useEditMask
true
if not explicitly set?autoMaskComponents
- New autoMaskComponents value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getAutoMaskComponents()
EditProxy.autoMaskChildren
EditProxy.useEditMask
true
if not explicitly set?public void setAutoParent(java.lang.String autoParent) throws java.lang.IllegalStateException
childName
of another
already-created auto-child, or "none"
to cause the component to be created without being added as a child
to any other widget.addAutoChild(...)
was called. See autoChildren
for an overview of the autoChild subsystem.
Note : This is an advanced setting
autoParent
- New autoParent value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getAutoParent()
childName
of another
already-created auto-child, or "none"
to cause the component to be created without being added as a child
to any other widget.addAutoChild(...)
was called. See autoChildren
for an overview of the autoChild subsystem.
public void setAutoShowParent(java.lang.Boolean autoShowParent)
Note : This is an advanced setting
autoShowParent
- New autoShowParent value. Default value is falseAppearance overview and related methods
public java.lang.Boolean getAutoShowParent()
Appearance overview and related methods
public void setBackgroundColor(java.lang.String backgroundColor)
newColor
.backgroundColor
- new background color, or null
to remove the current background color. Default value is nullCSSColor
,
Appearance overview and related methods
public java.lang.String getBackgroundColor()
CSSColor
,
Appearance overview and related methods
public void setBackgroundImage(java.lang.String backgroundImage)
backgroundImage
- new URL (local to Page image directory) for background image. Default value is nullSCImgURL
,
Appearance overview and related methods
public java.lang.String getBackgroundImage()
SCImgURL
,
Appearance overview and related methods
public void setBackgroundPosition(java.lang.String backgroundPosition) throws java.lang.IllegalStateException
backgroundPosition
- New backgroundPosition value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.String getBackgroundPosition()
Appearance overview and related methods
public void setBackgroundRepeat(BackgroundRepeat backgroundRepeat) throws java.lang.IllegalStateException
background-repeat
attribute. The default of null means no background-repeat
CSS will be
written out. See BackgroundRepeat
type for details on other settings.
NOTE: this
setting directly sets the CSS property background-repeat
but does not attempt to work around various known
bugs with this setting, or lack of support in IE6. If you need to apply CSS-based workarounds for browser limitations
with this setting, it's best to do so via setting styleName
.
backgroundRepeat
- New backgroundRepeat value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public BackgroundRepeat getBackgroundRepeat()
background-repeat
attribute. The default of null means no background-repeat
CSS will be
written out. See BackgroundRepeat
type for details on other settings.
NOTE: this
setting directly sets the CSS property background-repeat
but does not attempt to work around various known
bugs with this setting, or lack of support in IE6. If you need to apply CSS-based workarounds for browser limitations
with this setting, it's best to do so via setting styleName
.
Appearance overview and related methods
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
.
If isGroup
is set to true then border is derived from the groupBorderCSS
attribute, not from the explicit border property.
If this method is called after the component has been drawn/initialized:
Set the CSS border of this component, as a CSS string including border-width, border-style, and/or color (eg "2px solid blue").
This property applies the same border to all four sides of this component. Different per-side borders can be set in a CSS style and applied via styleName
.
border
- new border to set to (eg: "2px solid black"). Default value is nullAppearance overview and related methods
public 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
.
If isGroup
is set to true then border is derived from the groupBorderCSS
attribute, not from the explicit border property.
Appearance overview and related methods
public void setCanAcceptDrop(java.lang.Boolean canAcceptDrop)
Note : This is an advanced setting
canAcceptDrop
- New canAcceptDrop value. Default value is falseDragdrop overview and related methods
,
Drag create Examplepublic java.lang.Boolean getCanAcceptDrop()
Dragdrop overview and related methods
,
Drag create Examplepublic void setCanAdaptHeight(java.lang.Boolean canAdaptHeight)
canAdaptWidth
.canAdaptHeight
- New canAdaptHeight value. Default value is nullpublic java.lang.Boolean getCanAdaptHeight()
canAdaptWidth
.public void setCanAdaptWidth(java.lang.Boolean canAdaptWidth)
Unlike simply indicating a flexible size via width:"*", setting canAdaptWidth
indicates that a component has 2 (or more) different ways of rendering itself with different discrete sizes, but
does not have the ability to use every additional available pixel.
For example, a menu embedded in a toolbar might show as only a fixed-size icon which reveals menu options when clicked, or if enough space is available, could show all of the menu options directly in the toolbar. In this example, the menu should either be allocated just enough space for an icon, or enough space for all options to appear inline; any other amount of space being allocated is just a waste.
When a component with canAdaptWidth
is part of a Layout, AdaptWidthByCustomizer.adaptWidthBy()
will be called
every time component sizes are being calculated, passing a positive or negative pixel value:
minWidth
declared on the
canAdaptWidth
component itself Overflow
(introduce scrollbars, clip content, etc) unless
some component or set of components gives up at least this many pixels If a non-zero value is returned
from adaptWidthBy
, this means that the component is willing to shrink or expand by that many pixels.
Returning 0 means that the component is unable to reduce size further, or for a surplus, cannot make good use of the
surplus space.
AdaptWidthByCustomizer.adaptWidthBy()
may surrender as many pixels as desired (as long as the widget won't drop below
its minimum allowed width), no matter whether a positive (surplus) or negative (overflow) pixel value is supplied, but
AdaptWidthByCustomizer.adaptWidthBy()
may not increase its size by more than the number of offered pixels - so if an
overflow is present, it may not increase its size at all. Note that when the initial width is specified as a
stretch size (e.g. "*"), then after AdaptWidthByCustomizer.adaptWidthBy()
is called, the Framework will stretch (but not shrink) the member like any other
stretch-size Layout member, but the unadaptedWidth
argument will always reflect the unstretched width
requested by the previous call to AdaptWidthByCustomizer.adaptWidthBy()
. This behavior may be disabled by specifying the initial width as a number, or
leaving it unspecified.
Behavior is slightly different for overflow: "visible" members - in this case the
unadaptedWidth
passed in will reflect the current visible width of the member, rather than the last width
requested by the previous call to AdaptWidthByCustomizer.adaptWidthBy()
or the specified width (on the first call). However, note that the visible length
will match your requested width unless the member is actually overflowed. Stretch sizing is not supported for
adaptive-width members with overflow: "visible".
Caution: you must either determine the current size of the canvas
by maintaining your own internal state, or use the unadaptedWidth
parameter passed to AdaptWidthByCustomizer.adaptWidthBy()
. You must not
call getWidth()
or getVisibleWidth()
on the canvas itself inside AdaptWidthByCustomizer.adaptWidthBy()
as the size is in
the processing of being determined, but you may draw children or call getVisibleWidth()
on them, as we guarantee that the adaptive-width
canvas is drawn before the first call to AdaptWidthByCustomizer.adaptWidthBy()
. An example of drawing children in AdaptWidthByCustomizer.adaptWidthBy()
to compute
overall width may be seen in the Inlined Menu Mobile Sample.
Note that reasonable settings for minWidth
should be applied to all other flexible-sized members of a
layout where a canAdaptWidth
component appears, because when too little space is available, a
canAdaptWidth
component will absorb all available space until minimums for other components are hit (or the
canAdaptWidth
component reaches its maximum size). If more than one canAdaptWidth
component
is present, adaptiveWidthPriority
to give priority
to a particular component when allocating space.
All of the above behaviors are exactly the same for height, using
canAdaptHeight
and AdaptHeightByCustomizer.adaptHeightBy()
.
canAdaptWidth
- New canAdaptWidth value. Default value is nullsetCanAdaptHeight(java.lang.Boolean)
,
AdaptWidthByCustomizer.adaptWidthBy(int, int)
,
AdaptHeightByCustomizer.adaptHeightBy(int, int)
,
Inlined Menu Examplepublic java.lang.Boolean getCanAdaptWidth()
Unlike simply indicating a flexible size via width:"*", setting canAdaptWidth
indicates that a component has 2 (or more) different ways of rendering itself with different discrete sizes, but
does not have the ability to use every additional available pixel.
For example, a menu embedded in a toolbar might show as only a fixed-size icon which reveals menu options when clicked, or if enough space is available, could show all of the menu options directly in the toolbar. In this example, the menu should either be allocated just enough space for an icon, or enough space for all options to appear inline; any other amount of space being allocated is just a waste.
When a component with canAdaptWidth
is part of a Layout, AdaptWidthByCustomizer.adaptWidthBy()
will be called
every time component sizes are being calculated, passing a positive or negative pixel value:
minWidth
declared on the
canAdaptWidth
component itself Overflow
(introduce scrollbars, clip content, etc) unless
some component or set of components gives up at least this many pixels If a non-zero value is returned
from adaptWidthBy
, this means that the component is willing to shrink or expand by that many pixels.
Returning 0 means that the component is unable to reduce size further, or for a surplus, cannot make good use of the
surplus space.
AdaptWidthByCustomizer.adaptWidthBy()
may surrender as many pixels as desired (as long as the widget won't drop below
its minimum allowed width), no matter whether a positive (surplus) or negative (overflow) pixel value is supplied, but
AdaptWidthByCustomizer.adaptWidthBy()
may not increase its size by more than the number of offered pixels - so if an
overflow is present, it may not increase its size at all. Note that when the initial width is specified as a
stretch size (e.g. "*"), then after AdaptWidthByCustomizer.adaptWidthBy()
is called, the Framework will stretch (but not shrink) the member like any other
stretch-size Layout member, but the unadaptedWidth
argument will always reflect the unstretched width
requested by the previous call to AdaptWidthByCustomizer.adaptWidthBy()
. This behavior may be disabled by specifying the initial width as a number, or
leaving it unspecified.
Behavior is slightly different for overflow: "visible" members - in this case the
unadaptedWidth
passed in will reflect the current visible width of the member, rather than the last width
requested by the previous call to AdaptWidthByCustomizer.adaptWidthBy()
or the specified width (on the first call). However, note that the visible length
will match your requested width unless the member is actually overflowed. Stretch sizing is not supported for
adaptive-width members with overflow: "visible".
Caution: you must either determine the current size of the canvas
by maintaining your own internal state, or use the unadaptedWidth
parameter passed to AdaptWidthByCustomizer.adaptWidthBy()
. You must not
call getWidth()
or getVisibleWidth()
on the canvas itself inside AdaptWidthByCustomizer.adaptWidthBy()
as the size is in
the processing of being determined, but you may draw children or call getVisibleWidth()
on them, as we guarantee that the adaptive-width
canvas is drawn before the first call to AdaptWidthByCustomizer.adaptWidthBy()
. An example of drawing children in AdaptWidthByCustomizer.adaptWidthBy()
to compute
overall width may be seen in the Inlined Menu Mobile Sample.
Note that reasonable settings for minWidth
should be applied to all other flexible-sized members of a
layout where a canAdaptWidth
component appears, because when too little space is available, a
canAdaptWidth
component will absorb all available space until minimums for other components are hit (or the
canAdaptWidth
component reaches its maximum size). If more than one canAdaptWidth
component
is present, adaptiveWidthPriority
to give priority
to a particular component when allocating space.
All of the above behaviors are exactly the same for height, using
canAdaptHeight
and AdaptHeightByCustomizer.adaptHeightBy()
.
getCanAdaptHeight()
,
AdaptWidthByCustomizer.adaptWidthBy(int, int)
,
AdaptHeightByCustomizer.adaptHeightBy(int, int)
,
Inlined Menu Examplepublic void setCanDrag(java.lang.Boolean canDrag)
canDragReposition
or canDragResize
would be used instead of this property. Note: this property may be manipulated by higher-level dragging semantics.
If useNativeDrag
is true and this widget has been drawn, then this
widget must be redrawn
in order for a change of the value of this
attribute to take effect.
Note : This is an advanced setting
canDrag
- New canDrag value. Default value is falseDragdrop overview and related methods
,
Drag create Examplepublic java.lang.Boolean getCanDrag()
canDragReposition
or canDragResize
would be used instead of this property. Note: this property may be manipulated by higher-level dragging semantics.
If useNativeDrag
is true and this widget has been drawn, then this
widget must be redrawn
in order for a change of the value of this
attribute to take effect.
Dragdrop overview and related methods
,
Drag create Examplepublic void setCanDragReposition(java.lang.Boolean canDragReposition)
Note : This is an advanced setting
canDragReposition
- New canDragReposition value. Default value is falseDragdrop overview and related methods
,
Drag effects Examplepublic java.lang.Boolean getCanDragReposition()
Dragdrop overview and related methods
,
Drag effects Examplepublic void setCanDragResize(java.lang.Boolean canDragResize)
Note : This is an advanced setting
canDragResize
- New canDragResize value. Default value is falseDragdrop overview and related methods
,
Drag resize Examplepublic java.lang.Boolean getCanDragResize()
Dragdrop overview and related methods
,
Drag resize Examplepublic void setCanDragScroll(boolean canDragScroll)
Note : This is an advanced setting
canDragScroll
- New canDragScroll value. Default value is trueshouldDragScroll()
public boolean getCanDragScroll()
shouldDragScroll()
public void setCanDrop(java.lang.Boolean canDrop)
Note : This is an advanced setting
canDrop
- New canDrop value. Default value is falseDragdrop overview and related methods
,
Drag create Examplepublic java.lang.Boolean getCanDrop()
Dragdrop overview and related methods
,
Drag create Examplepublic void setCanDropBefore(java.lang.Boolean canDropBefore)
Note : This is an advanced setting
canDropBefore
- New canDropBefore value. Default value is nullLayout
,
LayoutMember overview and related methods
public java.lang.Boolean getCanDropBefore()
Layout
,
LayoutMember overview and related methods
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.
If this method is called after the component has been drawn/initialized:
Change whether a widget can accept keyboard focus.
Note : This is an advanced setting
canFocus
- whether the widget should now accept focus. Default value is nullFocus overview and related methods
,
Focus & Tabbing Examplepublic 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.
Focus overview and related methods
,
Focus & Tabbing Examplepublic void setCanHover(java.lang.Boolean canHover)
canHover
- New canHover value. Default value is nullsetShowHover(java.lang.Boolean)
,
HoverEvent
public java.lang.Boolean getCanHover()
getShowHover()
,
HoverEvent
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
- New canSelectText value. 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 CanvasItem getCanvasItem() throws java.lang.IllegalStateException
CanvasItem
, this property will be
set to point at the item. Otherwise this property will be null.
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Canvas[] getChildren()
Use addChild()
and removeChild()
to add and remove children after a Canvas has been created/drawn.
Containment overview and related methods
public void setChildrenResizeSnapAlign(java.lang.Boolean childrenResizeSnapAlign)
childrenResizeSnapAlign
- New childrenResizeSnapAlign value. Default value is nullpublic java.lang.Boolean getChildrenResizeSnapAlign()
public void setChildrenSnapAlign(java.lang.Boolean childrenSnapAlign)
childrenSnapToGrid
is enabled,
children dragged within this Canvas will also snap to positions where their edges or center lines would be aligned with
the edges or centers of other components, and lines will be shown to point out the possible alignment (with appearance
controlled by snapAlignCenterLineStyle
and snapAlignEdgeLineStyle
respectively. By default, edge-
or center-snapping is enabled for all components, but the set of eligible components can be explicitly set via snapAlignCandidates
.
See also childrenSnapCenterAlign
and childrenSnapEdgeAlign
for enabling or disabling center
alignment or edge alignment individually.
childrenSnapAlign
- New childrenSnapAlign value. Default value is nullpublic java.lang.Boolean getChildrenSnapAlign()
childrenSnapToGrid
is enabled,
children dragged within this Canvas will also snap to positions where their edges or center lines would be aligned with
the edges or centers of other components, and lines will be shown to point out the possible alignment (with appearance
controlled by snapAlignCenterLineStyle
and snapAlignEdgeLineStyle
respectively. By default, edge-
or center-snapping is enabled for all components, but the set of eligible components can be explicitly set via snapAlignCandidates
.
See also childrenSnapCenterAlign
and childrenSnapEdgeAlign
for enabling or disabling center
alignment or edge alignment individually.
public void setChildrenSnapCenterAlign(java.lang.Boolean childrenSnapCenterAlign)
childrenSnapAlign
. This setting enables or disables
snapping on center alignment only.childrenSnapCenterAlign
- New childrenSnapCenterAlign value. Default value is nullpublic java.lang.Boolean getChildrenSnapCenterAlign()
childrenSnapAlign
. This setting enables or disables
snapping on center alignment only.public void setChildrenSnapEdgeAlign(java.lang.Boolean childrenSnapEdgeAlign)
childrenSnapAlign
. This setting enables or disables
snapping on edge alignment only.childrenSnapEdgeAlign
- New childrenSnapEdgeAlign value. Default value is nullpublic java.lang.Boolean getChildrenSnapEdgeAlign()
childrenSnapAlign
. This setting enables or disables
snapping on edge alignment only.public void setChildrenSnapResizeToGrid(java.lang.Boolean childrenSnapResizeToGrid)
snapToGrid
or snapResizeToGrid
value on the child.childrenSnapResizeToGrid
- New childrenSnapResizeToGrid value. Default value is nullDragdrop overview and related methods
public java.lang.Boolean getChildrenSnapResizeToGrid()
snapToGrid
or snapResizeToGrid
value on the child.Dragdrop overview and related methods
public void setChildrenSnapToGrid(java.lang.Boolean childrenSnapToGrid)
snapToGrid
value on the child.childrenSnapToGrid
- New childrenSnapToGrid value. Default value is nullDragdrop overview and related methods
public java.lang.Boolean getChildrenSnapToGrid()
snapToGrid
value on the child.Dragdrop overview and related methods
public Canvas getComponentMask() throws java.lang.IllegalStateException
showComponentMask()
is called.
This component is an AutoChild named "componentMask". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.getComponentMaskDefaults()
public void setComponentMaskDefaults(Canvas componentMaskDefaults) throws java.lang.IllegalStateException
componentMask
autoChild. Default properties
include backgroundColor
being set to "black"
and opacity
being set to 20
.componentMaskDefaults
- New componentMaskDefaults value. Default value is {...}java.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public Canvas getComponentMaskDefaults()
componentMask
autoChild. Default properties
include backgroundColor
being set to "black"
and opacity
being set to 20
.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 " "setDynamicContents(java.lang.Boolean)
,
HTMLString
public java.lang.String getContents()
getDynamicContents()
,
HTMLString
public void setContextMenu(Menu contextMenu)
Note: if destroy()
is called on a canvas, any specified context menu is not
automatically destroyed as well. This is in contrast to MenuButton
s which
automatically destroy their specified MenuButton.menu
by
default. The behavior is intentional as context menus are commonly reused across components.
Note : This is an advanced setting
contextMenu
- New contextMenu value. Default value is nullShowContextMenuEvent
,
Cues overview and related methods
,
Context menus Examplepublic Menu getContextMenu()
Note: if destroy()
is called on a canvas, any specified context menu is not
automatically destroyed as well. This is in contrast to MenuButton
s which
automatically destroy their specified MenuButton.menu
by
default. The behavior is intentional as context menus are commonly reused across components.
ShowContextMenuEvent
,
Cues overview and related methods
,
Context menus Examplepublic void setCorrectZoomOverflow(java.lang.Boolean correctZoomOverflow)
maxZoomOverflowError
of overflow before enabling scrolling and displaying custom scrollbars. Only relevant when overflow
is "auto". This property is defaulted to true in the Canvas
prototype for those browsers where the situation has been observed, except for
Firefox, where a better solution is applied that doesn't rely on maxZoomOverflowError
and never clips any content. Setting
this property false will disable the workaround for all browsers, including Firefox. Without a workaround, scrollbars
may oscillate rapidly when the browser or OS is zoomed.
Note : This is an advanced setting
correctZoomOverflow
- New correctZoomOverflow value. Default value is variespublic java.lang.Boolean getCorrectZoomOverflow()
maxZoomOverflowError
of overflow before enabling scrolling and displaying custom scrollbars. Only relevant when overflow
is "auto". This property is defaulted to true in the Canvas
prototype for those browsers where the situation has been observed, except for
Firefox, where a better solution is applied that doesn't rely on maxZoomOverflowError
and never clips any content. Setting
this property false will disable the workaround for all browsers, including Firefox. Without a workaround, scrollbars
may oscillate rapidly when the browser or OS is zoomed.
public void setCursor(Cursor cursor)
See also disabledCursor
and noDropCursor
.
If this method is called after the component has been drawn/initialized:
Sets the cursor for this widget to cursor. See the cursor property for possible values.
Note : This is an advanced setting
cursor
- new cursor. Default value is Canvas.DEFAULTCues overview and related methods
,
Drag create Example,
Cursors Examplepublic Cursor getCursor()
See also disabledCursor
and noDropCursor
.
Cues overview and related methods
,
Drag create Example,
Cursors Examplepublic void setDataPath(java.lang.String dataPath)
For components which support displaying or editing data values, (such as DynamicForm
or
ListGrid
components), the dataPath may be set to specify how the components
data is
accessed. In this case the dataPath essentially specifies a nested object to edit - typically
a path to a field value within a dataSource record. Note that a ValuesManager will be required
to handle connecting the dataBoundcomponent to the appropriate sub object. This may be explicitly
specified on the component, or a parent of the component, or automatically generated
if a DataSource is specified on either the component or a parent thereof.
To provide a simple example - if a complex object existed with the following format:
Map values = new HashMap(); values.put("companyName", "Some company"); Map addressMap = new HashMap(); addressMap.put("street", "123 Main Street"); addressMap.put("city", "New York"); addressMap.put("state", "NY"); values.put("address", addressMap);a developer could specify a DynamicForm instance with 'dataPath' set to "address" to edit the nested address object:
ValuesManager vm = new ValuesManager(); Map values = new HashMap(); values.put("companyName", "Some company"); Map addressMap = new HashMap(); addressMap.put("street", "123 Main Street"); addressMap.put("city", "New York"); addressMap.put("state", "NY"); values.put("address", addressMap); vm.setValues(values); DynamicForm form = new DynamicForm(); form.setValuesManager(vm); form.setDataPath("address"); TextItem streetField = new TextItem("street"); TextItem cityField = new TextItem("city"); TextItem stateField = new TextItem("state"); form.setItems(streetField, cityField, stateField);If a component is specified with a
dataPath
attribute but does not have an
explicitly specified valuesManager, it will check its parent element chain for a specified
valuesManager and automatically bind to that. This simplifies binding multiple components used
to view or edit a nested data structure as the valuesManager needs only be defined once at a
reasonably high level component. Here's an example of this approach:
ValuesManager vm = new ValuesManager(); Map values = new HashMap(); values.put("companyName", "Some company"); Map addressMap = new HashMap(); addressMap.put("street", "123 Main Street"); addressMap.put("city", "New York"); addressMap.put("state", "NY"); values.put("address", addressMap); vm.setValues(values); Layout layout = new Layout(); layout.setValuesManager(vm); DynamicForm form = new DynamicForm(); form.setDataPath("/"); TextItem companyNameField = new TextItem("companyName"); form.setItems(companyNameField); DynamicForm form1 = new DynamicForm(); form1.setDataPath("address"); TextItem streetField = new TextItem("street"); TextItem cityField = new TextItem("city"); TextItem stateField = new TextItem("state"); form1.setItems(streetField, cityField, stateField); layout.addMember(form); layout.addMember(form1);Note that in this case the valuesManager is specified on a Layout, which has no 'values' management behavior of its own, but contains items with a specified dataPath which do. In this example you'd see 2 forms allowing editing of the nested data structure.
dataPaths from multiple nested components may also be combined. For example:
ValuesManager vm = new ValuesManager(); Map values = new HashMap(); values.put("companyName", "Some company"); Map addressMap = new HashMap(); addressMap.put("street", "123 Main Street"); addressMap.put("city", "New York"); addressMap.put("state", "NY"); values.put("address", addressMap); Map values1 = new HashMap(); values1.put("companyName", "Some Corporation"); Map addressMap1 = new HashMap(); addressMap1.put("street", "1 High Street"); addressMap1.put("city", "New York"); addressMap1.put("state", "NY"); values1.put("address", addressMap1); values.put("parentCompany", values1); vm.setValues(values); Layout layout = new Layout(); layout.setValuesManager(vm); DynamicForm form = new DynamicForm(); form.setDataPath("/"); TextItem companyNameField = new TextItem("companyName"); form.setItems(companyNameField); DynamicForm form1 = new DynamicForm(); form1.setDataPath("address"); TextItem streetField = new TextItem("street"); TextItem cityField = new TextItem("city"); TextItem stateField = new TextItem("state"); form1.setItems(streetField, cityField, stateField); Layout innerlayout = new Layout(); innerlayout.setDataPath("parentCompany"); DynamicForm form3 = new DynamicForm(); form3.setDataPath(""); StaticTextItem companyNameField1 = new StaticTextItem("companyName"); form3.setItems(companyNameField1); DetailViewer detailViewer = new DetailViewer(); detailViewer.setDataPath("address"); DetailViewerField streetDVField = new DetailViewerField("street"); DetailViewerField cityDVField = new DetailViewerField("city"); DetailViewerField stateDVField = new DetailViewerField("state"); detailViewer.setFields(streetDVField, cityDVField, stateDVField); innerlayout.addMember(form3); innerlayout.addMember(detailViewer); layout.addMember(form); layout.addMember(form1); layout.addMember(innerlayout);In this example the detailViewer will display data from the
parentCompany.address
object within the base record.
Note that if a component has a specified dataSource and shows child components with a
specified dataPath, there is no need to explicitly declare a valuesManager at all. If a component
with a dataPath has a dataSource, or an ancestor with a dataSource specified, it will, a
valuesManager will automatically be generated on the higher level component (and be available as
component.valuesManager
).
If that isn't clear, consider the form for entering the parent company name in the above
example. The correct dataPath to the field is /parentCompany/companyName
. We
have the "parentCompany" part of that path provided by the containing Layout, so we cannot
reiterate it on the form itself. However, if we omit the dataPath property altogether, the
framework will not seek to apply dataPath at all. So, we specify the empty string, which
tells Smart GWT to use dataPath and to retain the portion of the path derived so far from
the containment hierarchy.
One further clarification: relative paths are only different from absolute paths if they are
relative to something other than the root. So in the above example, although we specify
"/" as the dataPath of the "main" company name form, we would get exactly the same behavior
by specifying it as "", because the correct dataPath for the companyName field is
"/companyName" - ie, it is relative to the root.
If this method is called after the component has been drawn/initialized:
Setter for the dataPath
attribute. This method may be called directly at runtime to set the dataPath on a component, and will also be re-run automatically whenever a canvas' parent changes due to a call to addChild(). This method handles automatically binding the component to the appropriate valuesManager if necessary.
Note : This is an advanced setting
dataPath
- new dataPath. Default value is nullDataPath
public java.lang.String getDataPath()
For components which support displaying or editing data values, (such as DynamicForm
or
ListGrid
components), the dataPath may be set to specify how the components
data is
accessed. In this case the dataPath essentially specifies a nested object to edit - typically
a path to a field value within a dataSource record. Note that a ValuesManager will be required
to handle connecting the dataBoundcomponent to the appropriate sub object. This may be explicitly
specified on the component, or a parent of the component, or automatically generated
if a DataSource is specified on either the component or a parent thereof.
To provide a simple example - if a complex object existed with the following format:
Map values = new HashMap(); values.put("companyName", "Some company"); Map addressMap = new HashMap(); addressMap.put("street", "123 Main Street"); addressMap.put("city", "New York"); addressMap.put("state", "NY"); values.put("address", addressMap);a developer could specify a DynamicForm instance with 'dataPath' set to "address" to edit the nested address object:
ValuesManager vm = new ValuesManager(); Map values = new HashMap(); values.put("companyName", "Some company"); Map addressMap = new HashMap(); addressMap.put("street", "123 Main Street"); addressMap.put("city", "New York"); addressMap.put("state", "NY"); values.put("address", addressMap); vm.setValues(values); DynamicForm form = new DynamicForm(); form.setValuesManager(vm); form.setDataPath("address"); TextItem streetField = new TextItem("street"); TextItem cityField = new TextItem("city"); TextItem stateField = new TextItem("state"); form.setItems(streetField, cityField, stateField);If a component is specified with a
dataPath
attribute but does not have an
explicitly specified valuesManager, it will check its parent element chain for a specified
valuesManager and automatically bind to that. This simplifies binding multiple components used
to view or edit a nested data structure as the valuesManager needs only be defined once at a
reasonably high level component. Here's an example of this approach:
ValuesManager vm = new ValuesManager(); Map values = new HashMap(); values.put("companyName", "Some company"); Map addressMap = new HashMap(); addressMap.put("street", "123 Main Street"); addressMap.put("city", "New York"); addressMap.put("state", "NY"); values.put("address", addressMap); vm.setValues(values); Layout layout = new Layout(); layout.setValuesManager(vm); DynamicForm form = new DynamicForm(); form.setDataPath("/"); TextItem companyNameField = new TextItem("companyName"); form.setItems(companyNameField); DynamicForm form1 = new DynamicForm(); form1.setDataPath("address"); TextItem streetField = new TextItem("street"); TextItem cityField = new TextItem("city"); TextItem stateField = new TextItem("state"); form1.setItems(streetField, cityField, stateField); layout.addMember(form); layout.addMember(form1);Note that in this case the valuesManager is specified on a Layout, which has no 'values' management behavior of its own, but contains items with a specified dataPath which do. In this example you'd see 2 forms allowing editing of the nested data structure.
dataPaths from multiple nested components may also be combined. For example:
ValuesManager vm = new ValuesManager(); Map values = new HashMap(); values.put("companyName", "Some company"); Map addressMap = new HashMap(); addressMap.put("street", "123 Main Street"); addressMap.put("city", "New York"); addressMap.put("state", "NY"); values.put("address", addressMap); Map values1 = new HashMap(); values1.put("companyName", "Some Corporation"); Map addressMap1 = new HashMap(); addressMap1.put("street", "1 High Street"); addressMap1.put("city", "New York"); addressMap1.put("state", "NY"); values1.put("address", addressMap1); values.put("parentCompany", values1); vm.setValues(values); Layout layout = new Layout(); layout.setValuesManager(vm); DynamicForm form = new DynamicForm(); form.setDataPath("/"); TextItem companyNameField = new TextItem("companyName"); form.setItems(companyNameField); DynamicForm form1 = new DynamicForm(); form1.setDataPath("address"); TextItem streetField = new TextItem("street"); TextItem cityField = new TextItem("city"); TextItem stateField = new TextItem("state"); form1.setItems(streetField, cityField, stateField); Layout innerlayout = new Layout(); innerlayout.setDataPath("parentCompany"); DynamicForm form3 = new DynamicForm(); form3.setDataPath(""); StaticTextItem companyNameField1 = new StaticTextItem("companyName"); form3.setItems(companyNameField1); DetailViewer detailViewer = new DetailViewer(); detailViewer.setDataPath("address"); DetailViewerField streetDVField = new DetailViewerField("street"); DetailViewerField cityDVField = new DetailViewerField("city"); DetailViewerField stateDVField = new DetailViewerField("state"); detailViewer.setFields(streetDVField, cityDVField, stateDVField); innerlayout.addMember(form3); innerlayout.addMember(detailViewer); layout.addMember(form); layout.addMember(form1); layout.addMember(innerlayout);In this example the detailViewer will display data from the
parentCompany.address
object within the base record.
Note that if a component has a specified dataSource and shows child components with a
specified dataPath, there is no need to explicitly declare a valuesManager at all. If a component
with a dataPath has a dataSource, or an ancestor with a dataSource specified, it will, a
valuesManager will automatically be generated on the higher level component (and be available as
component.valuesManager
).
If that isn't clear, consider the form for entering the parent company name in the above
example. The correct dataPath to the field is /parentCompany/companyName
. We
have the "parentCompany" part of that path provided by the containing Layout, so we cannot
reiterate it on the form itself. However, if we omit the dataPath property altogether, the
framework will not seek to apply dataPath at all. So, we specify the empty string, which
tells Smart GWT to use dataPath and to retain the portion of the path derived so far from
the containment hierarchy.
One further clarification: relative paths are only different from absolute paths if they are relative to something other than the root. So in the above example, although we specify "/" as the dataPath of the "main" company name form, we would get exactly the same behavior by specifying it as "", because the correct dataPath for the companyName field is "/companyName" - ie, it is relative to the root.
DataPath
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
- New defaultHeight value. Default value is 100Sizing overview and related methods
public 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.
Sizing overview and related methods
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
- New defaultWidth value. Default value is 100Sizing overview and related methods
public 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.
Sizing overview and related methods
public java.lang.Boolean getDestroyed() throws java.lang.IllegalStateException
true
, the destroy()
method
has been called on this canvas. This implies the canvas is no longer valid. Its ID has been removed from global scope,
and calling standard canvas APIs on it is likely to result in errors.
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException
- if this widget has not yet been rendered.BaseWidget.destroy()
public java.lang.Boolean getDestroying() throws java.lang.IllegalStateException
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 this widget has not yet been rendered.BaseWidget.destroy()
public void setDisabledCursor(Cursor disabledCursor)
Note : This is an advanced setting
disabledCursor
- New disabledCursor value. Default value is Canvas.DEFAULTCues overview and related methods
public Cursor getDisabledCursor()
Cues overview and related methods
public void setDisableTouchScrollingForDrag(java.lang.Boolean disableTouchScrollingForDrag) throws java.lang.IllegalStateException
useTouchScrolling
whenever a built-in drag
operation has been enabled which is known to be non-functional if touch scrolling is enabled. Default behavior is to
leave touch scrolling enabled even if it makes other enabled drag operations non-functional, since any accessible
application must provide an alternative way to perform drag and drop
operations anyway. disableTouchScrollingForDrag
exists so that applications can change the default
setting on a per-component basis (via setDefaultProperties
), in order to make a system-wide or
per-component-type decision about whether to favor touch scrolling vs retaining the ability to drag and drop via finger
drags, instead of having to set useTouchScrolling
on each individual instance.
See the Mobile Development overview
for more background information.
disableTouchScrollingForDrag
- New disableTouchScrollingForDrag value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdScrolling overview and related methods
public java.lang.Boolean getDisableTouchScrollingForDrag()
useTouchScrolling
whenever a built-in drag
operation has been enabled which is known to be non-functional if touch scrolling is enabled. Default behavior is to
leave touch scrolling enabled even if it makes other enabled drag operations non-functional, since any accessible
application must provide an alternative way to perform drag and drop
operations anyway. disableTouchScrollingForDrag
exists so that applications can change the default
setting on a per-component basis (via setDefaultProperties
), in order to make a system-wide or
per-component-type decision about whether to favor touch scrolling vs retaining the ability to drag and drop via finger
drags, instead of having to set useTouchScrolling
on each individual instance.
See the Mobile Development overview
for more background information.
Scrolling overview and related methods
public void setDoubleClickDelay(int doubleClickDelay)
Note : This is an advanced setting
doubleClickDelay
- New doubleClickDelay value. Default value is 250public int getDoubleClickDelay()
public void setDragAppearance(DragAppearance dragAppearance)
dragResizeAppearance
and dragRepositionAppearance
.
Note : This is an advanced setting
dragAppearance
- New dragAppearance value. Default value is EventHandler.OUTLINEDragdrop overview and related methods
public DragAppearance getDragAppearance()
dragResizeAppearance
and dragRepositionAppearance
.Dragdrop overview and related methods
public void setDragIntersectStyle(DragIntersectStyle dragIntersectStyle)
Note : This is an advanced setting
dragIntersectStyle
- New dragIntersectStyle value. Default value is "mouse"Dragdrop overview and related methods
public DragIntersectStyle getDragIntersectStyle()
Dragdrop overview and related methods
public void setDragMaskType(DragMaskType dragMaskType)
useDragMask
is enabled.dragMaskType
- New dragMaskType value. Default value is "div"Dragdrop overview and related methods
public DragMaskType getDragMaskType()
useDragMask
is enabled.Dragdrop overview and related methods
public void setDragMaxHeight(int dragMaxHeight)
dragMaxHeight
and maxHeight
.
Note : This is an advanced setting
dragMaxHeight
- New dragMaxHeight value. Default value is 10000Sizing overview and related methods
public int getDragMaxHeight()
dragMaxHeight
and maxHeight
.Sizing overview and related methods
public void setDragMaxWidth(int dragMaxWidth)
dragMaxWidth
and maxWidth
.
Note : This is an advanced setting
dragMaxWidth
- New dragMaxWidth value. Default value is 10000Sizing overview and related methods
public int getDragMaxWidth()
dragMaxWidth
and maxWidth
.Sizing overview and related methods
public void setDragMinHeight(int dragMinHeight)
dragMinWidth
for details of behavior.
Note : This is an advanced setting
dragMinHeight
- New dragMinHeight value. Default value is 10setMinHeight(int)
,
Sizing overview and related methods
public int getDragMinHeight()
dragMinWidth
for details of behavior.getMinHeight()
,
Sizing overview and related methods
public void setDragMinWidth(int dragMinWidth)
dragMinWidth
and minWidth
. Note that a Canvas with overflow:"visible" has an implicit minimize size based on it's contents.
Note that dragMinWidth
affects only user-initiated
drag resizes. To set the minimum width of a Canvas embedded in a Layout, you can set +{minWidth}, or Layout.minMemberLength
to constrain the minimum size along
the length axis of all members of the Layout
.
Note : This is an advanced setting
dragMinWidth
- New dragMinWidth value. Default value is 10Sizing overview and related methods
public int getDragMinWidth()
dragMinWidth
and minWidth
. Note that a Canvas with overflow:"visible" has an implicit minimize size based on it's contents.
Note that dragMinWidth
affects only user-initiated
drag resizes. To set the minimum width of a Canvas embedded in a Layout, you can set +{minWidth}, or Layout.minMemberLength
to constrain the minimum size along
the length axis of all members of the Layout
.
Sizing overview and related methods
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
- New dragOpacity value. Default value is nullDragdrop overview and related methods
,
Drag effects Examplepublic 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.Dragdrop overview and related methods
,
Drag effects Examplepublic void setDragRepositionAppearance(DragAppearance dragRepositionAppearance)
canDragReposition
is true, this attributes specifies
the visual appearance to show during drag reposition. If unset dragAppearance
will be used.
Note : This is an advanced setting
dragRepositionAppearance
- New dragRepositionAppearance value. Default value is nullDragdrop overview and related methods
public DragAppearance getDragRepositionAppearance()
canDragReposition
is true, this attributes specifies
the visual appearance to show during drag reposition. If unset dragAppearance
will be used.Dragdrop overview and related methods
public void setDragRepositionCursor(Cursor dragRepositionCursor)
Note : This is an advanced setting
dragRepositionCursor
- New dragRepositionCursor value. Default value is Canvas.MOVEDragdrop overview and related methods
public Cursor getDragRepositionCursor()
Dragdrop overview and related methods
public void setDragResizeAppearance(DragAppearance dragResizeAppearance)
canDragResize
is true, this attributes specifies the
visual appearance to show during drag resize. If unset dragAppearance
will be used.
Note : This is an advanced setting
dragResizeAppearance
- New dragResizeAppearance value. Default value is nullDragdrop overview and related methods
public DragAppearance getDragResizeAppearance()
canDragResize
is true, this attributes specifies the
visual appearance to show during drag resize. If unset dragAppearance
will be used.Dragdrop overview and related methods
public void setDragScrollDelay(int dragScrollDelay)
Note : This is an advanced setting
dragScrollDelay
- New dragScrollDelay value. Default value is 100public int getDragScrollDelay()
public void setDragStartDistance(int dragStartDistance)
Note : This is an advanced setting
dragStartDistance
- New dragStartDistance value. Default value is 5Dragdrop overview and related methods
public int getDragStartDistance()
Dragdrop overview and related methods
public void setDragType(java.lang.String dragType)
dragType
for this widget used, to be compared to dropTypes
on possible drop target widgets. See dropTypes
for a full explanation.
Note : This is an advanced setting
dragType
- New dragType value. Default value is nullDragdrop overview and related methods
public java.lang.String getDragType()
dragType
for this widget used, to be compared to dropTypes
on possible drop target widgets. See dropTypes
for a full explanation.Dragdrop overview and related methods
public void setDropTypes(java.lang.String... dropTypes)
dragType
is
configured on the source widget, it is compared to the dropTypes
configured on the target widget, and a
drop is only allowed if the dragType
is listed in the target widget's dropTypes
array. The
default setting means any dragType
is eligible for dropping on this widget, including no
dragType
setting.
See also willAcceptDrop()
for dynamic determination of drop eligibility.
Note : This is an advanced setting
dropTypes
- New dropTypes value. Default value is Canvas.ANYTHINGDragdrop overview and related methods
public java.lang.String[] getDropTypes()
dragType
is
configured on the source widget, it is compared to the dropTypes
configured on the target widget, and a
drop is only allowed if the dragType
is listed in the target widget's dropTypes
array. The
default setting means any dragType
is eligible for dropping on this widget, including no
dragType
setting.
See also willAcceptDrop()
for dynamic determination of drop eligibility.
Dragdrop overview and related methods
public void setDropTypes(java.lang.String dropTypes)
dragType
is
configured on the source widget, it is compared to the dropTypes
configured on the target widget, and a
drop is only allowed if the dragType
is listed in the target widget's dropTypes
array. The
default setting means any dragType
is eligible for dropping on this widget, including no
dragType
setting.
See also willAcceptDrop()
for dynamic determination of drop eligibility.
Note : This is an advanced setting
dropTypes
- New dropTypes value. Default value is Canvas.ANYTHINGDragdrop overview and related methods
public java.lang.String getDropTypesAsString()
dragType
is
configured on the source widget, it is compared to the dropTypes
configured on the target widget, and a
drop is only allowed if the dragType
is listed in the target widget's dropTypes
array. The
default setting means any dragType
is eligible for dropping on this widget, including no
dragType
setting.
See also willAcceptDrop()
for dynamic determination of drop eligibility.
Dragdrop overview and related methods
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 evaluation contentext, this
points to the canvas instance that
has the dynamicContents string as its contents - in other words the canvas instance on
which the template is declared.
Note : This is an advanced setting
dynamicContents
- New dynamicContents value. Default value is falsesetContents(java.lang.String)
,
com.smartgwt.client.widgets.Canvas#setDynamicContentsVars
public 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 evaluation contentext, this
points to the canvas instance that
has the dynamicContents string as its contents - in other words the canvas instance on
which the template is declared.
getContents()
,
com.smartgwt.client.widgets.Canvas#getDynamicContentsVars
public void setEdgeBackgroundColor(java.lang.String edgeBackgroundColor) throws java.lang.IllegalStateException
edgeBackgroundColor
- New edgeBackgroundColor value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSColor
public java.lang.String getEdgeBackgroundColor()
CSSColor
public void setEdgeCenterBackgroundColor(java.lang.String edgeCenterBackgroundColor) throws java.lang.IllegalStateException
edgeCenterBackgroundColor
- New edgeCenterBackgroundColor value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSColor
public java.lang.String getEdgeCenterBackgroundColor()
CSSColor
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
- New edgeImage value. Default value is "[SKIN]edge.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCImgURL
,
Edges Examplepublic java.lang.String getEdgeImage()
The full list of extensions is: "_TL", "_TR", "_BL", "_BR", "_T", "_L", "_B", "_R", "_center".
SCImgURL
,
Edges Examplepublic void setEdgeMarginSize(int edgeMarginSize)
Note : This is an advanced setting
edgeMarginSize
- New edgeMarginSize value. Default value is 5Dragdrop overview and related methods
,
Drag resize Examplepublic int getEdgeMarginSize()
Dragdrop overview and related methods
,
Drag resize Examplepublic void setEdgeOffset(java.lang.Integer edgeOffset) throws java.lang.IllegalStateException
edgeOffset
- New edgeOffset value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getEdgeOffset()
public void setEdgeOpacity(java.lang.Integer edgeOpacity) throws java.lang.IllegalStateException
setOpacity()
is called on a Canvas where edgeOpacity is set, edgeOpacity will be considered a percentage of the
parent's opacity (so 50% opaque parent plus edgeOpacity 50 means 25% opaque edges)
edgeOpacity
and mark the canvas for redrawedgeOpacity
- new edge-opacity level. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getEdgeOpacity()
setOpacity()
is called on a Canvas where edgeOpacity is set, edgeOpacity will be considered a percentage of the
parent's opacity (so 50% opaque parent plus edgeOpacity 50 means 25% opaque edges)public void setEdgeShowCenter(java.lang.Boolean edgeShowCenter) throws java.lang.IllegalStateException
edgeShowCenter
- New edgeShowCenter value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getEdgeShowCenter()
public void setEdgeSize(int edgeSize) throws java.lang.IllegalStateException
edgeSize
- New edgeSize value. Default value is 10java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getEdgeSize()
public EditNode getEditNode() throws java.lang.IllegalStateException
EditNode
for a component that has been created by a Palette
from a PaletteNode
.
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public EditProxy getEditProxy() throws java.lang.IllegalStateException
EditProxy
controls the behaviors of a component when it is placed into editing mode
. The editProxy
AutoChild is created when a component is
first placed into edit mode via setEditMode()
.
editProxy
properties can be supplied on a PaletteNode
or EditNode
as editProxyProperties
, but must be provided before the component is first placed into edit mode.
Most editable
components use a custom EditProxy. See the documentation for each class' editProxyConstructor
to determine the class.
This component is an AutoChild named "editProxy". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.setEditMode(boolean)
public void setEditProxyConstructor(java.lang.String editProxyConstructor) throws java.lang.IllegalStateException
EditProxy
for this component when the component is
first placed into edit mode
.editProxyConstructor
- New editProxyConstructor value. Default value is "CanvasEditProxy"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCClassName
public java.lang.String getEditProxyConstructor()
EditProxy
for this component when the component is
first placed into edit mode
.SCClassName
public void setEnableWhen(AdvancedCriteria enableWhen) throws java.lang.IllegalStateException
ruleScope
changes. A basic criteria uses textMatchStyle:"exact".
When specified in Component XML
this property allows shorthand formats
for defining criteria.
enableWhen
- New enableWhen value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdRuleCriteria overview and related methods
public AdvancedCriteria getEnableWhen()
ruleScope
changes. A basic criteria uses textMatchStyle:"exact".
When specified in Component XML
this property allows shorthand formats
for defining criteria.
RuleCriteria overview and related methods
public void setEndLine(java.lang.Boolean endLine)
FlowLayout
. This property is not supported in a TileLayout
with TileLayout.layoutPolicy
: "fit" or if databound (i.e.TileGrid
).endLine
- New endLine value. Default value is falseTileLayout.setAutoWrapLines(java.lang.Boolean)
public java.lang.Boolean getEndLine()
FlowLayout
. This property is not supported in a TileLayout
with TileLayout.layoutPolicy
: "fit" or if databound (i.e.TileGrid
).TileLayout.getAutoWrapLines()
public void setExtraSpace(int extraSpace) throws java.lang.IllegalStateException
extraSpace
- New extraSpace value. Default value is 0java.lang.IllegalStateException
- this property cannot be changed after the component has been createdLayoutSpacer
,
LayoutMember overview and related methods
public int getExtraSpace()
LayoutSpacer
,
LayoutMember overview and related methods
public void setGroupBorderCSS(java.lang.String groupBorderCSS) throws java.lang.IllegalStateException
isGroup
is set to true.groupBorderCSS
- New groupBorderCSS value. Default value is "2px solid black"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.String getGroupBorderCSS()
isGroup
is set to true.Appearance overview and related methods
public void setGroupLabelBackgroundColor(java.lang.String groupLabelBackgroundColor)
isGroup
is set to true. This corresponds to the CSS background-color property on the grouping label. You can set this property to an RGB value (e.g. #22AAFF) or a named color (e.g. red) from a list of browser supported color names.
The getter for this attribute, getGroupLabelBackgroundColor()
, returns the color that will actually be used; i.e. if groupLabelBackgroundColor is
left unset or is set to null, then getGroupLabelBackgroundColor() returns the color string that will be used.
If this method is called after the component has been drawn/initialized:
Setter for groupLabelBackgroundColor
.
groupLabelBackgroundColor
- the new grouping label background color. Default value is nullCSSColor
,
Appearance overview and related methods
public java.lang.String getGroupLabelBackgroundColor()
isGroup
is set to true. This corresponds to the CSS background-color property on the grouping label. You can set this property to an RGB value (e.g. #22AAFF) or a named color (e.g. red) from a list of browser supported color names.
The getter for this attribute, getGroupLabelBackgroundColor()
, returns the color that will actually be used; i.e. if groupLabelBackgroundColor is
left unset or is set to null, then getGroupLabelBackgroundColor() returns the color string that will be used.
CSSColor
,
Appearance overview and related methods
public void setGroupLabelStyleName(java.lang.String groupLabelStyleName) throws java.lang.IllegalStateException
isGroup
is set to true. Note that groupLabelBackgroundColor
overrides any background-color of this style.
groupLabelStyleName
- New groupLabelStyleName value. Default value is "groupLabel"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
,
Appearance overview and related methods
public java.lang.String getGroupLabelStyleName()
isGroup
is set to true. Note that groupLabelBackgroundColor
overrides any background-color of this style.
CSSStyleName
,
Appearance overview and related methods
public void setGroupTitle(java.lang.String groupTitle)
isGroup
is
set to true.
groupTitle
.groupTitle
- The new title for the grouping. Default value is nullHTMLString
,
Appearance overview and related methods
public java.lang.String getGroupTitle()
isGroup
is
set to true.HTMLString
,
Appearance overview and related methods
public void setHeight(java.lang.Integer height)
Can be a number of pixels, or a percentage like "50%". See
documentation for width
for details on how percentage values are
resolved actual size.
Note that if overflow
is set to
"visible", this size is a minimum, and the component may overflow to show all content and/or children.
If trying to
establish a default height for a custom component, set defaultHeight
instead.
If this method is called after the component has been drawn/initialized:
Resizes the widget vertically to the specified height (moves the bottom side of the widget). The height parameter can be expressed as a percentage of viewport size or as the number of pixels.
NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
height
- new height. Default value is nullSizing overview and related methods
public java.lang.Integer getHeight()
Can be a number of pixels, or a percentage like "50%". See
documentation for width
for details on how percentage values are
resolved actual size.
Note that if overflow
is set to
"visible", this size is a minimum, and the component may overflow to show all content and/or children.
If trying to
establish a default height for a custom component, set defaultHeight
instead.
Sizing overview and related methods
public void setHeight(java.lang.String height)
Can be a number of pixels, or a percentage like "50%". See
documentation for width
for details on how percentage values are
resolved actual size.
Note that if overflow
is set to
"visible", this size is a minimum, and the component may overflow to show all content and/or children.
If trying to
establish a default height for a custom component, set defaultHeight
instead.
If this method is called after the component has been drawn/initialized:
Resizes the widget vertically to the specified height (moves the bottom side of the widget). The height parameter can be expressed as a percentage of viewport size or as the number of pixels.
NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
setHeight
in class com.google.gwt.user.client.ui.UIObject
height
- new height. Default value is nullSizing overview and related methods
public void setHideUsingDisplayNone(boolean hideUsingDisplayNone) throws java.lang.IllegalStateException
visibility
and hide()
), should display:none be applied to the outer element
? This setting is not supported for general use, but in certain cases, it has been shown that display:none is a work-around for browser bugs involving burn-through of iframes or plugins, where the content of the iframe or plugin may still be visible despite the containing widget being hidden.
Note : This is an advanced setting
hideUsingDisplayNone
- New hideUsingDisplayNone value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public boolean getHideUsingDisplayNone()
visibility
and hide()
), should display:none be applied to the outer element
? This setting is not supported for general use, but in certain cases, it has been shown that display:none is a work-around for browser bugs involving burn-through of iframes or plugins, where the content of the iframe or plugin may still be visible despite the containing widget being hidden.
Appearance overview and related methods
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
- New hoverAlign value. Default value is nullsetShowHover(java.lang.Boolean)
public Alignment getHoverAlign()
this.showHover
is true, this property can be used to customize the alignment of content in the hover
canvas.getShowHover()
public void setHoverAutoDestroy(java.lang.Boolean hoverAutoDestroy)
this.showHover
is true and getHoverComponent()
is implemented, should the hoverCanvas returned from it be automatically destroyed when it is
hidden? The default of null indicates that the component will be automatically destroyed. Set to false to prevent this.
hoverAutoDestroy
- New hoverAutoDestroy value. Default value is nullsetShowHover(java.lang.Boolean)
public java.lang.Boolean getHoverAutoDestroy()
this.showHover
is true and getHoverComponent()
is implemented, should the hoverCanvas returned from it be automatically destroyed when it is
hidden? The default of null indicates that the component will be automatically destroyed. Set to false to prevent this.
getShowHover()
public void setHoverAutoFitMaxWidth(int hoverAutoFitMaxWidth)
hoverAutoFitWidth
is enabled. May be specified as a pixel value, or a percentage of page width.hoverAutoFitMaxWidth
- New hoverAutoFitMaxWidth value. Default value is 100public int getHoverAutoFitMaxWidth()
hoverAutoFitWidth
is enabled. May be specified as a pixel value, or a percentage of page width.public void setHoverAutoFitMaxWidth(java.lang.String hoverAutoFitMaxWidth)
hoverAutoFitWidth
is enabled. May be specified as a pixel value, or a percentage of page width.hoverAutoFitMaxWidth
- New hoverAutoFitMaxWidth value. Default value is 100public java.lang.String getHoverAutoFitMaxWidthAsString()
hoverAutoFitWidth
is enabled. May be specified as a pixel value, or a percentage of page width.public void setHoverAutoFitWidth(java.lang.Boolean hoverAutoFitWidth)
showHover
is true, this property will cause the specified
hoverWidth
to be treated as a minimum width for the hover. If
the hover content string exceeds this, the hover will expand to accomodate it up to hoverAutoFitMaxWidth
(without the text wrapping). Using
this settings differs from simply disabling wrapping via hoverWrap:false
as the content will wrap if the hoverAutoFitMaxWidth
is exceeded.
Note : This is an advanced setting
hoverAutoFitWidth
- New hoverAutoFitWidth value. Default value is truesetShowHover(java.lang.Boolean)
public java.lang.Boolean getHoverAutoFitWidth()
showHover
is true, this property will cause the specified
hoverWidth
to be treated as a minimum width for the hover. If
the hover content string exceeds this, the hover will expand to accomodate it up to hoverAutoFitMaxWidth
(without the text wrapping). Using
this settings differs from simply disabling wrapping via hoverWrap:false
as the content will wrap if the hoverAutoFitMaxWidth
is exceeded.
getShowHover()
public void setHoverDelay(int hoverDelay)
this.canHover
is true, how long should the mouse be kept over this widget before the hover event is
firedhoverDelay
- New hoverDelay value. Default value is 300setCanHover(java.lang.Boolean)
,
HoverEvent
public int getHoverDelay()
this.canHover
is true, how long should the mouse be kept over this widget before the hover event is
firedgetCanHover()
,
HoverEvent
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
- New hoverHeight value. Default value is nullsetShowHover(java.lang.Boolean)
public java.lang.Integer getHoverHeight()
this.showHover
is true, this property can be used to customize the height of the hover canvas shown.getShowHover()
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
- New hoverMoveWithMouse value. Default value is nullsetShowHover(java.lang.Boolean)
public java.lang.Boolean getHoverMoveWithMouse()
this.showHover
is true, should this widget's hover canvas be moved with the mouse while visible?getShowHover()
public void setHoverOpacity(java.lang.Integer hoverOpacity)
this.showHover
is true, should the hover canvas be shown with opacity other than 100?hoverOpacity
- New hoverOpacity value. Default value is nullsetShowHover(java.lang.Boolean)
,
Hovers / Tooltips Examplepublic java.lang.Integer getHoverOpacity()
this.showHover
is true, should the hover canvas be shown with opacity other than 100?getShowHover()
,
Hovers / Tooltips Examplepublic 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
- New hoverStyle value. Default value is nullsetShowHover(java.lang.Boolean)
,
CSSStyleName
,
Hovers / Tooltips Examplepublic java.lang.String getHoverStyle()
this.showHover
is true, this property can be used to specify the css style to apply to the hover canvas.getShowHover()
,
CSSStyleName
,
Hovers / Tooltips Examplepublic 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
- New hoverVAlign value. Default value is nullsetShowHover(java.lang.Boolean)
public VerticalAlignment getHoverVAlign()
this.showHover
is true, this property can be used to customize the vertical alignment of content in the
hover canvas.getShowHover()
public void setHoverWidth(int hoverWidth)
this.showHover
is true, this property can be used to
customize the width of the hover canvas shown. See also hoverAutoFitWidth
and hoverAutoFitMaxWidth
.hoverWidth
- New hoverWidth value. Default value is 1setShowHover(java.lang.Boolean)
,
Hovers / Tooltips Examplepublic int getHoverWidth()
this.showHover
is true, this property can be used to
customize the width of the hover canvas shown. See also hoverAutoFitWidth
and hoverAutoFitMaxWidth
.getShowHover()
,
Hovers / Tooltips Examplepublic 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. Note that if developers wish to have hovers expand horizontally to fit
their text without wrapping *up to some maximum*, and then wrap rather than exceeding that maximum, the hoverAutoFitWidth
and hoverAutoFitMaxWidth
attributes may be used instead of
simply setting hoverWrap to false.
hoverWrap
- New hoverWrap value. Default value is nullsetShowHover(java.lang.Boolean)
public 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. Note that if developers wish to have hovers expand horizontally to fit
their text without wrapping *up to some maximum*, and then wrap rather than exceeding that maximum, the hoverAutoFitWidth
and hoverAutoFitMaxWidth
attributes may be used instead of
simply setting hoverWrap to false.
getShowHover()
public void setHtmlElement(com.google.gwt.user.client.Element htmlElement)
draw()
. NOTES:
This feature is intended for temporary
integration with legacy page architectures only; the native browser's reaction to DOM insertion is unspecified and
unsupported. For consistent cross-browser layout and positioning semantics, use Canvas parents (especially Layouts) and
use absolute positioning at top level.
Persistence of htmlElement: If htmlPosition
is set to "replace"
the htmlElement will
be removed from the DOM when the canvas is drawn - therefore the htmlElement attribute will be cleared at this time.
Otherwise if a Canvas is clear()d and then draw()n again it will be rendered inside the same htmlElement.
If a
Canvas is added as a child to Canvas parent, its htmlElement will be dropped.
position
should typically be set to "relative"
if the
widget is to be rendered inline within a standard page.
If this method is called after the component has been drawn/initialized:
Setter for the htmlElement
.
Note : This is an advanced setting
setHtmlElement
in class BaseWidget
htmlElement
- New htmlElement for this canvas, or Null to clear the existing htmlElement. Default value is nullPositioning overview and related methods
public com.google.gwt.user.client.Element getHtmlElement()
draw()
. NOTES:
This feature is intended for temporary
integration with legacy page architectures only; the native browser's reaction to DOM insertion is unspecified and
unsupported. For consistent cross-browser layout and positioning semantics, use Canvas parents (especially Layouts) and
use absolute positioning at top level.
Persistence of htmlElement: If htmlPosition
is set to "replace"
the htmlElement will
be removed from the DOM when the canvas is drawn - therefore the htmlElement attribute will be cleared at this time.
Otherwise if a Canvas is clear()d and then draw()n again it will be rendered inside the same htmlElement.
If a
Canvas is added as a child to Canvas parent, its htmlElement will be dropped.
position
should typically be set to "relative"
if the
widget is to be rendered inline within a standard page.
Positioning overview and related methods
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.
htmlPosition
.
Note : This is an advanced setting
htmlPosition
- New htmlPosition for this canvas. Default value is "afterBegin"Positioning overview and related methods
public DrawPosition getHtmlPosition()
htmlElement
is specified, this attribute specifies the
position where the canvas should be inserted relative to the htmlElement
in the DOM.Positioning overview and related methods
public void setIsGroup(boolean isGroup) throws java.lang.IllegalStateException
isGroup
- New isGroup value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetGroupBorderCSS(java.lang.String)
,
setGroupLabelStyleName(java.lang.String)
,
setGroupLabelBackgroundColor(java.lang.String)
public boolean getIsGroup()
getGroupBorderCSS()
,
getGroupLabelStyleName()
,
getGroupLabelBackgroundColor()
public java.lang.Boolean getIsPrinting() throws java.lang.IllegalStateException
showPrintPreview()
(or just getPrintHTML()
). Note that this flag is set recursively as parent
widgets generate print HTML for their children. This is a read-only property and should not be modified by application code.
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public void setIsRuleScope(java.lang.Boolean isRuleScope) throws java.lang.IllegalStateException
ruleScope
that will be discovered by
any contained DataBoundComponent
s which do not specify an explicit
ruleScope
.isRuleScope
- New isRuleScope value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getIsRuleScope()
ruleScope
that will be discovered by
any contained DataBoundComponent
s which do not specify an explicit
ruleScope
.public void setIsSnapAlignCandidate(java.lang.Boolean isSnapAlignCandidate)
childrenSnapAlign
is enabled on this Canvas' parent.isSnapAlignCandidate
- New isSnapAlignCandidate value. Default value is nullpublic java.lang.Boolean getIsSnapAlignCandidate()
childrenSnapAlign
is enabled on this Canvas' parent.public void setKeepInParentRect(java.lang.Boolean keepInParentRect)
If this canvas has no parent, constrains dragging to within the browser window.
Affects target and outline dragAppearance, not tracker.
Note: keepInParentRect affects only user drag interactions, not programmatic moves.
Example use cases:
keepInParentRect: true
-
confine to parent
keepInParentRect: [0, 0, 500, 500]
- confine to top left 500x500 region within
parent
keepInParentRect: [0, 0, 10000, 10000]
- in combination with overflow: "auto", confine to
parent, but allow moving off the right and bottom of the parent to force scrolling (and hence enlarge the scrollWidth of
the parent).
Note : This is an advanced setting
keepInParentRect
- New keepInParentRect value. Default value is nullDragdrop overview and related methods
,
Drag create Examplepublic java.lang.Boolean getKeepInParentRect()
If this canvas has no parent, constrains dragging to within the browser window.
Affects target and outline dragAppearance, not tracker.
Note: keepInParentRect affects only user drag interactions, not programmatic moves.
Example use cases:
keepInParentRect: true
-
confine to parent
keepInParentRect: [0, 0, 500, 500]
- confine to top left 500x500 region within
parent
keepInParentRect: [0, 0, 10000, 10000]
- in combination with overflow: "auto", confine to
parent, but allow moving off the right and bottom of the parent to force scrolling (and hence enlarge the scrollWidth of
the parent).
Dragdrop overview and related methods
,
Drag create Examplepublic void setKeepInParentRect(java.lang.Integer... keepInParentRect)
If this canvas has no parent, constrains dragging to within the browser window.
Affects target and outline dragAppearance, not tracker.
Note: keepInParentRect affects only user drag interactions, not programmatic moves.
Example use cases:
keepInParentRect: true
-
confine to parent
keepInParentRect: [0, 0, 500, 500]
- confine to top left 500x500 region within
parent
keepInParentRect: [0, 0, 10000, 10000]
- in combination with overflow: "auto", confine to
parent, but allow moving off the right and bottom of the parent to force scrolling (and hence enlarge the scrollWidth of
the parent).
Note : This is an advanced setting
keepInParentRect
- New keepInParentRect value. Default value is nullDragdrop overview and related methods
,
Drag create Examplepublic void setLayoutAlign(Alignment layoutAlign)
layoutAlign
- New layoutAlign value. Default value is nullLayoutMember overview and related methods
public Alignment getLayoutAlign()
LayoutMember overview and related methods
public void setLayoutAlign(VerticalAlignment layoutAlign)
layoutAlign
- New layoutAlign value. Default value is nullLayoutMember overview and related methods
public void setLeavePageSpace(java.lang.Integer leavePageSpace)
defaultPageSpace
.
leavePageSpace
.
Note : This is an advanced setting
leavePageSpace
- new value for leavePageSpace
. Default value is nullPositioning overview and related methods
public java.lang.Integer getLeavePageSpace()
defaultPageSpace
.Positioning overview and related methods
public void setLeft(int left)
position
property). Can also be set as a percentage, specified as a
String ending in '%', eg, "50%". In this case the top coordinate is considered as a percentage of the specified width
of the parent
.
If this method is called after the component has been drawn/initialized:
Set the left coordinate of this object, relative to its enclosing context, in pixels. NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo() instead
left
- new left coordinate. Default value is 0Positioning overview and related methods
public int getLeft()
position
property). Can also be set as a percentage, specified as a
String ending in '%', eg, "50%". In this case the top coordinate is considered as a percentage of the specified width
of the parent
.
Positioning overview and related methods
public void setLeft(java.lang.String left)
position
property). Can also be set as a percentage, specified as a
String ending in '%', eg, "50%". In this case the top coordinate is considered as a percentage of the specified width
of the parent
.
If this method is called after the component has been drawn/initialized:
Set the left coordinate of this object, relative to its enclosing context, in pixels. NOTE: if you're setting multiple coordinates, use setRect(), moveTo() or resizeTo() instead
left
- new left coordinate. Default value is 0Positioning overview and related methods
public void setLocateChildrenBy(LocatorStrategy locateChildrenBy)
Note : This is an advanced setting
locateChildrenBy
- New locateChildrenBy value. Default value is nullpublic LocatorStrategy getLocateChildrenBy()
public void setLocateChildrenType(LocatorTypeStrategy locateChildrenType)
LocatorTypeStrategy
to use when finding children within this canvas.
Note : This is an advanced setting
locateChildrenType
- New locateChildrenType value. Default value is nullpublic LocatorTypeStrategy getLocateChildrenType()
LocatorTypeStrategy
to use when finding children within this canvas.public void setLocatePeersBy(LocatorStrategy locatePeersBy)
Note : This is an advanced setting
locatePeersBy
- New locatePeersBy value. Default value is nullpublic LocatorStrategy getLocatePeersBy()
public void setLocatePeersType(LocatorTypeStrategy locatePeersType)
LocatorTypeStrategy
to use when finding peers of this canvas.
Note : This is an advanced setting
locatePeersType
- New locatePeersType value. Default value is nullpublic LocatorTypeStrategy getLocatePeersType()
LocatorTypeStrategy
to use when finding peers of this canvas.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.
If this method is called after the component has been drawn/initialized:
Set the CSS Margin, in pixels, for this component. Margin provides blank space outside of the border.
This property sets the same thickness of margin on every side. Differing per-side margins can be set in a CSS style and applied via styleName
.
Note that the specified size of the widget will be the size including the margin thickness on each side.
margin
- new margin in pixels. Default value is nullAppearance overview and related methods
public 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.
Appearance overview and related methods
public Canvas getMasterElement() throws java.lang.IllegalStateException
getMasterCanvas()
as of Smart GWT release 9.1Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException
- if this widget has not yet been rendered.Containment overview and related methods
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
- New matchElement value. 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 setMaxHeight(int maxHeight)
maxWidth
for
details of behavior.
Note : This is an advanced setting
maxHeight
- New maxHeight value. Default value is 10000setDragMaxHeight(int)
,
Sizing overview and related methods
public int getMaxHeight()
maxWidth
for
details of behavior.getDragMaxHeight()
,
Sizing overview and related methods
public void setMaxWidth(int maxWidth)
The maxWidth
and maxHeight
settings apply to:
Layout
, the maximum size the layout should apply to the
canvas. CanvasItem
(maxHeight
only) drag resizing
ListGrid recordComponents
.
Note : This is an advanced setting
maxWidth
- New maxWidth value. Default value is 10000setDragMaxWidth(int)
,
Sizing overview and related methods
public int getMaxWidth()
The maxWidth
and maxHeight
settings apply to:
Layout
, the maximum size the layout should apply to the
canvas. CanvasItem
(maxHeight
only) drag resizing
ListGrid recordComponents
.getDragMaxWidth()
,
Sizing overview and related methods
public void setMaxZoomOverflowError(int maxZoomOverflowError)
correctZoomOverflow
is true and browser or
OS-level zoom is active, determines how much overflow must occur before the Framework enables scrolling for this canvas.
The larger the value, the more clipping that can occur before scrolling is enabled. So, this property should never be set larger than the minimum amount needed to prevent scrollbar oscillation when zoomed - which is the maximum scrollHeight or scrollWidth error.
Note : This is an advanced setting
maxZoomOverflowError
- New maxZoomOverflowError value. Default value is variespublic int getMaxZoomOverflowError()
correctZoomOverflow
is true and browser or
OS-level zoom is active, determines how much overflow must occur before the Framework enables scrolling for this canvas.
The larger the value, the more clipping that can occur before scrolling is enabled. So, this property should never be set larger than the minimum amount needed to prevent scrollbar oscillation when zoomed - which is the maximum scrollHeight or scrollWidth error.
public void setMenuConstructor(java.lang.String menuConstructor) throws java.lang.IllegalStateException
menuConstructor
- New menuConstructor value. Default value is "Menu"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdShowContextMenuEvent
,
SCClassName
,
Cues overview and related methods
public java.lang.String getMenuConstructor()
ShowContextMenuEvent
,
SCClassName
,
Cues overview and related methods
public void setMinHeight(int minHeight)
minWidth
for
details of behavior.
minHeight
.
Note : This is an advanced setting
minHeight
- new minimum height. Default value is 0setDragMinHeight(int)
,
Sizing overview and related methods
public int getMinHeight()
minWidth
for
details of behavior.getDragMinHeight()
,
Sizing overview and related methods
public void setMinNonEdgeSize(int minNonEdgeSize)
minNonEdgeSize
, the edgeMarginSize will be reduced such that the non-edge part
of the widget is at least 1/3 of the total space (with two draggable edges) or half of it (with one draggable edge).
Note : This is an advanced setting
minNonEdgeSize
- New minNonEdgeSize value. Default value is 0Dragdrop overview and related methods
,
Drag resize Examplepublic int getMinNonEdgeSize()
minNonEdgeSize
, the edgeMarginSize will be reduced such that the non-edge part
of the widget is at least 1/3 of the total space (with two draggable edges) or half of it (with one draggable edge).Dragdrop overview and related methods
,
Drag resize Examplepublic void setMinWidth(int minWidth)
The minWidth
and minHeight
settings apply to:
Layout
, the minimum size the layout should apply to the
canvas. CanvasItem
(minHeight
only) drag resizing
Overflow
"visible" outside of a Layout - minimum size will be the greater of this
setting or the minimum size needed to make all content visible Minimum sizes do not apply in various
other circumstances where sizes are being determined, such as ListGrid recordComponents
.
See also Layout.minMemberLength
as a way of establishing minimum
sizes along the length axis for all members of a Layout
with a single
setting.
If this method is called after the component has been drawn/initialized:
Resizes the widget horizontally if required to satisfy the specified minWidth
.
Note : This is an advanced setting
minWidth
- new minimum width. Default value is 0setDragMinWidth(int)
,
Sizing overview and related methods
public int getMinWidth()
The minWidth
and minHeight
settings apply to:
Layout
, the minimum size the layout should apply to the
canvas. CanvasItem
(minHeight
only) drag resizing
Overflow
"visible" outside of a Layout - minimum size will be the greater of this
setting or the minimum size needed to make all content visible Minimum sizes do not apply in various
other circumstances where sizes are being determined, such as ListGrid recordComponents
.
See also Layout.minMemberLength
as a way of establishing minimum
sizes along the length axis for all members of a Layout
with a single
setting.
getDragMinWidth()
,
Sizing overview and related methods
public void setMomentumScrollMinSpeed(double momentumScrollMinSpeed)
Note : This is an advanced setting
momentumScrollMinSpeed
- New momentumScrollMinSpeed value. Default value is 200public double getMomentumScrollMinSpeed()
public void setMouseStillDownDelay(int mouseStillDownDelay)
Canvas.mouseStillDown()
for details.
Note : This is an advanced setting
mouseStillDownDelay
- New mouseStillDownDelay value. Default value is 100public int getMouseStillDownDelay()
Canvas.mouseStillDown()
for details.public void setMouseStillDownInitialDelay(int mouseStillDownInitialDelay)
Canvas.mouseStillDown()
for details.
Note : This is an advanced setting
mouseStillDownInitialDelay
- New mouseStillDownInitialDelay value. Default value is 400public int getMouseStillDownInitialDelay()
Canvas.mouseStillDown()
for details.public void setName(java.lang.String name) throws java.lang.IllegalStateException
parent
to get defined results for Layout.getMember()
and Layout.getMemberNumber()
.name
- New name value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdBaseWidget.setID(java.lang.String)
,
Identifier
public java.lang.String getName()
parent
to get defined results for Layout.getMember()
and Layout.getMemberNumber()
.BaseWidget.getID()
,
Identifier
public void setNoDoubleClicks(java.lang.Boolean noDoubleClicks)
click
events rather than as doubleClick
events.
Note : This is an advanced setting
noDoubleClicks
- New noDoubleClicks value. Default value is nullpublic java.lang.Boolean getNoDoubleClicks()
click
events rather than as doubleClick
events.public void setNoDropCursor(Cursor noDropCursor)
showNoDropIndicator
is
true.
Note : This is an advanced setting
noDropCursor
- New noDropCursor value. Default value is Canvas.NOT_ALLOWEDCues overview and related methods
public Cursor getNoDropCursor()
showNoDropIndicator
is
true.Cues overview and related methods
public void setOpacity(java.lang.Integer opacity)
In older versions of Internet
Explorer (Pre IE9 / HTML5), opacity is achieved through proprietary filters. If filters have been disabled
within this application developers
must set useOpacityFilter
to true for specific components
on which opacity support is required.
Also note that opacity is incompatible with backMasks
.
If this method is called after the component has been drawn/initialized:
Sets the opacity for the widget to the newOpacity value. This newOpacity value must be within the range of 0 (transparent) to 100 (opaque). Null means don't specify opacity directly. Note that heavy use of opacity may have a performance impact on some older browsers.
In older versions of Internet Explorer (Pre IE9 / HTML5), opacity is achieved through proprietary filters. If filters have been disabled
within this application developers must set useOpacityFilter
to true for specific components on which opacity support is required.
Also note that opacity is incompatible with backMasks
.
Note : This is an advanced setting
opacity
- new opacity level. Default value is nullCues overview and related methods
public java.lang.Integer getOpacity()
In older versions of Internet
Explorer (Pre IE9 / HTML5), opacity is achieved through proprietary filters. If filters have been disabled
within this application developers
must set useOpacityFilter
to true for specific components
on which opacity support is required.
Also note that opacity is incompatible with backMasks
.
Cues overview and related methods
public void setOverflow(Overflow overflow)
overflow
of a Canvas after it has been created.overflow
- New overflow value. Default value is Canvas.VISIBLESizing overview and related methods
public Overflow getOverflow()
Sizing overview and related methods
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 CSS margins
or use a Layout
as the parent instead, and use properties such as Layout.layoutMargin
to create blank space.
If this method is called after the component has been drawn/initialized:
Set the CSS padding of this component, in pixels. Padding provides space between the border and the component's contents.
This property sets the same thickness of padding on every side. Differing per-side padding can be set in a CSS style and applied via styleName
.
padding
- new padding in pixels. Default value is nullAppearance overview and related methods
public 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 CSS margins
or use a Layout
as the parent instead, and use properties such as Layout.layoutMargin
to create blank space.
Appearance overview and related methods
public void setParentCanvas(Canvas parentCanvas) throws java.lang.IllegalStateException
addChild()
and removeChild()
calls on the parent. The parent Canvas should be fetched using getParentCanvas()
.parentCanvas
- New parentCanvas value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdContainment overview and related methods
public Canvas getParentCanvas()
addChild()
and removeChild()
calls on the parent. The parent Canvas should be fetched using getParentCanvas()
.Containment overview and related methods
public void setParentElement(Canvas parentElement) throws java.lang.IllegalStateException
parentCanvas
and getParentCanvas()
addChild()
and removeChild()
calls on the parent.
Note : This is an advanced setting
parentElement
- New parentElement value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdContainment overview and related methods
public Canvas getParentElement()
parentCanvas
and getParentCanvas()
addChild()
and removeChild()
calls on the parent.Containment overview and related methods
public void setPeers(Canvas... peers) throws java.lang.IllegalStateException
Use addPeer()
and removePeer()
to add and remove peers after a Canvas has been
created/drawn.
Note : This is an advanced setting
peers
- New peers value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdContainment overview and related methods
public Canvas[] getPeers()
Use addPeer()
and removePeer()
to add and remove peers after a Canvas has been
created/drawn.
Containment overview and related methods
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 other canvas
.
Determines whether the coordinates used for sizing
(for percentage sized widgets) and positioning (if snapTo
is set) should be relative to the visible size or
the viewport size of the percentSource or master canvas
widget.
Note : This is an advanced setting
percentBox
- New percentBox value. Default value is "visible"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdSizing overview and related methods
public PercentBoxModel getPercentBox()
snapTo
. Only affects widgets with a a specified
percentSource
, or widgets that have snapTo
set and are peers of some other canvas
.
Determines whether the coordinates used for sizing
(for percentage sized widgets) and positioning (if snapTo
is set) should be relative to the visible size or
the viewport size of the percentSource or master canvas
widget.
Sizing overview and related methods
public void setPercentSource(Canvas percentSource)
If unset percentage sizing is based on
- the master canvas
if there is one and snapTo
is set,
- otherwise on the amount of space available in this
widget's parent canvas, if this is a child of some other widget
- otherwise the page size.
If this method is called after the component has been drawn/initialized:
Setter method for the percentSource
attribute.
Note : This is an advanced setting
percentSource
- eterNew percent source (if omitted existing percentSource will just be cleared). Default value is nullsetPercentBox(com.smartgwt.client.types.PercentBoxModel)
,
Sizing overview and related methods
public Canvas getPercentSource()
If unset percentage sizing is based on
- the master canvas
if there is one and snapTo
is set,
- otherwise on the amount of space available in this
widget's parent canvas, if this is a child of some other widget
- otherwise the page size.
getPercentBox()
,
Sizing overview and related methods
public void setPosition(Positioning position)
Setting position:"relative"
enables Smart GWT components to be embedded
directly into the native HTML flow of a page, causing the component to be rendered
within an existing DOM structure.
This attribute should only be set to "relative"
on a top level component
(a component with no getParentCanvas()
).
There are 2 ways to embed relatively positioned canvases in the DOM - by default the
component will be written out inline when it gets drawn()n
. For example
to embed a canvas in an HTML table you could use this code:
<table> <tr> <td> <script> isc.Canvas.create({autoDraw:true, backgroundColor:"red", position:"relative"}); </script> <td> </tr> </table>Alternatively you can make use of the
htmlElement
attribute.
Relative positioning is intended as a short-term integration scenario while incrementally
upgrading existing applications.
Note that relative positioning is not used to manage layout within Smart GWT components -
instead the Layout
class would typically be used.
For best consistency and flexibility across browsers, all Smart GWT layout managers
use absolute positioning.
For canvases with a specified htmlElement
, this attribute
defaults to
"relative"
. In all other cases the default value will be
"absolute"
.
Note : This is an advanced setting
position
- New position value. Default value is nullPositioning overview and related methods
public Positioning getPosition()
Setting position:"relative"
enables Smart GWT components to be embedded
directly into the native HTML flow of a page, causing the component to be rendered
within an existing DOM structure.
This attribute should only be set to "relative"
on a top level component
(a component with no getParentCanvas()
).
There are 2 ways to embed relatively positioned canvases in the DOM - by default the
component will be written out inline when it gets drawn()n
. For example
to embed a canvas in an HTML table you could use this code:
<table> <tr> <td> <script> isc.Canvas.create({autoDraw:true, backgroundColor:"red", position:"relative"}); </script> <td> </tr> </table>Alternatively you can make use of the
htmlElement
attribute.
Relative positioning is intended as a short-term integration scenario while incrementally
upgrading existing applications.
Note that relative positioning is not used to manage layout within Smart GWT components -
instead the Layout
class would typically be used.
For best consistency and flexibility across browsers, all Smart GWT layout managers
use absolute positioning.
For canvases with a specified htmlElement
, this attribute
defaults to
"relative"
. In all other cases the default value will be
"absolute"
.
Positioning overview and related methods
public void setPrintChildrenAbsolutelyPositioned(java.lang.Boolean printChildrenAbsolutelyPositioned)
printable HTML
. By default explicitly specified absolute positioning and sizing is ignored when generating print HTML. This is done intentionally: there is no way for the framework to predict how explicit sizes will translate to a the printed page and if HTML for printing includes the same absolute positioning and sizing as is displayed within an application it is very common to encounter undesirable effects, such as seeing tables get broken over several pages horizontally when there is enough room to print them on a single page of paper.
In some cases, however, a developer may wish to have explicit sizing and positioning respected
within the print-view. Setting this attribute to true
will cause this to occur.
Note : This is an advanced setting
printChildrenAbsolutelyPositioned
- New printChildrenAbsolutelyPositioned value. Default value is falsePrinting overview and related methods
public java.lang.Boolean getPrintChildrenAbsolutelyPositioned()
printable HTML
. By default explicitly specified absolute positioning and sizing is ignored when generating print HTML. This is done intentionally: there is no way for the framework to predict how explicit sizes will translate to a the printed page and if HTML for printing includes the same absolute positioning and sizing as is displayed within an application it is very common to encounter undesirable effects, such as seeing tables get broken over several pages horizontally when there is enough room to print them on a single page of paper.
In some cases, however, a developer may wish to have explicit sizing and positioning respected
within the print-view. Setting this attribute to true
will cause this to occur.
Printing overview and related methods
public void setPrompt(java.lang.String prompt)
showHover
is true.prompt
- New prompt value. Default value is nullHTMLString
,
Hovers / Tooltips Examplepublic java.lang.String getPrompt()
showHover
is true.HTMLString
,
Hovers / Tooltips Examplepublic void setProportionalResizing(ProportionalResizeMode proportionalResizing) throws java.lang.IllegalStateException
canDragResize
is true, this property specifies the
conditions for when proportional resizing is used. The default is ProportionalResizeMode.MODIFIER_OFF
, which means that proportional resizing is disabled.proportionalResizing
- New proportionalResizing value. Default value is "none"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetProportionalResizeModifiers(java.lang.String...)
,
Dragdrop overview and related methods
public ProportionalResizeMode getProportionalResizing()
canDragResize
is true, this property specifies the
conditions for when proportional resizing is used. The default is ProportionalResizeMode.MODIFIER_OFF
, which means that proportional resizing is disabled.getProportionalResizeModifiers()
,
Dragdrop overview and related methods
public void setReceiveScrollbarEvents(boolean receiveScrollbarEvents) throws java.lang.IllegalStateException
events
from its scrollbars, which are peers
. Normally, a canvas only gets bubbled events from its children
. Note that this property only has an impact if showCustomScrollbars
is true.
receiveScrollbarEvents
- New receiveScrollbarEvents value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetShowCustomScrollbars(boolean)
,
Scrolling overview and related methods
public boolean getReceiveScrollbarEvents()
events
from its scrollbars, which are peers
. Normally, a canvas only gets bubbled events from its children
. Note that this property only has an impact if showCustomScrollbars
is true.
getShowCustomScrollbars()
,
Scrolling overview and related methods
public void setRedrawOnResize(java.lang.Boolean redrawOnResize)
Should be set to true for components whose inner HTML
will not automatically reflow to fit the component's new
size.
Note : This is an advanced setting
redrawOnResize
- New redrawOnResize value. Default value is nullDrawing overview and related methods
public java.lang.Boolean getRedrawOnResize()
Should be set to true for components whose inner HTML
will not automatically reflow to fit the component's new
size.
Drawing overview and related methods
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
- New resizeBarTarget value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetShowResizeBar(java.lang.Boolean)
,
LayoutMember overview and related methods
public 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.
getShowResizeBar()
,
LayoutMember overview and related methods
public void setResizeFrom(EdgeName... resizeFrom)
canDragResize
, restricts
resizes to only certain edges or corners. The default of null indicates the widget can be resized from any corner or
edge (if canDragResize
is true).
To restrict resizing to only certain corners, set
resizeFrom
to an Array of EdgeName
s.
Note : This is an advanced setting
resizeFrom
- New resizeFrom value. Default value is nullDragdrop overview and related methods
,
Drag resize Examplepublic EdgeName[] getResizeFrom()
canDragResize
, restricts
resizes to only certain edges or corners. The default of null indicates the widget can be resized from any corner or
edge (if canDragResize
is true).
To restrict resizing to only certain corners, set
resizeFrom
to an Array of EdgeName
s.
Dragdrop overview and related methods
,
Drag resize Examplepublic void setRuleScope(java.lang.String ruleScope) throws java.lang.IllegalStateException
ID
of the component that gathers the context for evaluation of
criteria-based
rules specified by properties such as FormItem.visibleWhen
.
If not specified, this component will search through it's parentCanvas
chain until it
either reaches the top or reaches a parent marked isRuleScope
.
Determination of the
ruleScope
happens when the component is first drawn.
The component designated as the ruleScope
manages a nested data structure called
the "rule context" which contains information from all DataBoundComponent
s that are
registered with the ruleScope
. By specifying Criterion.fieldName
as a
DataPath
, AdvancedCriteria defined in properties such as
FormItem.visibleWhen
can access any part of the
rule context.
By default, the rule context contains data as follows:
DataBoundComponent
that has a DataSource contributes the values of the
selected record or record being edited under the ID of the DataSource. For any collision
an editable display (such as a form or editable grid) wins over a static display (such as
a non-editable grid with a selection.)
ID
will contribute the values of the selected record under
<componentId>.selectedRecord
, and also contributes 3 flags for checking
for selection: anySelected
, multiSelected
,
numSelected
.
ID
contributes its current values under
<componentId>.values
, and contributes a flag hasChanges
.
ID
contributes a value <componentId>.focusField
. When present the value
indicates the component has focus along with the name of the field that has focus. Its absense
indicates the component does not have focus at all.
ID
contributes a
flag
isGrouped
under <componentId>
.
supplyItem
sample DataSource
getRuleContext()
,
expressed as JSON, would be:
{ supplyItem : { itemID : "654321", itemName : "Sewing Machine", price : 5.50, // note: user change ..other properties.. }, itemForm.values : { itemID : "654321", itemName : "Sewing Machine", price : 5.50, // note: user change ..other properties.. }, itemForm.focusField : "itemName", itemForm.hasChanges : true, itemGrid.selectedRecord : { itemID : "654321", itemName : "Sewing Machine", price : 3.50, // note: old price ..other properties.. }, itemGrid.anySelected : true, itemGrid.multiSelected : false, itemGrid.numSelected : 1, itemGrid.isGrouped : false }In addition, an application can put custom data into the ruleScope via
provideRuleContext()
.ruleScope
- New ruleScope value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getRuleScope()
ID
of the component that gathers the context for evaluation of
criteria-based
rules specified by properties such as FormItem.visibleWhen
.
If not specified, this component will search through it's parentCanvas
chain until it
either reaches the top or reaches a parent marked isRuleScope
.
Determination of the
ruleScope
happens when the component is first drawn.
The component designated as the ruleScope
manages a nested data structure called
the "rule context" which contains information from all DataBoundComponent
s that are
registered with the ruleScope
. By specifying Criterion.fieldName
as a
DataPath
, AdvancedCriteria defined in properties such as
FormItem.visibleWhen
can access any part of the
rule context.
By default, the rule context contains data as follows:
DataBoundComponent
that has a DataSource contributes the values of the
selected record or record being edited under the ID of the DataSource. For any collision
an editable display (such as a form or editable grid) wins over a static display (such as
a non-editable grid with a selection.)
ID
will contribute the values of the selected record under
<componentId>.selectedRecord
, and also contributes 3 flags for checking
for selection: anySelected
, multiSelected
,
numSelected
.
ID
contributes its current values under
<componentId>.values
, and contributes a flag hasChanges
.
ID
contributes a value <componentId>.focusField
. When present the value
indicates the component has focus along with the name of the field that has focus. Its absense
indicates the component does not have focus at all.
ID
contributes a
flag
isGrouped
under <componentId>
.
supplyItem
sample DataSource
getRuleContext()
,
expressed as JSON, would be:
{ supplyItem : { itemID : "654321", itemName : "Sewing Machine", price : 5.50, // note: user change ..other properties.. }, itemForm.values : { itemID : "654321", itemName : "Sewing Machine", price : 5.50, // note: user change ..other properties.. }, itemForm.focusField : "itemName", itemForm.hasChanges : true, itemGrid.selectedRecord : { itemID : "654321", itemName : "Sewing Machine", price : 3.50, // note: old price ..other properties.. }, itemGrid.anySelected : true, itemGrid.multiSelected : false, itemGrid.numSelected : 1, itemGrid.isGrouped : false }In addition, an application can put custom data into the ruleScope via
provideRuleContext()
.public void setScrollbarConstructor(java.lang.String scrollbarConstructor) throws java.lang.IllegalStateException
When spriting is enabled
and supported by the skin, the default
scrollbarConstructor
is changed to a different scrollbar class which handles scrollbar spriting. Spriting
of the scrollbars of an individual component can therefore be disabled by creating the component with
scrollbarConstructor
set to the "Scrollbar" class. "Scrollbar" is a basic scrollbar class that does not
employ spriting.
Note : This is an advanced setting
scrollbarConstructor
- New scrollbarConstructor value. Default value is "Scrollbar"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdScrolling overview and related methods
public void setScrollbarSize(int scrollbarSize)
showCustomScrollbars
is true
.
NOTE: When spriting is enabled
, changing the
scrollbarSize
may cause tiling of certain images and backgrounds that make up the custom scrollbar. This
can be fixed for a component by creating it with scrollbarConstructor
set to "Scrollbar"—a basic scrollbar class that does not employ spriting.
Note : This is an advanced setting
scrollbarSize
- New scrollbarSize value. Default value is 16getScrollbarSize()
,
Scrolling overview and related methods
public int getScrollbarSize()
showCustomScrollbars
is true
.
NOTE: When spriting is enabled
, changing the
scrollbarSize
may cause tiling of certain images and backgrounds that make up the custom scrollbar. This
can be fixed for a component by creating it with scrollbarConstructor
set to "Scrollbar"—a basic scrollbar class that does not employ spriting.
this.scrollbarSize
. Default value is 16getScrollbarSize()
,
Scrolling overview and related methods
public void setShadowColor(java.lang.String shadowColor)
useCSSShadow
is
true and showShadow
is true. Has no effect if we are not
using css-based shadows - in that case, use shadowImage
instead.
Note : This is an advanced setting
shadowColor
- New shadowColor value. Default value is "#AAAAAA"CSSColor
public java.lang.String getShadowColor()
useCSSShadow
is
true and showShadow
is true. Has no effect if we are not
using css-based shadows - in that case, use shadowImage
instead.
CSSColor
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
- New shadowDepth value. Default value is 4java.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 setShadowHOffset(java.lang.Integer shadowHOffset)
shadow
. Takes precedence over shadowOffset
if set. Has no effect if css-shadows
are not being used for this canvas.
Note : This is an advanced setting
shadowHOffset
- New shadowHOffset value. Default value is nullpublic java.lang.Integer getShadowHOffset()
shadow
. Takes precedence over shadowOffset
if set. Has no effect if css-shadows
are not being used for this canvas.public void setShadowImage(java.lang.String shadowImage) throws java.lang.IllegalStateException
useCSSShadow
is false, (or for browsers that do not
support css3), this property supplies the base name of the series of images for the sides, corners, and center of the
shadow. The actual image names fetched for the dropShadow combine the segment name and the shadowDepth
setting. For example, given "ds.png" as the base name, a depth of 4, and the top-left segment of the shadow, we'd use
"ds4_TL.png".
The names for segments are the same as those given for controlling resizable edges; see resizeFrom
. The center segment has the name "center". The center
segment is the only segment that doesn't include the depth in the URL, so the final image name for the center given a
baseName of "ds.png" would be just "ds_center.png".
Note : This is an advanced setting
shadowImage
- New shadowImage value. Default value is "[SKIN]ds.png"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCImgURL
public java.lang.String getShadowImage()
useCSSShadow
is false, (or for browsers that do not
support css3), this property supplies the base name of the series of images for the sides, corners, and center of the
shadow. The actual image names fetched for the dropShadow combine the segment name and the shadowDepth
setting. For example, given "ds.png" as the base name, a depth of 4, and the top-left segment of the shadow, we'd use
"ds4_TL.png".
The names for segments are the same as those given for controlling resizable edges; see resizeFrom
. The center segment has the name "center". The center
segment is the only segment that doesn't include the depth in the URL, so the final image name for the center given a
baseName of "ds.png" would be just "ds_center.png".
SCImgURL
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.
If css shadows
are being used, separate vertical and horizontal offsets
may be specified via shadowHOffset
and shadowVOffset
.
Note : This is an advanced setting
shadowOffset
- New shadowOffset value. 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.
If css shadows
are being used, separate vertical and horizontal offsets
may be specified via shadowHOffset
and shadowVOffset
.
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
- New shadowSoftness value. 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 setShadowSpread(java.lang.Integer shadowSpread)
useCSSShadow
is true and showShadow
is true. This property
governs how much larger than the widget the shadow will appear. A negative value (coupled with an explicit offset) will
result in a smaller shadow. Has no effect if we are not using css-based shadows - in that case, use shadowImage
instead.
Note : This is an advanced setting
shadowSpread
- New shadowSpread value. Default value is nullpublic java.lang.Integer getShadowSpread()
useCSSShadow
is true and showShadow
is true. This property
governs how much larger than the widget the shadow will appear. A negative value (coupled with an explicit offset) will
result in a smaller shadow. Has no effect if we are not using css-based shadows - in that case, use shadowImage
instead.
public void setShadowVOffset(java.lang.Integer shadowVOffset)
shadow
. Takes precedence over shadowOffset
if set. Has no effect if css-shadows
are not being used for this canvas.
Note : This is an advanced setting
shadowVOffset
- New shadowVOffset value. Default value is nullpublic java.lang.Integer getShadowVOffset()
shadow
. Takes precedence over shadowOffset
if set. Has no effect if css-shadows
are not being used for this canvas.public void setShouldPrint(java.lang.Boolean shouldPrint)
Default is to:
PrintProperties.omitControls
) shouldPrint
- New shouldPrint value. Default value is nullPrinting overview and related methods
public java.lang.Boolean getShouldPrint()
Default is to:
PrintProperties.omitControls
) Printing overview and related methods
public void setShowCustomScrollbars(boolean showCustomScrollbars) throws java.lang.IllegalStateException
Smart GWT-based scrollbars are skinnable, giving you complete control over look and
feel. Smart GWT-based scrollbars also enable some interactions not possible with
native scrollbars, such as variable height
records
in grids in combination with data paging
.
Native browser scrollbars are slightly faster simply because there are less Smart GWT components that need to be created, drawn and updated. Each visible Smart GWT-based scrollbar on the screen has roughly the impact of two StretchImgButtons.
Smart GWT is always aware of the size of the scrollbar, regardless of whether native
or custom scrollbars are used, and regardless of what operating system and/or operating
system "theme" or "skin" is in use. This means Smart GWT will correctly report the
viewport size
, that is, the interior area of the
widget excluding space taken by scrollbars, which is key for exactly filling a component
with content without creating unnecessary scrolling.
The showCustomScrollbars
setting is typically overridden in load_skin.js in
order to change the default for all Smart GWT components at once.
This may be achieved via the static setDefaultShowCustomScrollbars(boolean)
method or
calling setProperty() , like so:
Canvas canvas = new Canvas(); canvas.setProperty("showCustomScrollbars", false);
On touch devices
, custom scrollbars are disabled in favor of enabling
native touch scrolling if available. However, custom scrollbars and native touch
scrolling can be enabled for the component by setting alwaysShowScrollbars
to true
.
Note : This is an advanced setting
showCustomScrollbars
- New showCustomScrollbars value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetReceiveScrollbarEvents(boolean)
,
Scrolling overview and related methods
public boolean getShowCustomScrollbars()
Smart GWT-based scrollbars are skinnable, giving you complete control over look and
feel. Smart GWT-based scrollbars also enable some interactions not possible with
native scrollbars, such as variable height
records
in grids in combination with data paging
.
Native browser scrollbars are slightly faster simply because there are less Smart GWT components that need to be created, drawn and updated. Each visible Smart GWT-based scrollbar on the screen has roughly the impact of two StretchImgButtons.
Smart GWT is always aware of the size of the scrollbar, regardless of whether native
or custom scrollbars are used, and regardless of what operating system and/or operating
system "theme" or "skin" is in use. This means Smart GWT will correctly report the
viewport size
, that is, the interior area of the
widget excluding space taken by scrollbars, which is key for exactly filling a component
with content without creating unnecessary scrolling.
The showCustomScrollbars
setting is typically overridden in load_skin.js in
order to change the default for all Smart GWT components at once.
This may be achieved via the static setDefaultShowCustomScrollbars(boolean)
method or
calling setProperty() , like so:
Canvas canvas = new Canvas(); canvas.setProperty("showCustomScrollbars", false);
On touch devices
, custom scrollbars are disabled in favor of enabling
native touch scrolling if available. However, custom scrollbars and native touch
scrolling can be enabled for the component by setting alwaysShowScrollbars
to true
.
getReceiveScrollbarEvents()
,
Scrolling overview and related methods
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
- New showDragShadow value. Default value is nullDragdrop overview and related methods
,
Drag effects Examplepublic java.lang.Boolean getShowDragShadow()
"target"
, should we show a shadow behind the canvas
during the drag.Dragdrop overview and related methods
,
Drag effects Examplepublic void setShowEdges(java.lang.Boolean showEdges) throws java.lang.IllegalStateException
EdgedCanvas
should be used to show image-based edges around this
component.showEdges
- New showEdges value. Default value is falsejava.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 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
- New showHover value. Default value is truegetHoverHTML()
public java.lang.Boolean getShowHover()
this.canHover
is true, should we show the global hover canvas by default when the user hovers over this
canvas?getHoverHTML()
public void setShowHoverComponents(java.lang.Boolean showHoverComponents)
getHoverComponent
to provide the Canvas to show as the
hoverComponent.
Note : This is an advanced setting
showHoverComponents
- New showHoverComponents value. Default value is falsepublic java.lang.Boolean getShowHoverComponents()
getHoverComponent
to provide the Canvas to show as the
hoverComponent.public void setShowResizeBar(java.lang.Boolean showResizeBar)
Layout
, whether a resizeBar
should be shown after this member in the layout, to allow it to be resized. Whether a resizeBar is actually shown
also depends on the defaultResizeBars
attribute
of the layout, and whether this Canvas is the last layout member.
By default the resize bar acts on the Canvas that
it is declared on. If you want the resize bar to instead act on the next member of the Layout (e.g. to collapse down or
to the right), set resizeBarTarget
as well.
If this method is called after the component has been drawn/initialized:
When this Canvas is included as a member in a Layout
, dynamically updates whether a resizeBar should be shown after this member in the layout, to allow it to be resized.
Whether a resizeBar is actually shown also depends on the defaultResizeBars
attribute of the layout, and whether this Canvas is the last layout member.
showResizeBar
- setting for this.showResizeBar. Default value is falsesetResizeBarTarget(java.lang.String)
,
Layout.setDefaultResizeBars(com.smartgwt.client.types.LayoutResizeBarPolicy)
,
LayoutMember overview and related methods
,
Nesting Examplepublic java.lang.Boolean getShowResizeBar()
Layout
, whether a resizeBar
should be shown after this member in the layout, to allow it to be resized. Whether a resizeBar is actually shown
also depends on the defaultResizeBars
attribute
of the layout, and whether this Canvas is the last layout member.
By default the resize bar acts on the Canvas that
it is declared on. If you want the resize bar to instead act on the next member of the Layout (e.g. to collapse down or
to the right), set resizeBarTarget
as well.
getResizeBarTarget()
,
Layout.getDefaultResizeBars()
,
LayoutMember overview and related methods
,
Nesting Examplepublic void setShowShadow(java.lang.Boolean showShadow)
Shadows may be rendered using css
or via images. The appearance of shadows can be customized via
shadowColor
(for css-based shadows) or shadowImage
(for image based shadows), shadowDepth
, shadowOffset
and shadowSoftness
.
When useCSSShadow
is false, developers should be aware that the drop
shadow is rendered as a peer
and is drawn outside the specified
width and height of the widget meaning a widget with shadows takes up a little more space than it otherwise would. A
full screen canvas with showShadow set to true as this would be likely to cause browser scrollbars to appear -
developers can handle this by either setting this property to false on full-screen widgets, or by setting overflow to
"hidden" on the <body> element if browser-level scrolling is never intended to occur.
If this method is called after the component has been drawn/initialized:
Method to update showShadow
.
showShadow
- true if the shadow should be visible false if not. Default value is falsepublic java.lang.Boolean getShowShadow()
Shadows may be rendered using css
or via images. The appearance of shadows can be customized via
shadowColor
(for css-based shadows) or shadowImage
(for image based shadows), shadowDepth
, shadowOffset
and shadowSoftness
.
When useCSSShadow
is false, developers should be aware that the drop
shadow is rendered as a peer
and is drawn outside the specified
width and height of the widget meaning a widget with shadows takes up a little more space than it otherwise would. A
full screen canvas with showShadow set to true as this would be likely to cause browser scrollbars to appear -
developers can handle this by either setting this property to false on full-screen widgets, or by setting overflow to
"hidden" on the <body> element if browser-level scrolling is never intended to occur.
public void setShowSnapGrid(java.lang.Boolean showSnapGrid)
childrenSnapToGrid
or childrenSnapResizeToGrid
is true
. Grid
is based on snapHGap
and snapVGap
properties.
If this method is called after the component has been drawn/initialized:
Set the showSnapGrid property.
showSnapGrid
- New showSnapGrid value. Default value is nullpublic java.lang.Boolean getShowSnapGrid()
childrenSnapToGrid
or childrenSnapResizeToGrid
is true
. public void setShrinkElementOnHide(boolean shrinkElementOnHide)
true
, when a widget is hidden
, the widget's handle will be resized such that it takes up no space, in
addition to having its css visibility
property set to "hidden"
. In addition to preventing
the size of this widget from impacting the scroll size
of any
parent widget while hidden, this setting works around a native bug observed in Internet Explorer 10, whereby an
<IFRAME>
element with visibility set to hidden can cause rendering problems, if the HTML loaded by
the <IFRAME>
contains a <frameset>
. In this case the browser may refuse to draw
other elements at the same coordinates with a lower z-index than the hidden frame. Setting this property to
true
works around this problem for cases where an <IFRAME>
containing a
<frameset
will be rendered out, for example in an HTMLFlow
with
contentsType
set to "page"
.
Note : This is an advanced setting
shrinkElementOnHide
- New shrinkElementOnHide value. Default value is falseVisibility overview and related methods
public boolean getShrinkElementOnHide()
true
, when a widget is hidden
, the widget's handle will be resized such that it takes up no space, in
addition to having its css visibility
property set to "hidden"
. In addition to preventing
the size of this widget from impacting the scroll size
of any
parent widget while hidden, this setting works around a native bug observed in Internet Explorer 10, whereby an
<IFRAME>
element with visibility set to hidden can cause rendering problems, if the HTML loaded by
the <IFRAME>
contains a <frameset>
. In this case the browser may refuse to draw
other elements at the same coordinates with a lower z-index than the hidden frame. Setting this property to
true
works around this problem for cases where an <IFRAME>
containing a
<frameset
will be rendered out, for example in an HTMLFlow
with
contentsType
set to "page"
.
Visibility overview and related methods
public void setSizeMayChangeOnRedraw(java.lang.Boolean sizeMayChangeOnRedraw)
redraw()
on this widget will change its
size? Used by framework layout code when determining whether a component which has been marked as dirty
needs an immediate redraw to determine its drawn size.
If unset, default behavior assumes any component with overflow set to "visible" may change size on redraw, and any component with overflow set to "hidden", "scroll", or "auto" will not. This property overrides that behavior, and may be used to indicate that some component with non visible overflow can change size on redraw. An example use case would be a custom component with an override to explicitly resize the component as part of the redraw() flow.
Note : This is an advanced setting
sizeMayChangeOnRedraw
- New sizeMayChangeOnRedraw value. Default value is nullpublic java.lang.Boolean getSizeMayChangeOnRedraw()
redraw()
on this widget will change its
size? Used by framework layout code when determining whether a component which has been marked as dirty
needs an immediate redraw to determine its drawn size.
If unset, default behavior assumes any component with overflow set to "visible" may change size on redraw, and any component with overflow set to "hidden", "scroll", or "auto" will not. This property overrides that behavior, and may be used to indicate that some component with non visible overflow can change size on redraw. An example use case would be a custom component with an override to explicitly resize the component as part of the redraw() flow.
public void setSkinImgDir(java.lang.String skinImgDir)
skinDir
.
Note : This is an advanced setting
skinImgDir
- New skinImgDir value. Default value is "images/"SCImgURL
,
Images overview and related methods
public java.lang.String getSkinImgDir()
skinDir
.SCImgURL
,
Images overview and related methods
public void setSnapAlignCandidates(Canvas... snapAlignCandidates)
childrenSnapAlign
is enabled, list of candidates to
check for alignment. If a list of snapAlignCandidates
is never provided, the default is to use all
children that are not explicitly excluded via isSnapAlignCandidate
, including automatically adding newly added children as candidates, and ignoring children that
have been removed. Use addSnapAlignCandidate()
and
removeSnapAlignCandidate()
to add and remove special
candidates while retaining all children as default candidates.
Possible candidates which are not drawn or are hidden are automatically ignored.
snapAlignCandidates
- New snapAlignCandidates value. Default value is nullpublic Canvas[] getSnapAlignCandidates()
childrenSnapAlign
is enabled, list of candidates to
check for alignment. If a list of snapAlignCandidates
is never provided, the default is to use all
children that are not explicitly excluded via isSnapAlignCandidate
, including automatically adding newly added children as candidates, and ignoring children that
have been removed. Use addSnapAlignCandidate()
and
removeSnapAlignCandidate()
to add and remove special
candidates while retaining all children as default candidates.
Possible candidates which are not drawn or are hidden are automatically ignored.
public void setSnapAlignCenterLineStyle(java.lang.String snapAlignCenterLineStyle) throws java.lang.IllegalStateException
childrenSnapAlign
is set.snapAlignCenterLineStyle
- New snapAlignCenterLineStyle value. Default value is "1px solid blue"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getSnapAlignCenterLineStyle()
childrenSnapAlign
is set.public void setSnapAlignEdgeLineStyle(java.lang.String snapAlignEdgeLineStyle) throws java.lang.IllegalStateException
childrenSnapAlign
is set.snapAlignEdgeLineStyle
- New snapAlignEdgeLineStyle value. Default value is "1px solid #555555"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getSnapAlignEdgeLineStyle()
childrenSnapAlign
is set.public void setSnapAxis(java.lang.String snapAxis)
snapAxis
- New snapAxis value. Default value is "both"setSnapToGrid(java.lang.Boolean)
,
setSnapResizeToGrid(java.lang.Boolean)
,
setChildrenSnapToGrid(java.lang.Boolean)
,
setChildrenSnapResizeToGrid(java.lang.Boolean)
,
Dragdrop overview and related methods
public java.lang.String getSnapAxis()
getSnapToGrid()
,
getSnapResizeToGrid()
,
getChildrenSnapToGrid()
,
getChildrenSnapResizeToGrid()
,
Dragdrop overview and related methods
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.
If this method is called after the component has been drawn/initialized:
Set the snapEdge property of this canvas, and handle repositioning.
snapEdge
- new snapEdge value. Default value is nullsetSnapTo(java.lang.String)
,
Sizing overview and related methods
public 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.
getSnapTo()
,
Sizing overview and related methods
public void setSnapHDirection(java.lang.String snapHDirection)
snapHDirection
- New snapHDirection value. Default value is "after"setSnapToGrid(java.lang.Boolean)
,
setSnapResizeToGrid(java.lang.Boolean)
,
setChildrenSnapToGrid(java.lang.Boolean)
,
setChildrenSnapResizeToGrid(java.lang.Boolean)
,
Dragdrop overview and related methods
public java.lang.String getSnapHDirection()
getSnapToGrid()
,
getSnapResizeToGrid()
,
getChildrenSnapToGrid()
,
getChildrenSnapResizeToGrid()
,
Dragdrop overview and related methods
public void setSnapHGap(int snapHGap)
snapHGap
- New snapHGap value. Default value is 20setSnapToGrid(java.lang.Boolean)
,
setSnapResizeToGrid(java.lang.Boolean)
,
setChildrenSnapToGrid(java.lang.Boolean)
,
setChildrenSnapResizeToGrid(java.lang.Boolean)
,
Dragdrop overview and related methods
public int getSnapHGap()
getSnapToGrid()
,
getSnapResizeToGrid()
,
getChildrenSnapToGrid()
,
getChildrenSnapResizeToGrid()
,
Dragdrop overview and related methods
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
specified as "L"
and snapOffsetLeft
is set to 6, this widget will be rendered 6px inside the
left edge of its parent or master element. Alternatively if snapTo
was set to "R"
, a
snapOffsetLeft
value of -6 would cause the component to be rendered 6px inside the right edge of its parent
or master canvas
.
If this method is called after the component has been drawn/initialized:
Setter for snapOffsetLeft
.
snapOffsetLeft
- new snapOffsetLeft value. Default value is nullsetSnapTo(java.lang.String)
,
Sizing overview and related methods
public 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
specified as "L"
and snapOffsetLeft
is set to 6, this widget will be rendered 6px inside the
left edge of its parent or master element. Alternatively if snapTo
was set to "R"
, a
snapOffsetLeft
value of -6 would cause the component to be rendered 6px inside the right edge of its parent
or master canvas
.
getSnapTo()
,
Sizing overview and related methods
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
specified as "T"
and snapOffsetTop
is set to 6, this widget will be rendered 6px below the top
edge of its parent or master element. . Alternatively if snapTo
was set to "B"
, a
snapOffsetTop
value of -6 would cause the component to be rendered 6px inside the bottom edge of its parent
or master canvas
.
If this method is called after the component has been drawn/initialized:
Setter for snapOffsetTop
.
snapOffsetTop
- new snapOffsetTop value. Default value is nullsetSnapTo(java.lang.String)
,
Sizing overview and related methods
public 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
specified as "T"
and snapOffsetTop
is set to 6, this widget will be rendered 6px below the top
edge of its parent or master element. . Alternatively if snapTo
was set to "B"
, a
snapOffsetTop
value of -6 would cause the component to be rendered 6px inside the bottom edge of its parent
or master canvas
.
getSnapTo()
,
Sizing overview and related methods
public void setSnapOnDrop(java.lang.Boolean snapOnDrop)
Note : This is an advanced setting
snapOnDrop
- New snapOnDrop value. Default value is truesetSnapToGrid(java.lang.Boolean)
,
com.smartgwt.client.widgets.Canvas#shouldSnapOnDrop
,
Dragdrop overview and related methods
public java.lang.Boolean getSnapOnDrop()
getSnapToGrid()
,
com.smartgwt.client.widgets.Canvas#shouldSnapOnDrop
,
Dragdrop overview and related methods
public void setSnapResizeToAlign(java.lang.Boolean snapResizeToAlign)
To control snapping to align for the children
resized within this Canvas, see childrenResizeSnapAlign
instead.
snapResizeToAlign
- New snapResizeToAlign value. Default value is nullpublic java.lang.Boolean getSnapResizeToAlign()
To control snapping to align for the children
resized within this Canvas, see childrenResizeSnapAlign
instead.
public void setSnapResizeToGrid(java.lang.Boolean snapResizeToGrid)
snapToGrid
value if undefined.snapResizeToGrid
- New snapResizeToGrid value. Default value is nullDragdrop overview and related methods
public java.lang.Boolean getSnapResizeToGrid()
snapToGrid
value if undefined.Dragdrop overview and related methods
public void setSnapTo(java.lang.String snapTo)
master
(if specified), or its parent canvas
. Note that this property also impacts the sizing
of this widget. If this widgets size is specified as a percent value, and has no explicit percentSource
, sizing will be calculated based on the size of the
master canvas
when snapTo is set.
Possible values: BR, BL, TR, TL, R, L, B, T, C where B=Bottom, T=Top, L=Left, R=right and C=center
Standard snapTo behavior will attach
the outer edge of the widget to the parent or master element - for example setting snapTo
to
"B"
would align the bottom edge of this component with the bottom edge of the master or parent element (and
center this component horizontally over its master or parent element). snapEdge
can be specified to change this behavior allowing the developer
to, for example, align the top edge of this component with the bottom edge of its master canvas
.
snapOffsetLeft
and snapOffsetTop
may also be specified to offset the element from
exact snapTo alignment.
If this method is called after the component has been drawn/initialized:
Set the snapTo property of this canvas, and handle repositioning.
snapTo
- new snapTo value. Default value is nullsetSnapEdge(java.lang.String)
,
setPercentBox(com.smartgwt.client.types.PercentBoxModel)
,
Sizing overview and related methods
public java.lang.String getSnapTo()
master
(if specified), or its parent canvas
. Note that this property also impacts the sizing
of this widget. If this widgets size is specified as a percent value, and has no explicit percentSource
, sizing will be calculated based on the size of the
master canvas
when snapTo is set.
Possible values: BR, BL, TR, TL, R, L, B, T, C where B=Bottom, T=Top, L=Left, R=right and C=center
Standard snapTo behavior will attach
the outer edge of the widget to the parent or master element - for example setting snapTo
to
"B"
would align the bottom edge of this component with the bottom edge of the master or parent element (and
center this component horizontally over its master or parent element). snapEdge
can be specified to change this behavior allowing the developer
to, for example, align the top edge of this component with the bottom edge of its master canvas
.
snapOffsetLeft
and snapOffsetTop
may also be specified to offset the element from
exact snapTo alignment.
getSnapEdge()
,
getPercentBox()
,
Sizing overview and related methods
public void setSnapToAlign(java.lang.Boolean snapToAlign)
childrenSnapAlign
is enabled on this Canvas' parent. To
control snapping to align for the children dragged within this Canvas, see childrenSnapAlign
instead.
snapToAlign
- New snapToAlign value. Default value is nullpublic java.lang.Boolean getSnapToAlign()
childrenSnapAlign
is enabled on this Canvas' parent. To
control snapping to align for the children dragged within this Canvas, see childrenSnapAlign
instead.
public void setSnapToCenterAlign(java.lang.Boolean snapToCenterAlign)
childrenSnapAlign
is enabled on this Canvas' parent.snapToCenterAlign
- New snapToCenterAlign value. Default value is nullpublic java.lang.Boolean getSnapToCenterAlign()
childrenSnapAlign
is enabled on this Canvas' parent.public void setSnapToEdgeAlign(java.lang.Boolean snapToEdgeAlign)
childrenSnapAlign
is enabled on this Canvas' parent.snapToEdgeAlign
- New snapToEdgeAlign value. Default value is nullpublic java.lang.Boolean getSnapToEdgeAlign()
childrenSnapAlign
is enabled on this Canvas' parent.public void setSnapToGrid(java.lang.Boolean snapToGrid)
snapToGrid
- New snapToGrid value. Default value is nullsetChildrenSnapToGrid(java.lang.Boolean)
,
Dragdrop overview and related methods
public java.lang.Boolean getSnapToGrid()
getChildrenSnapToGrid()
,
Dragdrop overview and related methods
public void setSnapVDirection(java.lang.String snapVDirection)
snapVDirection
- New snapVDirection value. Default value is "after"setSnapToGrid(java.lang.Boolean)
,
setSnapResizeToGrid(java.lang.Boolean)
,
setChildrenSnapToGrid(java.lang.Boolean)
,
setChildrenSnapResizeToGrid(java.lang.Boolean)
,
Dragdrop overview and related methods
public java.lang.String getSnapVDirection()
getSnapToGrid()
,
getSnapResizeToGrid()
,
getChildrenSnapToGrid()
,
getChildrenSnapResizeToGrid()
,
Dragdrop overview and related methods
public void setSnapVGap(int snapVGap)
snapVGap
- New snapVGap value. Default value is 20setSnapToGrid(java.lang.Boolean)
,
setSnapResizeToGrid(java.lang.Boolean)
,
setChildrenSnapToGrid(java.lang.Boolean)
,
setChildrenSnapResizeToGrid(java.lang.Boolean)
,
Dragdrop overview and related methods
public int getSnapVGap()
getSnapToGrid()
,
getSnapResizeToGrid()
,
getChildrenSnapToGrid()
,
getChildrenSnapResizeToGrid()
,
Dragdrop overview and related methods
public void setStartLine(java.lang.Boolean startLine)
FlowLayout
. This property is not supported in a TileLayout
with TileLayout.layoutPolicy
: "fit" or if databound (i.e. for a TileGrid
).startLine
- New startLine value. Default value is falseTileLayout.setAutoWrapLines(java.lang.Boolean)
public java.lang.Boolean getStartLine()
FlowLayout
. This property is not supported in a TileLayout
with TileLayout.layoutPolicy
: "fit" or if databound (i.e. for a TileGrid
).TileLayout.getAutoWrapLines()
public void setStyleName(java.lang.String styleName)
setStyleName
in class com.google.gwt.user.client.ui.UIObject
styleName
- new CSS style name. Default value is "normal"CSSStyleName
,
Appearance overview and related methods
,
CSS styles Examplepublic java.lang.String getStyleName()
getStyleName
in class com.google.gwt.user.client.ui.UIObject
CSSStyleName
,
Appearance overview and related methods
,
CSS styles Examplepublic void setTabIndex(java.lang.Integer tabIndex)
-1
will
ensure the canvas does not show up in the page's tab order, though if canFocus
is true, the user may still give it keyboard focus by clicking
on the widget directly. By default Smart GWT auto-assigns tab-indices, ensuring focusable widgets are reachable by tabbing in an intuitive order based on widget hierarchy and draw order. Specifying an explicit tab index means a widget will not participate in this automatic tab position allocation and is typically not recommended except for very simple cases.
For more information on automatic tab index assignment, including recommended approaches for customizing tab
order assignation, see the TabOrderOverview
. Developers may call clearExplicitTabIndex()
to clear any explicitly assigned tab
index, and have the widget participate in automatic tab position allocation.
canvas.tabIndex
cannot be
set to greater than TAB_INDEX_FLOOR
- as we reserve the
values above this range for auto-assigned tab-indices.
If this method is called after the component has been drawn/initialized:
Assign an explicit tabIndex
to this widget at runtime.
Developers may also call clearExplicitTabIndex()
to clear any explicitly assigned tab index, and have the widget participate in automatic tab position allocation. For more information see tabIndex
Note : This is an advanced setting
tabIndex
- New tabIndex for this widget. Must be less than TAB_INDEX_FLOOR
to avoid interfering with auto-assigned
tab indices on the page. Default value is nullFocus overview and related methods
public java.lang.Integer getTabIndex()
-1
will
ensure the canvas does not show up in the page's tab order, though if canFocus
is true, the user may still give it keyboard focus by clicking
on the widget directly. By default Smart GWT auto-assigns tab-indices, ensuring focusable widgets are reachable by tabbing in an intuitive order based on widget hierarchy and draw order. Specifying an explicit tab index means a widget will not participate in this automatic tab position allocation and is typically not recommended except for very simple cases.
For more information on automatic tab index assignment, including recommended approaches for customizing tab
order assignation, see the TabOrderOverview
. Developers may call clearExplicitTabIndex()
to clear any explicitly assigned tab
index, and have the widget participate in automatic tab position allocation.
canvas.tabIndex
cannot be
set to greater than TAB_INDEX_FLOOR
- as we reserve the
values above this range for auto-assigned tab-indices.
Focus overview and related methods
public void setTop(int top)
position
property). Can also be set as a percentage, specified as a String ending in '%', eg, "50%". In this case
the top coordinate is considered as a percentage of the specified height of the parent
.
If this method is called after the component has been drawn/initialized:
Set the top coordinate of this object, relative to its enclosing context, in pixels.
NOTE: if you're setting multiple coordinates, use setRect() or moveTo() instead
top
- new top coordinate. Default value is 0Positioning overview and related methods
public int getTop()
position
property). Can also be set as a percentage, specified as a String ending in '%', eg, "50%". In this case
the top coordinate is considered as a percentage of the specified height of the parent
.
Positioning overview and related methods
public void setTop(java.lang.String top)
position
property). Can also be set as a percentage, specified as a String ending in '%', eg, "50%". In this case
the top coordinate is considered as a percentage of the specified height of the parent
.
If this method is called after the component has been drawn/initialized:
Set the top coordinate of this object, relative to its enclosing context, in pixels.
NOTE: if you're setting multiple coordinates, use setRect() or moveTo() instead
top
- new top coordinate. Default value is 0Positioning overview and related methods
public Canvas getTopElement() throws java.lang.IllegalStateException
Note : This method should be called only after the widget has been rendered.
java.lang.IllegalStateException
- if this widget has not yet been rendered.Containment overview and related methods
public void setUpdateTabPositionOnDraw(boolean updateTabPositionOnDraw)
parent canvas
be moved to the end of
the TabIndexManager tree on draw()? If set to false, the tab-position will not be modified on draw.
This property is useful for cases where the tab position of a widget will be managed by some explicit tabIndex management code.
Note : This is an advanced setting
updateTabPositionOnDraw
- New updateTabPositionOnDraw value. Default value is truepublic boolean getUpdateTabPositionOnDraw()
parent canvas
be moved to the end of
the TabIndexManager tree on draw()? If set to false, the tab-position will not be modified on draw.
This property is useful for cases where the tab position of a widget will be managed by some explicit tabIndex management code.
public void setUpdateTabPositionOnReparent(boolean updateTabPositionOnReparent)
parent canvas
be added to the
TabIndexManager under the parent as described in updateChildTabPositions()
and updateChildTabPosition()
? If set to false, the tab-position will not be modified on parent change.
This
property is useful for cases where the tab position of a widget will be managed by something other than the parent
canvas, for example for canvasItem canvases
.
If this method is called after the component has been drawn/initialized:
Setter for the updateTabPositionOnReparent
attribute.
Note : This is an advanced setting
updateTabPositionOnReparent
- new value for canvas.updateTabPositionOnReparent. Default value is truepublic boolean getUpdateTabPositionOnReparent()
parent canvas
be added to the
TabIndexManager under the parent as described in updateChildTabPositions()
and updateChildTabPosition()
? If set to false, the tab-position will not be modified on parent change.
This
property is useful for cases where the tab position of a widget will be managed by something other than the parent
canvas, for example for canvasItem canvases
.
public void setUseBackMask(java.lang.Boolean useBackMask)
The backMask is a workaround for this issue. If useBackMask
is set to
true
, the component will render an empty <IFRAME> element behind the canvas, which prevents this
effect in all known cases.
Has no effect in other browsers.
Note : This is an advanced setting
useBackMask
- New useBackMask value. Default value is falsepublic java.lang.Boolean getUseBackMask()
The backMask is a workaround for this issue. If useBackMask
is set to
true
, the component will render an empty <IFRAME> element behind the canvas, which prevents this
effect in all known cases.
Has no effect in other browsers.
public void setUseCSSShadow(boolean useCSSShadow) throws java.lang.IllegalStateException
showShadow
is true, should we use the css
box-shadow
property (where supported) to achieve the shadow? Set this property to false to switch to a
media-based approach, achieved by rendering the shadowImage
in
an automatically generated peer. This approach is also used regardless of this property value in older browsers where
the css box-shadow
property isn't supported.
See also shadowColor
, shadowDepth
, shadowOffset
, shadowSoftness
and shadowSpread
Note : This is an advanced setting
useCSSShadow
- New useCSSShadow value. Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getUseCSSShadow()
showShadow
is true, should we use the css
box-shadow
property (where supported) to achieve the shadow? Set this property to false to switch to a
media-based approach, achieved by rendering the shadowImage
in
an automatically generated peer. This approach is also used regardless of this property value in older browsers where
the css box-shadow
property isn't supported.
See also shadowColor
, shadowDepth
, shadowOffset
, shadowSoftness
and shadowSpread
public void setUseDragMask(boolean useDragMask)
Note that this property will be defaulted to false unless the canvas contains an IFrame, in which case it will be defaulted to true.
The dragMaskType
property controls what kind of
mask is used in case useDragMask is enabled.
useDragMask
- New useDragMask value. Default value is falseDragdrop overview and related methods
public boolean getUseDragMask()
Note that this property will be defaulted to false unless the canvas contains an IFrame, in which case it will be defaulted to true.
The dragMaskType
property controls what kind of
mask is used in case useDragMask is enabled.
Dragdrop overview and related methods
public void setUseImageForSVG(boolean useImageForSVG) throws java.lang.IllegalStateException
Img
or ImgButton
, or the icon of a Button
. Rendering via <object> tag provides the maximum support for CSS in SVG,
but may result in a flicker at the browser level when changing images - either manually such as with setImage()
or via state change from rollover, mouseDown, etc. Using
<image> tags to inline the images breaks CSS support but may avoid flickering.
If this property is not
set, then you can also control whether an SVG image is rendered in an object or image tag by setting the query param
"tag" on the image URL - see SCImgURL
for details.
Note that if multiple icons are
potentially present in a canvas (e.g. removeIcons
in the
cells of a grid body), then setting this property on the widget instance may have no effect. In such case, the Canvas
prototype is consulted.
Note : This is an advanced setting
useImageForSVG
- New useImageForSVG value. Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdImg.setSrc(java.lang.String)
,
Button.setIcon(java.lang.String)
,
Images overview and related methods
public boolean getUseImageForSVG()
Img
or ImgButton
, or the icon of a Button
. Rendering via <object> tag provides the maximum support for CSS in SVG,
but may result in a flicker at the browser level when changing images - either manually such as with setImage()
or via state change from rollover, mouseDown, etc. Using
<image> tags to inline the images breaks CSS support but may avoid flickering.
If this property is not
set, then you can also control whether an SVG image is rendered in an object or image tag by setting the query param
"tag" on the image URL - see SCImgURL
for details.
Note that if multiple icons are
potentially present in a canvas (e.g. removeIcons
in the
cells of a grid body), then setting this property on the widget instance may have no effect. In such case, the Canvas
prototype is consulted.
Img.getSrc()
,
Button.getIcon()
,
Images overview and related methods
public void setUseNativeDrag(java.lang.Boolean useNativeDrag) throws java.lang.IllegalStateException
When using native HTML5 drags, the same series of events fires as for a normal drag (Canvas.dragStart()
, Canvas.dropMove()
, etc.), and the dragType
/ dropTypes
system works. dragAppearance
is not supported;
however, basic customization of the browser's tracker image is supported in certain browsers via the EventHandler.setDragTrackerImage()
API.
The primary difference with a native drag is that it can be cross-frame; that is, the user can drag out of the current browser window and drop into a different window or tab.
To provide information that will be available to a foreign frame,
use EventHandler.setNativeDragData()
. This API must be
called when the Canvas.dragStart()
event fires, and will
not work if called at any other time.
However, due to browser bugs and/or browser-imposed limitations, the
information provided to setNativeDragData
cannot be accessed in the foreign frame until the actual drop
occurs (mouse button released). This means drop eligibility cannot be determined dynamically based on the dragged data;
instead, eligibility can only be determined based on the dragType
/ dropTypes
system. For this reason, a dragType
must be set on the source of a drag.
NOTE: Although Internet Explorer 10+ and Edge support a subset of the HTML5 drag and drop standard, native drag and drop is disabled in IE and Edge because cross-window drags—the primary purpose of this API—are not possible.
useNativeDrag
- New useNativeDrag value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDragdrop overview and related methods
,
Native Drag Create Examplepublic java.lang.Boolean getUseNativeDrag()
When using native HTML5 drags, the same series of events fires as for a normal drag (Canvas.dragStart()
, Canvas.dropMove()
, etc.), and the dragType
/ dropTypes
system works. dragAppearance
is not supported;
however, basic customization of the browser's tracker image is supported in certain browsers via the EventHandler.setDragTrackerImage()
API.
The primary difference with a native drag is that it can be cross-frame; that is, the user can drag out of the current browser window and drop into a different window or tab.
To provide information that will be available to a foreign frame,
use EventHandler.setNativeDragData()
. This API must be
called when the Canvas.dragStart()
event fires, and will
not work if called at any other time.
However, due to browser bugs and/or browser-imposed limitations, the
information provided to setNativeDragData
cannot be accessed in the foreign frame until the actual drop
occurs (mouse button released). This means drop eligibility cannot be determined dynamically based on the dragged data;
instead, eligibility can only be determined based on the dragType
/ dropTypes
system. For this reason, a dragType
must be set on the source of a drag.
NOTE: Although Internet Explorer 10+ and Edge support a subset of the HTML5 drag and drop standard, native drag and drop is disabled in IE and Edge because cross-window drags—the primary purpose of this API—are not possible.
Dragdrop overview and related methods
,
Native Drag Create Examplepublic void setUseOpacityFilter(java.lang.Boolean useOpacityFilter) throws java.lang.IllegalStateException
With the default of null, opacity filters are used unless
neverUseFilters
has been set. When set explicitly to true,
opacity filters are used even if neverUseFilters
is true.
See IEFilters
for background.
useOpacityFilter
- New useOpacityFilter value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdIEFilters overview and related methods
public java.lang.Boolean getUseOpacityFilter()
With the default of null, opacity filters are used unless
neverUseFilters
has been set. When set explicitly to true,
opacity filters are used even if neverUseFilters
is true.
See IEFilters
for background.
IEFilters overview and related methods
public void setUseTouchScrolling(java.lang.Boolean useTouchScrolling) throws java.lang.IllegalStateException
touch devices
, if this Canvas
can be scrolled, should
touch-dragging the content area result in scrolling? Set to false
if touch-dragging should not cause
scrolling. Note that setting to false
enables the use of custom scrollbars
on touch devices.
useTouchScrolling
can default to false
if disableTouchScrollingForDrag
is true
and various built-in drag operations are enabled that normally interfere with touch scrolling (e.g. ListGrid.canDragSelect
and ListGrid.canReorderRecords
).
When touch scrolling is
disabled, it can be difficult to interact with parts of the custom scrollbars at their default size of 16 pixels. In
touch browsers, any touch 8px before the thumb of a custom scrollbar
will
be mapped to the thumb, but the other parts of the scrollbar do not have a similar tolerance applied. The width of the
custom scrollbars can be increased by setting the scrollbarSize
to a larger value, but note that when spriting is enabled
,
changing the scrollbarSize
may cause tiling of certain images and backgrounds that make up the custom
scrollbar. This can be fixed for a component by creating it with scrollbarConstructor
set to "Scrollbar"—a basic
scrollbar class that does not employ spriting.
Note : This is an advanced setting
useTouchScrolling
- New useTouchScrolling value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdScrolling overview and related methods
public java.lang.Boolean getUseTouchScrolling()
touch devices
, if this Canvas
can be scrolled, should
touch-dragging the content area result in scrolling? Set to false
if touch-dragging should not cause
scrolling. Note that setting to false
enables the use of custom scrollbars
on touch devices.
useTouchScrolling
can default to false
if disableTouchScrollingForDrag
is true
and various built-in drag operations are enabled that normally interfere with touch scrolling (e.g. ListGrid.canDragSelect
and ListGrid.canReorderRecords
).
When touch scrolling is
disabled, it can be difficult to interact with parts of the custom scrollbars at their default size of 16 pixels. In
touch browsers, any touch 8px before the thumb of a custom scrollbar
will
be mapped to the thumb, but the other parts of the scrollbar do not have a similar tolerance applied. The width of the
custom scrollbars can be increased by setting the scrollbarSize
to a larger value, but note that when spriting is enabled
,
changing the scrollbarSize
may cause tiling of certain images and backgrounds that make up the custom
scrollbar. This can be fixed for a component by creating it with scrollbarConstructor
set to "Scrollbar"—a basic
scrollbar class that does not employ spriting.
Scrolling overview and related methods
public void setValuesManager(ValuesManager valuesManager)
ValuesManager
for managing values displayed in this component. If specified at
initialization time, this component will be added to the valuesManager via ValuesManager.addMember()
. ValuesManagers allow different fields of a single object to be displayed or edited across multiple UI components. Given a single values object, a valuesManager will handle determining the appropriate field values for its member components and displaying them / responding to edits if the components support this.
Data may be derived simply from the specified fieldNames within
the member components, or for complex nested data structures can be specified by both component and field-level DataPath
.
Note that components may be automatically bound to an existing valuesManager
attached to a parent component if dataPath is specified. See dataPath
for more information. Also note that if a databound component has a specified dataSource and dataPath but no
specified valuesManager object one will be automatically generated as part of the databinding process
If this method is called after the component has been drawn/initialized:
Setter for the valuesManager
attribute. This method may be called directly at runtime to set the ValuesManager for a component; it has the same effect as calling ValuesManager.addMember()
, passing in this DataBoundComponent.
Note : This is an advanced setting
valuesManager
- new dataPath. Default value is nullpublic ValuesManager getValuesManager()
ValuesManager
for managing values displayed in this component. If specified at
initialization time, this component will be added to the valuesManager via ValuesManager.addMember()
. ValuesManagers allow different fields of a single object to be displayed or edited across multiple UI components. Given a single values object, a valuesManager will handle determining the appropriate field values for its member components and displaying them / responding to edits if the components support this.
Data may be derived simply from the specified fieldNames within
the member components, or for complex nested data structures can be specified by both component and field-level DataPath
.
Note that components may be automatically bound to an existing valuesManager
attached to a parent component if dataPath is specified. See dataPath
for more information. Also note that if a databound component has a specified dataSource and dataPath but no
specified valuesManager object one will be automatically generated as part of the databinding process
public void setValuesManager(java.lang.String valuesManager)
ValuesManager
for managing values displayed in this component. If specified at
initialization time, this component will be added to the valuesManager via ValuesManager.addMember()
. ValuesManagers allow different fields of a single object to be displayed or edited across multiple UI components. Given a single values object, a valuesManager will handle determining the appropriate field values for its member components and displaying them / responding to edits if the components support this.
Data may be derived simply from the specified fieldNames within
the member components, or for complex nested data structures can be specified by both component and field-level DataPath
.
Note that components may be automatically bound to an existing valuesManager
attached to a parent component if dataPath is specified. See dataPath
for more information. Also note that if a databound component has a specified dataSource and dataPath but no
specified valuesManager object one will be automatically generated as part of the databinding process
If this method is called after the component has been drawn/initialized:
Setter for the valuesManager
attribute. This method may be called directly at runtime to set the ValuesManager for a component; it has the same effect as calling ValuesManager.addMember()
, passing in this DataBoundComponent.
Note : This is an advanced setting
valuesManager
- new dataPath. Default value is nullGlobalId
public java.lang.String getValuesManagerAsString()
ValuesManager
for managing values displayed in this component. If specified at
initialization time, this component will be added to the valuesManager via ValuesManager.addMember()
. ValuesManagers allow different fields of a single object to be displayed or edited across multiple UI components. Given a single values object, a valuesManager will handle determining the appropriate field values for its member components and displaying them / responding to edits if the components support this.
Data may be derived simply from the specified fieldNames within
the member components, or for complex nested data structures can be specified by both component and field-level DataPath
.
Note that components may be automatically bound to an existing valuesManager
attached to a parent component if dataPath is specified. See dataPath
for more information. Also note that if a databound component has a specified dataSource and dataPath but no
specified valuesManager object one will be automatically generated as part of the databinding process
GlobalId
public void setVisibility(Visibility visibility)
Visibility
type for
details. Specifying "visible" sets the CSS visiblity to "visible", forcing a child to be visible even if the parent is hidden. Not supported for use with Smart GWT layouts, scrolling or auto-sizing but may be useful when working with third-party or legacy DOM layout systems.
Note that if hideUsingDisplayNone
is set for a hidden ancestor, setting
visibility
will have no effect at all until that ancestor becomes visible.
If this method is called after the component has been drawn/initialized:
Sets this widget's visibility to "inherit", so that it becomes visible if all of its parents are visible or it has no parents.
If the widget has not yet been drawn (and doesn't have a parent or master), this method calls the draw method as well.
visibility
- New visibility value. Default value is Canvas.INHERITAppearance overview and related methods
public Visibility getVisibility()
Visibility
type for
details. Specifying "visible" sets the CSS visiblity to "visible", forcing a child to be visible even if the parent is hidden. Not supported for use with Smart GWT layouts, scrolling or auto-sizing but may be useful when working with third-party or legacy DOM layout systems.
Note that if hideUsingDisplayNone
is set for a hidden ancestor, setting
visibility
will have no effect at all until that ancestor becomes visible.
NOTE: Undrawn widgets will report themselves as visible if they would be visible if drawn. Default value is Canvas.INHERIT
Appearance overview and related methods
public void setVisibleWhen(AdvancedCriteria visibleWhen) throws java.lang.IllegalStateException
ruleScope
changes. A basic criteria uses textMatchStyle:"exact".
When specified in Component XML
this property allows shorthand formats
for defining criteria.
visibleWhen
- New visibleWhen value. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdRuleCriteria overview and related methods
public AdvancedCriteria getVisibleWhen()
ruleScope
changes. A basic criteria uses textMatchStyle:"exact".
When specified in Component XML
this property allows shorthand formats
for defining criteria.
RuleCriteria overview and related methods
public void setWidth(java.lang.Integer 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
).master canvas
, and snapTo
is set for the widget, sizing will be a percentage of the size
of that widget (see also percentBox
).parent canvas
's viewport.maxWidth
or minWidth
are specified (or maxHeight
/ minHeight
for heights), these properties act as explicit pixel limits
on the canvas' size. For example, a canvas with maxWidth
set to
500
, and width specified as "100%" will not render larger than 500 pixels in width even if there is more
space available in the parent canvas or percentSource. Layouts
may
specially interpret percentage sizes on their children, and also allow "*" as a size.
Note that if overflow
is set to "visible", this size is a minimum, and the component
may overflow to show all content and/or children.
If trying to establish a default width for a custom component, set
defaultWidth
instead.
If this method is called after the component has been drawn/initialized:
Resizes the widget horizontally to the specified width (moves the right side of the widget). The width parameter can be expressed as a percentage of viewport size or as the number of pixels.
NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
width
- new width. Default value is nullSizing overview and related methods
public java.lang.Integer getWidth()
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
).master canvas
, and snapTo
is set for the widget, sizing will be a percentage of the size
of that widget (see also percentBox
).parent canvas
's viewport.maxWidth
or minWidth
are specified (or maxHeight
/ minHeight
for heights), these properties act as explicit pixel limits
on the canvas' size. For example, a canvas with maxWidth
set to
500
, and width specified as "100%" will not render larger than 500 pixels in width even if there is more
space available in the parent canvas or percentSource. Layouts
may
specially interpret percentage sizes on their children, and also allow "*" as a size.
Note that if overflow
is set to "visible", this size is a minimum, and the component
may overflow to show all content and/or children.
If trying to establish a default width for a custom component, set
defaultWidth
instead.
Sizing overview and related methods
public 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
).master canvas
, and snapTo
is set for the widget, sizing will be a percentage of the size
of that widget (see also percentBox
).parent canvas
's viewport.maxWidth
or minWidth
are specified (or maxHeight
/ minHeight
for heights), these properties act as explicit pixel limits
on the canvas' size. For example, a canvas with maxWidth
set to
500
, and width specified as "100%" will not render larger than 500 pixels in width even if there is more
space available in the parent canvas or percentSource. Layouts
may
specially interpret percentage sizes on their children, and also allow "*" as a size.
Note that if overflow
is set to "visible", this size is a minimum, and the component
may overflow to show all content and/or children.
If trying to establish a default width for a custom component, set
defaultWidth
instead.
If this method is called after the component has been drawn/initialized:
Resizes the widget horizontally to the specified width (moves the right side of the widget). The width parameter can be expressed as a percentage of viewport size or as the number of pixels.
NOTE: if you're setting multiple coordinates, use resizeTo() or setRect() instead
setWidth
in class com.google.gwt.user.client.ui.UIObject
width
- new width. Default value is nullSizing overview and related methods
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 addContainment overview and related methods
public Canvas addChild(Canvas newChild, java.lang.String name, java.lang.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)Containment overview and related methods
public Canvas addPeer(Canvas newPeer)
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)
newPeer
- new peer widget to addContainment overview and related methods
public Canvas addPeer(Canvas newPeer, java.lang.String name, java.lang.Boolean autoDraw, java.lang.Boolean preDraw)
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)
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 masterContainment overview and related methods
public void addSnapAlignCandidate(Canvas newCandidate)
snapAlignCandidates
. Duplicates
are automatically avoided.newCandidate
- public void adjustForContent(boolean immediate)
adjustForContent()
, specify sizes on replaced elements wherever possible. DOM-level Integration overview
. Note that only contents supplied to a widget via contents
or via an override of getInnerHTML()
should be manipulated directly. Contents automatically
generated by Smart GWT components (such as the basic structure of a Button) should never be manipulated: these
structures are considered internal, differ by platform, and will change without notice. immediate
- By default the adjustment will occur on a small delay for performance reasons. Pass in this parameter to force
immediate adjustment.Sizing overview and related methods
public void animateFade(java.lang.Integer opacity)
opacity
- desired final opacitypublic void animateFade(java.lang.Integer opacity, AnimationCallback callback)
animateFade(java.lang.Integer)
public void animateFade(java.lang.Integer opacity, AnimationCallback callback, java.lang.Integer duration)
animateFade(java.lang.Integer)
public void animateFade(java.lang.Integer opacity, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)
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, for example by a call to the non-animated
API setOpacity()
.duration
- Duration in ms of the animated fadeacceleration
- Optional animation acceleration to bias the ratiospublic void animateMove(java.lang.Integer left, java.lang.Integer top)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)public void animateMove(java.lang.Integer left, java.lang.Integer top, AnimationCallback callback)
public void animateMove(java.lang.Integer left, java.lang.Integer top, AnimationCallback callback, java.lang.Integer duration)
public void animateMove(java.lang.Integer left, java.lang.Integer top, AnimationCallback callback, java.lang.Integer 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, for example by a call to the non-animated
APIs moveTo()
or moveBy()
.duration
- Duration in ms of the animated moveacceleration
- Optional acceleration effect to bias the ratiospublic void animateRect(java.lang.Integer left, java.lang.Integer top, java.lang.Integer width, java.lang.Integer 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(java.lang.Integer left, java.lang.Integer top, java.lang.Integer width, java.lang.Integer height, AnimationCallback callback)
public void animateRect(java.lang.Integer left, java.lang.Integer top, java.lang.Integer width, java.lang.Integer height, AnimationCallback callback, java.lang.Integer duration)
public void animateRect(java.lang.Integer left, java.lang.Integer top, java.lang.Integer width, java.lang.Integer height, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)
left
- new left position (or null for unchanged)top
- new top position (or null for unchanged)width
- new width (or null for unchanged)height
- new height (or null for unchanged)callback
- When the setRect completes this callback will be fired. Single 'earlyFinish' parameter will be
passed if the animation was cut short, for example by a call to the non-animated
API setRect()
.duration
- Duration in ms of the animated setRectacceleration
- Optional acceleration effect to apply to the animationpublic void animateResize(java.lang.Integer width, java.lang.Integer height)
Note that animateResizeLayoutMode
allows you to control whether
child layout is rerun during every step of the animation, or just at the end, since the former may incur significant
overhead depending on the widget hierarchy.
width
- new width (or null for unchanged)height
- new height (or null for unchanged)public void animateResize(java.lang.Integer width, java.lang.Integer height, AnimationCallback callback)
public void animateResize(java.lang.Integer width, java.lang.Integer height, AnimationCallback callback, java.lang.Integer duration)
public void animateResize(java.lang.Integer width, java.lang.Integer height, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)
Note that animateResizeLayoutMode
allows you to control whether
child layout is rerun during every step of the animation, or just at the end, since the former may incur significant
overhead depending on the widget hierarchy.
width
- new width (or null for unchanged)height
- new height (or null for unchanged)callback
- When the resize completes this callback will be fired. Single 'earlyFinish' parameter will be
passed if the animation was cut short, for example by a call to the non-animated
APIs resizeTo()
or resizeBy()
.duration
- Duration in ms of the animated resizeacceleration
- Optional acceleration effect to apply to the resizepublic void animateScroll(java.lang.Integer scrollLeft, java.lang.Integer scrollTop)
scrollLeft
- desired final left scroll positionscrollTop
- desired final top scroll positionpublic void animateScroll(java.lang.Integer scrollLeft, java.lang.Integer scrollTop, AnimationCallback callback)
public void animateScroll(java.lang.Integer scrollLeft, java.lang.Integer scrollTop, AnimationCallback callback, java.lang.Integer duration)
public void animateScroll(java.lang.Integer scrollLeft, java.lang.Integer scrollTop, AnimationCallback callback, java.lang.Integer duration, AnimationAcceleration acceleration)
scrollLeft
- desired final left scroll positionscrollTop
- desired final top scroll positioncallback
- When the scroll completes this callback will be fired. Single 'earlyFinish' parameter will be
passed if the animation was cut short, for example by a call to the non-animated
APIs scrollTo()
or scrollBy()
.duration
- Duration in ms of the animated scrollacceleration
- Optional acceleration to bias the animation ratiospublic void blur()
Focus overview and related methods
public void bringToFront()
ZIndex overview and related methods
,
Layer Examplepublic void clear()
This is more expensive than hide(), because in order to become visible
again, the Canvas must be draw()n again. Generally, application code has no reason to call clear() unless it is
attempting to do advanced memory management. If you want to temporarily hide a Canvas, use hide() and show(), and if
you want to permanently destroy a Canvas, use destroy()
.
You would only use clear() if you were managing a very large pool of components and you wanted to reclaim some of the memory used by components that had not been used in a while, while still being able to just draw() them to make them active and visible again.
Note: a clear() will happen as part of moving a Canvas to a different parent. See addChild()
.
public void clearExplicitTabIndex()
tabIndex
was assigned to this widget, clear it.
This will enable automatic tab index managment behaviors via the TabIndexManager
class as described in the TabOrderOverview
public com.google.gwt.event.shared.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 handlerHandlerRegistration
used to remove this handlerpublic java.lang.Boolean clickMaskUp()
showClickMask(com.smartgwt.client.core.Function, com.smartgwt.client.types.ClickMaskMode, com.smartgwt.client.widgets.Canvas[])
public java.lang.Boolean 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.showClickMask(com.smartgwt.client.core.Function, com.smartgwt.client.types.ClickMaskMode, com.smartgwt.client.widgets.Canvas[])
public java.lang.Boolean contains(Canvas canvas)
canvas
- the canvas to be tested