@ScopeParam"

From Documentation
Line 31: Line 31:
 
'''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 to SPACE, PAGE, DESKTOP, EXECUTION, 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.
+
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 =

Revision as of 08:50, 29 August 2018

Stop.png 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

Last Update : 2018/08/29


Version Date Content
6.0.0 February 2012 The MVVM was introduced.
8.6.0 October 2018 EXECUTION is added into the Scope enumeration.




Last Update : 2018/08/29

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