1 /*
2 * Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javafx.beans.property.adapter;
27
28 import com.sun.javafx.binding.ExpressionHelper;
29 import com.sun.javafx.property.MethodHelper;
30 import com.sun.javafx.property.adapter.Disposer;
31 import com.sun.javafx.property.adapter.PropertyDescriptor;
32 import javafx.beans.InvalidationListener;
33 import javafx.beans.property.StringProperty;
34 import javafx.beans.value.ChangeListener;
35 import javafx.beans.value.ObservableValue;
36
37 import java.lang.reflect.InvocationTargetException;
38 import java.lang.reflect.UndeclaredThrowableException;
39
40 import java.security.AccessController;
41 import java.security.AccessControlContext;
42 import java.security.PrivilegedAction;
43
44 /**
45 * A {@code JavaBeanStringProperty} provides an adapter between a regular
46 * Java Bean property of type {@code String} and a JavaFX
47 * {@code StringProperty}. It cannot be created directly, but a
48 * {@link JavaBeanStringPropertyBuilder} has to be used.
49 * <p>
50 * As a minimum, the Java Bean class must implement a getter and a setter for the
51 * property.
52 * The class, as well as the getter and a setter methods, must be declared public.
53 * If the getter of an instance of this class is called, the property of
54 * the Java Bean is returned. If the setter is called, the value will be passed
55 * to the Java Bean property. If the Java Bean property is bound (i.e. it supports
56 * PropertyChangeListeners), this {@code JavaBeanStringProperty} will be
57 * aware of changes in the Java Bean. Otherwise it can be notified about
58 * changes by calling {@link #fireValueChangedEvent()}. If the Java Bean property
59 * is also constrained (i.e. it supports VetoableChangeListeners), this
60 * {@code JavaBeanStringProperty} will reject changes, if it is bound to an
61 * {@link javafx.beans.value.ObservableValue ObservableValue<String>}.
62 * </p>
63 * <p><b>Deploying an Application as a Module</b></p>
64 * <p>
65 * If the Java Bean class is in a named module, then it must be reflectively
66 * accessible to the {@code javafx.base} module.
67 * A class is reflectively accessible if the module
68 * {@link Module#isOpen(String,Module) opens} the containing package to at
69 * least the {@code javafx.base} module.
70 * </p>
71 * <p>
72 * For example, if {@code com.foo.MyBeanClass} is in the {@code foo.app} module,
73 * the {@code module-info.java} might
74 * look like this:
75 * </p>
76 *
77 <pre>{@code module foo.app {
78 opens com.foo to javafx.base;
79 }}</pre>
80 *
81 * <p>
82 * Alternatively, a class is reflectively accessible if the module
83 * {@link Module#isExported(String) exports} the containing package
84 * unconditionally.
85 * </p>
86 *
87 * @see javafx.beans.property.StringProperty
88 * @see JavaBeanStringPropertyBuilder
89 * @since JavaFX 2.1
90 */
91 public final class JavaBeanStringProperty extends StringProperty implements JavaBeanProperty<String> {
92
93 private final PropertyDescriptor descriptor;
94 private final PropertyDescriptor.Listener<String> listener;
95
96 private ObservableValue<? extends String> observable = null;
97 private ExpressionHelper<String> helper = null;
98
99 private final AccessControlContext acc = AccessController.getContext();
100
101 JavaBeanStringProperty(PropertyDescriptor descriptor, Object bean) {
102 this.descriptor = descriptor;
103 this.listener = descriptor.new Listener<String>(bean, this);
104 descriptor.addListener(listener);
105 Disposer.addRecord(this, new DescriptorListenerCleaner(descriptor, listener));
106 }
107
108 /**
109 * {@inheritDoc}
110 *
111 * @throws UndeclaredThrowableException if calling the getter of the Java Bean
112 * property throws an {@code IllegalAccessException} or an
113 * {@code InvocationTargetException}.
114 */
115 @Override
116 public String get() {
117 return AccessController.doPrivileged((PrivilegedAction<String>) () -> {
118 try {
119 return (String)MethodHelper.invoke(descriptor.getGetter(), getBean(), (Object[])null);
120 } catch (IllegalAccessException e) {
121 throw new UndeclaredThrowableException(e);
122 } catch (InvocationTargetException e) {
123 throw new UndeclaredThrowableException(e);
124 }
125 }, acc);
126 }
127
128 /**
129 * {@inheritDoc}
130 *
131 * @throws UndeclaredThrowableException if calling the getter of the Java Bean
132 * property throws an {@code IllegalAccessException} or an
133 * {@code InvocationTargetException}.
134 */
135 @Override
136 public void set(final String value) {
137 if (isBound()) {
138 throw new RuntimeException("A bound value cannot be set.");
139 }
140 AccessController.doPrivileged((PrivilegedAction<Void>) () -> {
141 try {
142 MethodHelper.invoke(descriptor.getSetter(), getBean(), new Object[] {value});
143 ExpressionHelper.fireValueChangedEvent(helper);
144 } catch (IllegalAccessException e) {
145 throw new UndeclaredThrowableException(e);
146 } catch (InvocationTargetException e) {
147 throw new UndeclaredThrowableException(e);
148 }
149 return null;
150 }, acc);
151 }
152
153 /**
154 * {@inheritDoc}
155 */
156 @Override
157 public void bind(ObservableValue<? extends String> observable) {
158 if (observable == null) {
159 throw new NullPointerException("Cannot bind to null");
160 }
161
162 if (!observable.equals(this.observable)) {
163 unbind();
164 set(observable.getValue());
165 this.observable = observable;
166 this.observable.addListener(listener);
167 }
168 }
169
170 /**
171 * {@inheritDoc}
172 */
173 @Override
174 public void unbind() {
175 if (observable != null) {
176 observable.removeListener(listener);
177 observable = null;
178 }
179 }
180
181 /**
182 * {@inheritDoc}
183 */
184 @Override
185 public boolean isBound() {
186 return observable != null;
187 }
188
189 /**
190 * {@inheritDoc}
191 */
192 @Override
193 public Object getBean() {
194 return listener.getBean();
195 }
196
197 /**
198 * {@inheritDoc}
199 */
200 @Override
201 public String getName() {
202 return descriptor.getName();
203 }
204
205 /**
206 * {@inheritDoc}
207 */
208 @Override
209 public void addListener(ChangeListener<? super String> listener) {
210 helper = ExpressionHelper.addListener(helper, this, listener);
211 }
212
213 /**
214 * {@inheritDoc}
215 */
216 @Override
217 public void removeListener(ChangeListener<? super String> listener) {
218 helper = ExpressionHelper.removeListener(helper, listener);
219 }
220
221 /**
222 * {@inheritDoc}
223 */
224 @Override
225 public void addListener(InvalidationListener listener) {
226 helper = ExpressionHelper.addListener(helper, this, listener);
227 }
228
229 /**
230 * {@inheritDoc}
231 */
232 @Override
233 public void removeListener(InvalidationListener listener) {
234 helper = ExpressionHelper.removeListener(helper, listener);
235 }
236
237 /**
238 * {@inheritDoc}
239 */
240 @Override
241 public void fireValueChangedEvent() {
242 ExpressionHelper.fireValueChangedEvent(helper);
243 }
244
245 /**
246 * {@inheritDoc}
247 */
248 @Override
249 public void dispose() {
250 descriptor.removeListener(listener);
251
252 }
253 }