zk.eff

Class Mask

java.lang.Object

zk.Object

zk.eff.Mask

public class Mask
extends Object

Applies the mask over the specified element to indicate it is busy.

Field Summary

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
void	$init(Map opts) The constructor.
void	destroy() Removes the mask.
void	hide() Hide the mask.
void	sync() Synchronizes the visual states of the mask with the specified element and the browser window.

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

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

Method Detail

$init

public void $init(Map opts)

The constructor.

To remove the mask, invoke destroy().

Parameters:

opts - [optional] the options:

• String id - the id of the applied mask, if any.
• String/DOMElement anchor - the anchor of the applied mask, it can be an instance of String or DOMElement.
• String msg - the message of the indicator, if any. null, Loading... is assumed.

hide

public void hide()

Hide the mask. Application developers rarely need to invoke this method. Rather, use sync() to synchronized the visual states.

sync

public void sync()

Synchronizes the visual states of the mask with the specified element and the browser window. The visual states include the visibility and Z Index.

destroy

public void destroy()

Removes the mask.