public class Window extends VLayout implements HasCloseClickHandlers, HasMaximizeClickHandlers, HasMinimizeClickHandlers, HasRestoreClickHandlers
Windows can contain arbitrary Smart GWT components, configured via the items property. Windows may be modal or non-modal.
Windows provide a series of highly configurable
and skinnable autoChildren including a header, various header controls,
footer, and corner resizer.
The more specialized Dialog subclass of Window has
additional functionality targetted at simple prompts and confirmations, such as buttons with default actions, and
single-method shortcuts for common application dialogs.
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
Window() |
Window(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.event.shared.HandlerRegistration |
addCloseClickHandler(CloseClickHandler handler)
Add a closeClick handler.
|
void |
addItem(Canvas component)
Adds a widget to the window.
|
void |
addItem(com.google.gwt.user.client.ui.Widget widget)
Adds a widget to the window.
|
com.google.gwt.event.shared.HandlerRegistration |
addMaximizeClickHandler(MaximizeClickHandler handler)
Add a maximizeClick handler.
|
void |
addMember(Canvas newMember)
Same as
Layout.addMember(). |
void |
addMember(Canvas newMember,
java.lang.Integer position)
Same as
Layout.addMember(). |
com.google.gwt.event.shared.HandlerRegistration |
addMinimizeClickHandler(MinimizeClickHandler handler)
Add a minimizeClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRestoreClickHandler(RestoreClickHandler handler)
Add a restoreClick handler.
|
void |
centerInPage()
Centers the Window in the page.
|
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 |
close()
Close this window.
|
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
flash()
Makes the window header flash if it's visible; if there's no header, or the header is hidden, makes the window
body flash instead.
|
java.lang.Boolean |
getAnimateMinimize()
Should this window minimize, maximize, and restore as an animation, or as a simple 1-step transition?
|
java.lang.Boolean |
getAutoCenter()
If true, this Window widget will automatically be centered on the page when shown.
|
java.lang.Boolean |
getAutoSize()
If true, the window is resized automatically to accommodate the contents of the body, if they would otherwise require
scrolling.
|
Canvas |
getBody()
Body of the Window, where
contained components or loaded content is shown. |
java.lang.String |
getBodyColor()
Color of the Window body.
|
java.lang.String |
getBodyStyle()
Style of the Window body.
|
boolean |
getBringToFrontOnMouseUp()
Should this window automatically be shown at the top of the page's z-order and be brought to front via
Canvas.bringToFront() whenever the user clicks it? |
java.lang.Boolean |
getCanDragReposition()
If true, this Window may be moved around by the user by dragging on the Window header.
|
java.lang.Boolean |
getCanDragResize()
Can the window be drag-resized? If true the window may be drag resized from its edges, and if showing, via the resizer
icon in the footer.
|
java.lang.Boolean |
getCanFocusInHeaderButtons()
If true, the user can give the header buttons focus (see
minimizeButton, maximizeButton, restoreButton and closeButton). |
ImgButton |
getCloseButton()
Button show in the header that will close this Window by calling
Window.closeClick(). |
ContentLayoutPolicy |
getContentLayout()
The layout policy that should be used for widgets within the Window body.
|
java.lang.String |
getContentsType()
If this window has
src specified, this property can be used to
indicate whether the source is a standalone HTML page or an HTML fragment. |
int |
getDefaultMinimizeHeight()
If
minimizeHeight is unset, by the window will shrink to
the height of the header when minimized. |
java.lang.Boolean |
getDismissOnEscape()
Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape" key?
Behavior will only occur while the window or one of its descendants has focus, and does not cancel the Escape keypress.
|
java.lang.Boolean |
getDismissOnOutsideClick()
If true, a click outside the bounds of the Window will have the same effect as pressing its cancel button.
Note: Applies only to modal windows. |
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
java.lang.String |
getFillSpaceStyleName()
Alternative style for the window used whenever
placement
settings indicate the menu will be filling a portion of the screen or a panel. |
HLayout |
getFooter()
Optional footer for the window, providing space for controls such as the resizer and status bar.
|
int |
getFooterHeight()
The height of the footer, in pixels.
|
HLayout |
getHeader()
Header for the Window, based on an HLayout.
|
Img |
getHeaderBackground()
Img background component for the header, for gradient or image-based display
|
Img |
getHeaderIcon()
Header icon shown at left end of header by default.
|
Label |
getHeaderLabel()
Label that shows Window title in header.
|
java.lang.String |
getHeaderSrc()
If
showHeaderBackground is true, this
property provides the URL of the background image for the header. |
java.lang.String |
getHeaderStyle()
Style for the Window header.
|
java.lang.String |
getHiliteBodyColor()
Highlight color for the Window body (shown when the body is flashed).
|
java.lang.String |
getHiliteHeaderSrc()
If
showHeaderBackground is true, this governs the URL
of the image to use in the header's highlighted state when the window is flashed |
java.lang.String |
getHiliteHeaderStyle()
Highlight style for the Window header.
|
java.lang.Boolean |
getIsModal()
If true, when shown this Window will intercept and block events to all other existing components on the page.
|
Canvas[] |
getItems()
The contents of the Window body.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
ImgButton |
getMaximizeButton()
Button that will make this Window fill the browser via
maximize(). |
java.lang.Boolean |
getMaximized()
Is this window maximized.
|
AnimationAcceleration |
getMinimizeAcceleration()
Default acceleration function for performing an animated minimize / maximize.
|
ImgButton |
getMinimizeButton()
ImgButton shown in the header that will minimize this Window by calling
minimize(). |
java.lang.Boolean |
getMinimized()
Is this window minimized.
|
java.lang.Integer |
getMinimizeHeight()
Height for the window when minimized.
|
java.lang.Integer |
getMinimizeTime()
If this window is minimizeable, and animateMinimize is true, what should the duration of the minimize / maximize be (in
ms)? If unset defaults to
canvas.animationTime. |
Canvas |
getModalMask()
A ScreenSpan instance used to darken the rest of a page when a modal window is active.
|
int |
getModalMaskOpacity()
Controls the opacity of the modal mask displayed behind modal windows.
|
java.lang.String |
getModalMaskStyle()
Specifies the CSS style for the modal mask.
|
java.lang.Integer |
getOpacity()
Renders the widget to be partly transparent.
|
static Window |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
PanelPlacement |
getPlacement()
Where should the window be placed on the screen? Valid settings include
"fillScreen",
"fillPanel", "halfScreen" and "none" |
java.lang.String |
getPrintBodyStyle()
Style for the Window body in printed output.
|
java.lang.String |
getPrintHeaderStyle()
CSS Style for header in printed output
|
ImgButton |
getResizer()
ImgButton-based resizer, shown in the footer.
|
ImgButton |
getRestoreButton()
ImgButton that restores the Window via
restore(). |
java.lang.Boolean |
getShowBody()
If true, draw the body contents when this Window is drawn.
|
java.lang.Boolean |
getShowCloseButton()
If true, show a close button in the header, which will dismiss this window by calling
Window.closeClick(). |
java.lang.Boolean |
getShowEdges()
showEdges dynamically defaults to false when the placement setting indicates the Window will be filling a portion of the screen or a panel. |
java.lang.Boolean |
getShowFooter()
If true, show a footer for this Window, including resizer, statusBar, etc.
|
java.lang.Boolean |
getShowHeader()
If true, show a
header for this Window. |
java.lang.Boolean |
getShowHeaderBackground()
Should the window header show a background image? Default value is true for all browsers except for Internet
Explorer.
If set to true the image source is derived from headerSrc and hiliteHeaderSrc, otherwise the background
will be styled according to headerStyle / hiliteHeaderStyle. |
java.lang.Boolean |
getShowHeaderIcon()
If true, we show an icon on the left in the header.
|
java.lang.Boolean |
getShowMaximizeButton()
If true, show a maximize button in the header - clicking it maximizes the Window
|
java.lang.Boolean |
getShowMinimizeButton()
If true, show a minimize button in the header--clicking it minimizes the Window.
|
java.lang.Boolean |
getShowModalMask()
If true, displays a translucent mask over the rest of the page when a modal window is displayed.
|
java.lang.Boolean |
getShowResizer()
If true, show a button in the lower right corner that allows users to resize the Window.
|
java.lang.Boolean |
getShowShadow()
Whether to show a drop shadow for this Canvas.
|
java.lang.Boolean |
getShowStatusBar()
If true, show a statusBar for this Window, including resizer.
|
java.lang.Boolean |
getShowTitle()
Show a title (typically just text) on the header for this window.
|
java.lang.String |
getSrc()
A URL to load as content for the Window's body.
|
java.lang.String |
getStatus()
Text to show in the status bar of the window (if one is visible)
|
Canvas |
getStatusBar()
Simple Canvas-based status bar, shown in the footer.
|
java.lang.String |
getTitle()
title for this Window, shown in the header (if drawn)
|
java.lang.Boolean |
getUseBackMask()
By default Windows show a
backMask in Internet Explorer
versions predating Internet Explorer 9. |
void |
maximize()
Maximize the window.
|
void |
minimize()
Minimize the window.
|
static void |
preloadImages()
Preload primary window skin images
|
void |
removeItem(Canvas component)
Removes a widget from the window.
|
void |
restore()
Restores the window to its specified height and width after a call to
minimize() or maximize(). |
void |
setAnimateMinimize(java.lang.Boolean animateMinimize)
Should this window minimize, maximize, and restore as an animation, or as a simple 1-step transition?
|
void |
setAutoCenter(java.lang.Boolean autoCenter)
If true, this Window widget will automatically be centered on the page when shown.
|
void |
setAutoSize(java.lang.Boolean autoSize)
If true, the window is resized automatically to accommodate the contents of the body, if they would otherwise require
scrolling.
|
void |
setBodyColor(java.lang.String bodyColor)
Color of the Window body.
|
void |
setBodyDefaults(java.util.Map bodyDefaults)
Default properties for the body of the Window
You can change the class-level bodyDefaults for all Windows by changing this item or set instance.body to be another object of properties to override for your instance only |
void |
setBodyStyle(java.lang.String bodyStyle)
Style of the Window body.
|
void |
setBringToFrontOnMouseUp(boolean bringToFrontOnMouseUp)
Should this window automatically be shown at the top of the page's z-order and be brought to front via
Canvas.bringToFront() whenever the user clicks it? |
void |
setCanDragReposition(java.lang.Boolean canDragReposition)
If true, this Window may be moved around by the user by dragging on the Window header.
|
void |
setCanDragResize(java.lang.Boolean canDragResize)
Can the window be drag-resized? If true the window may be drag resized from its edges, and if showing, via the resizer
icon in the footer.
|
void |
setCanFocusInHeaderButtons(java.lang.Boolean canFocusInHeaderButtons)
If true, the user can give the header buttons focus (see
minimizeButton, maximizeButton, restoreButton and closeButton). |
void |
setContentLayout(ContentLayoutPolicy contentLayout)
The layout policy that should be used for widgets within the Window body.
|
void |
setContentLayout(java.lang.String contentLayout)
Deprecated.
use the other
setContentLayout()
|
void |
setContentsType(java.lang.String contentsType)
If this window has
src specified, this property can be used to
indicate whether the source is a standalone HTML page or an HTML fragment. |
void |
setDefaultMinimizeHeight(int defaultMinimizeHeight)
If
minimizeHeight is unset, by the window will shrink to
the height of the header when minimized. |
static void |
setDefaultProperties(Window windowProperties)
Class level method to set the default properties of this class.
|
void |
setDismissOnEscape(java.lang.Boolean dismissOnEscape)
Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape" key?
Behavior will only occur while the window or one of its descendants has focus, and does not cancel the Escape keypress.
|
void |
setDismissOnOutsideClick(java.lang.Boolean dismissOnOutsideClick)
If true, a click outside the bounds of the Window will have the same effect as pressing its cancel button.
Note: Applies only to modal windows. |
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. |
void |
setFillSpaceStyleName(java.lang.String fillSpaceStyleName)
Alternative style for the window used whenever
placement
settings indicate the menu will be filling a portion of the screen or a panel. |
void |
setFooterControls(java.lang.Object... footerControls)
Array of members to show in the Window footer.
|
void |
setFooterHeight(int footerHeight)
The height of the footer, in pixels.
|
void |
setHeaderControls(java.lang.Object... headerControls)
Array of members to show in the Window header.
|
void |
setHeaderIcon(java.lang.String imgSrc)
Sets the Window header icon.
|
void |
setHeaderIcon(java.lang.String imgSrc,
int width,
int height)
Sets the Window header icon.
|
void |
setHeaderIconDefaults(java.util.Map headerIconDefaults)
This is an object literal property block specifying the various properties of the headerIcon - the icon that appears at
the top left of the window and is by default the Isomorphic logo.
|
void |
setHeaderIconProperties(java.util.Map headerIconProperties) |
void |
setHeaderSrc(java.lang.String headerSrc)
If
showHeaderBackground is true, this
property provides the URL of the background image for the header. |
void |
setHeaderStyle(java.lang.String headerStyle)
Style for the Window header.
|
void |
setHiliteBodyColor(java.lang.String hiliteBodyColor)
Highlight color for the Window body (shown when the body is flashed).
|
void |
setHiliteHeaderSrc(java.lang.String hiliteHeaderSrc)
If
showHeaderBackground is true, this governs the URL
of the image to use in the header's highlighted state when the window is flashed |
void |
setHiliteHeaderStyle(java.lang.String hiliteHeaderStyle)
Highlight style for the Window header.
|
void |
setIsModal(java.lang.Boolean isModal)
If true, when shown this Window will intercept and block events to all other existing components on the page.
|
void |
setKeepInParentRect(java.lang.Boolean keepInParentRect)
If Window.canDragReposition or Window.canDragResize is true, should the windows size and position be constrained
such that it remains within the viewport of its parent element (or for top level windows, within the viewport of
the browser window)?
Note: keepInParentRect affects only user drag interactions, not programmatic moves. |
void |
setKeepInParentRect(Rectangle rectangle)
If Window.canDragReposition or Window.canDragRShowcaseDataesize is true, should the windows size and position be
constrained such that it remains within the viewport of its parent element (or for top level windows, within the
viewport of the browser window)? Can also be set to an array denoting an arbitrary Rectangle beyond which the
window cannot be moved.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.WindowLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
void |
setMaximized(java.lang.Boolean maximized)
Is this window maximized.
|
void |
setMinimizeAcceleration(AnimationAcceleration minimizeAcceleration)
Default acceleration function for performing an animated minimize / maximize.
|
void |
setMinimized(java.lang.Boolean minimized)
Is this window minimized.
|
void |
setMinimizeHeight(java.lang.Integer minimizeHeight)
Height for the window when minimized.
|
void |
setMinimizeTime(java.lang.Integer minimizeTime)
If this window is minimizeable, and animateMinimize is true, what should the duration of the minimize / maximize be (in
ms)? If unset defaults to
canvas.animationTime. |
void |
setModalMaskOpacity(int modalMaskOpacity)
Controls the opacity of the modal mask displayed behind modal windows.
|
void |
setModalMaskStyle(java.lang.String modalMaskStyle)
Specifies the CSS style for the modal mask.
|
void |
setOpacity(java.lang.Integer opacity)
Renders the widget to be partly transparent.
|
void |
setPlacement(PanelPlacement placement)
Where should the window be placed on the screen? Valid settings include
"fillScreen",
"fillPanel", "halfScreen" and "none" |
void |
setPrintBodyStyle(java.lang.String printBodyStyle)
Style for the Window body in printed output.
|
void |
setPrintHeaderStyle(java.lang.String printHeaderStyle)
CSS Style for header in printed output
|
void |
setShowBody(java.lang.Boolean showBody)
If true, draw the body contents when this Window is drawn.
|
void |
setShowCloseButton(java.lang.Boolean showCloseButton)
If true, show a close button in the header, which will dismiss this window by calling
Window.closeClick(). |
void |
setShowEdges(java.lang.Boolean showEdges)
showEdges dynamically defaults to false when the placement setting indicates the Window will be filling a portion of the screen or a panel. |
void |
setShowFooter(java.lang.Boolean showFooter)
If true, show a footer for this Window, including resizer, statusBar, etc.
|
void |
setShowHeader(java.lang.Boolean showHeader)
If true, show a
header for this Window. |
void |
setShowHeaderBackground(java.lang.Boolean showHeaderBackground)
Should the window header show a background image? Default value is true for all browsers except for Internet
Explorer.
If set to true the image source is derived from headerSrc and hiliteHeaderSrc, otherwise the background
will be styled according to headerStyle / hiliteHeaderStyle. |
void |
setShowHeaderIcon(java.lang.Boolean showHeaderIcon)
If true, we show an icon on the left in the header.
|
void |
setShowMaximizeButton(java.lang.Boolean showMaximizeButton)
If true, show a maximize button in the header - clicking it maximizes the Window
If this method is called after the component has been drawn/initialized: Dynamically update showMaximizeButton to show / hide the maximizeButton |
void |
setShowMinimizeButton(java.lang.Boolean showMinimizeButton)
If true, show a minimize button in the header--clicking it minimizes the Window.
|
void |
setShowModalMask(java.lang.Boolean showModalMask)
If true, displays a translucent mask over the rest of the page when a modal window is displayed.
|
void |
setShowResizer(java.lang.Boolean showResizer)
If true, show a button in the lower right corner that allows users to resize the Window.
|
void |
setShowShadow(java.lang.Boolean showShadow)
Whether to show a drop shadow for this Canvas.
|
void |
setShowStatusBar(java.lang.Boolean showStatusBar)
If true, show a statusBar for this Window, including resizer.
|
void |
setShowTitle(java.lang.Boolean showTitle)
Show a title (typically just text) on the header for this window.
|
void |
setSrc(java.lang.String src)
A URL to load as content for the Window's body.
|
void |
setStatus(java.lang.String status)
Text to show in the status bar of the window (if one is visible)
If this method is called after the component has been drawn/initialized: Sets the text in the status bar of the window, redrawing if necessary. |
void |
setTitle(java.lang.String title)
|
void |
setUseBackMask(java.lang.Boolean useBackMask)
By default Windows show a
backMask in Internet Explorer
versions predating Internet Explorer 9. |
java.lang.Boolean |
shouldDismissOnEscape()
Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape"
key?
Default behavior: if dismissOnEscape is set, just
return it. |
setDefaultProperties, setLogicalStructureaddMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMemberaddChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowHover, getShowHoverComponents, getShowResizeBar, getShowSnapGrid, getShrinkElementOnHide, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowHover, setShowHoverComponents, setShowResizeBar, setShowSnapGrid, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDropaddDrawHandler, applyFactoryProperties, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getById, getByJSObject, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, 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, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventpublic Window()
public Window(com.google.gwt.core.client.JavaScriptObject jsObj)
public static Window getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public 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.AutoChildUsagepublic 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.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
public void setAnimateMinimize(java.lang.Boolean animateMinimize)
Note : This is an advanced setting
animateMinimize - Default value is nullAppearance overview and related methods,
Window Minimize Examplepublic java.lang.Boolean getAnimateMinimize()
Appearance overview and related methods,
Window Minimize Examplepublic void setAutoCenter(java.lang.Boolean autoCenter)
Note: If an
auto-centering Window is either programmatically moved or dragged by an end user, auto-centering behavior is
automatically turned off. To manually center a Window, you can use centerInPage().
autoCenter - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getAutoCenter()
Note: If an
auto-centering Window is either programmatically moved or dragged by an end user, auto-centering behavior is
automatically turned off. To manually center a Window, you can use centerInPage().
Appearance overview and related methodspublic void setAutoSize(java.lang.Boolean autoSize)
autoSizeautoSize - true if the window should auto-size to its content. Default value is falseAppearance overview and related methods,
Auto Size Examplepublic java.lang.Boolean getAutoSize()
Appearance overview and related methods,
Auto Size Examplepublic Canvas getBody() throws java.lang.IllegalStateException
contained components or loaded content is shown. The following passthroughs apply:
bodyStyle for the Canvas.styleNameprintBodyStyle for the styleName to use when
printingbodyColor / hiliteBodyColor for the Canvas.backgroundColor
This component is an AutoChild named "body". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setBodyColor(java.lang.String bodyColor)
bodyColor.bodyColor - new backgroundColor for the body.CSSColor . Default value is "#FFFFFF",
flash(),
Appearance overview and related methodspublic java.lang.String getBodyColor()
CSSColor,
flash(),
Appearance overview and related methodspublic void setBodyDefaults(java.util.Map bodyDefaults)
Note : This is an advanced setting
bodyDefaults - Default value is ...Appearance overview and related methodspublic void setBodyStyle(java.lang.String bodyStyle)
bodyStyle.bodyStyle - new styleName for the body.CSSStyleName . Default value is "windowBody",
Appearance overview and related methodspublic java.lang.String getBodyStyle()
CSSStyleName,
Appearance overview and related methodspublic void setBringToFrontOnMouseUp(boolean bringToFrontOnMouseUp)
Canvas.bringToFront() whenever the user clicks it? If isModal is true for this window, this setting will have no effect - we
always bring the window to the front on initial display and on mouseDown. By default we also do this for non-modal
windows (which matches user expectation for most standard interfaces - think of switching between OS-level application
windows), but this may be disabled for cases where it is not appropriate by setting this attribute to
false
bringToFrontOnMouseUp - Default value is truepublic boolean getBringToFrontOnMouseUp()
Canvas.bringToFront() whenever the user clicks it? If isModal is true for this window, this setting will have no effect - we
always bring the window to the front on initial display and on mouseDown. By default we also do this for non-modal
windows (which matches user expectation for most standard interfaces - think of switching between OS-level application
windows), but this may be disabled for cases where it is not appropriate by setting this attribute to
false
public void setCanDragReposition(java.lang.Boolean canDragReposition)
setCanDragReposition in class CanvascanDragReposition - Default value is truesetShowHeader(java.lang.Boolean)public java.lang.Boolean getCanDragReposition()
getCanDragReposition in class CanvasgetShowHeader()public void setCanDragResize(java.lang.Boolean canDragResize)
setCanDragResize in class CanvascanDragResize - Default value is falsesetShowResizer(java.lang.Boolean)public java.lang.Boolean getCanDragResize()
getCanDragResize in class CanvasgetShowResizer()public void setCanFocusInHeaderButtons(java.lang.Boolean canFocusInHeaderButtons)
minimizeButton, maximizeButton, restoreButton and closeButton).
Note : This is an advanced setting
canFocusInHeaderButtons - Default value is falseFocus overview and related methodspublic java.lang.Boolean getCanFocusInHeaderButtons()
minimizeButton, maximizeButton, restoreButton and closeButton).Focus overview and related methodspublic ImgButton getCloseButton() throws java.lang.IllegalStateException
Window.closeClick().
This component is an AutoChild named "closeButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setContentLayout(ContentLayoutPolicy contentLayout)
See ContentLayoutPolicy and bodyConstructor for details.
Note : This is an advanced setting
contentLayout - Default value is "vertical"Appearance overview and related methodspublic ContentLayoutPolicy getContentLayout()
See ContentLayoutPolicy and bodyConstructor for details.
Appearance overview and related methodspublic void setContentsType(java.lang.String contentsType)
throws java.lang.IllegalStateException
src specified, this property can be used to
indicate whether the source is a standalone HTML page or an HTML fragment. This is similar to the HTMLFlow.contentsType property - be sure to read the HTMLFlow
documentation to understand circumstances where contentsType:"page" is unsafe and not recommended.
contentsType - Default value is "page"java.lang.IllegalStateException - this property cannot be changed after the component has been createdsetSrc(java.lang.String),
Appearance overview and related methodspublic java.lang.String getContentsType()
src specified, this property can be used to
indicate whether the source is a standalone HTML page or an HTML fragment. This is similar to the HTMLFlow.contentsType property - be sure to read the HTMLFlow
documentation to understand circumstances where contentsType:"page" is unsafe and not recommended.
getSrc(),
Appearance overview and related methodspublic void setDefaultMinimizeHeight(int defaultMinimizeHeight)
minimizeHeight is unset, by the window will shrink to
the height of the header when minimized. defaultMinimizeHeight will be used
instead.
Note : This is an advanced setting
defaultMinimizeHeight - Default value is 16Appearance overview and related methodspublic int getDefaultMinimizeHeight()
minimizeHeight is unset, by the window will shrink to
the height of the header when minimized. defaultMinimizeHeight will be used
instead.Appearance overview and related methodspublic void setDismissOnEscape(java.lang.Boolean dismissOnEscape)
If unset default behavior depends on whether a close / cancel button is visible for this item.
dismissOnEscape - Default value is nullshouldDismissOnEscape()public java.lang.Boolean getDismissOnEscape()
If unset default behavior depends on whether a close / cancel button is visible for this item.
shouldDismissOnEscape()public void setDismissOnOutsideClick(java.lang.Boolean dismissOnOutsideClick)
dismissOnOutsideClick - Default value is falsesetIsModal(java.lang.Boolean)public java.lang.Boolean getDismissOnOutsideClick()
getIsModal()public void setEditProxyConstructor(java.lang.String editProxyConstructor)
throws java.lang.IllegalStateException
EditProxy for this component when the component is
first placed into edit mode.setEditProxyConstructor in class LayouteditProxyConstructor - java.lang.IllegalStateException - this property cannot be changed after the component has been createdSCClassName . Default value is "WindowEditProxy"public java.lang.String getEditProxyConstructor()
EditProxy for this component when the component is
first placed into edit mode.getEditProxyConstructor in class LayoutSCClassNamepublic void setFillSpaceStyleName(java.lang.String fillSpaceStyleName)
throws java.lang.IllegalStateException
placement
settings indicate the menu will be filling a portion of the screen or a panel. Generally this alternative style should
not have rounded or excessively large edges.fillSpaceStyleName - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is "windowBackgroundFill"public java.lang.String getFillSpaceStyleName()
placement
settings indicate the menu will be filling a portion of the screen or a panel. Generally this alternative style should
not have rounded or excessively large edges.CSSStyleNamepublic HLayout getFooter() throws java.lang.IllegalStateException
This component is an AutoChild named "footer". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setFooterHeight(int footerHeight)
throws java.lang.IllegalStateException
footerHeight - Default value is 18java.lang.IllegalStateException - this property cannot be changed after the component has been createdAppearance overview and related methodspublic int getFooterHeight()
Appearance overview and related methodspublic HLayout getHeader() throws java.lang.IllegalStateException
headerControls. The
following passthroughs apply:
headerStyle for Canvas.styleNameprintHeaderStyle for the styleName to use when
printing.
This component is an AutoChild named "header". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public Img getHeaderBackground() throws java.lang.IllegalStateException
This component is an AutoChild named "headerBackground". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public Img getHeaderIcon() throws java.lang.IllegalStateException
This component is an AutoChild named "headerIcon". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setHeaderIconDefaults(java.util.Map headerIconDefaults)
16 and specifies the width of the headerIcon. 14 and
specifies the height of the headerIcon. "[SKIN]/Window/minimize.gif" and specifies
the image for the headerIcon. Note : This is an advanced setting
headerIconDefaults - Default value is ...Appearance overview and related methodspublic Label getHeaderLabel() throws java.lang.IllegalStateException
The following passthrough
applies: title for Label.contents.
This component is an AutoChild named "headerLabel". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setHeaderSrc(java.lang.String headerSrc)
showHeaderBackground is true, this
property provides the URL of the background image for the header.
Note : This is an advanced setting
headerSrc - SCImgURL . Default value is "[SKIN]Window/headerGradient.gif" | null,
Appearance overview and related methodspublic java.lang.String getHeaderSrc()
showHeaderBackground is true, this
property provides the URL of the background image for the header.SCImgURL,
Appearance overview and related methodspublic void setHeaderStyle(java.lang.String headerStyle)
headerStyle.
Note : This is an advanced setting
headerStyle - new styleName for the header.CSSStyleName . Default value is "WindowHeader",
Appearance overview and related methodspublic java.lang.String getHeaderStyle()
CSSStyleName,
Appearance overview and related methodspublic void setHiliteBodyColor(java.lang.String hiliteBodyColor)
hiliteBodyColor.hiliteBodyColor - new hiliteBodyColor.CSSColor . Default value is "#EEEEEE",
flash(),
Appearance overview and related methodspublic java.lang.String getHiliteBodyColor()
CSSColor,
flash(),
Appearance overview and related methodspublic void setHiliteHeaderSrc(java.lang.String hiliteHeaderSrc)
showHeaderBackground is true, this governs the URL
of the image to use in the header's highlighted state when the window is flashed
Note : This is an advanced setting
hiliteHeaderSrc - SCImgURL . Default value is "[SKIN]Window/headerGradient_hilite.gif" | null,
Appearance overview and related methodspublic java.lang.String getHiliteHeaderSrc()
showHeaderBackground is true, this governs the URL
of the image to use in the header's highlighted state when the window is flashedSCImgURL,
Appearance overview and related methodspublic void setHiliteHeaderStyle(java.lang.String hiliteHeaderStyle)
flashed
Note : This is an advanced setting
hiliteHeaderStyle - CSSStyleName . Default value is "WindowHeader",
Appearance overview and related methodspublic java.lang.String getHiliteHeaderStyle()
flashedCSSStyleName,
Appearance overview and related methodspublic void setIsModal(java.lang.Boolean isModal)
Use
showModalMask to darken all other elements on the screen
when a modal dialog is showing.
Chained modal windows - that is, modal windows that launch other modal windows - are allowed. You can accomplish this by simply creating a second modal Window while a modal Window is showing.
Note only top-level Windows (Windows without parents) can be modal.
isModal - Default value is falsepublic java.lang.Boolean getIsModal()
Use
showModalMask to darken all other elements on the screen
when a modal dialog is showing.
Chained modal windows - that is, modal windows that launch other modal windows - are allowed. You can accomplish this by simply creating a second modal Window while a modal Window is showing.
Note only top-level Windows (Windows without parents) can be modal.
public ImgButton getMaximizeButton() throws java.lang.IllegalStateException
maximize().
This component is an AutoChild named "maximizeButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setMaximized(java.lang.Boolean maximized)
maximize() or restore().maximized - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getMaximized()
maximize() or restore().Appearance overview and related methodspublic void setMinimizeAcceleration(AnimationAcceleration minimizeAcceleration)
this.animateAcceleration will be used by default instead
Note : This is an advanced setting
minimizeAcceleration - Default value is nullAppearance overview and related methodspublic AnimationAcceleration getMinimizeAcceleration()
this.animateAcceleration will be used by default insteadAppearance overview and related methodspublic ImgButton getMinimizeButton() throws java.lang.IllegalStateException
minimize().
This component is an AutoChild named "minimizeButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setMinimized(java.lang.Boolean minimized)
minimize() or restore().minimized - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getMinimized()
minimize() or restore().Appearance overview and related methodspublic void setMinimizeHeight(java.lang.Integer minimizeHeight)
this.defaultMinimizeHeight
Note : This is an advanced setting
minimizeHeight - Default value is nullAppearance overview and related methodspublic java.lang.Integer getMinimizeHeight()
this.defaultMinimizeHeightAppearance overview and related methodspublic void setMinimizeTime(java.lang.Integer minimizeTime)
canvas.animationTime.
Note : This is an advanced setting
minimizeTime - Default value is nullAppearance overview and related methods,
Window Minimize Examplepublic java.lang.Integer getMinimizeTime()
canvas.animationTime.Appearance overview and related methods,
Window Minimize Examplepublic Canvas getModalMask() throws java.lang.IllegalStateException
showModalMask to true, add a CSS style "modalMask" to the active
skin (generally with background-color set), and adjust modalMaskOpacity.
This component is an AutoChild named "modalMask". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.Appearance overview and related methodspublic void setModalMaskOpacity(int modalMaskOpacity)
throws java.lang.IllegalStateException
modalMaskOpacity - Default value is 50java.lang.IllegalStateException - this property cannot be changed after the component has been createdcom.smartgwt.client.widgets.Window#setModalMask,
Appearance overview and related methodspublic int getModalMaskOpacity()
getModalMask(),
Appearance overview and related methodspublic void setModalMaskStyle(java.lang.String modalMaskStyle)
throws java.lang.IllegalStateException
modalMaskStyle - Default value is "modalMask"java.lang.IllegalStateException - this property cannot be changed after the component has been createdcom.smartgwt.client.widgets.Window#setModalMask,
Appearance overview and related methodspublic java.lang.String getModalMaskStyle()
getModalMask(),
Appearance overview and related methodspublic 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 Canvas.useOpacityFilter to true for specific components on which
opacity support is required.
Also note that opacity is incompatible with backMasks, and that this property is enabled by default for Window
instances.
Note : This is an advanced setting
setOpacity in class Canvasopacity - Default value is nullCues overview and related methodspublic 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 Canvas.useOpacityFilter to true for specific components on which
opacity support is required.
Also note that opacity is incompatible with backMasks, and that this property is enabled by default for Window
instances.
getOpacity in class CanvasCues overview and related methodspublic void setPlacement(PanelPlacement placement) throws java.lang.IllegalStateException
"fillScreen",
"fillPanel", "halfScreen" and "none" If not explicitly specified, default is
to use PanelPlacement "fillScreen" if isHandset, and "none" for non-handset devices.
If
window.placement is something other than "none", sizing and positioning settings (either
explicit left, top, width, height settings or the autoCenter
and autoSize features) will have no effect.
placement - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic PanelPlacement getPlacement()
"fillScreen",
"fillPanel", "halfScreen" and "none" If not explicitly specified, default is
to use PanelPlacement "fillScreen" if isHandset, and "none" for non-handset devices.
If
window.placement is something other than "none", sizing and positioning settings (either
explicit left, top, width, height settings or the autoCenter
and autoSize features) will have no effect.
public void setPrintBodyStyle(java.lang.String printBodyStyle)
throws java.lang.IllegalStateException
printBodyStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is "printHeader"public java.lang.String getPrintBodyStyle()
CSSStyleNamepublic void setPrintHeaderStyle(java.lang.String printHeaderStyle)
throws java.lang.IllegalStateException
printHeaderStyle - java.lang.IllegalStateException - this property cannot be changed after the component has been createdCSSStyleName . Default value is "printHeader"public java.lang.String getPrintHeaderStyle()
CSSStyleNamepublic ImgButton getResizer() throws java.lang.IllegalStateException
This component is an AutoChild named "resizer". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public ImgButton getRestoreButton() throws java.lang.IllegalStateException
restore().
This component is an AutoChild named "restoreButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setShowBody(java.lang.Boolean showBody)
Note : This is an advanced setting
showBody - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowBody()
Appearance overview and related methodspublic void setShowCloseButton(java.lang.Boolean showCloseButton)
Window.closeClick().
showCloseButton to show / hide the closeButtonshowCloseButton - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowCloseButton()
Window.closeClick().Appearance overview and related methodspublic void setShowEdges(java.lang.Boolean showEdges)
throws java.lang.IllegalStateException
showEdges dynamically defaults to false when the placement setting indicates the Window will be filling a portion of the screen or a panel.setShowEdges in class CanvasshowEdges - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowEdges()
showEdges dynamically defaults to false when the placement setting indicates the Window will be filling a portion of the screen or a panel.getShowEdges in class Canvaspublic void setShowFooter(java.lang.Boolean showFooter)
showFooter - Default value is trueAppearance overview and related methods,
Footer Examplepublic java.lang.Boolean getShowFooter()
Appearance overview and related methods,
Footer Examplepublic void setShowHeader(java.lang.Boolean showHeader)
throws java.lang.IllegalStateException
header for this Window.
Note that in certain Smartclient skins showHeaderBackground may be set to
false and the header's appearance implemented as part of the
window's edge media. In this case suppressing the header can be
achieved
by overriding the edge media as well as setting this property to false. For example, to
create a headerless window with a similar appearance to a Menu in the
TreeFrog skin, the following attributes could be used:
showHeader:false,
edgeImage:"[SKIN]/Menu/m.png",
edgeSize:10, edgeTop:17, edgeBottom:17,
edgeCenterBackgroundColor:"#F7F7F7"
showHeader - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdAppearance overview and related methodspublic java.lang.Boolean getShowHeader()
header for this Window.
Note that in certain Smartclient skins showHeaderBackground may be set to
false and the header's appearance implemented as part of the
window's edge media. In this case suppressing the header can be
achieved
by overriding the edge media as well as setting this property to false. For example, to
create a headerless window with a similar appearance to a Menu in the
TreeFrog skin, the following attributes could be used:
showHeader:false,
edgeImage:"[SKIN]/Menu/m.png",
edgeSize:10, edgeTop:17, edgeBottom:17,
edgeCenterBackgroundColor:"#F7F7F7"
Appearance overview and related methodspublic void setShowHeaderBackground(java.lang.Boolean showHeaderBackground)
throws java.lang.IllegalStateException
headerSrc and hiliteHeaderSrc, otherwise the background
will be styled according to headerStyle / hiliteHeaderStyle.
Note : This is an advanced setting
showHeaderBackground - Default value is variesjava.lang.IllegalStateException - this property cannot be changed after the component has been createdAppearance overview and related methodspublic java.lang.Boolean getShowHeaderBackground()
headerSrc and hiliteHeaderSrc, otherwise the background
will be styled according to headerStyle / hiliteHeaderStyle.Appearance overview and related methodspublic void setShowHeaderIcon(java.lang.Boolean showHeaderIcon)
showHeaderIcon to show / hide the headerIconshowHeaderIcon - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowHeaderIcon()
Appearance overview and related methodspublic void setShowMaximizeButton(java.lang.Boolean showMaximizeButton)
showMaximizeButton to show / hide the maximizeButtonshowMaximizeButton - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getShowMaximizeButton()
Appearance overview and related methodspublic void setShowMinimizeButton(java.lang.Boolean showMinimizeButton)
showMinimizeButton to show / hide the minimizeButtonshowMinimizeButton - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowMinimizeButton()
Appearance overview and related methodspublic void setShowModalMask(java.lang.Boolean showModalMask)
throws java.lang.IllegalStateException
showModalMask - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdcom.smartgwt.client.widgets.Window#setModalMask,
Appearance overview and related methodspublic java.lang.Boolean getShowModalMask()
getModalMask(),
Appearance overview and related methodspublic void setShowResizer(java.lang.Boolean showResizer)
showFooter) and canDragResize is true.showResizer - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowResizer()
showFooter) and canDragResize is true.Appearance overview and related methodspublic void setShowShadow(java.lang.Boolean showShadow)
throws java.lang.IllegalStateException
Developers should be aware that the drop shadow 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 browser-level scrolling is never intended to occur.
showShadow
dynamically defaults to false when the placement setting
indicates the Window will be filling a portion of the screen or a panel.
setShowShadow in class CanvasshowShadow - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowShadow()
Developers should be aware that the drop shadow 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 browser-level scrolling is never intended to occur.
showShadow
dynamically defaults to false when the placement setting
indicates the Window will be filling a portion of the screen or a panel.
getShowShadow in class Canvaspublic void setShowStatusBar(java.lang.Boolean showStatusBar)
showStatusBar - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowStatusBar()
Appearance overview and related methodspublic void setShowTitle(java.lang.Boolean showTitle)
showTitle - Default value is trueAppearance overview and related methodspublic java.lang.Boolean getShowTitle()
Appearance overview and related methodspublic void setSrc(java.lang.String src)
Note that setting window.src is essentially a shortcut for setting items to a single HTMLflow with a specified contentsURL.
If this method is called after the component has been drawn/initialized:
Sets the URL of the contents to display in the body of the window, redrawing if necessary.
src - URL of new contents to be displayed in the window body. Default value is nullsetContentsType(java.lang.String),
Appearance overview and related methodspublic java.lang.String getSrc()
Note that setting window.src is essentially a shortcut for setting items to a single HTMLflow with a specified contentsURL.
getContentsType(),
Appearance overview and related methodspublic void setStatus(java.lang.String status)
status - new text for the status bar. Default value is nullAppearance overview and related methodspublic java.lang.String getStatus()
Appearance overview and related methodspublic Canvas getStatusBar() throws java.lang.IllegalStateException
setStatus()
can be used to show text here.
This component is an AutoChild named "statusBar". For an overview of how to use and
configure AutoChildren, see Using AutoChildren.
java.lang.IllegalStateException - if this widget has not yet been rendered.public void setTitle(java.lang.String title)
title that appears in the window header. The header will be redrawn if necessary.setTitle in class Canvastitle - new title.HTMLString . Default value is "Untitled Window",
Appearance overview and related methodspublic java.lang.String getTitle()
getTitle in class CanvasHTMLString,
Appearance overview and related methodspublic void setUseBackMask(java.lang.Boolean useBackMask)
throws java.lang.IllegalStateException
backMask in Internet Explorer
versions predating Internet Explorer 9. This is a workaround for a native browser issue whereby certain DOM elements
such as IFRAMEs (whether rendered within Smart GWT components via features such as contentsURL or explicitly written into the HTML of the page) will
not be properly occluded by DOM elements which overlap them but have a higher z-index. A side-effect of this is that
the opacity can not be modified for the entire window. Developers
may disable the backmask in order to support opacity in IE versions less than 9 by setting this property to false,
however you should be aware that in doing this there is a potential for the "burn through" problem described above.
Note : This is an advanced setting
setUseBackMask in class CanvasuseBackMask - Default value is variesjava.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseBackMask()
backMask in Internet Explorer
versions predating Internet Explorer 9. This is a workaround for a native browser issue whereby certain DOM elements
such as IFRAMEs (whether rendered within Smart GWT components via features such as contentsURL or explicitly written into the HTML of the page) will
not be properly occluded by DOM elements which overlap them but have a higher z-index. A side-effect of this is that
the opacity can not be modified for the entire window. Developers
may disable the backmask in order to support opacity in IE versions less than 9 by setting this property to false,
however you should be aware that in doing this there is a potential for the "burn through" problem described above.
getUseBackMask in class Canvaspublic void addMember(Canvas newMember)
Layout.addMember(). Note that in order to add items
to body, you use addItem() rather than addMember. Adding a member to a Window adds the member as a sibling to the header,
body and other built-in Window subcomponents.addMember in class LayoutnewMember - the canvas object to be added to the layoutLayout.addMembers(java.lang.Object[], int)public void addMember(Canvas newMember, java.lang.Integer position)
Layout.addMember(). Note that in order to add items
to body, you use addItem() rather than addMember. Adding a member to a Window adds the member as a sibling to the header,
body and other built-in Window subcomponents.newMember - the canvas object to be added to the layoutposition - the position in the layout to place newMember (starts with 0); if omitted, it will be added
at the last positionLayout.addMembers(java.lang.Object[], int)public void centerInPage()
public void close()
Window.closeClick() implementation. Default implementation will hide the window.public com.google.gwt.event.shared.HandlerRegistration addCloseClickHandler(CloseClickHandler handler)
Handles a click on the close button of this window. The default implementation calls close() and returns false to prevent bubbling of the click event.
Developers may use addCloseClickHandler() to provide custom handling when the user clicks this button.
Custom implementations may call close() to trigger the default behavior.
addCloseClickHandler in interface HasCloseClickHandlershandler - the closeClick handlerHandlerRegistration used to remove this handlerpublic void flash()
This method is executed when users click outside the bounds of a modal window so they'll notice that they have to do something with the window.
public void maximize()
this.showMaximizeButton is true.0, 0 and resizes the window to "100%" on both axes, so it will fill the
browser window (or the parent of the Window instance, if appropriate).animateMinimize is true, the maximize will be animated. A restore
button will be displayed in place of the maximize button when the window is maximized.public void minimize()
this.showMinimizeButton is true.animateMinimize is true, the resize will be animated. A restore
button will be displayed in place of the minimize button when the window is minimized.public com.google.gwt.event.shared.HandlerRegistration addMaximizeClickHandler(MaximizeClickHandler handler)
Notification method fired when the user clicks the 'maximize' button.
addMaximizeClickHandler in interface HasMaximizeClickHandlershandler - the maximizeClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addMinimizeClickHandler(MinimizeClickHandler handler)
Notification method fired when the user clicks the 'minimize' button.
addMinimizeClickHandler in interface HasMinimizeClickHandlershandler - the minimizeClick handlerHandlerRegistration used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addRestoreClickHandler(RestoreClickHandler handler)
Notification method fired when the user clicks the 'restore' button.
addRestoreClickHandler in interface HasRestoreClickHandlershandler - the restoreClick handlerHandlerRegistration used to remove this handlerpublic void restore()
minimize() or maximize(). Called from a click on the restore
button shown in place of the minimize or maximize button when the window is minimized or maximized.animateMinimize is true.public java.lang.Boolean shouldDismissOnEscape()
dismissOnEscape is set, just
return it. Otherwise return true if this window is showing a "close" control in the header (see headerControls).public static void setDefaultProperties(Window windowProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
windowProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic void addItem(com.google.gwt.user.client.ui.Widget widget)
widget - the widget to be addedpublic void addItem(Canvas component)
component - the widget to be addedpublic void removeItem(Canvas component)
component - the widget to be removedpublic void setKeepInParentRect(java.lang.Boolean keepInParentRect)
setKeepInParentRect in class CanvaskeepInParentRect - true to keepInParentRectDragdrop overview and related methods,
Drag create Examplepublic void setHeaderIconProperties(java.util.Map headerIconProperties)
public void setHeaderIcon(java.lang.String imgSrc)
imgSrc - the icon image sourcepublic void setHeaderIcon(java.lang.String imgSrc,
int width,
int height)
imgSrc - the icon image sourcewidth - the icon width. default 16height - the icon height. default 14public void setHeaderControls(java.lang.Object... headerControls)
HeaderControls listing the standard header controls in their default order: headerControls - an array containing either HeaderControl enums values or Canvas instancesHeaderControlspublic void setFooterControls(java.lang.Object... footerControls)
FooterControls listing the standard footer controls in their default order: footerControls - an array containing either FooterControl enums values or Canvas instancesFooterControlspublic void setKeepInParentRect(Rectangle rectangle)
setKeepInParentRect in class Canvasrectangle - the rectangle boundspublic Canvas[] getItems()
public static void preloadImages()
public void setContentLayout(java.lang.String contentLayout)
setContentLayout()
Valid values are "vertical", "horizontal", or "none". If the body is a Layout, this
controls how the items are stacked in the body by setting Layout.vertical. See bodyConstructor for details.
Note : This is an advanced setting
contentLayout - Default value is "vertical"Appearance overview and related methodspublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.WindowLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class VLayout