パッケージ org.wcardinal.controller.annotation

Annotation Interface OnChange

@Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface OnChange

Annotated methods are called when the specified fields get changed by browsers. The types of the specified fields must be the ones in the package org.wcardinal.controller.data.

 @Autowired
 SString name;

 @OnChange("name")
 void onChange( String newValue, String oldValue ){
   // Invoked when the name field is changed by browsers.
 }
 

Events propagate to parents. To catch an event triggered by a child, use a name prefixed with a child name.

 @Component
 class MyComponent extends AbstractComponent {
   @Autowired
   SString bar;
 }

 @Controller
 class MyController {
   @Autowired
   MyComponent foo;

   @OnChange("foo.bar")
   void onChange(){
     // Called when the 'bar' field of the child 'foo' is changed
   }
 }
 

The methods are invoked with two optional arguments. Argument types and their meanings are different among field types as follows:

OnChange argument types

Field type	Argument type	First argument	Second argument
SBoolean	Boolean	new value	old value
SInteger	Integer	new value	old value
SLong	Long	new value	old value
SFloat	Float	new value	old value
SDouble	Double	new value	old value
SString	String	new value	old value
SClass	T	new value	old value
SArrayNode	ArrayNode	new value	old value
SObjectNode	ObjectNode	new value	old value
SJsonNode	JsonNode	new value	old value
SList	SortedMap<Integer, T> (sorted in ascending order of keys)	sorted map of inserted values and their index	sorted map of removed values and their index
SMap	Map<String, T>	map of inserted values and their keys	map of removed values and their keys
SROQueue	does not emit a change event

In case of SString, arguments are, for instance, two strings representing a new value and an old value as shown above.

Arguments are optional. All of the following are, thus, valid.

 @OnChange("name")
 static void onChange(){}

 @OnChange("name")
 static void onChange( String newValue ){}
 

When a method is called, a controller owing the method is locked for preventing simultaneous modifications. For instance, in the above example, when the 'onChange' method is called, the 'MyController' controller is locked. The only exception to this is the case that a modified field belongs to a component annotated with SharedComponent and an event handler method does not belong to the same component, because shared components and the other controllers do not share a lock.

必須要素の概要

必須要素

修飾子とタイプ	必須要素	説明
String[]	value

要素の詳細

value

String[] value