Package org.adempiere.webui

Class ShowMaskWrapper

java.lang.Object

org.adempiere.webui.ShowMaskWrapper

All Implemented Interfaces:

ISupportMask

public class ShowMaskWrapper
extends Object
implements ISupportMask

Helper class for any component want implement ISupportMask Just make a instance of this class and let it do everything

Author:

hieplq

Field Summary

Fields inherited from interface org.adempiere.webui.ISupportMask

READY_SHOW_MASK_FLAG

Constructor Summary

Constructors

Constructor	Description
ShowMaskWrapper(UIPart uiPart)	this mask will show over component from UIPart.getComponent()
ShowMaskWrapper(org.zkoss.zk.ui.Component comp)	comp is component want implement this interface

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
static boolean	hasFlagShowMask(org.zkoss.zk.ui.Component comp)	check flag ISupportMask.READY_SHOW_MASK_FLAG ready in scope Component.REQUEST_SCOPE
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
static void	setFlagShowMask(org.zkoss.zk.ui.Component comp)	Set flag ISupportMask.READY_SHOW_MASK_FLAG to Component.REQUEST_SCOPE
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

Constructor Detail

ShowMaskWrapper

public ShowMaskWrapper(org.zkoss.zk.ui.Component comp)

comp is component want implement this interface

Parameters:

comp -

ShowMaskWrapper

public ShowMaskWrapper(UIPart uiPart)

this mask will show over component from UIPart.getComponent()

Parameters:

uiPart -

Method Detail

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 return new Mask when mask is not yet create

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()

Specified by:

getMaskComponent in interface ISupportMask

Returns:

setFlagShowMask

public static void setFlagShowMask(org.zkoss.zk.ui.Component comp)

Set flag ISupportMask.READY_SHOW_MASK_FLAG to Component.REQUEST_SCOPE

Parameters:

comp -

hasFlagShowMask

public static boolean hasFlagShowMask(org.zkoss.zk.ui.Component comp)

check flag ISupportMask.READY_SHOW_MASK_FLAG ready in scope Component.REQUEST_SCOPE

Parameters:

comp -

Returns: