Class Window
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,HasClickHandlers,HasCloseClickHandlers,HasDoubleClickHandlers,HasDragMoveHandlers,HasDragRepositionMoveHandlers,HasDragRepositionStartHandlers,HasDragRepositionStopHandlers,HasDragResizeMoveHandlers,HasDragResizeStartHandlers,HasDragResizeStopHandlers,HasDragStartHandlers,HasDragStopHandlers,HasDropHandlers,HasDropMoveHandlers,HasDropOutHandlers,HasDropOverHandlers,HasFocusChangedHandlers,HasHoverHandlers,HasHoverHiddenHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasMaximizeClickHandlers,HasMinimizeClickHandlers,HasMouseDownHandlers,HasMouseMoveHandlers,HasMouseOutHandlers,HasMouseOverHandlers,HasMouseStillDownHandlers,HasMouseUpHandlers,HasMouseWheelHandlers,HasMovedHandlers,HasParentMovedHandlers,HasResizedHandlers,HasRestoreClickHandlers,HasRightMouseDownHandlers,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasVisibilityChangedHandlers,HasMembersChangedHandlers
- Direct Known Subclasses:
AISortProgressDialog,AIWindow,ColorPicker,DateRangeDialog,Dialog,EditSearchWindow,FieldPickerWindow,ListPropertiesDialog,MultiGroupDialog,MultiSortDialog,Portlet,PrintWindow,TourWindow
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCloseClickHandler(CloseClickHandler handler) Add a closeClick handler.voidAdds a widget to the window.voidAdds a widget to the window.Add a maximizeClick handler.voidSame asLayout.addMember().voidSame asLayout.addMember().Add a minimizeClick handler.Add a restoreClick handler.voidCenters the Window in the page.static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.voidclose()Close this window.protected JavaScriptObjectcreate()voidflash()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.Should this window minimize, maximize, and restore as an animation, or as a simple 1-step transition?If true, this Window widget will automatically be centered on the page when shown.If true, the window is resized automatically to accommodate the contents of the body, if they would otherwise require scrolling.getBody()Body of the Window, wherecontained componentsorloaded contentis shown.Color of the Window body.Style of the Window body.booleanShould this window automatically be shown at the top of the page's z-order and be brought to front viaCanvas.bringToFront()whenever the user clicks it?If true, this Window may be moved around by the user by dragging on the Window header.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.If true, the user can give the header buttons focus (seeminimizeButton,maximizeButton,restoreButtonandcloseButton).Button show in the header that will close this Window by callingWindow.closeClick().The layout policy that should be used for widgets within the Window body.If this window hassrcspecified, this property can be used to indicate whether the source is a standalone HTML page or an HTML fragment.intIfminimizeHeightis unset, by the window will shrink to the height of the header when minimized.Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape" key?
Windows with this setting will dismiss on Escape keypresses in any of the following cases: The window or one of its descendants has focus (and does not cancel the Escape keypress) The window ismodal, and not itself masked.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.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.Alternative style for the window used wheneverplacementsettings indicate the menu will be filling a portion of the screen or a panel.Optional footer for the window, providing space for controls such as the resizer and status bar.intThe height of the footer, in pixels.Header for the Window, based on an HLayout.Img background component for the header, for gradient or image-based displayHeader icon shown at left end of header by default.Label that shows Window title in header.IfshowHeaderBackgroundistrue, this property provides the URL of the background image for the header.Style for the Window header.Highlight color for the Window body (shown when the body is flashed).IfshowHeaderBackgroundis true, this governs the URL of the image to use in the header's highlighted state when the window isflashedHighlight style for the Window header.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.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.Button that will make this Window fill the browser viamaximize().Is this window maximized.Default acceleration function for performing an animated minimize / maximize.ImgButton shown in the header that will minimize this Window by callingminimize().Is this window minimized.Height for the window when minimized.If this window is minimizeable, and animateMinimize is true, what should the duration of the minimize / maximize be (in ms)? If unset defaults tocanvas.animationTime.A ScreenSpan instance used to darken the rest of a page when a modal window is active.intControls the opacity of the modal mask displayed behind modal windows.Specifies the CSS style for the modal mask.Renders the widget to be partly transparent.static WindowgetOrCreateRef(JavaScriptObject jsObj) Where should the window be placed on the screen? Valid settings include"fillScreen","fillPanel","halfScreen"and"none"Style for the Window body in printed output.CSS Style for header in printed outputEdgeName[]When drag resizing is enabled viacanDragResize, restricts resizes to only certain edges or corners.ImgButton-based resizer, shown in the footer.ImgButton that restores the Window viarestore().If true, draw the body contents when this Window is drawn.If true, show a close button in the header, which will dismiss this window by callingWindow.closeClick().showEdgesdynamically defaults to false when theplacementsetting indicates the Window will be filling a portion of the screen or a panel.If true, show a footer for this Window, including resizer, statusBar, etc.If true, show aheaderfor this Window.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 fromheaderSrcandhiliteHeaderSrc, otherwise the background will be styled according toheaderStyle/hiliteHeaderStyle.If true, we show an icon on the left in the header.If true, show a maximize button in the header - clicking it maximizes the WindowIf true, show a minimize button in the header--clicking it minimizes the Window.If true, displays a translucent mask over the rest of the page when a modal window is displayed.If true, show a button in the lower right corner that allows users to resize the Window.Whether to show a drop shadow for this Canvas.If true, show a statusBar for this Window, including resizer.Show a title (typically just text) on the header for this window.getSrc()A URL to load as content for the Window's body.Text to show in the status bar of the window (if one is visible)Simple Canvas-based status bar, shown in the footer.getTitle()By default Windows show abackMaskin Internet Explorer versions predating Internet Explorer 9.voidmaximize()Maximize the window.voidminimize()Minimize the window.static voidPreload primary window skin imagesvoidremoveItem(Canvas component) Removes a widget from the window.voidrestore()Restores the window to its specified height and width after a call tominimize()ormaximize().voidrevealChild(Canvas child) Reveals the child Canvas passed in by showing it if it is currently hidden.voidrevealChild(String childID) Reveals the child Canvas passed in by showing it if it is currently hidden.setAnimateMinimize(Boolean animateMinimize) Should this window minimize, maximize, and restore as an animation, or as a simple 1-step transition?setAutoCenter(Boolean autoCenter) If true, this Window widget will automatically be centered on the page when shown.setAutoSize(Boolean autoSize) If true, the window is resized automatically to accommodate the contents of the body, if they would otherwise require scrolling.setBodyColor(String bodyColor) Color of the Window body.setBodyDefaults(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 onlysetBodyStyle(String bodyStyle) Style of the Window body.setBringToFrontOnMouseUp(boolean bringToFrontOnMouseUp) Should this window automatically be shown at the top of the page's z-order and be brought to front viaCanvas.bringToFront()whenever the user clicks it?setCanDragReposition(Boolean canDragReposition) If true, this Window may be moved around by the user by dragging on the Window header.setCanDragResize(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.setCanFocusInHeaderButtons(Boolean canFocusInHeaderButtons) If true, the user can give the header buttons focus (seeminimizeButton,maximizeButton,restoreButtonandcloseButton).setContentLayout(ContentLayoutPolicy contentLayout) The layout policy that should be used for widgets within the Window body.voidsetContentLayout(String contentLayout) Deprecated.setContentsType(String contentsType) If this window hassrcspecified, this property can be used to indicate whether the source is a standalone HTML page or an HTML fragment.setDefaultMinimizeHeight(int defaultMinimizeHeight) IfminimizeHeightis unset, by the window will shrink to the height of the header when minimized.static voidsetDefaultProperties(Window windowProperties) Class level method to set the default properties of this class.setDismissOnEscape(Boolean dismissOnEscape) Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape" key?
Windows with this setting will dismiss on Escape keypresses in any of the following cases: The window or one of its descendants has focus (and does not cancel the Escape keypress) The window ismodal, and not itself masked.setDismissOnOutsideClick(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.setEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.setFillSpaceStyleName(String fillSpaceStyleName) Alternative style for the window used wheneverplacementsettings indicate the menu will be filling a portion of the screen or a panel.voidsetFooterControls(Object... footerControls) Array of members to show in the Window footer.setFooterHeight(int footerHeight) The height of the footer, in pixels.voidsetHeaderControls(Object... headerControls) Array of members to show in the Window header.voidsetHeaderIcon(String imgSrc) Sets the Window header icon.voidsetHeaderIcon(String imgSrc, int width, int height) Sets the Window header icon.setHeaderIconDefaults(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.voidsetHeaderIconProperties(Map headerIconProperties) setHeaderSrc(String headerSrc) IfshowHeaderBackgroundistrue, this property provides the URL of the background image for the header.setHeaderStyle(String headerStyle) Style for the Window header.setHiliteBodyColor(String hiliteBodyColor) Highlight color for the Window body (shown when the body is flashed).setHiliteHeaderSrc(String hiliteHeaderSrc) IfshowHeaderBackgroundis true, this governs the URL of the image to use in the header's highlighted state when the window isflashedsetHiliteHeaderStyle(String hiliteHeaderStyle) Highlight style for the Window header.setIsModal(Boolean isModal) If true, when shown this Window will intercept and block events to all other existing components on the page.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.setKeepInParentRect(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)?Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setMaximized(Boolean maximized) Is this window maximized.setMinimizeAcceleration(AnimationAcceleration minimizeAcceleration) Default acceleration function for performing an animated minimize / maximize.setMinimized(Boolean minimized) Is this window minimized.setMinimizeHeight(Integer minimizeHeight) Height for the window when minimized.setMinimizeTime(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 tocanvas.animationTime.setModalMaskOpacity(int modalMaskOpacity) Controls the opacity of the modal mask displayed behind modal windows.setModalMaskStyle(String modalMaskStyle) Specifies the CSS style for the modal mask.setOpacity(Integer opacity) Renders the widget to be partly transparent.setPlacement(PanelPlacement placement) Where should the window be placed on the screen? Valid settings include"fillScreen","fillPanel","halfScreen"and"none"setPrintBodyStyle(String printBodyStyle) Style for the Window body in printed output.setPrintHeaderStyle(String printHeaderStyle) CSS Style for header in printed outputsetResizeFrom(EdgeName... resizeFrom) When drag resizing is enabled viacanDragResize, restricts resizes to only certain edges or corners.setShowBody(Boolean showBody) If true, draw the body contents when this Window is drawn.setShowCloseButton(Boolean showCloseButton) If true, show a close button in the header, which will dismiss this window by callingWindow.closeClick().setShowEdges(Boolean showEdges) showEdgesdynamically defaults to false when theplacementsetting indicates the Window will be filling a portion of the screen or a panel.setShowFooter(Boolean showFooter) If true, show a footer for this Window, including resizer, statusBar, etc.setShowHeader(Boolean showHeader) If true, show aheaderfor this Window.setShowHeaderBackground(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 fromheaderSrcandhiliteHeaderSrc, otherwise the background will be styled according toheaderStyle/hiliteHeaderStyle.setShowHeaderIcon(Boolean showHeaderIcon) If true, we show an icon on the left in the header.setShowMaximizeButton(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 updateshowMaximizeButtonto show / hide the maximizeButtonsetShowMinimizeButton(Boolean showMinimizeButton) If true, show a minimize button in the header--clicking it minimizes the Window.setShowModalMask(Boolean showModalMask) If true, displays a translucent mask over the rest of the page when a modal window is displayed.setShowResizer(Boolean showResizer) If true, show a button in the lower right corner that allows users to resize the Window.setShowShadow(Boolean showShadow) Whether to show a drop shadow for this Canvas.setShowStatusBar(Boolean showStatusBar) If true, show a statusBar for this Window, including resizer.setShowTitle(Boolean showTitle) Show a title (typically just text) on the header for this window.A URL to load as content for the Window's body.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.voidsetUseBackMask(Boolean useBackMask) By default Windows show abackMaskin Internet Explorer versions predating Internet Explorer 9.Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape" key?
Default behavior: ifdismissOnEscapeis set, just return it.Methods inherited from class com.smartgwt.client.widgets.layout.VLayout
setDefaultProperties, setLogicalStructureMethods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, 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, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, replaceMember, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, 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, showMemberMethods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, animateHide, 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, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, 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, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, 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, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
Window
public Window() -
Window
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
setAnimateMinimize
Should this window minimize, maximize, and restore as an animation, or as a simple 1-step transition?Note : This is an advanced setting
- Parameters:
animateMinimize- New animateMinimize value. Default value is null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getAnimateMinimize
Should this window minimize, maximize, and restore as an animation, or as a simple 1-step transition?- Returns:
- Current animateMinimize value. Default value is null
- See Also:
-
setAutoCenter
If true, this Window widget will automatically be centered on the page when shown. If false, it will show up in the last position it was placed (either programmatically, or by user interaction).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(). Auto-centering will also be disabled if you pass an explicitleftortopvalue at create time.
If this method is called after the component has been drawn/initialized: Setter for theautoCenterattribute.- Parameters:
autoCenter- new value for autoCenter. Default value is false- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getAutoCenter
If true, this Window widget will automatically be centered on the page when shown. If false, it will show up in the last position it was placed (either programmatically, or by user interaction).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(). Auto-centering will also be disabled if you pass an explicitleftortopvalue at create time.- Returns:
- Current autoCenter value. Default value is false
- See Also:
-
setAutoSize
If true, the window is resized automatically to accommodate the contents of the body, if they would otherwise require scrolling.
If this method is called after the component has been drawn/initialized: Setter forautoSize- Parameters:
autoSize- true if the window should auto-size to its content. Default value is false- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getAutoSize
If true, the window is resized automatically to accommodate the contents of the body, if they would otherwise require scrolling.- Returns:
- Current autoSize value. Default value is false
- See Also:
-
getBody
Body of the Window, wherecontained componentsorloaded contentis shown.The following
passthroughsapply:bodyStylefor theCanvas.styleNameprintBodyStylefor thestyleNameto use when printingbodyColor/hiliteBodyColorfor theCanvas.backgroundColor
This component is an AutoChild named "body". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current body value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setBodyColor
Color of the Window body. Overrides the background color specified in the style.
If this method is called after the component has been drawn/initialized: Setter forbodyColor.- Parameters:
bodyColor- newbackgroundColorfor thebody. Default value is "#FFFFFF"- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getBodyColor
Color of the Window body. Overrides the background color specified in the style.- Returns:
- Current bodyColor value. Default value is "#FFFFFF"
- See Also:
-
setBodyDefaults
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 onlyNote : This is an advanced setting
- Parameters:
bodyDefaults- New bodyDefaults value. Default value is ...- Returns:
Windowinstance, for chaining setter calls- See Also:
-
setBodyStyle
Style of the Window body.
If this method is called after the component has been drawn/initialized: Setter forbodyStyle. -
getBodyStyle
Style of the Window body.- Returns:
- Current bodyStyle value. Default value is "windowBody"
- See Also:
-
setBringToFrontOnMouseUp
Should this window automatically be shown at the top of the page's z-order and be brought to front viaCanvas.bringToFront()whenever the user clicks it?If
isModalis 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 tofalse- Parameters:
bringToFrontOnMouseUp- New bringToFrontOnMouseUp value. Default value is true- Returns:
Windowinstance, for chaining setter calls
-
getBringToFrontOnMouseUp
public boolean getBringToFrontOnMouseUp()Should this window automatically be shown at the top of the page's z-order and be brought to front viaCanvas.bringToFront()whenever the user clicks it?If
isModalis 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 tofalse- Returns:
- Current bringToFrontOnMouseUp value. Default value is true
-
setCanDragReposition
If true, this Window may be moved around by the user by dragging on the Window header. Note that if the header is not showing, the Window can't be drag-repositioned regardless of this setting.- Overrides:
setCanDragRepositionin classCanvas- Parameters:
canDragReposition- New canDragReposition value. Default value is true- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getCanDragReposition
If true, this Window may be moved around by the user by dragging on the Window header. Note that if the header is not showing, the Window can't be drag-repositioned regardless of this setting.- Overrides:
getCanDragRepositionin classCanvas- Returns:
- Current canDragReposition value. Default value is true
- See Also:
-
setCanDragResize
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.- Overrides:
setCanDragResizein classCanvas- Parameters:
canDragResize- New canDragResize value. Default value is false- Returns:
Windowinstance, for chaining setter calls- See Also:
-
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.- Overrides:
getCanDragResizein classCanvas- Returns:
- Current canDragResize value. Default value is false
- See Also:
-
setCanFocusInHeaderButtons
If true, the user can give the header buttons focus (seeminimizeButton,maximizeButton,restoreButtonandcloseButton).Note : This is an advanced setting
-
getCanFocusInHeaderButtons
If true, the user can give the header buttons focus (seeminimizeButton,maximizeButton,restoreButtonandcloseButton).- Returns:
- Current canFocusInHeaderButtons value. Default value is false
- See Also:
-
getCloseButton
Button show in the header that will close this Window by callingWindow.closeClick().This component is an AutoChild named "closeButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current closeButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setContentLayout
The layout policy that should be used for widgets within the Window body.See
ContentLayoutPolicyandbodyConstructorfor details.Note : This is an advanced setting
- Parameters:
contentLayout- New contentLayout value. Default value is "vertical"- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getContentLayout
The layout policy that should be used for widgets within the Window body.See
ContentLayoutPolicyandbodyConstructorfor details.- Returns:
- Current contentLayout value. Default value is "vertical"
- See Also:
-
setContentsType
If this window hassrcspecified, 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.contentsTypeproperty - be sure to read the HTMLFlow documentation to understand circumstances where contentsType:"page" is unsafe and not recommended.- Parameters:
contentsType- New contentsType value. Default value is "page"- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getContentsType
If this window hassrcspecified, 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.contentsTypeproperty - be sure to read the HTMLFlow documentation to understand circumstances where contentsType:"page" is unsafe and not recommended.- Returns:
- Current contentsType value. Default value is "page"
- See Also:
-
setDefaultMinimizeHeight
IfminimizeHeightis unset, by the window will shrink to the height of the header when minimized.
If there is no header, thedefaultMinimizeHeightwill be used instead.Note : This is an advanced setting
- Parameters:
defaultMinimizeHeight- New defaultMinimizeHeight value. Default value is 16- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getDefaultMinimizeHeight
public int getDefaultMinimizeHeight()IfminimizeHeightis unset, by the window will shrink to the height of the header when minimized.
If there is no header, thedefaultMinimizeHeightwill be used instead.- Returns:
- Current defaultMinimizeHeight value. Default value is 16
- See Also:
-
setDismissOnEscape
Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape" key?
Windows with this setting will dismiss on Escape keypresses in any of the following cases:- The window or one of its descendants has focus (and does not cancel the Escape keypress)
- The window is
modal, and not itself masked. This ensures that focus is not on some unrelated element on the page.
If unset default behavior depends on whether a close / cancel button is visible for this item.
- Parameters:
dismissOnEscape- New dismissOnEscape value. Default value is null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getDismissOnEscape
Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape" key?
Windows with this setting will dismiss on Escape keypresses in any of the following cases:- The window or one of its descendants has focus (and does not cancel the Escape keypress)
- The window is
modal, and not itself masked. This ensures that focus is not on some unrelated element on the page.
If unset default behavior depends on whether a close / cancel button is visible for this item.
- Returns:
- Current dismissOnEscape value. Default value is null
- See Also:
-
setDismissOnOutsideClick
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.- Parameters:
dismissOnOutsideClick- New dismissOnOutsideClick value. Default value is false- Returns:
Windowinstance, for chaining setter calls- See Also:
-
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.- Returns:
- Current dismissOnOutsideClick value. Default value is false
- See Also:
-
setEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classLayout- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "WindowEditProxy"- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin classLayout- Returns:
- Current editProxyConstructor value. Default value is "WindowEditProxy"
- See Also:
-
setFillSpaceStyleName
Alternative style for the window used wheneverplacementsettings 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.- Parameters:
fillSpaceStyleName- New fillSpaceStyleName value. Default value is "windowBackgroundFill"- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getFillSpaceStyleName
Alternative style for the window used wheneverplacementsettings 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.- Returns:
- Current fillSpaceStyleName value. Default value is "windowBackgroundFill"
- See Also:
-
getHeader
Header for the Window, based on an HLayout. The header contains the title and some standard controls for the window, which may be configured viaheaderControls.The following
passthroughsapply:headerStyleforCanvas.styleNameprintHeaderStylefor thestyleNameto use when printing.
This component is an AutoChild named "header". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current header value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
getHeaderBackground
Img background component for the header, for gradient or image-based displayThis component is an AutoChild named "headerBackground". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current headerBackground value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
getHeaderIcon
Header icon shown at left end of header by default.This component is an AutoChild named "headerIcon". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current headerIcon value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setHeaderIconDefaults
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. Overrideable defaults are as follows:- width
- default to
16and specifies the width of the headerIcon. - height - default to
14and specifies the height of the headerIcon. - src - defaults to
"[SKIN]/Window/minimize.gif"and specifies the image for the headerIcon.
Note : This is an advanced setting
- Parameters:
headerIconDefaults- New headerIconDefaults value. Default value is ...- Returns:
Windowinstance, for chaining setter calls- See Also:
- width
- default to
-
getHeaderLabel
Label that shows Window title in header.The following
passthroughapplies:titleforLabel.contents.This component is an AutoChild named "headerLabel". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current headerLabel value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setHeaderSrc
IfshowHeaderBackgroundistrue, this property provides the URL of the background image for the header.Note : This is an advanced setting
- Parameters:
headerSrc- New headerSrc value. Default value is "[SKIN]Window/headerGradient.gif" | null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getHeaderSrc
IfshowHeaderBackgroundistrue, this property provides the URL of the background image for the header.- Returns:
- Current headerSrc value. Default value is "[SKIN]Window/headerGradient.gif" | null
- See Also:
-
setHeaderStyle
Style for the Window header.
If this method is called after the component has been drawn/initialized: Setter forheaderStyle.Note : This is an advanced setting
-
getHeaderStyle
Style for the Window header.- Returns:
- Current headerStyle value. Default value is "WindowHeader"
- See Also:
-
setHiliteBodyColor
Highlight color for the Window body (shown when the body is flashed).
If this method is called after the component has been drawn/initialized: Setter forhiliteBodyColor.- Parameters:
hiliteBodyColor- newhiliteBodyColor. Default value is "#EEEEEE"- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getHiliteBodyColor
Highlight color for the Window body (shown when the body is flashed).- Returns:
- Current hiliteBodyColor value. Default value is "#EEEEEE"
- See Also:
-
setHiliteHeaderSrc
IfshowHeaderBackgroundis true, this governs the URL of the image to use in the header's highlighted state when the window isflashedNote : This is an advanced setting
- Parameters:
hiliteHeaderSrc- New hiliteHeaderSrc value. Default value is "[SKIN]Window/headerGradient_hilite.gif" | null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getHiliteHeaderSrc
IfshowHeaderBackgroundis true, this governs the URL of the image to use in the header's highlighted state when the window isflashed- Returns:
- Current hiliteHeaderSrc value. Default value is "[SKIN]Window/headerGradient_hilite.gif" | null
- See Also:
-
setHiliteHeaderStyle
Highlight style for the Window header. Displayed when a window isflashedNote : This is an advanced setting
- Parameters:
hiliteHeaderStyle- New hiliteHeaderStyle value. Default value is "WindowHeader"- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getHiliteHeaderStyle
Highlight style for the Window header. Displayed when a window isflashed- Returns:
- Current hiliteHeaderStyle value. Default value is "WindowHeader"
- See Also:
-
setIsModal
If true, when shown this Window will intercept and block events to all other existing components on the page.Use
showModalMaskto 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.
- Parameters:
isModal- New isModal value. Default value is false- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getIsModal
If true, when shown this Window will intercept and block events to all other existing components on the page.Use
showModalMaskto 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.
- Returns:
- Current isModal value. Default value is false
- See Also:
-
getMaximizeButton
Button that will make this Window fill the browser viamaximize().This component is an AutoChild named "maximizeButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current maximizeButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setMaximized
Is this window maximized. If true at init time, the window will be drawn maximized. To set this property at runtime usemaximize()orrestore().- Parameters:
maximized- New maximized value. Default value is false- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getMaximized
Is this window maximized. If true at init time, the window will be drawn maximized. To set this property at runtime usemaximize()orrestore().- Returns:
- Current maximized value. Default value is false
- See Also:
-
setMinimizeAcceleration
Default acceleration function for performing an animated minimize / maximize. If unset,this.animateAccelerationwill be used by default insteadNote : This is an advanced setting
- Parameters:
minimizeAcceleration- New minimizeAcceleration value. Default value is null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getMinimizeAcceleration
Default acceleration function for performing an animated minimize / maximize. If unset,this.animateAccelerationwill be used by default instead- Returns:
- Current minimizeAcceleration value. Default value is null
- See Also:
-
getMinimizeButton
ImgButton shown in the header that will minimize this Window by callingminimize().This component is an AutoChild named "minimizeButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current minimizeButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setMinimized
Is this window minimized. If true at init time, the window will be drawn minimized. To set this property at runtime useminimize()orrestore().- Parameters:
minimized- New minimized value. Default value is false- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getMinimized
Is this window minimized. If true at init time, the window will be drawn minimized. To set this property at runtime useminimize()orrestore().- Returns:
- Current minimized value. Default value is false
- See Also:
-
setMinimizeHeight
Height for the window when minimized. If unset the window will shrink to the height of the header, if present, otherwisethis.defaultMinimizeHeightNote : This is an advanced setting
- Parameters:
minimizeHeight- New minimizeHeight value. Default value is null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getMinimizeHeight
Height for the window when minimized. If unset the window will shrink to the height of the header, if present, otherwisethis.defaultMinimizeHeight- Returns:
- Current minimizeHeight value. Default value is null
- See Also:
-
setMinimizeTime
If this window is minimizeable, and animateMinimize is true, what should the duration of the minimize / maximize be (in ms)? If unset defaults tocanvas.animationTime.Note : This is an advanced setting
- Parameters:
minimizeTime- New minimizeTime value. Default value is null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getMinimizeTime
If this window is minimizeable, and animateMinimize is true, what should the duration of the minimize / maximize be (in ms)? If unset defaults tocanvas.animationTime.- Returns:
- Current minimizeTime value. Default value is null
- See Also:
-
getModalMask
A ScreenSpan instance used to darken the rest of a page when a modal window is active. To use, setshowModalMaskto true, add a CSS style "modalMask" to the active skin (generally with background-color set), and adjustmodalMaskOpacity.This component is an AutoChild named "modalMask". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current modalMask value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.- See Also:
-
setModalMaskOpacity
Controls the opacity of the modal mask displayed behind modal windows.- Parameters:
modalMaskOpacity- New modalMaskOpacity value. Default value is 50- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.Window#setModalMaskAppearance overview and related methods
-
getModalMaskOpacity
public int getModalMaskOpacity()Controls the opacity of the modal mask displayed behind modal windows.- Returns:
- Current modalMaskOpacity value. Default value is 50
- See Also:
-
setModalMaskStyle
Specifies the CSS style for the modal mask.- Parameters:
modalMaskStyle- New modalMaskStyle value. Default value is "modalMask"- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.Window#setModalMaskAppearance overview and related methods
-
getModalMaskStyle
Specifies the CSS style for the modal mask.- Returns:
- Current modalMaskStyle value. Default value is "modalMask"
- See Also:
-
setOpacity
Renders the widget to be partly transparent. A widget's opacity property may be set to any number between 0 (transparent) to 100 (opaque). Null means don't specify opacity directly, 100 is fully opaque. Note that heavy use of opacity may have a performance impact on some older browsers.In older versions of Internet Explorer (Pre IE9 / HTML5), opacity is achieved through proprietary filters. If
filters have been disabledwithin this application developers must setCanvas.useOpacityFilterto 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
- Overrides:
setOpacityin classCanvas- Parameters:
opacity- New opacity value. Default value is null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getOpacity
Renders the widget to be partly transparent. A widget's opacity property may be set to any number between 0 (transparent) to 100 (opaque). Null means don't specify opacity directly, 100 is fully opaque. Note that heavy use of opacity may have a performance impact on some older browsers.In older versions of Internet Explorer (Pre IE9 / HTML5), opacity is achieved through proprietary filters. If
filters have been disabledwithin this application developers must setCanvas.useOpacityFilterto 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.- Overrides:
getOpacityin classCanvas- Returns:
- Current opacity value. Default value is null
- See Also:
-
setPlacement
Where should the window be placed on the screen? Valid settings include"fillScreen","fillPanel","halfScreen"and"none"If not explicitly specified, default is to use
PanelPlacement"fillScreen" ifisHandset, and "none" for non-handset devices.If
window.placementis something other than"none", sizing and positioning settings (either explicit left, top, width, height settings or theautoCenterandautoSizefeatures) will have no effect.- Parameters:
placement- New placement value. Default value is null- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getPlacement
Where should the window be placed on the screen? Valid settings include"fillScreen","fillPanel","halfScreen"and"none"If not explicitly specified, default is to use
PanelPlacement"fillScreen" ifisHandset, and "none" for non-handset devices.If
window.placementis something other than"none", sizing and positioning settings (either explicit left, top, width, height settings or theautoCenterandautoSizefeatures) will have no effect.- Returns:
- Current placement value. Default value is null
-
setPrintBodyStyle
Style for the Window body in printed output.- Parameters:
printBodyStyle- New printBodyStyle value. Default value is "printHeader"- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getPrintBodyStyle
Style for the Window body in printed output.- Returns:
- Current printBodyStyle value. Default value is "printHeader"
- See Also:
-
setPrintHeaderStyle
CSS Style for header in printed output- Parameters:
printHeaderStyle- New printHeaderStyle value. Default value is "printHeader"- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getPrintHeaderStyle
CSS Style for header in printed output- Returns:
- Current printHeaderStyle value. Default value is "printHeader"
- See Also:
-
setResizeFrom
When drag resizing is enabled viacanDragResize, restricts resizes to only certain edges or corners.This property on
Windowoverrides the default defined byCanvas.resizeFrom.Note : This is an advanced setting
- Overrides:
setResizeFromin classCanvas- Parameters:
resizeFrom- New resizeFrom value. Default value is ["R","B","BR"]- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getResizeFrom
When drag resizing is enabled viacanDragResize, restricts resizes to only certain edges or corners.This property on
Windowoverrides the default defined byCanvas.resizeFrom.- Overrides:
getResizeFromin classCanvas- Returns:
- Current resizeFrom value. Default value is ["R","B","BR"]
- See Also:
-
getResizer
ImgButton-based resizer, shown in the footer.This component is an AutoChild named "resizer". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current resizer value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
getRestoreButton
ImgButton that restores the Window viarestore().This component is an AutoChild named "restoreButton". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current restoreButton value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setShowBody
If true, draw the body contents when this Window is drawn.Note : This is an advanced setting
- Parameters:
showBody- New showBody value. Default value is true- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getShowBody
If true, draw the body contents when this Window is drawn.- Returns:
- Current showBody value. Default value is true
- See Also:
-
setShowCloseButton
If true, show a close button in the header, which will dismiss this window by callingWindow.closeClick().
If this method is called after the component has been drawn/initialized: Dynamically updateshowCloseButtonto show / hide the closeButton- Parameters:
showCloseButton- New showCloseButton value. Default value is true- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getShowCloseButton
If true, show a close button in the header, which will dismiss this window by callingWindow.closeClick().- Returns:
- Current showCloseButton value. Default value is true
- See Also:
-
setShowEdges
showEdgesdynamically defaults to false when theplacementsetting indicates the Window will be filling a portion of the screen or a panel.- Overrides:
setShowEdgesin classCanvas- Parameters:
showEdges- New showEdges value. Default value is null- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowEdges
showEdgesdynamically defaults to false when theplacementsetting indicates the Window will be filling a portion of the screen or a panel.- Overrides:
getShowEdgesin classCanvas- Returns:
- Current showEdges value. Default value is null
- See Also:
-
setShowHeader
If true, show aheaderfor this Window.Note that in certain Smartclient skins
showHeaderBackgroundmay be set tofalseand the header's appearance implemented as part of the window'sedge 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 aMenuin theTreeFrogskin, the following attributes could be used:showHeader:false, edgeImage:"[SKIN]/Menu/m.png", edgeSize:10, edgeTop:17, edgeBottom:17, edgeCenterBackgroundColor:"#F7F7F7"- Parameters:
showHeader- New showHeader value. Default value is true- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowHeader
If true, show aheaderfor this Window.Note that in certain Smartclient skins
showHeaderBackgroundmay be set tofalseand the header's appearance implemented as part of the window'sedge 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 aMenuin theTreeFrogskin, the following attributes could be used:showHeader:false, edgeImage:"[SKIN]/Menu/m.png", edgeSize:10, edgeTop:17, edgeBottom:17, edgeCenterBackgroundColor:"#F7F7F7"- Returns:
- Current showHeader value. Default value is true
- See Also:
-
setShowHeaderBackground
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 fromheaderSrcandhiliteHeaderSrc, otherwise the background will be styled according toheaderStyle/hiliteHeaderStyle.Note : This is an advanced setting
- Parameters:
showHeaderBackground- New showHeaderBackground value. Default value is varies- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
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 fromheaderSrcandhiliteHeaderSrc, otherwise the background will be styled according toheaderStyle/hiliteHeaderStyle.- Returns:
- Current showHeaderBackground value. Default value is varies
- See Also:
-
setShowHeaderIcon
If true, we show an icon on the left in the header.
If this method is called after the component has been drawn/initialized: Dynamically updateshowHeaderIconto show / hide the headerIcon- Parameters:
showHeaderIcon- New showHeaderIcon value. Default value is true- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getShowHeaderIcon
If true, we show an icon on the left in the header.- Returns:
- Current showHeaderIcon value. Default value is true
- See Also:
-
setShowMaximizeButton
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 updateshowMaximizeButtonto show / hide the maximizeButton- Parameters:
showMaximizeButton- New showMaximizeButton value. Default value is false- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getShowMaximizeButton
If true, show a maximize button in the header - clicking it maximizes the Window- Returns:
- Current showMaximizeButton value. Default value is false
- See Also:
-
setShowMinimizeButton
If true, show a minimize button in the header--clicking it minimizes the Window.
If this method is called after the component has been drawn/initialized: Dynamically updateshowMinimizeButtonto show / hide the minimizeButton- Parameters:
showMinimizeButton- New showMinimizeButton value. Default value is true- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getShowMinimizeButton
If true, show a minimize button in the header--clicking it minimizes the Window.- Returns:
- Current showMinimizeButton value. Default value is true
- See Also:
-
setShowModalMask
If true, displays a translucent mask over the rest of the page when a modal window is displayed.- Parameters:
showModalMask- New showModalMask value. Default value is null- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
com.smartgwt.client.widgets.Window#setModalMaskAppearance overview and related methods
-
getShowModalMask
If true, displays a translucent mask over the rest of the page when a modal window is displayed.- Returns:
- Current showModalMask value. Default value is null
- See Also:
-
setShowResizer
If true, show a button in the lower right corner that allows users to resize the Window. Note that the resizer will only be displayed if the footer is showing for the window (showFooter) andcanDragResizeis true.- Parameters:
showResizer- New showResizer value. Default value is true- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getShowResizer
If true, show a button in the lower right corner that allows users to resize the Window. Note that the resizer will only be displayed if the footer is showing for the window (showFooter) andcanDragResizeis true.- Returns:
- Current showResizer value. Default value is true
- See Also:
-
setShowShadow
Whether to show a drop shadow for this Canvas.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.
showShadowdynamically defaults to false when theplacementsetting indicates the Window will be filling a portion of the screen or a panel.- Overrides:
setShowShadowin classCanvas- Parameters:
showShadow- New showShadow value. Default value is null- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowShadow
Whether to show a drop shadow for this Canvas.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.
showShadowdynamically defaults to false when theplacementsetting indicates the Window will be filling a portion of the screen or a panel.- Overrides:
getShowShadowin classCanvas- Returns:
- Current showShadow value. Default value is null
- See Also:
-
setShowStatusBar
If true, show a statusBar for this Window, including resizer. Note that the status bar will only be displayed if the footer is showing for the window (showFooter).- Parameters:
showStatusBar- New showStatusBar value. Default value is true- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getShowStatusBar
If true, show a statusBar for this Window, including resizer. Note that the status bar will only be displayed if the footer is showing for the window (showFooter).- Returns:
- Current showStatusBar value. Default value is true
- See Also:
-
setShowTitle
Show a title (typically just text) on the header for this window.
If this method is called after the component has been drawn/initialized: Updates whether thetitleis shown in theheader. No impact unless the header is being shown. The header will be redrawn if necessary.- Parameters:
showTitle- new showTitle. Default value is true- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getShowTitle
Show a title (typically just text) on the header for this window.- Returns:
- Current showTitle value. Default value is true
- See Also:
-
setSrc
A URL to load as content for the Window's body. If specified, this attribute will take precedence over the items attribute.Note that setting window.src is essentially a shortcut for setting
itemsto a single HTMLflow with a specifiedcontentsURL.
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.- Parameters:
src- URL of new contents to be displayed in the window body. Default value is null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getSrc
A URL to load as content for the Window's body. If specified, this attribute will take precedence over the items attribute.Note that setting window.src is essentially a shortcut for setting
itemsto a single HTMLflow with a specifiedcontentsURL.- Returns:
- Current src value. Default value is null
- See Also:
-
setStatus
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.- Parameters:
status- new text for the status bar. Default value is null- Returns:
Windowinstance, for chaining setter calls- See Also:
-
getStatus
Text to show in the status bar of the window (if one is visible)- Returns:
- Current status value. Default value is null
- See Also:
-
getStatusBar
Simple Canvas-based status bar, shown in the footer.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.- Returns:
- Current statusBar value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setTitle
Title for this Window, shown ifshowTitleis true in theheader(if drawn).
If this method is called after the component has been drawn/initialized: Sets thetitlethat appears in the windowheader. The header will be redrawn if necessary. -
getTitle
-
setUseBackMask
By default Windows show abackMaskin Internet Explorer versions predating Internet Explorer 9. This is a workaround for a native browser issue whereby certain DOM elements such asIFRAMEs (whether rendered within Smart GWT components via features such ascontentsURLor 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
opacitycan 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
- Overrides:
setUseBackMaskin classCanvas- Parameters:
useBackMask- New useBackMask value. Default value is varies- Returns:
Windowinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getUseBackMask
By default Windows show abackMaskin Internet Explorer versions predating Internet Explorer 9. This is a workaround for a native browser issue whereby certain DOM elements such asIFRAMEs (whether rendered within Smart GWT components via features such ascontentsURLor 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
opacitycan 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.- Overrides:
getUseBackMaskin classCanvas- Returns:
- Current useBackMask value. Default value is varies
-
addMember
Same asLayout.addMember(). Note that in order to add items tobody, you useaddItem()rather thanaddMember. Adding a member to a Window adds the member as a sibling to the header, body and other built-in Window subcomponents. -
addMember
Same asLayout.addMember(). Note that in order to add items tobody, you useaddItem()rather thanaddMember. Adding a member to a Window adds the member as a sibling to the header, body and other built-in Window subcomponents.- Parameters:
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 position- See Also:
-
Layout.addMembers(java.lang.Object[], int)
-
centerInPage
public void centerInPage()Centers the Window in the page. This is called automatically in window.show() if Window.autoCenter is true. Note - if the Window is a child of another widget, we center in the parent widget rather than centering in the page. -
close
public void close()Close this window. This method is fired by the defaultWindow.closeClick()implementation. Default implementation will hide the window. -
addCloseClickHandler
Add a closeClick 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 callclose()to trigger the default behavior.- Specified by:
addCloseClickHandlerin interfaceHasCloseClickHandlers- Parameters:
handler- the closeClick handler- Returns:
HandlerRegistrationused to remove this handler
-
flash
public 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.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.
-
maximize
public void maximize()Maximize the window. Fired when the user clicks the maximize button ifthis.showMaximizeButtonis true.
Default implementation moves the window to0, 0and resizes the window to"100%"on both axes, so it will fill the browser window (or the parent of the Window instance, if appropriate).
IfanimateMinimizeis true, the maximize will be animated. A restore button will be displayed in place of the maximize button when the window is maximized. -
minimize
public void minimize()Minimize the window. Fired when the user clicks the minimize button ifthis.showMinimizeButtonis true.
Default implementation shrinks the window to just the height of the header bar, hiding the body. IfanimateMinimizeis true, the resize will be animated. A restore button will be displayed in place of the minimize button when the window is minimized. -
addMaximizeClickHandler
Add a maximizeClick handler.Notification method fired when the user clicks the 'maximize' button.
- Specified by:
addMaximizeClickHandlerin interfaceHasMaximizeClickHandlers- Parameters:
handler- the maximizeClick handler- Returns:
HandlerRegistrationused to remove this handler
-
addMinimizeClickHandler
Add a minimizeClick handler.Notification method fired when the user clicks the 'minimize' button.
- Specified by:
addMinimizeClickHandlerin interfaceHasMinimizeClickHandlers- Parameters:
handler- the minimizeClick handler- Returns:
HandlerRegistrationused to remove this handler
-
addRestoreClickHandler
Add a restoreClick handler.Notification method fired when the user clicks the 'restore' button.
- Specified by:
addRestoreClickHandlerin interfaceHasRestoreClickHandlers- Parameters:
handler- the restoreClick handler- Returns:
HandlerRegistrationused to remove this handler
-
restore
public void restore()Restores the window to its specified height and width after a call tominimize()ormaximize(). Called from a click on the restore button shown in place of the minimize or maximize button when the window is minimized or maximized.
Resizing will occur as an animation ifanimateMinimizeis true. -
shouldDismissOnEscape
Should this window be dismissed (same effect as pressing the "Cancel" button) when the user presses the "Escape" key?
Default behavior: ifdismissOnEscapeis set, just return it. Otherwise return true if this window is showing a "close" control in the header (seeheaderControls).- Returns:
- true if the window should be dismissed when the user hits escape
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
windowProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
addItem
Adds a widget to the window.- Parameters:
widget- the widget to be added
-
addItem
Adds a widget to the window.- Parameters:
component- the widget to be added
-
removeItem
Removes a widget from the window.- Parameters:
component- the widget to be removed
-
setKeepInParentRect
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.- Overrides:
setKeepInParentRectin classCanvas- Parameters:
keepInParentRect- true to keepInParentRect- Returns:
Windowinstance, for chaining setter calls- See Also:
-
setHeaderIconProperties
-
setHeaderIcon
Sets the Window header icon.- Parameters:
imgSrc- the icon image source
-
setHeaderIcon
Sets the Window header icon.- Parameters:
imgSrc- the icon image sourcewidth- the icon width. default 16height- the icon height. default 14
-
setHeaderControls
Array of members to show in the Window header.The default value of headerControls is an Array of HeaderControlslisting the standard header controls in their default order:
headerControls : [HeaderControls.HEADER_ICON, HeaderControls.HEADER_LABEL, HeaderControls.MINIMIZE_BUTTON, HeaderControls.MAXIMIZE_BUTTON, HeaderControls.CLOSE_BUTTON]
You can set headerControls to change the order of standard controls in the header. You can also omit standard controls this way, although it more efficient to use the related "show" property if available (eg Window.showMinimizeButton).
By embedding a Canvas directly in this list you can add arbitrary additional controls to the header, for example, an additional button (eg return to dock) or a DynamicForm with various kinds of input controls. Tip: custom controls need to set layoutAlign:"center" to appear vertically centered.- Parameters:
headerControls- an array containing either HeaderControl enums values or Canvas instances- See Also:
-
setKeepInParentRect
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.
Note: keepInParentRect affects only user drag interactions, not programmatic moves.- Overrides:
setKeepInParentRectin classCanvas- Parameters:
rectangle- the rectangle bounds- Returns:
Windowinstance, for chaining setter calls
-
getItems
The contents of the Window body. Can be specified three different ways:- an Array of Canvases that will become the children of the Window's body when it is initialized; the canvases in this array should be created, but not drawn (autodraw: false).
- a single canvas that will become a child of the Window body.
- a string that will be set as the body's contents.
- Returns:
- items
-
preloadImages
public static void preloadImages()Preload primary window skin images -
setContentLayout
Deprecated.use the othersetContentLayout()The layout policy that should be used for widgets within the Window body.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. SeebodyConstructorfor details.Note : This is an advanced setting
- Parameters:
contentLayout- Default value is "vertical"- See Also:
-
revealChild
Reveals the child Canvas passed in by showing it if it is currently hidden. Note, in the case of Window, "child Canvas" means widgets in the Window's "items" collection as well as real children (the children of a Window - ie, the elements of its "children" array - are its component parts like header and body) NOTE: This is an override point.- Overrides:
revealChildin classLayout- Parameters:
childID- the global ID of the child Canvas to reveal
-
revealChild
Reveals the child Canvas passed in by showing it if it is currently hidden. Note, in the case of Window, "child Canvas" means widgets in the Window's "items" collection as well as real children (the children of a Window - ie, the elements of its "children" array - are its component parts like header and body) NOTE: This is an override point.- Overrides:
revealChildin classLayout- Parameters:
child- the child Canvas to reveal
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classVLayout
-
setContentLayout()