@AfterCompose"

From Documentation
Line 17: Line 17:
 
'''Purpose:''' Marker annotation to identify a life cycle method which will be invoked in doAfterCompose() of <javadoc>org.zkoss.bind.BindComposer</javadoc>.  
 
'''Purpose:''' Marker annotation to identify a life cycle method which will be invoked in doAfterCompose() of <javadoc>org.zkoss.bind.BindComposer</javadoc>.  
  
'''At most one''' @AfterCompose-annotated method is allowed in a ViewModel class. If you set annotation element '''superclass''' to '''true''', the ViewModel's parent class's @AfterCompose-annotated method will be invoked first then child's, and this logic repeat on super class. If a class has no method with @AfterCompose, no method will be called (including the super class's) <ref>If you override parent class's @AfterCompose-annotated method e.g. Parent.m1() <- Child.m1(). Because of Java's limitation,  <javadoc>org.zkoss.bind.BindComposer</javadoc> still call Child.m1(), and Child.m1() will be called twice. To avoid this, you should set <tt>superclass=false </tt> for Child.m1() and call super.m1() inside it.
+
'''At most one''' @AfterCompose-annotated method is allowed in a ViewModel class. If you set annotation element '''superclass''' to '''true''', the ViewModel's parent class's @AfterCompose-annotated method will be invoked first then child's, and this logic repeats on super class. If a class has no method with @AfterCompose, no method will be called (including the super class's). <ref>If you override parent class's @AfterCompose-annotated method e.g. Parent.m1() <- Child.m1(). Because of Java's limitation,  <javadoc>org.zkoss.bind.BindComposer</javadoc> still call Child.m1(), and Child.m1() will be called twice. To avoid this, you should set <tt>superclass=false </tt> for Child.m1() and call super.m1() inside it.
 
</ref>.
 
</ref>.
  
For example, in class hierarchy A(has @AfterCompose) <- B(has @AfterCompose) <- C(no @AfterCompose) <- D (has @AfterCompose, superclass=true).  D is the last child class.
+
For example, in a class hierarchy: A(has @AfterCompose) <- B(has @AfterCompose) <- C(no @AfterCompose) <- D (has @AfterCompose, superclass=true).  D is the last child class.
 
* When <javadoc>org.zkoss.bind.BindComposer</javadoc> start to handle D while in doAfterCompose(), it will call D's @AfterCompose method.
 
* When <javadoc>org.zkoss.bind.BindComposer</javadoc> start to handle D while in doAfterCompose(), it will call D's @AfterCompose method.
 
* When <javadoc>org.zkoss.bind.BindComposer</javadoc> reaches C, no method will be called.
 
* When <javadoc>org.zkoss.bind.BindComposer</javadoc> reaches C, no method will be called.

Revision as of 06:23, 10 July 2012

since 6.0.2

Syntax

@AfterCompose

@AfterCompose(superclass=true)

Description

Target: method, class

Purpose: Marker annotation to identify a life cycle method which will be invoked in doAfterCompose() of BindComposer.

At most one @AfterCompose-annotated method is allowed in a ViewModel class. If you set annotation element superclass to true, the ViewModel's parent class's @AfterCompose-annotated method will be invoked first then child's, and this logic repeats on super class. If a class has no method with @AfterCompose, no method will be called (including the super class's). [1].

For example, in a class hierarchy: A(has @AfterCompose) <- B(has @AfterCompose) <- C(no @AfterCompose) <- D (has @AfterCompose, superclass=true). D is the last child class.

  • When BindComposer start to handle D while in doAfterCompose(), it will call D's @AfterCompose method.
  • When BindComposer reaches C, no method will be called.
  • When BindComposer reaches B , it will call As' then B's.
  • When BindComposer reaches A, it will call A's.

We also can use parameter related annotation on AfterCompose method's parameters just as what we can do in @Init, please refer to subsections of ZK Developer's Reference/MVVM/Syntax/ViewModel/Parameters.


  1. If you override parent class's @AfterCompose-annotated method e.g. Parent.m1() <- Child.m1(). Because of Java's limitation, BindComposer still call Child.m1(), and Child.m1() will be called twice. To avoid this, you should set superclass=false for Child.m1() and call super.m1() inside it.

Example

public class FooViewModel{
	@AfterCompose
	public void doFoo(){
		//do while AfterCompose
	}
}

public class BarViewModel extends FooViewModel{
	@AfterCompose(superclass=true)
	public void afterComposeBar(){
		//AfterCompose method of super class FooViewModel will be called first.
	}
}

@AfterCompose(superclass=true)
public class ChildViewModel extends BarViewModel{

}

Version History

Last Update : 2012/07/10


Version Date Content
6.0.2 June 2012 The @AfterCompose was introduced.




Last Update : 2012/07/10

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