Package org.adempiere.webui

Interface ISupportMask

All Known Implementing Classes:

AboutWindow, AbstractADTabbox, AbstractADWindowContent, AbstractDesktop, AbstractProcessDialog, AbstractUIPart, AbstractWQuickEntry, AddAuthorizationForm, ADForm, ADWindow, ADWindowContent, BroadcastMessageWindow, BusyDialog, CalendarWindow, ChangePasswordPanel, CompareCtxHelpSuggestion, CompareFieldSuggestion, CompositeADTabbox, CustomForm, CustomizeGridViewDialog, DashboardPanel, DefaultDesktop, DesktopTabpanel, DetailPane.Tabpanel, DPActivities, DPCalendar, DPDocumentStatus, DPFavourites, DPGoogleCalendar, DPMenuTree, DPPerformance, DPRecentItems, DPRunningJobs, DPViews, EventWindow, FavouriteFolderDialog, FedexLabelWindow, FeedbackRequestWindow, FindWindow, FolderBrowser, FooterPanel, FWindow, HelpWindow, InfoAssetPanel, InfoAssetWindow, InfoAssignmentPanel, InfoAssignmentWindow, InfoBPartnerPanel, InfoBPartnerWindow, InfoCashLinePanel, InfoGeneralPanel, InfoInOutPanel, InfoInOutWindow, InfoInvoicePanel, InfoInvoiceWindow, InfoOrderPanel, InfoOrderWindow, InfoPanel, InfoPAttributeInstancePanel, InfoPAttributeInstanceWindow, InfoPAttributePanel, InfoPAttributeWindow, InfoPaymentPanel, InfoPaymentWindow, InfoProductPanel, InfoProductWindow, InfoSchedule, InfoWindow, InvoiceHistory, LinkWindow, LoginOpenSequenceDialog, LoginPanel, LoginWindow, Messagebox, MFARegisterForm, MultiFileDownloadDialog, MultiTabPart, ProcessDialog, ProcessInfoDialog, ProcessModalDialog, RequestWindow, ResetPasswordPanel, RolePanel, ShowMaskWrapper, SimplePDFViewer, TabbedDesktop, Tabpanel, UPSHtmlLabelWindow, ValidateMFAPanel, ValuePreference, WAccountDialog, WAcctViewer, WAssignmentDialog, WAttachment, WAttributeGrid, WBOMDrop, WBPartner, WChat, WCreateFromForm, WCreateFromWindow, WCtxHelpSuggestion, WDocActionPanel, WEMailDialog, WFEditor, WFieldRecordInfo, WFieldSuggestion, WFileImport, WGadgets, WGenForm, WImageDialog, Window, WindowContainer, WLocationDialog, WLocatorDialog, WLogin, WMediaDialog, WMediaOptions, WMergeUI, WOnlyCurrentDays, WPAttributeDialog, WPAttributeInstance, WPaymentFormWindow, WPerformanceDetail, WPluginManager, WPostIt, WPreference, WProcessParameterForm, WQuickEntry, WQuickForm, WRC1DisplayFieldsPanel, WRC2FieldOrderPanel, WRC3SortCriteriaPanel, WRC4GroupingCriteriaPanel, WRC5SummaryFieldsPanel, WRCTabPanel, WRecordAccessDialog, WRecordInfo, WRecordTimeLine, WReportExportDialog, WReportUploadDialog, WSchedule, WSQLProcess, WTabEditorForm, WTask, WTextEditorDialog, WViewPI, WWFActivity, ZkJRViewer, ZkReportViewer

public interface ISupportMask

interface for any component want support show other window over it with a mask. object manage component as AbstractUIPart also implement this interface consider below case. 1. show a dialog => show mask 2. process a event 2.1. show other dialog => show mask 2.1. hidden dialog in step 1 => hidden mask 3. result dialog show without mask to void this case process as below in showMask() set a flag to request scope by call: Component.setAttribute(String, Object, int) key is READY_SHOW_MASK_FLAG value is Integer(1) and scope is Component.REQUEST_SCOPE in hideMask() check flag before hidden mask. when has flag, don't hidden mask component want support show mask can implement this interface or use support class ShowMaskWrapper as composite object

Field Summary

Fields

Modifier and Type	Field	Description
static String	READY_SHOW_MASK_FLAG

Method Summary

Modifier and Type	Method	Description
org.zkoss.zk.ui.Component	getMaskComponent()	return self if is a component or return component it manage if AbstractUIPart is implement this interface, return UIPart.getComponent()
Mask	getMaskObj()	return cache object or make new object and return
void	hideMask()	Hide mask. at code call showMask will hand reference to this object. and call this function in handle close event of window when override, remember check exists of key READY_SHOW_MASK_FLAG at scope Component.REQUEST_SCOPE in attribute by call LayoutUtils if exists flag, don't hidden mask
void	showMask()	show mask over this component when override, remember call Component.setAttribute(String, Object, int) with key is READY_SHOW_MASK_FLAG value is Integer(1) and scope is Component.REQUEST_SCOPE by call LayoutUtils

Field Detail

READY_SHOW_MASK_FLAG

static final String READY_SHOW_MASK_FLAG

See Also:

Constant Field Values

Method Detail

showMask

void showMask()

show mask over this component when override, remember call Component.setAttribute(String, Object, int) with key is READY_SHOW_MASK_FLAG value is Integer(1) and scope is Component.REQUEST_SCOPE by call LayoutUtils

hideMask

void hideMask()

Hide mask. at code call showMask will hand reference to this object. and call this function in handle close event of window when override, remember check exists of key READY_SHOW_MASK_FLAG at scope Component.REQUEST_SCOPE in attribute by call LayoutUtils if exists flag, don't hidden mask

getMaskObj

Mask getMaskObj()

return cache object or make new object and return

Returns:

getMaskComponent

org.zkoss.zk.ui.Component getMaskComponent()

return self if is a component or return component it manage if AbstractUIPart is implement this interface, return UIPart.getComponent()

Returns: