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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/*
* Copyright 2000-2014 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.ui;
import com.vaadin.data.BufferedValidatable;
import com.vaadin.data.Property;
import com.vaadin.ui.Component.Focusable;
/**
* Field interface is implemented by all classes (field components) that have a
* value that the user can change through the user interface.
*
* Field components are built upon the framework defined in the Field interface
* and the {@link com.vaadin.AbstractField} base class.
*
* The Field interface inherits the {@link com.vaadin.ui.Component}
* superinterface and also the {@link com.vaadin.ui.Property} interface to have
* a value for the field.
*
*
* @author Vaadin Ltd.
*
* @param T
* the type of values in the field, which might not be the same type
* as that of the data source if converters are used
*
* @author IT Mill Ltd.
*/
public interface Field<T> extends Component, BufferedValidatable, Property<T>,
Property.ValueChangeNotifier, Property.ValueChangeListener,
Property.Editor, Focusable {
/**
* Is this field required.
*
* Required fields must filled by the user.
*
* @return <code>true</code> if the field is required,otherwise
* <code>false</code>.
* @since 3.1
*/
public boolean isRequired();
/**
* Sets the field required. Required fields must filled by the user.
*
* @param required
* Is the field required.
* @since 3.1
*/
public void setRequired(boolean required);
/**
* Sets the error message to be displayed if a required field is empty.
*
* @param requiredMessage
* Error message.
* @since 5.2.6
*/
public void setRequiredError(String requiredMessage);
/**
* Gets the error message that is to be displayed if a required field is
* empty.
*
* @return Error message.
* @since 5.2.6
*/
public String getRequiredError();
/**
* An <code>Event</code> object specifying the Field whose value has been
* changed.
*
* @author Vaadin Ltd.
* @since 3.0
*/
@SuppressWarnings("serial")
public static class ValueChangeEvent extends Component.Event implements
Property.ValueChangeEvent {
/**
* Constructs a new event object with the specified source field object.
*
* @param source
* the field that caused the event.
*/
public ValueChangeEvent(Field source) {
super(source);
}
/**
* Gets the Property which triggered the event.
*
* @return the Source Property of the event.
*/
@Override
public Property getProperty() {
return (Property) getSource();
}
}
/**
* Is the field empty?
*
* In general, "empty" state is same as null. As an exception, TextField
* also treats empty string as "empty".
*
* @since
* @return true if the field is empty, false otherwise
*/
public boolean isEmpty();
/**
* Clears the value of the field.
* <p>
* The field value is typically reset to the initial value of the field.
* Calling {@link #isEmpty()} on a cleared field must always returns true.
*
* @since
*/
public void clear();
}
|
