Specify Stubonly for Client-only Components"

From Documentation
Line 21: Line 21:
 
   a stub-only label
 
   a stub-only label
 
   <textbox stubonly="false"/>
 
   <textbox stubonly="false"/>
 +
  <splitter/>
 
   <listbox>
 
   <listbox>
 
     <listitem label="also stubonly"/>
 
     <listitem label="also stubonly"/>

Revision as of 10:23, 9 August 2010

DocumentationZK Developer's ReferencePerformance TipsSpecify Stubonly for Client-only Components
Specify Stubonly for Client-only Components


Stop.png This documentation is for an older version of ZK. For the latest one, please click here.


Overview

[since 5.0.4][ZK EE]

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 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 at the server (and all states are maintained at the client). For example,

<hbox stubonly="true">
</hbox>

Values of Stubonly: true, false and inherit

The default value of the stubonly property is inherit that is the same as its parent, 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. For example, only textbox is not stub-only in the following example.

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

Invalidation and Smart Updates

Event Handling


Last Update : 2010/08/09

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