@ScopeParam"
From Documentation
m ((via JWB)) |
|||
| (16 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{ZKDevelopersReferencePageHeader}} | {{ZKDevelopersReferencePageHeader}} | ||
| + | {{Deprecated | url=[http://books.zkoss.org/zk-mvvm-book/8.0/syntax/scopeparam.html zk-mvvm-book/8.0/syntax/viewmodel/parameters/scopeparam]|}} | ||
| Line 15: | Line 16: | ||
enum Scope { | enum Scope { | ||
| − | COMPONENT, SPACE, PAGE, DESKTOP, SESSION, APPLICATION | + | EXECUTION, COMPONENT, SPACE, PAGE, DESKTOP, SESSION, APPLICATION// single scope |
AUTO //find by comp.getAttribute(name,true) | AUTO //find by comp.getAttribute(name,true) | ||
} | } | ||
</source> | </source> | ||
| + | |||
| + | {{versionSince|8.6.0}} | ||
| + | Note: EXECUTION is added into the Scope enumeration | ||
= Description = | = Description = | ||
| − | '''Target:''' A method's parameter (initial | + | '''Target:''' A method's parameter (for initial and command methods) |
'''Purpose:''' Tell binder to retrieve a value with specified scope | '''Purpose:''' Tell binder to retrieve a value with specified scope | ||
| − | The default scope: '''AUTO''' means searching the value from COMPONENT | + | The default scope: '''AUTO''' means searching the value from EXECUTION to COMPONENT, SPACE, PAGE, DESKTOP, SESSION, APPLICATION one by one automatically until find a non-null value. If you specified the '''scopes''' element, binder will search the only scope you specified. |
= Example = | = Example = | ||
| Line 46: | Line 50: | ||
=Version History= | =Version History= | ||
| − | + | ||
| − | {| | + | {| class='wikitable' | width="100%" |
! Version !! Date !! Content | ! Version !! Date !! Content | ||
|- | |- | ||
| Line 53: | Line 57: | ||
| February 2012 | | February 2012 | ||
| The MVVM was introduced. | | The MVVM was introduced. | ||
| + | |- | ||
| + | | 8.6.0 | ||
| + | | October 2018 | ||
| + | | EXECUTION is added into the Scope enumeration. | ||
|} | |} | ||
Latest revision as of 07:36, 8 July 2022
This article is out of date, please refer to zk-mvvm-book/8.0/syntax/viewmodel/parameters/scopeparam for more up to date information.
Syntax
@ScopeParam("keyString")
@ScopeParam(scopes=Scope.APPLICATION, value="keyString")
A list of all scopes enumeration:
enum Scope {
EXECUTION, COMPONENT, SPACE, PAGE, DESKTOP, SESSION, APPLICATION// single scope
AUTO //find by comp.getAttribute(name,true)
}
Since 8.6.0 Note: EXECUTION is added into the Scope enumeration
Description
Target: A method's parameter (for initial and command methods)
Purpose: Tell binder to retrieve a value with specified scope
The default scope: AUTO means searching the value from EXECUTION to COMPONENT, SPACE, PAGE, DESKTOP, SESSION, APPLICATION one by one automatically until find a non-null value. If you specified the scopes element, binder will search the only scope you specified.
Example
public class ScopeParamVM {
@Init
public void init(@ScopeParam(scopes=Scope.APPLICATION , value="config") String sysConfig,
@ScopeParam(scopes=Scope.SESSION,value="user") String userCredential){
}
Version History
| Version | Date | Content |
|---|---|---|
| 6.0.0 | February 2012 | The MVVM was introduced. |
| 8.6.0 | October 2018 | EXECUTION is added into the Scope enumeration. |