From Documentation

(Difference between revisions)
Jump to: navigation, search
(Event Handling)
 
(17 intermediate revisions not shown)
Line 1: Line 1:
-
{{ZKDevelopersGuidePageHeader}}
+
{{ZKDevelopersReferencePageHeader}}
__TOC__
__TOC__
= Overview =
= Overview =
-
  [since 5.0.4][ZK EE]
+
  [since 5.0.4][ZK EE] [since 6.0.0][ZK CE]
-
It is common that the states of some components are not required to maintain at the server. A typical example is that an application might use some components, such as <tt>hbox</tt>, for layout and won't access it again after rendered. To minimize the memory footprint, ZK supports a special property called <tt>stubonly</tt> (<javadoc method="setStubonly(java.lang.String)">org.zkoss.zk.ui.Component</javadoc>). Once specified with <tt>true</tt>, its states won't be maintained at the server (and all states are maintained at the client). For example,
+
It is common that the states of some components are not required to maintain on the server. A typical example is that an application might use some components, such as <tt>hbox</tt>, for layout and won't access it again after rendered. To minimize the memory footprint, ZK supports a special property called <tt>stubonly</tt> (<javadoc method="setStubonly(java.lang.String)">org.zkoss.zk.ui.Component</javadoc>). Once specified with <tt>true</tt>, its states won't be maintained on the server (and all states are maintained at the client). For example,
-
<source lang="xml">
+
<syntax lang="xml">
<hbox stubonly="true">
<hbox stubonly="true">
</hbox>
</hbox>
-
</source>
+
</syntax>
-
* Notice this feature is available since ZK 5.0.4 EE.
+
* Notice this feature is available since ZK 5.0.4 EE, and available in CE since ZK 6.0.0.
== Values of Stubonly: true, false and inherit ==
== Values of Stubonly: true, false and inherit ==
Line 20: Line 20:
<tt>listitem</tt> and labels are all stub-only.
<tt>listitem</tt> and labels are all stub-only.
-
<source lang="xml">
+
<syntax lang="xml">
<hbox stubonly="true">
<hbox stubonly="true">
   a stub-only label
   a stub-only label
Line 29: Line 29:
   </listbox>
   </listbox>
</hbox>
</hbox>
-
</source>
+
</syntax>
= Limitation of Stub Components =
= Limitation of Stub Components =
-
When a component is stub only, it will be replaced with a special component called a stub component (<javadoc>org.zkoss.zk.ui.StubComponent</javadoc>) after rendered. In additions, adjacent stub components might be merged to minimize the memory further. Thus, the application shall not access the component again at the server, if it is specified as stub only.
+
When a component is stub only, it will be replaced with a special component called a stub component (<javadoc>org.zkoss.zk.ui.StubComponent</javadoc>) after rendered. In addition, the adjacent stub components might be merged to minimize the memory further. Thus, the application should not access the component again on the server, if it is specified as stub only.
== Invalidation ==
== Invalidation ==
-
While a stub component cannot be invalidated directly, it is safe to invalidate its parent. ZK will rerender all non-stub components and retain the states of stub components at the client. For example, in the following snippet, it is safe to click the <tt>invalidate</tt> button. For end user's point of view, there is no difference whether <tt>stubonly</tt> is specified or not.
+
While a stub component cannot be invalidated directly, it is safe to invalidate its parent. ZK will rerender all non-stub components and retain the states of stub components at the client. For example, in the following snippet, it is safe to click the <tt>invalidate</tt> button. From an end user's point of view, there is no difference whether <tt>stubonly</tt> is specified or not.
-
<source lang="xml">
+
<syntax lang="xml">
  <window>
  <window>
   <button label="self.parent.invalidate()"/>
   <button label="self.parent.invalidate()"/>
Line 46: Line 46:
   </vbox>
   </vbox>
</window>
</window>
 +
</syntax>
 +
 +
It is a special case that [[ZK_Component_Reference/Supplementary/Paging|paging]] can not apply <tt>stubonly</tt> at the same time. For example,
 +
<source lang="xml" >
 +
<listbox mold="paging" pageSize="1" >
 +
<listitem >
 +
<listcell stubonly="true"/>
 +
</listitem>
 +
<listitem>
 +
<listcell />
 +
</listitem>
 +
</listbox>
</source>
</source>
 +
Although paging will [[ZK_Developer's_Reference/UI_Composing/Component-based_UI#Invalidate_a_Component|invalidate]] <tt>listbox</tt> and its children, <tt>stubonly</tt> needs the referred widget in client side which is detached during paging and throws mounting error.
 +
 +
== Detach and Reuse ==
 +
The detailed information of a stub component is stored at the client. It is removed when the component is removed. Thus, you can't reuse a component if the component has some stub components and it is detached. For example, the following code won't work:
 +
 +
<syntax lang="java">
 +
public class MyListener implements EventListener {
 +
  private static Window win;
 +
  public void onEvent(Event evt) throws Exception{
 +
      if (win ==null) {  
 +
        win = new Window();
 +
        win.setTitle("Hello!");
 +
        win.setClosable(true);
 +
        Label testLabel = new Label("My Label");
 +
        testLabel.setStubonly("true");
 +
        win.appendChild(testLabel);
 +
      }
 +
      win.setParent(evt.getTarget().getFellow("mainWindow"));
 +
      win.doModal();
 +
    }
 +
}
 +
</syntax>
 +
 +
In the above example<ref>Please refer to [http://tracker.zkoss.org/browse/ZK-1094 ZK-1094] for a real case.</ref>, <code>win</code> is reused but it also has a stub component (a label). When the window is closed, all the information at the client are removed (since Window's onClose() method detaches the window). Thus, if the event was executed again, the client can restore the detailed information back.
 +
 +
<blockquote>
 +
----
 +
<references/>
 +
</blockquote>
== Event Handling ==
== Event Handling ==
-
ZK will preserve all registered event listeners and handlers, when converting a stub-only component to a stub component. In other words, the listener will be called if the corresponding event is fired. However, since the original component no longer exists, the event is fired in the most generic format: an instance of <javadoc>org.zkoss.zk.ui.event.Event</javadoc>, rather than a derived class.
+
ZK will preserve all registered event listeners and handlers when converting a stub-only component to a stub component. In other words, the listener will be called if the corresponding event is fired. However, since the original component no longer exists, the event is fired in the most generic format: an instance of <javadoc>org.zkoss.zk.ui.event.Event</javadoc>, rather than a derived class.
-
For example, in the following snippet, "org.zkoss.zk.ui.event.Event:onChange" will be generated to <tt>System.out</tt>.
+
For example, in the following snippet, [https://www.zkoss.org/javadoc/latest/zk/org/zkoss/zk/ui/event/StubEvent.html org.zkoss.zk.ui.event.StubEvent:onStub] will be generated to <tt>System.out</tt>.
-
<source lang="xml">
+
<syntax lang="xml">
-
<textbox stubonly="true" onChange='System.out.println(event.getClass().getName()+":"+event.getName())'/>
+
<textbox stubonly="true"  
-
</source>
+
onChange='System.out.println(event.getClass().getName()+":"+event.getName())'/>
 +
</syntax>
-
In addition, the target (<javadoc method="getTarget()">org.zkoss.zk.ui.event.Event</javadoc>) is the stub component rather than the original one (<tt>text</tt>).
+
In addition, the target (<javadoc method="getTarget()">org.zkoss.zk.ui.event.Event</javadoc>) is the stub component rather than the original one, <tt>Textbox</tt>.
== Client-side Programming ==
== Client-side Programming ==
Line 64: Line 106:
The client-side widget of a component is the same no matter if it is stub only. Thus, the application can have the full control by registering the client side event listener, such as
The client-side widget of a component is the same no matter if it is stub only. Thus, the application can have the full control by registering the client side event listener, such as
-
<source lang="xml">
+
<syntax lang="xml">
<textbox stubonly="true" w:onChange="doSomething(this.value)" xmlns:w="client"/>
<textbox stubonly="true" w:onChange="doSomething(this.value)" xmlns:w="client"/>
-
</source>
+
</syntax>
 +
 
 +
In other words, the stub-only components behave the same at the client.
-
In other words, stub-only components behave the same at the client.
+
Refer to [[Small_Talks/2010/April/Client_Side_Programming |Client Side Programming]] and [[ZK_Client-side_Reference/General_Control|ZK Client-side Reference: General Control]] for more information.
-
Refer to [http://docs.zkoss.org/wiki/Client_Side_Programming Client Side Programming] and [http://docs.zkoss.org/wiki/ZK5:_Client_Computing_with_ZUML Client Computing with ZUML] for more information.
+
=Version History=
 +
{{LastUpdated}}
 +
{| border='1px' | width="100%"
 +
! Version !! Date !! Content
 +
|-
 +
| 6.0.2
 +
| June, 2012
 +
| [http://tracker.zkoss.org/browse/ZK-1182 Bug: stubonly doesn't work], and change the event handle from origin event to StubEvent.
 +
|}
-
{{ ZKDevelopersGuidePageFooter}}
+
{{ ZKDevelopersReferencePageFooter}}
-
[http://www.example.com link title]
+

Latest revision as of 02:47, 30 January 2020






Contents


Overview

[since 5.0.4][ZK EE] [since 6.0.0][ZK CE]

It is common that the states of some components are not required to maintain on the server. A typical example is that an application might use some components, such as hbox, for layout and won't access it again after rendered. To minimize the memory footprint, ZK supports a special property called stubonly (Component.setStubonly(String)). Once specified with true, its states won't be maintained on the server (and all states are maintained at the client). For example,

<hbox stubonly="true">
</hbox>
  • Notice this feature is available since ZK 5.0.4 EE, and available in CE since ZK 6.0.0.

Values of Stubonly: true, false and inherit

The default value of the stubonly property is inherit. It means the value is the same as its parent's, if any, or false, if no parent at all. Thus, if a component's stubonly is specified with true, all its descendants are stub-only too, unless false is specified explicitly. For example, in the following snippet, only textbox is not stub-only, while hbox, splitter, listbox, listitem and labels are all stub-only.

<hbox stubonly="true">
  a stub-only label
  <textbox stubonly="false"/>
  <splitter/>
  <listbox>
    <listitem label="also stubonly"/>
  </listbox>
</hbox>

Limitation of Stub Components

When a component is stub only, it will be replaced with a special component called a stub component (StubComponent) after rendered. In addition, the adjacent stub components might be merged to minimize the memory further. Thus, the application should not access the component again on the server, if it is specified as stub only.

Invalidation

While a stub component cannot be invalidated directly, it is safe to invalidate its parent. ZK will rerender all non-stub components and retain the states of stub components at the client. For example, in the following snippet, it is safe to click the invalidate button. From an end user's point of view, there is no difference whether stubonly is specified or not.

 <window>
  <button label="self.parent.invalidate()"/>
  <vbox stubonly="true">
  stubonly <textbox/>
  </vbox>
</window>

It is a special case that paging can not apply stubonly at the same time. For example,

<listbox mold="paging" pageSize="1" >
	<listitem >
		<listcell stubonly="true"/>
	</listitem>
	<listitem>
		<listcell />
	</listitem>
</listbox>

Although paging will invalidate listbox and its children, stubonly needs the referred widget in client side which is detached during paging and throws mounting error.

Detach and Reuse

The detailed information of a stub component is stored at the client. It is removed when the component is removed. Thus, you can't reuse a component if the component has some stub components and it is detached. For example, the following code won't work:

public class MyListener implements EventListener {
   private static Window win;
   public void onEvent(Event evt) throws Exception{
      if (win ==null) {	   
         win = new Window();
         win.setTitle("Hello!");
         win.setClosable(true);
         Label testLabel = new Label("My Label");
         testLabel.setStubonly("true");
         win.appendChild(testLabel);
      }
      win.setParent(evt.getTarget().getFellow("mainWindow"));
      win.doModal();
    }
 }

In the above example[1], win is reused but it also has a stub component (a label). When the window is closed, all the information at the client are removed (since Window's onClose() method detaches the window). Thus, if the event was executed again, the client can restore the detailed information back.


  1. Please refer to ZK-1094 for a real case.

Event Handling

ZK will preserve all registered event listeners and handlers when converting a stub-only component to a stub component. In other words, the listener will be called if the corresponding event is fired. However, since the original component no longer exists, the event is fired in the most generic format: an instance of Event, rather than a derived class.

For example, in the following snippet, org.zkoss.zk.ui.event.StubEvent:onStub will be generated to System.out.

<textbox stubonly="true" 
onChange='System.out.println(event.getClass().getName()+":"+event.getName())'/>

In addition, the target (Event.getTarget()) is the stub component rather than the original one, Textbox.

Client-side Programming

The client-side widget of a component is the same no matter if it is stub only. Thus, the application can have the full control by registering the client side event listener, such as

<textbox stubonly="true" w:onChange="doSomething(this.value)" xmlns:w="client"/>

In other words, the stub-only components behave the same at the client.

Refer to Client Side Programming and ZK Client-side Reference: General Control for more information.

Version History

Last Update : 2020/1/30


Version Date Content
6.0.2 June, 2012 Bug: stubonly doesn't work, and change the event handle from origin event to StubEvent.




Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.