1 /* 2 * ************************************************************************************************************************************************************* 3 * 4 * TheseFoolishThings: Miscellaneous utilities 5 * http://tidalwave.it/projects/thesefoolishthings 6 * 7 * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it) 8 * 9 * ************************************************************************************************************************************************************* 10 * 11 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * 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 17 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 18 * 19 * ************************************************************************************************************************************************************* 20 * 21 * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src 22 * git clone https://github.com/tidalwave-it/thesefoolishthings-src 23 * 24 * ************************************************************************************************************************************************************* 25 */ 26 package it.tidalwave.role.ui; 27 28 import javax.annotation.Nonnull; 29 import java.beans.PropertyChangeSupport; 30 import lombok.AllArgsConstructor; 31 import lombok.EqualsAndHashCode; 32 import lombok.NoArgsConstructor; 33 import lombok.ToString; 34 import lombok.experimental.Delegate; 35 36 /*************************************************************************************************************************************************************** 37 * 38 * @author Fabrizio Giudici 39 * 40 **************************************************************************************************************************************************************/ 41 // FIXME: weak listeners 42 @AllArgsConstructor @NoArgsConstructor @EqualsAndHashCode(exclude="pcs") @ToString(exclude="pcs") 43 public class BoundProperty<T> implements ChangingSource<T>, Changeable<T> 44 { 45 @Delegate 46 private final transient PropertyChangeSupport pcs = new PropertyChangeSupport(this); 47 48 public static final String PROP_VALUE = "value"; 49 50 private T value; 51 52 /*********************************************************************************************************************************************************** 53 * Creates a new {@code BoundProperty} with the given initial value. 54 * 55 * @param <T> the type of the property 56 * @param value the initial value 57 * @return the property 58 * @since 3.2-ALPHA-2 59 **********************************************************************************************************************************************************/ 60 @Nonnull 61 public static <T> BoundProperty<T> of (@Nonnull final T value) 62 { 63 return new BoundProperty<>(value); 64 } 65 66 /*********************************************************************************************************************************************************** 67 * {@inheritDoc} 68 * This method fires a property change event associated to {@link #PROP_VALUE}. 69 **********************************************************************************************************************************************************/ 70 @Override 71 public void set (final T value) 72 { 73 final var oldValue = this.value; 74 this.value = value; 75 pcs.firePropertyChange(PROP_VALUE, oldValue, value); 76 } 77 78 /*********************************************************************************************************************************************************** 79 * {@inheritDoc} 80 **********************************************************************************************************************************************************/ 81 @Override 82 public T get() 83 { 84 return value; 85 } 86 87 /*********************************************************************************************************************************************************** 88 * Binds this property to a {@link ChangingSource}. Every change in the value of the source will be synchronized to 89 * the value of this property. If the source is a {@link Changeable} binding will be bidirectional, that is the 90 * object will be set to the current value of this property and will be kept in sync. 91 * 92 * @param source the source 93 **********************************************************************************************************************************************************/ 94 public void bind (@Nonnull final ChangingSource<T> source) 95 { 96 source.addPropertyChangeListener(event -> set((T)event.getNewValue())); 97 98 if (source instanceof Changeable) 99 { 100 final var changeable = (Changeable<T>)source; 101 changeable.set(value); 102 this.addPropertyChangeListener(event -> changeable.set((T)event.getNewValue())); 103 } 104 } 105 106 /*********************************************************************************************************************************************************** 107 * {@inheritDoc} 108 **********************************************************************************************************************************************************/ 109 @Override 110 public void unbindAll() 111 { 112 for (final var listener : pcs.getPropertyChangeListeners().clone()) 113 { 114 pcs.removePropertyChangeListener(listener); 115 } 116 } 117 }