Package org.adempiere.webui.component
Class Window
java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Window
org.adempiere.webui.component.Window
- All Implemented Interfaces:
Serializable
,Cloneable
,ISupportMask
,org.zkoss.zk.ui.Component
,org.zkoss.zk.ui.ext.Scope
,org.zkoss.zk.ui.IdSpace
,org.zkoss.zk.ui.sys.ComponentCtrl
,org.zkoss.zul.ext.Framable
- Direct Known Subclasses:
AboutWindow
,AbstractProcessDialog
,AbstractWQuickEntry
,ADForm
,BroadcastMessageWindow
,BusyDialog
,CalendarWindow
,ChangePasswordPanel
,CustomizeGridViewDialog
,DashboardPanel
,ErrorWindow
,EventWindow
,FavouriteFolderDialog
,FedexLabelWindow
,FeedbackRequestWindow
,FindWindow
,FolderBrowser
,FooterPanel
,FWindow
,HelpWindow
,InfoPanel
,InfoPAttributeInstancePanel
,InfoPAttributePanel
,InfoSchedule
,InvoiceHistory
,LinkWindow
,LoginOpenSequenceDialog
,LoginPanel
,LoginWindow
,Messagebox
,MultiFileDownloadDialog
,ProcessInfoDialog
,RequestWindow
,ResetPasswordPanel
,RolePanel
,SimplePDFViewer
,UPSHtmlLabelWindow
,ValidateMFAPanel
,ValuePreference
,WAccountDialog
,WAcctViewer
,WAssignmentDialog
,WAttachment
,WBPartner
,WChat
,WCreateFromWindow
,WCtxHelpSuggestion
,WDocActionPanel
,WDrillReport
,WEMailDialog
,WFieldRecordInfo
,WFieldSuggestion
,WGadgets
,WImageDialog
,WLocationDialog
,WLocatorDialog
,WMediaDialog
,WMediaOptions
,WOnlyCurrentDays
,WPAttributeDialog
,WPAttributeInstance
,WPaymentFormWindow
,WPerformanceDetail
,WPostIt
,WQuickForm
,WRecordAccessDialog
,WRecordIDDialog
,WRecordInfo
,WRecordTimeLine
,WReportExportDialog
,WReportUploadDialog
,WSchedule
,WTask
,WTextEditorDialog
,ZkJRViewer
,ZkReportViewer
Extend
Window
- Version:
- $Revision: 0.10 $
- Author:
- Ashley G Ramdass
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.zkoss.zul.Window
org.zkoss.zul.Window.Mode
Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.AbstractComponent.Children
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Append to the end of tabs of desktopstatic final String
Insert next to the active tab of desktopstatic final String
Window attribute to store desktop tab insert position for embedded modestatic final String
Show as desktop tabstatic final String
Show as overlapped window with background maskstatic final String
Window attribute to store display mode (modal, popup, etc)static final String
Show as modal windowstatic final String
Show as floating/overlapped windowstatic final String
Show as popup windowstatic final String
Replace current desktop tab contentprotected ShowMaskWrapper
Fields inherited from class org.zkoss.zul.Window
EMBEDDED, HIGHLIGHTED, MODAL, OVERLAPPED, POPUP
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
_zclass
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
Fields inherited from interface org.adempiere.webui.ISupportMask
READY_SHOW_MASK_FLAG
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
dispose()
alias for detach, to ease porting of swing formorg.zkoss.zk.ui.Component
Return self if is a component or return component it manage.
AbstractUIPart
subclasses that implement this interface should returnUIPart.getComponent()
.Return cache Mask or create new Mask and return.org.zkoss.zul.Window.Mode
Get the window mode attributevoid
hideMask()
Hide mask.boolean
void
onPageDetached
(org.zkoss.zk.ui.Page page) void
setFireWindowCloseEventOnDetach
(boolean fireWindowCloseEventOnDetach) void
showMask()
Show mask over this component.
When override, remember to callComponent.setAttribute(String, Object, int)
with nameISupportMask.READY_SHOW_MASK_FLAG
, value Integer(1) and scopeComponent.REQUEST_SCOPE
.
Call byLayoutUtils
.Methods inherited from class org.zkoss.zul.Window
beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getContentSclass, getContentStyle, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, getModeType, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onClose, onModal, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDefaultActionOnShow, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setMode, setPosition, setShadow, setSizable, setTitle, setTopmost, setVisible
Methods inherited from class org.zkoss.zul.impl.XulElement
getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
invalidatePartial
Methods inherited from interface org.zkoss.zk.ui.IdSpace
getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
-
Field Details
-
showMaskWrapper
-
MODE_MODAL
Show as modal window- See Also:
-
MODE_POPUP
Show as popup window- See Also:
-
MODE_OVERLAPPED
Show as floating/overlapped window- See Also:
-
MODE_EMBEDDED
Show as desktop tab- See Also:
-
MODE_HIGHLIGHTED
Show as overlapped window with background mask- See Also:
-
MODE_KEY
Window attribute to store display mode (modal, popup, etc)- See Also:
-
INSERT_POSITION_KEY
Window attribute to store desktop tab insert position for embedded mode- See Also:
-
INSERT_END
Append to the end of tabs of desktop- See Also:
-
INSERT_NEXT
Insert next to the active tab of desktop- See Also:
-
REPLACE
Replace current desktop tab content- See Also:
-
-
Constructor Details
-
Window
public Window()Default constructor
-
-
Method Details
-
dispose
public void dispose()alias for detach, to ease porting of swing form -
onPageDetached
public void onPageDetached(org.zkoss.zk.ui.Page page) - Specified by:
onPageDetached
in interfaceorg.zkoss.zk.ui.sys.ComponentCtrl
- Overrides:
onPageDetached
in classorg.zkoss.zul.Window
-
getModeAttribute
public org.zkoss.zul.Window.Mode getModeAttribute()Get the window mode attribute- Returns:
- Window.Mode
-
showMask
public void showMask()Show mask over this component.
When override, remember to callComponent.setAttribute(String, Object, int)
with nameISupportMask.READY_SHOW_MASK_FLAG
, value Integer(1) and scopeComponent.REQUEST_SCOPE
.
Call byLayoutUtils
.- Specified by:
showMask
in interfaceISupportMask
-
hideMask
public void hideMask()Hide mask. With ISupportMask return from showMask, call this function in handle close event of window.
When override, remember check exists of keyISupportMask.READY_SHOW_MASK_FLAG
at scopeComponent.REQUEST_SCOPE
in attribute. If flag exists, don't hide mask.
Call byLayoutUtils
.- Specified by:
hideMask
in interfaceISupportMask
-
getMaskObj
Return cache Mask or create new Mask and return.- Specified by:
getMaskObj
in interfaceISupportMask
- Returns:
Mask
-
getMaskComponent
public org.zkoss.zk.ui.Component getMaskComponent()Return self if is a component or return component it manage.
AbstractUIPart
subclasses that implement this interface should returnUIPart.getComponent()
.- Specified by:
getMaskComponent
in interfaceISupportMask
- Returns:
Component
-
isFireWindowCloseEventOnDetach
public boolean isFireWindowCloseEventOnDetach()- Returns:
- true if
DialogEvents.ON_WINDOW_CLOSE
event is fire when window is detach from page
-
setFireWindowCloseEventOnDetach
public void setFireWindowCloseEventOnDetach(boolean fireWindowCloseEventOnDetach) - Parameters:
fireWindowCloseEventOnDetach
- true to fireDialogEvents.ON_WINDOW_CLOSE
event when window is detach from page (default is true)
-