Java Doc for Window.java in  » Ajax » zk » org » zkoss » zul » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Unlike other elements, each Window is an independent ID space (by implementing IdSpace ). It means a window and all its descendants forms a ID space and the ID of each of them is unique in this space. You could retrieve any of them in this space by calling Window.getFellow .

If a window X is a descendant of another window Y, X's descendants are not visible in Y's space. To retrieve a descendant, say Z, of X, you have to invoke Y.getFellow('X').getFellow('Z').

Events:
onMove, onOpen, onClose, onOK, onCacnel and onCtrlKey.
Note: to have better performance, onOpen is sent only if a non-deferrable event listener is registered (see org.zkoss.zk.ui.event.Deferrable ).

onClose is sent when the close button is pressed (if Window.isClosable is true). The window has to detach or hide the window. By default, Window.onClose detaches the window. To prevent it from detached, you have to call org.zkoss.zk.ui.event.Event.stopPropagation to prevent Window.onClose is called.

On the other hand, onOpen is sent when a popup window (i.e., Window.getMode is popup) is closed due to user's activity (such as press ESC). This event is only a notification. In other words, the popup is hidden before the event is sent to the server. The application cannot prevent the window from being hidden.
author:
   tomyeh

Default: null which depends on Window.getMode : If overlapped or popup, Window.setLeft and Window.setTop are assumed.

The string could be a combination of the following:

^k

A control key, i.e., Ctrl+k, where k could be a~z, 0~9, #n

@k

A alt key, i.e., Alt+k, where k could be a~z, 0~9, #n

$k

A shift key, i.e., Shift+k, where k could be #n

#home

Home

#end

End

#ins

Insert

#del

Delete

#left

Left arrow

#right

Right arrow

#up

Up arrow

#down

Down arrow

#pgup

PageUp

#pgdn

PageDn

#f1 #f2 ...

Default: null.

Notice: Events.ON_MODAL is posted if you specify "modal" to this method and in a thread other than an event listener ( Events.inEventListener ). In other words, if this method is called with modal and not in any event listener, the mode won't be changed immediately (until Events.ON_MODAL is processed later).
Parameters:
  name - the mode which could be one of"embedded", "overlapped", "popup", "modal", "highlighted".Note: it cannot be "modal".

Note: If a modal dialog becomes invisible, the modal state will be ended automatically.

Notice: Events.ON_MODAL is posted if you specify "modal" to this method and in a thread other than an event listener ( Events.inEventListener ). In other words, if this method is called with modal and not in any event listener, the mode won't be changed immediately (until Events.ON_MODAL is processed later).
exception:
  SuspendNotAllowedException - if there are too many suspendedprocessing thread than the deployer allows.By default, there is no limit of # of suspended threads.
exception:
  InterruptedException - thrown if the desktop orthe Web application is being destroyed, ororg.zkoss.zk.ui.sys.DesktopCtrl.ceaseSuspendedThread.To tell the difference, check the getMessage method of InterruptedException.

Default: "none".

If Window.setContentSclass was called with a non-empty value, say, "mycnt", then

1. Case 1: If Window.getBorder is "normal", "mycnt" is returned.
2. Case 2: Otherwise, "mycnt-border" is returned where border is the value returned by Window.getBorder .

If Window.setContentSclass was not called, or called with null, then the content style class is decided by Window.getSclass as follows:

1. Case 1: If Window.getBorder is "normal", "wc-sclass" is returned, where sclass is the value returned by Window.getSclass .
2. Otherwise, "wc-mode-border", where border is the value returned by Window.getBorder .

See Also:   Window.setContentSclass

Default: null.

Default: null which depends on Window.getMode : If overlapped or popup, Window.setLeft and Window.setTop are assumed. If modal or highlighted, it is centered.

If a window has a caption whose label ( Caption.getLabel ) is not empty, then this attribute is ignored.

Default: empty.

It returns "wt-sclass" is returned, where sclass is the value returned by Window.getSclass .

Default: detach itself.

Default: false.

You can intercept the default behavior by either overriding Window.onClose , or listening the onClose event.

Note: the close button won't be displayed if no title or caption at all.

Default: null.

The string could be a combination of the following:

^k

A control key, i.e., Ctrl+k, where k could be a~z, 0~9, #n

@k

A alt key, i.e., Alt+k, where k could be a~z, 0~9, #n

$k

A shift key, i.e., Shift+k, where k could be #n

#home

Home

#end

End

#ins

Insert

#del

Delete

#left

Left arrow

#right

Right arrow

#up

Up arrow

#down

Down arrow

#pgup

PageUp

#pgdn

PageDn

#f1 #f2 ... #f12

Function keys representing F1, F2, ... F12

For example,

^a^d@c#f10#left#right

It means you want to intercept Ctrl+A, Ctrl+D, Alt+C, F10, Left and Right.

^#left

It means Ctrl+Left.

^#f1

It means Ctrl+F1.

@#f3

It means Alt+F3.

Note: it doesn't support Ctrl+Alt, Shift+Ctrl, Shift+Alt or Shift+Ctrl+Alt.

Default: null. In other words, if the property is null, it will refer to the configuration of zk.xml to find the preference with "org.zkoss.zul.Window.defaultActionOnShow", if any. For example,

<preference>
 <name>org.zkoss.zul.Window.defaultActionOnShow</name>
 <value>moveDown</value>
 </preference>

In JavaScript, the property will match the same function name with the prefix "anima.". For example, if the property is "moveDown", the function name should be "anima.moveDown" accordingly.

Node: The method is available in modal mode only. And if the onshow command of client-side action has been assigned on the component, its priority is higher than this method.
For example,

action="onshow:anima.appear(#{self});"

Notice: Events.ON_MODAL is posted if you specify "modal" to this method and in a thread other than an event listener ( Events.inEventListener ). In other words, if this method is called with modal and not in any event listener, the mode won't be changed immediately (until Events.ON_MODAL is processed later).
Parameters:
  name - the mode which could be one of"embedded", "overlapped", "popup", "modal", "highlighted".Note: it cannot be "modal". Use Window.doModal instead.
exception:
  InterruptedException - thrown if "modal" is specified,and one of the following conditions occurs:1) the desktop or the Web application is being destroyed, or2) org.zkoss.zk.ui.sys.DesktopCtrl.ceaseSuspendedThread.To tell the difference, check the getMessage method of InterruptedException.

center

Position the window at the center. Window.setTop and Window.setLeftare both ignored.

left

Position the window at the left edge. Window.setLeft is ignored.

right

Position the window at the right edge. Window.setLeft is ignored.

top

Position the window at the top edge. Window.setTop is ignored.

bottom

Position the window at the bottom edge. Window.setTop is ignored.

parent

Position the window relative to its parent.That is, the left and top (Window.getTop and Window.getLeft)is an offset to his parent's let-top corner. (since 3.0.2)

For example, "left,center" means to position it at the center ofthe left edge.

Default: false.

Note: If a modal dialog becomes invisible, the modal state will be ended automatically. In other words, the mode ( Window.getMode ) will become Window.OVERLAPPED and the suspending thread is resumed.