zk.eff
Class FullMask

java.lang.Object
  zk.Object
      zk.eff.FullMask

public class FullMask
extends Object

A mask covers the browser window fully.

Field Summary

Fields inherited from class zk.Object

$class, $oid

Method Summary

void	$init(Map opts) The constructor of the full mask object.
void	destroy() Removes the full mask.
void	hide() Hide the full mask.
void	sync() Synchronizes the visual states of the full 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 of the full mask object.

To remove the full mask, invoke destroy().

Parameters:

opts - [optional] the options. Allowed options:

• DOMElement mask: the mask element if the mask was created somewhere else. Default: create a new one.
• DOMElement anchor: whether to insert the mask before.
• String id: the mask ID. Default: z_mask.
• int zIndex: z-index to assign. Default: defined in the CSS called z-modal-mask.
• boolean visible: whether it is visible

destroy

public void destroy()

Removes the full mask. You can not access this object any more.

hide

public void hide()

Hide the full 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 full mask with the specified element and the browser window. The visual states include the visibility and Z Index.