Allow editing the ex-date in the account transaction dialog

Issue: portfolio-performance#5439

Allow editing the ex-date in the account transaction dialog portfolio-performance#5511

- initial check-in

Author: ZfT2

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/Messages.java

@@ -1095,12 +1095,14 @@ public class Messages extends NLS
     public static String MsgConfirmInstall;
     public static String MsgCreateTransactionsAutomaticallyUponOpening;
     public static String MsgDateIsInTheFuture;
+    public static String MsgDateExIsAfterTheDate;
     public static String MsgDeletionNotPossible;
     public static String MsgDeletionNotPossibleDetail;
     public static String MsgDialogInputRequired;
     public static String MsgDialogNotAValidCurrency;
     public static String MsgDialogNotAValidISIN;
     public static String MsgEmbeddedBrowserError;
+    public static String MsgExDateNotAllowed;
     public static String MsgErrorAccountNotExist;
     public static String MsgErrorConvertedAmount;
     public static String MsgErrorConvertToBuySellCurrencyMismatch;

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/dialogs/transactions/AbstractTransactionDialog.java

@@ -4,6 +4,8 @@
 import java.text.DecimalFormat;
 import java.text.MessageFormat;
 import java.text.NumberFormat;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
 import java.time.LocalTime;
 import java.util.ArrayList;
 import java.util.List;
@@ -41,6 +43,7 @@
 import org.eclipse.swt.events.MouseListener;
 import org.eclipse.swt.layout.FormLayout;
 import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Control;
 import org.eclipse.swt.widgets.Label;
 import org.eclipse.swt.widgets.Shell;
@@ -59,7 +62,10 @@
 import name.abuchen.portfolio.ui.util.CurrencyProposalProvider;
 import name.abuchen.portfolio.ui.util.CurrencyToStringConverter;
 import name.abuchen.portfolio.ui.util.DatePicker;
+import name.abuchen.portfolio.ui.util.DateTimeToDateConverter;
+import name.abuchen.portfolio.ui.util.DateToDateTimeConverter;
 import name.abuchen.portfolio.ui.util.IValidatingConverter;
+import name.abuchen.portfolio.ui.util.NullableDateTimeDateSelectionProperty;
 import name.abuchen.portfolio.ui.util.SimpleDateTimeDateSelectionProperty;
 import name.abuchen.portfolio.ui.util.SimpleDateTimeTimeSelectionProperty;
 import name.abuchen.portfolio.ui.util.StringToCurrencyConverter;
@@ -320,6 +326,40 @@ public void linkActivated(HyperlinkEvent e)
         }
     }
 
+    public class ExDateInput
+    {
+        public final Button checkBox;
+        public final DatePicker date;
+
+        public ExDateInput(Composite editArea)
+        {
+            checkBox = new Button(editArea, SWT.CHECK);
+            checkBox.setText(Messages.ColumnExDate);
+            date = new DatePicker(editArea);
+        }
+
+        public void bindDate(String property)
+        {
+            UpdateValueStrategy<LocalDate, LocalDateTime> targetToModel = new UpdateValueStrategy<>();
+            targetToModel.setConverter(new DateToDateTimeConverter());
+
+            UpdateValueStrategy<LocalDateTime, LocalDate> modelToTarget = new UpdateValueStrategy<>();
+            modelToTarget.setConverter(new DateTimeToDateConverter());
+
+            IObservableValue<LocalDate> targetObservable = new NullableDateTimeDateSelectionProperty()
+                            .observe(date.getControl());
+            IObservableValue<LocalDateTime> modelObservable = BeanProperties.value(property, LocalDateTime.class)
+                            .observe(model);
+            context.bindValue(targetObservable, modelObservable, targetToModel, modelToTarget);
+        }
+
+        public void setVisible(boolean visible)
+        {
+            checkBox.setVisible(visible);
+            date.getControl().setVisible(visible);
+        }
+    }
+
     public class ExchangeRateInput extends Input
     {
         public final ImageHyperlink buttonInvertExchangeRate;

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/dialogs/transactions/AccountTransactionDialog.java

@@ -28,6 +28,7 @@
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.SelectionAdapter;
 import org.eclipse.swt.events.SelectionEvent;
+import org.eclipse.swt.events.SelectionListener;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Label;
@@ -121,6 +122,12 @@ protected void createFormElements(Composite editArea) // NOSONAR
         dateTime.bindTime(Properties.time.name());
         dateTime.bindButton(() -> model().getTime(), time -> model().setTime(time));
 
+        // ex-date
+
+        var exDate = new ExDateInput(editArea);
+        exDate.bindDate(Properties.exDate.name());
+        exDate.setVisible(model().supportsSecurity());
+
         // shares
 
         Input shares = new Input(editArea, Messages.ColumnShares);
@@ -251,6 +258,20 @@ public void widgetSelected(SelectionEvent e)
 
         startingWith(dateTime.date.getControl()).thenRight(dateTime.time).thenRight(dateTime.button, 0);
 
+        if (model().supportsSecurity())
+        {
+            startingWith(dateTime.button).thenRight(exDate.checkBox).thenRight(exDate.date.getControl());
+
+            var hasExDate = model().getExDate() != null;
+            toggleExDatePicker(exDate, hasExDate);
+
+            exDate.checkBox.addSelectionListener(SelectionListener.widgetSelectedAdapter(event -> {
+                var button = (Button) event.widget;
+                toggleExDatePicker(exDate, button.getSelection());
+                editArea.layout();
+            }));
+        }
+
         // shares [- amount per share]
         forms.thenBelow(shares.value).width(amountWidth).label(shares.label).suffix(btnShares) //
                         // fxAmount - exchange rate - amount
@@ -352,6 +373,22 @@ public void widgetSelected(SelectionEvent e)
         model.firePropertyChange(Properties.exchangeRateCurrencies.name(), "", model().getExchangeRateCurrencies()); //$NON-NLS-1$
     }
 
+    private void toggleExDatePicker(ExDateInput exDate, boolean enable)
+    {
+        exDate.checkBox.setSelection(enable);
+        exDate.date.getControl().setVisible(enable);
+
+        if (enable)
+        {
+            model().setExDate(exDate.date.getSelection().atStartOfDay());
+        }
+        else
+        {
+            model().setExDate(null);
+            exDate.date.setSelection(model.getDate());
+        }
+    }
+
     private ComboInput setupSecurities(Composite editArea)
     {
         List<Security> activeSecurities = new ArrayList<>();

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/dialogs/transactions/AccountTransactionModel.java

@@ -32,7 +32,7 @@ public class AccountTransactionModel extends AbstractModel
 {
     public enum Properties
     {
-        security, account, date, time, shares, fxGrossAmount, dividendAmount, exchangeRate, inverseExchangeRate, grossAmount, // NOSONAR
+        security, account, date, exDate, time, shares, fxGrossAmount, dividendAmount, exchangeRate, inverseExchangeRate, grossAmount, // NOSONAR
         fxTaxes, taxes, fxFees, fees, total, note, exchangeRateCurrencies, inverseExchangeRateCurrencies, // NOSONAR
         accountCurrencyCode, securityCurrencyCode, fxCurrencyCode, calculationStatus; // NOSONAR
     }
@@ -52,6 +52,7 @@ public enum Properties
     private Account account;
     private LocalDate date = PresetValues.getLastTransactionDate();
     private LocalTime time = PresetValues.getTime();
+    private LocalDateTime exDate;
     private long shares;
 
     private long fxGrossAmount;
@@ -103,6 +104,9 @@ public void applyChanges()
         if (account == null)
             throw new UnsupportedOperationException(Messages.MsgMissingAccount);
 
+        if (exDate != null && (security == null || EMPTY_SECURITY.equals(security)))
+            throw new UnsupportedOperationException(Messages.MsgExDateNotAllowed);
+
         AccountTransaction t;
 
         if (sourceTransaction != null && sourceAccount.equals(account))
@@ -122,14 +126,14 @@ public void applyChanges()
 
                 // preserve the source field from the original transaction
                 t.setSource(sourceTransaction.getSource());
-                t.setExDate(sourceTransaction.getExDate());
 
                 sourceTransaction = null;
                 sourceAccount = null;
             }
         }
 
         t.setDateTime(LocalDateTime.of(date, time));
+        t.setExDate(exDate);
         t.setSecurity(!EMPTY_SECURITY.equals(security) ? security : null);
         t.setShares(supportsShares() ? shares : 0);
         t.setAmount(total);
@@ -182,6 +186,7 @@ public void resetToNewTransaction()
         setFxTaxes(0);
         setNote(null);
         setTime(PresetValues.getTime());
+        setExDate(null);
     }
 
     public boolean supportsShares()
@@ -234,6 +239,7 @@ public void presetFromSource(Account account, AccountTransaction transaction)
         LocalDateTime transactionDate = transaction.getDateTime();
         this.date = transactionDate.toLocalDate();
         this.time = transactionDate.toLocalTime();
+        this.exDate = transaction.getExDate();
         this.shares = transaction.getShares();
         this.total = transaction.getAmount();
 
@@ -292,6 +298,9 @@ public IStatus getCalculationStatus()
      */
     private IStatus calculateStatus()
     {
+        if (exDate != null && exDate.toLocalDate().isAfter(date))
+            return ValidationStatus.error(Messages.MsgDateExIsAfterTheDate);
+
         // check whether converted amount is in range
         long upper = Math.round(fxGrossAmount * exchangeRate.add(BigDecimal.valueOf(0.0001)).doubleValue());
         long lower = Math.round(fxGrossAmount * exchangeRate.add(BigDecimal.valueOf(-0.0001)).doubleValue());
@@ -449,6 +458,19 @@ public void setTime(LocalTime time)
         firePropertyChange(Properties.time.name(), this.time, this.time = time); // NOSONAR
     }
 
+    public LocalDateTime getExDate()
+    {
+        return exDate;
+    }
+
+    public void setExDate(LocalDateTime exDate)
+    {
+        firePropertyChange(Properties.exDate.name(), this.exDate, this.exDate = exDate); // NOSONAR
+
+        firePropertyChange(Properties.calculationStatus.name(), this.calculationStatus,
+                        this.calculationStatus = calculateStatus()); // NOSONAR
+    }
+
     public long getShares()
     {
         return shares;

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/messages.properties

@@ -2182,6 +2182,8 @@ MsgCreateTransactionsAutomaticallyUponOpening = Create transactions automaticall
 
 MsgDateIsInTheFuture = Attention: the date of this transaction is in the future.
 
+MsgDateExIsAfterTheDate = Attention: the Ex date is newer than the transaction date.
+
 MsgDeletionNotPossible = Deletion not possible
 
 MsgDeletionNotPossibleDetail = Securities with associated transactions cannot be deleted.\nThe securities are needed to calculate the historical performance.\n\nSecurities with transactions: {0}.
@@ -2194,6 +2196,8 @@ MsgDialogNotAValidISIN = Invalid ISIN: {0}
 
 MsgEmbeddedBrowserError = Unable to create embedded browser to display charts\n\n* Are you running the latest version of your browser?\n* On Linux one has to install the packet ''libwebkitgtk-3.0-0''\n\nThe error message\n  "No more handles [Unknown Mozilla path (MOZILLA_FIVE_HOME not set)]"\nindicates that libwebkitgtk has to be installed. On Ubuntu 18.04, run\n  sudo apt-get install libwebkitgtk-3.0-0\n\n\nDetails:\n{0}
 
+MsgExDateNotAllowed = Ex-Date is only allowed for dividend transactions.
+
 MsgErrorAccountNotExist = There is no account.\nPlease create a new account.
 
 MsgErrorConvertToBuySellCurrencyMismatch = Transaction with currency {0} cannot be booked on account ''{2}'' with the currency {1}.

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/messages_de.properties

@@ -2175,6 +2175,8 @@ MsgCreateTransactionsAutomaticallyUponOpening = Buchungen automatisch nach dem \
 
 MsgDateIsInTheFuture = Achtung: Das Datum dieser Buchung liegt in der Zukunft.
 
+MsgDateExIsAfterTheDate = Achtung: Der Ex-Tag darf nicht neuer sein als das Transaktionsdatum.
+
 MsgDeletionNotPossible = L\u00F6schung nicht m\u00F6glich
 
 MsgDeletionNotPossibleDetail = Wertpapiere mit Ums\u00E4tzen k\u00F6nnen nicht gel\u00F6scht werden.\nDie Wertpapiere werden zur Berechnung der historischen Performance ben\u00F6tigt.\n\nWertpapiere mit Ums\u00E4tzen: {0}.
@@ -2187,6 +2189,8 @@ MsgDialogNotAValidISIN = Ung\u00FCltige ISIN: {0}
 
 MsgEmbeddedBrowserError = Fehler beim \u00D6ffnen des Web Browsers zur Darstellung der Grafiken\n\n* Aktuellste Version des Browsers installiert?\n* Unter Linux muss das Paket ''libwebkitgtk-3.0-0'' installiert sein.\n\nDer Fehlertext\n  "No more handles [Unknown Mozilla path (MOZILLA_FIVE_HOME not set)]"\nhei\u00DFt meistens, dass libwebkitgtk installiert werden muss. Unter Ubuntu 18.04 z. B. mit\n  sudo apt-get install libwebkitgtk-3.0-0\n\n\nDetails:\n{0}
 
+MsgExDateNotAllowed = Ex-Datum ist nur f\u00FCr Dividenden-Transaktionen erlaubt.
+
 MsgErrorAccountNotExist = Es ist kein Konto vorhanden.\nBitte erstellen Sie ein Konto.
 
 MsgErrorConvertToBuySellCurrencyMismatch = Buchung in der W\u00E4hrung {0} kann nicht auf Konto ''{2}'' mit der W\u00E4hrung {1} gebucht werden.

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/util/DateTimeToDateConverter.java

@@ -0,0 +1,28 @@
+package name.abuchen.portfolio.ui.util;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+
+import org.eclipse.core.databinding.conversion.IConverter;
+
+public class DateTimeToDateConverter implements IConverter<LocalDateTime, LocalDate>
+{
+
+    @Override
+    public Object getFromType()
+    {
+        return LocalDateTime.class;
+    }
+
+    @Override
+    public Object getToType()
+    {
+        return LocalDate.class;
+    }
+
+    @Override
+    public LocalDate convert(LocalDateTime fromObject)
+    {
+        return fromObject != null ? fromObject.toLocalDate() : null;
+    }
+}

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/util/DateToDateTimeConverter.java

@@ -0,0 +1,28 @@
+package name.abuchen.portfolio.ui.util;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+
+import org.eclipse.core.databinding.conversion.IConverter;
+
+public class DateToDateTimeConverter implements IConverter<LocalDate, LocalDateTime>
+{
+
+    @Override
+    public Object getFromType()
+    {
+        return LocalDate.class;
+    }
+
+    @Override
+    public Object getToType()
+    {
+        return LocalDateTime.class;
+    }
+
+    @Override
+    public LocalDateTime convert(LocalDate fromObject)
+    {
+        return fromObject != null ? fromObject.atStartOfDay() : null;
+    }
+}

name.abuchen.portfolio.ui/src/name/abuchen/portfolio/ui/util/NullableDateTimeDateSelectionProperty.java

@@ -0,0 +1,55 @@
+package name.abuchen.portfolio.ui.util;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.ZoneId;
+import java.util.Date;
+
+import org.eclipse.nebula.widgets.cdatetime.CDateTime;
+import org.eclipse.swt.widgets.Control;
+import org.eclipse.swt.widgets.DateTime;
+
+public class NullableDateTimeDateSelectionProperty extends SimpleDateTimeDateSelectionProperty
+{
+    @Override
+    protected LocalDate doGetValue(Control source)
+    {
+        if (source instanceof CDateTime dateTime)
+        {
+            var date = dateTime.getSelection();
+            return date == null ? null
+                            : LocalDateTime.ofInstant(date.toInstant(), ZoneId.systemDefault()).toLocalDate();
+        }
+
+        return super.doGetValue(source);
+    }
+
+    @Override
+    protected void doSetValue(Control source, LocalDate date)
+    {
+        if (source instanceof DateTime dateTime)
+        {
+            if (date == null)
+            {
+                // DateTime does not support null
+                var now = LocalDate.now();
+                dateTime.setDate(now.getYear(), now.getMonthValue() - 1, now.getDayOfMonth());
+            }
+            else
+            {
+                // DateTime widget has zero-based months
+                dateTime.setDate(date.getYear(), date.getMonthValue() - 1, date.getDayOfMonth());
+            }
+        }
+        else if (source instanceof CDateTime dateTime)
+        {
+            dateTime.setSelection(
+                            date != null ? Date.from(date.atStartOfDay().atZone(ZoneId.systemDefault()).toInstant())
+                                            : null);
+        }
+        else
+        {
+            throw new UnsupportedOperationException();
+        }
+    }
+}