blob: b914699edfa7ddd1e0a597b27f29b8e0db467fb6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
/*
* Copyright 2000-2016 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import com.vaadin.data.BeanBinder;
import com.vaadin.data.Binder;
import com.vaadin.data.HasValue;
/**
* Defines the custom property name to be bound to a {@link Field} using
* {@link Binder} or {@link BeanBinder}.
* <p>
* The automatic data binding in Binder and BeanBinder relies on a naming
* convention by default: properties of an item are bound to similarly named
* field components in given a editor object. If you want to map a property with
* a different name (ID) to a {@link HasValue}, you can use this annotation for
* the member fields, with the name (ID) of the desired property as the
* parameter.
* <p>
* In following usage example, the text field would be bound to property "foo"
* in the Entity class. <code>
* <pre>
* class Editor extends FormLayout {
@PropertyId("foo")
TextField myField = new TextField();
}
class Entity {
String foo;
}
{
Editor editor = new Editor();
BeanBinder<Entity> binder = new BeanBinder(Entity.class);
binder.bindInstanceFields(editor);
}
</pre>
* </code>
*
* @since 7.0
* @author Vaadin Ltd
*/
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface PropertyId {
String value();
}
|
