Package org.adempiere.webui.part

Class AbstractUIPart

java.lang.Object

org.adempiere.webui.part.AbstractUIPart

All Implemented Interfaces:

ISupportMask, UIPart

Direct Known Subclasses:

AbstractADTabbox, AbstractADWindowContent, AbstractDesktop, ADWindow, MultiTabPart, WindowContainer, WLogin

public abstract class AbstractUIPart
extends Object
implements UIPart, ISupportMask

Author:

Low Heng Sin

Field Summary

Fields

Modifier and Type	Field	Description
protected org.zkoss.zk.ui.Page	page
protected ShowMaskWrapper	showMaskWrapper

Fields inherited from interface org.adempiere.webui.ISupportMask

READY_SHOW_MASK_FLAG

Constructor Summary

Constructors

Constructor	Description
AbstractUIPart()

Method Summary

Modifier and Type	Method	Description
org.zkoss.zk.ui.Component	createPart(Object parent)
protected abstract org.zkoss.zk.ui.Component	doCreatePart(org.zkoss.zk.ui.Component parent)
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 ISupportMask.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 ISupportMask.READY_SHOW_MASK_FLAG value is Integer(1) and scope is Component.REQUEST_SCOPE by call LayoutUtils

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.adempiere.webui.part.UIPart

getComponent

Field Detail

page

protected org.zkoss.zk.ui.Page page

showMaskWrapper

protected ShowMaskWrapper showMaskWrapper

Constructor Detail

AbstractUIPart

public AbstractUIPart()

Method Detail

createPart

public org.zkoss.zk.ui.Component createPart(Object parent)

Specified by:

createPart in interface UIPart

doCreatePart

protected abstract org.zkoss.zk.ui.Component doCreatePart(org.zkoss.zk.ui.Component parent)

showMask

public void showMask()

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

Specified by:

showMask in interface ISupportMask

hideMask

public 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 ISupportMask.READY_SHOW_MASK_FLAG at scope Component.REQUEST_SCOPE in attribute by call LayoutUtils if exists flag, don't hidden mask

Specified by:

hideMask in interface ISupportMask

getMaskObj

public Mask getMaskObj()

return cache object or make new object and return

Specified by:

getMaskObj in interface ISupportMask

Returns:

getMaskComponent

public 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() knowIssue: because IDesktop.getComponent() return BorderLayout , don't append window to child list of it, in this case we must get parent of BorderLayout

Specified by:

getMaskComponent in interface ISupportMask

Returns: