MoneyWiseTransactionTable.java
/*
* MoneyWise: Finance Application
* Copyright 2012-2026. Tony Washer
*
* 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 io.github.tonywasher.joceanus.moneywise.lethe.ui.panel;
import io.github.tonywasher.joceanus.oceanus.base.OceanusException;
import io.github.tonywasher.joceanus.oceanus.date.OceanusDate;
import io.github.tonywasher.joceanus.oceanus.date.OceanusDateConfig;
import io.github.tonywasher.joceanus.oceanus.date.OceanusDateRange;
import io.github.tonywasher.joceanus.oceanus.decimal.OceanusDecimal;
import io.github.tonywasher.joceanus.oceanus.event.OceanusEvent;
import io.github.tonywasher.joceanus.oceanus.event.OceanusEventManager;
import io.github.tonywasher.joceanus.oceanus.event.OceanusEventRegistrar;
import io.github.tonywasher.joceanus.oceanus.event.OceanusEventRegistrar.OceanusEventProvider;
import io.github.tonywasher.joceanus.oceanus.profile.OceanusProfile;
import io.github.tonywasher.joceanus.metis.data.MetisDataDifference;
import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataFieldId;
import io.github.tonywasher.joceanus.metis.ui.MetisAction;
import io.github.tonywasher.joceanus.metis.ui.MetisErrorPanel;
import io.github.tonywasher.joceanus.metis.ui.MetisIcon;
import io.github.tonywasher.joceanus.metis.viewer.MetisViewerEntry;
import io.github.tonywasher.joceanus.metis.viewer.MetisViewerManager;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseAssetDirection;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseBasicDataType;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseBasicResource;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseTransAsset;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseTransCategory;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseTransTag;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseTransaction;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseTransaction.MoneyWiseTransactionList;
import io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseTransInfoClass;
import io.github.tonywasher.joceanus.moneywise.data.validate.MoneyWiseValidateTransaction;
import io.github.tonywasher.joceanus.moneywise.lethe.ui.controls.MoneyWiseAnalysisSelect;
import io.github.tonywasher.joceanus.moneywise.lethe.ui.controls.MoneyWiseAnalysisSelect.MoneyWiseStatementSelect;
import io.github.tonywasher.joceanus.moneywise.lethe.ui.dialog.MoneyWiseTransactionDialog;
import io.github.tonywasher.joceanus.moneywise.lethe.views.MoneyWiseAnalysisFilter;
import io.github.tonywasher.joceanus.moneywise.lethe.views.MoneyWiseAnalysisView;
import io.github.tonywasher.joceanus.moneywise.ui.MoneyWiseAnalysisColumnSet;
import io.github.tonywasher.joceanus.moneywise.ui.MoneyWiseIcon;
import io.github.tonywasher.joceanus.moneywise.ui.MoneyWiseUIResource;
import io.github.tonywasher.joceanus.moneywise.ui.base.MoneyWiseBaseTable;
import io.github.tonywasher.joceanus.moneywise.views.MoneyWiseView;
import io.github.tonywasher.joceanus.prometheus.data.PrometheusDataResource;
import io.github.tonywasher.joceanus.prometheus.ui.PrometheusActionButtons;
import io.github.tonywasher.joceanus.prometheus.views.PrometheusDataEvent;
import io.github.tonywasher.joceanus.prometheus.views.PrometheusEditSet;
import io.github.tonywasher.joceanus.prometheus.views.PrometheusUIEvent;
import io.github.tonywasher.joceanus.prometheus.views.PrometheusViewerEntryId;
import io.github.tonywasher.joceanus.tethys.api.base.TethysUIComponent;
import io.github.tonywasher.joceanus.tethys.api.button.TethysUIButton;
import io.github.tonywasher.joceanus.tethys.api.control.TethysUIControl.TethysUIIconMapSet;
import io.github.tonywasher.joceanus.tethys.api.factory.TethysUIFactory;
import io.github.tonywasher.joceanus.tethys.api.menu.TethysUIScrollMenu;
import io.github.tonywasher.joceanus.tethys.api.pane.TethysUIBorderPaneManager;
import io.github.tonywasher.joceanus.tethys.api.pane.TethysUIPaneFactory;
import io.github.tonywasher.joceanus.tethys.api.table.TethysUITableManager;
import java.util.Map;
/**
* MoneyWise Transaction Table.
*/
public class MoneyWiseTransactionTable
extends MoneyWiseBaseTable<MoneyWiseTransaction> {
/**
* The analysis data entry.
*/
private final MetisViewerEntry theViewerAnalysis;
/**
* The filter data entry.
*/
private final MetisViewerEntry theViewerFilter;
/**
* The transaction dialog.
*/
private final MoneyWiseTransactionDialog theActiveTran;
/**
* The new button.
*/
private final TethysUIButton theNewButton;
/**
* Analysis View.
*/
private final MoneyWiseAnalysisView theAnalysisView;
/**
* Analysis Selection panel.
*/
private final MoneyWiseAnalysisSelect theSelect;
/**
* The action buttons.
*/
private final PrometheusActionButtons theActionButtons;
/**
* The UpdateSet.
*/
private final PrometheusEditSet theEditSet;
/**
* The error panel.
*/
private final MetisErrorPanel theError;
/**
* The date range.
*/
private OceanusDateRange theRange;
/**
* The analysis filter.
*/
private MoneyWiseAnalysisFilter<?, ?> theFilter;
/**
* The edit list.
*/
private MoneyWiseTransactionList theTransactions;
/**
* ColumnSet.
*/
private MoneyWiseAnalysisColumnSet theColumnSet;
/**
* Constructor.
*
* @param pView the view
* @param pEditSet the editSet
* @param pError the error panel
* @param pFilter the filter viewer entry
* @param pAnalysis the analysis viewer entry
*/
MoneyWiseTransactionTable(final MoneyWiseView pView,
final PrometheusEditSet pEditSet,
final MetisErrorPanel pError,
final MetisViewerEntry pFilter,
final MetisViewerEntry pAnalysis) {
/* Store parameters */
super(pView, pEditSet, pError, MoneyWiseBasicDataType.TRANSACTION);
/* store parameters */
theEditSet = pEditSet;
theError = pError;
/* Store viewer entries */
theViewerAnalysis = pAnalysis;
theViewerFilter = pFilter;
/* Access gui factory */
final TethysUIFactory<?> myGuiFactory = pView.getGuiFactory();
final TethysUITableManager<MetisDataFieldId, MoneyWiseTransaction> myTable = getTable();
/* Create new button */
theNewButton = myGuiFactory.buttonFactory().newButton();
MetisIcon.configureNewIconButton(theNewButton);
/* Create the Analysis View */
theAnalysisView = new MoneyWiseAnalysisView(pView, getEditSet());
/* Create the Analysis Selection */
theSelect = new MoneyWiseAnalysisSelect(myGuiFactory, pView, theAnalysisView, theNewButton);
/* Create the action buttons */
theActionButtons = new PrometheusActionButtons(myGuiFactory, getEditSet());
/* Create a transaction panel */
theActiveTran = new MoneyWiseTransactionDialog(myGuiFactory, pEditSet, theSelect, this);
declareItemPanel(theActiveTran);
/* Set table configuration */
myTable.setDisabled(MoneyWiseTransaction::isDisabled)
.setComparator(MoneyWiseTransaction::compareTo);
/* Create the date column */
myTable.declareDateColumn(MoneyWiseBasicResource.MONEYWISEDATA_FIELD_DATE)
.setDateConfigurator((r, c) -> handleDateEvent(c))
.setCellValueFactory(this::getFilteredDate)
.setEditable(true)
.setCellEditable(r -> !r.isHeader() && !r.isReconciled())
.setColumnWidth(WIDTH_DATE)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setDate, r, v));
/* Create the account column */
myTable.declareScrollColumn(MoneyWiseBasicResource.TRANSACTION_ACCOUNT, MoneyWiseTransAsset.class)
.setMenuConfigurator(this::buildAccountMenu)
.setCellValueFactory(MoneyWiseTransaction::getAccount)
.setEditable(true)
.setCellEditable(r -> !r.isHeader() && !r.isReconciled())
.setColumnWidth(WIDTH_NAME)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setAccount, r, v));
/* Create the category column */
myTable.declareScrollColumn(MoneyWiseBasicDataType.TRANSCATEGORY, MoneyWiseTransCategory.class)
.setMenuConfigurator(this::buildCategoryMenu)
.setCellValueFactory(MoneyWiseTransaction::getCategory)
.setEditable(true)
.setCellEditable(r -> !r.isHeader() && !r.isReconciled())
.setColumnWidth(WIDTH_NAME)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setCategory, r, v));
/* Create the direction column */
final Map<Boolean, TethysUIIconMapSet<MoneyWiseAssetDirection>> myDirMapSets = MoneyWiseIcon.configureDirectionIconButton(myGuiFactory);
myTable.declareIconColumn(MoneyWiseBasicResource.TRANSACTION_DIRECTION, MoneyWiseAssetDirection.class)
.setIconMapSet(r -> myDirMapSets.get(determineDirectionState(r)))
.setCellValueFactory(MoneyWiseTransactionTable::getFilteredDirection)
.setEditable(true)
.setCellEditable(r -> !r.isHeader() && !r.isReconciled() && r.canSwitchDirection())
.setColumnWidth(WIDTH_ICON)
.setOnCommit((r, v) -> updateField(this::setDirection, r, v));
/* Create the partner column */
myTable.declareScrollColumn(MoneyWiseBasicResource.TRANSACTION_PARTNER, MoneyWiseTransAsset.class)
.setMenuConfigurator(this::buildPartnerMenu)
.setCellValueFactory(MoneyWiseTransaction::getPartner)
.setEditable(true)
.setCellEditable(r -> !r.isHeader() && !r.isReconciled())
.setColumnWidth(WIDTH_NAME)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setPartner, r, v));
/* Create the reconciled column */
final Map<Boolean, TethysUIIconMapSet<Boolean>> myRecMapSets = MoneyWiseIcon.configureReconciledIconButton(myGuiFactory);
myTable.declareIconColumn(MoneyWiseBasicResource.TRANSACTION_RECONCILED, Boolean.class)
.setIconMapSet(r -> myRecMapSets.get(determineReconciledState(r)))
.setCellValueFactory(MoneyWiseTransaction::isReconciled)
.setEditable(true)
.setCellEditable(r -> !r.isHeader() && !r.isLocked())
.setColumnWidth(WIDTH_ICON)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setReconciled, r, v));
/* Create the comments column */
myTable.declareStringColumn(MoneyWiseTransInfoClass.COMMENTS)
.setCellValueFactory(MoneyWiseTransactionTable::getFilteredComments)
.setEditable(true)
.setCellEditable(r -> !r.isHeader())
.setColumnWidth(WIDTH_DESC)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setComments, r, v));
/* Create the amount column */
myTable.declareMoneyColumn(MoneyWiseBasicResource.TRANSACTION_AMOUNT)
.setCellValueFactory(MoneyWiseTransaction::getAmount)
.setEditable(true)
.setColumnWidth(WIDTH_MONEY)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setAmount, r, v));
/* Create the tag column */
myTable.declareListColumn(MoneyWiseTransInfoClass.TRANSTAG, MoneyWiseTransTag.class)
.setSelectables(c -> theActiveTran.buildTransactionTags())
.setCellValueFactory(MoneyWiseTransaction::getTransactionTags)
.setEditable(true)
.setColumnWidth(WIDTH_NAME)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setTransactionTags, r, v));
/* Create the reference column */
myTable.declareStringColumn(MoneyWiseTransInfoClass.REFERENCE)
.setCellValueFactory(MoneyWiseTransaction::getReference)
.setEditable(true)
.setColumnWidth(WIDTH_DESC)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setReference, r, v));
/* Create the taxCredit column */
myTable.declareMoneyColumn(MoneyWiseTransInfoClass.TAXCREDIT)
.setCellValueFactory(MoneyWiseTransaction::getTaxCredit)
.setEditable(true)
.setColumnWidth(WIDTH_MONEY)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setTaxCredit, r, v));
/* Create the EeNatIns column */
myTable.declareMoneyColumn(MoneyWiseTransInfoClass.EMPLOYEENATINS)
.setCellValueFactory(MoneyWiseTransaction::getEmployeeNatIns)
.setEditable(true)
.setColumnWidth(WIDTH_MONEY)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setEmployeeNatIns, r, v));
/* Create the ErNatIns column */
myTable.declareMoneyColumn(MoneyWiseTransInfoClass.EMPLOYERNATINS)
.setCellValueFactory(MoneyWiseTransaction::getEmployerNatIns)
.setEditable(true)
.setColumnWidth(WIDTH_MONEY)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setEmployerNatIns, r, v));
/* Create the Benefit column */
myTable.declareMoneyColumn(MoneyWiseTransInfoClass.DEEMEDBENEFIT)
.setCellValueFactory(MoneyWiseTransaction::getDeemedBenefit)
.setEditable(true)
.setColumnWidth(WIDTH_MONEY)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setDeemedBenefit, r, v));
/* Create the Withheld column */
myTable.declareMoneyColumn(MoneyWiseTransInfoClass.WITHHELD)
.setCellValueFactory(MoneyWiseTransaction::getWithheld)
.setEditable(true)
.setColumnWidth(WIDTH_MONEY)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setWithheld, r, v));
/* Create the AccountUnits column */
myTable.declareUnitsColumn(MoneyWiseTransInfoClass.ACCOUNTDELTAUNITS)
.setCellValueFactory(MoneyWiseTransaction::getAccountDeltaUnits)
.setEditable(true)
.setColumnWidth(WIDTH_UNITS)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setAccountDeltaUnits, r, v));
/* Create the PartnerUnits column */
myTable.declareUnitsColumn(MoneyWiseTransInfoClass.PARTNERDELTAUNITS)
.setCellValueFactory(MoneyWiseTransaction::getPartnerDeltaUnits)
.setEditable(true)
.setColumnWidth(WIDTH_UNITS)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setPartnerDeltaUnits, r, v));
/* Create the Dilution column */
myTable.declareRatioColumn(MoneyWiseTransInfoClass.DILUTION)
.setCellValueFactory(MoneyWiseTransaction::getDilution)
.setEditable(true)
.setColumnWidth(WIDTH_UNITS)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setDilution, r, v));
/* Create the QualifyYears column */
myTable.declareIntegerColumn(MoneyWiseTransInfoClass.QUALIFYYEARS)
.setCellValueFactory(MoneyWiseTransaction::getYears)
.setEditable(true)
.setColumnWidth(WIDTH_UNITS)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setYears, r, v));
/* Create the returned cash account column */
myTable.declareScrollColumn(MoneyWiseTransInfoClass.RETURNEDCASHACCOUNT, MoneyWiseTransAsset.class)
.setMenuConfigurator(this::buildReturnedMenu)
.setCellValueFactory(MoneyWiseTransaction::getReturnedCashAccount)
.setEditable(true)
.setCellEditable(r -> !r.isReconciled())
.setColumnWidth(WIDTH_NAME)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setReturnedCashAccount, r, v));
/* Create the returned cash column */
myTable.declareMoneyColumn(MoneyWiseTransInfoClass.RETURNEDCASH)
.setCellValueFactory(MoneyWiseTransaction::getReturnedCash)
.setEditable(true)
.setColumnWidth(WIDTH_MONEY)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setReturnedCash, r, v));
/* Create the partner amount column */
myTable.declareMoneyColumn(MoneyWiseTransInfoClass.PARTNERAMOUNT)
.setCellValueFactory(MoneyWiseTransaction::getPartnerAmount)
.setEditable(true)
.setColumnWidth(WIDTH_MONEY)
.setOnCommit((r, v) -> updateField(MoneyWiseTransaction::setPartnerAmount, r, v));
/* Create the debit column */
myTable.declareRawDecimalColumn(MoneyWiseTransDataId.DEBIT)
.setCellValueFactory(this::getFilteredDebit)
.setEditable(false)
.setColumnWidth(WIDTH_MONEY);
/* Create the credit column */
myTable.declareRawDecimalColumn(MoneyWiseTransDataId.CREDIT)
.setCellValueFactory(this::getFilteredCredit)
.setEditable(false)
.setColumnWidth(WIDTH_MONEY);
/* Create the balance column */
myTable.declareRawDecimalColumn(MoneyWiseTransDataId.BALANCE)
.setCellValueFactory(this::getFilteredBalance)
.setEditable(false)
.setColumnWidth(WIDTH_MONEY);
/* Create the Active column */
final TethysUIIconMapSet<MetisAction> myActionMapSet = MetisIcon.configureStatusIconButton(myGuiFactory);
myTable.declareIconColumn(PrometheusDataResource.DATAITEM_TOUCH, MetisAction.class)
.setIconMapSet(r -> myActionMapSet)
.setCellValueFactory(MoneyWiseTransactionTable::getFilteredAction)
.setName(MoneyWiseUIResource.STATICDATA_ACTIVE.getValue())
.setEditable(true)
.setCellEditable(r -> !r.isHeader() && !r.isReconciled())
.setColumnWidth(WIDTH_ICON)
.setOnCommit((r, v) -> updateField(this::deleteRow, r, v));
/* Add listeners */
pView.getEventRegistrar().addEventListener(e -> refreshData());
theActionButtons.getEventRegistrar().addEventListener(this::handleActionButtons);
theNewButton.getEventRegistrar().addEventListener(e -> addNewItem());
theError.getEventRegistrar().addEventListener(e -> handleErrorPane());
theSelect.getEventRegistrar().addEventListener(PrometheusDataEvent.SELECTIONCHANGED, e -> handleFilterSelection());
theSelect.getEventRegistrar().addEventListener(PrometheusDataEvent.SAVETOFILE, e -> writeCSVToFile(pView.getGuiFactory()));
theActiveTran.getEventRegistrar().addEventListener(PrometheusDataEvent.ADJUSTVISIBILITY, e -> handlePanelState());
/* Hide the action buttons initially */
theActionButtons.setVisible(false);
theFilter = theSelect.getFilter();
/* Initialise the columns */
adjustColumns(theSelect.showColumns()
? theSelect.getColumns()
: MoneyWiseAnalysisColumnSet.BALANCE);
}
/**
* Obtain the selection panel.
*
* @return the select panel
*/
MoneyWiseAnalysisSelect getSelect() {
return theSelect;
}
/**
* Obtain the action buttons.
*
* @return the action buttons
*/
PrometheusActionButtons getActionButtons() {
return theActionButtons;
}
/**
* Delete row.
*
* @param pRow the row
* @param pValue the value (ignored)
* @throws OceanusException on error
*/
protected void setDirection(final MoneyWiseTransaction pRow,
final Object pValue) throws OceanusException {
pRow.switchDirection();
}
@Override
protected boolean isItemEditing() {
return theActiveTran.isEditing();
}
/**
* handle Date event.
*
* @param pConfig the dateConfig
*/
private void handleDateEvent(final OceanusDateConfig pConfig) {
pConfig.setEarliestDate(theRange == null
? null
: theRange.getStart());
pConfig.setLatestDate(theRange == null
? null
: theRange.getEnd());
}
@Override
public boolean isFieldChanged(final MetisDataFieldId pField,
final MoneyWiseTransaction pItem) {
if (pField.equals(MoneyWiseTransDataId.DEBIT)
|| pField.equals(MoneyWiseTransDataId.CREDIT)
|| pField.equals(MoneyWiseTransDataId.BALANCE)) {
return false;
}
return super.isFieldChanged(pField, pItem);
}
/**
* Determine reconciled state.
*
* @param pTrans the transaction
* @return the state
*/
private static boolean determineReconciledState(final MoneyWiseTransaction pTrans) {
return pTrans.isLocked();
}
/**
* Determine direction state.
*
* @param pTrans the transaction
* @return the state
*/
private static boolean determineDirectionState(final MoneyWiseTransaction pTrans) {
return pTrans.isReconciled();
}
/**
* Determine Focus.
*/
protected void determineFocus() {
/* Request the focus */
getTable().requestFocus();
}
/**
* Obtain filtered debit for transaction.
*
* @param pTrans the transaction
* @return the debit
*/
private OceanusDecimal getFilteredDebit(final MoneyWiseTransaction pTrans) {
return theFilter.getDebitForTransaction(pTrans);
}
/**
* Obtain filtered debit for transaction.
*
* @param pTrans the transaction
* @return the debit
*/
private OceanusDecimal getFilteredCredit(final MoneyWiseTransaction pTrans) {
return theFilter.getCreditForTransaction(pTrans);
}
/**
* Obtain filtered debit for transaction.
*
* @param pTrans the transaction
* @return the debit
*/
private OceanusDecimal getFilteredBalance(final MoneyWiseTransaction pTrans) {
return pTrans.isHeader() ? theFilter.getStartingBalance() : theFilter.getBalanceForTransaction(pTrans);
}
/**
* Obtain date value.
*
* @param pTrans the transaction
* @return the date value
*/
private OceanusDate getFilteredDate(final MoneyWiseTransaction pTrans) {
return pTrans.isHeader() ? theRange.getStart() : pTrans.getDate();
}
/**
* Obtain date value.
*
* @param pTrans the transaction
* @return the date value
*/
private static String getFilteredComments(final MoneyWiseTransaction pTrans) {
return pTrans.isHeader() ? MoneyWiseUIResource.STATEMENT_OPENINGBALANCE.getValue() : pTrans.getComments();
}
/**
* Obtain direction value.
*
* @param pTrans the transaction
* @return the direction value
*/
private static MoneyWiseAssetDirection getFilteredDirection(final MoneyWiseTransaction pTrans) {
return pTrans.isHeader() ? null : pTrans.getDirection();
}
/**
* Obtain date value.
*
* @param pTrans the transaction
* @return the date value
*/
private static MetisAction getFilteredAction(final MoneyWiseTransaction pTrans) {
return (pTrans.isHeader() || pTrans.isReconciled()) ? MetisAction.DO : MetisAction.DELETE;
}
@Override
protected void selectItem(final MoneyWiseTransaction pTrans) {
final MoneyWiseTransaction myTrans = pTrans != null && !pTrans.isHeader() ? pTrans : null;
theActiveTran.setItem(myTrans);
}
/**
* Select Statement.
*
* @param pSelect the selection
*/
void selectStatement(final MoneyWiseStatementSelect pSelect) {
/* Update selection */
theSelect.selectStatement(pSelect);
/* Set the filter */
theFilter = theSelect.getFilter();
/* Ensure that columns are correct */
adjustColumns(theSelect.showColumns()
? theSelect.getColumns()
: MoneyWiseAnalysisColumnSet.BALANCE);
/* Update the lists */
updateList();
}
/**
* handleErrorPane.
*/
private void handleErrorPane() {
/* Determine whether we have an error */
final boolean isError = theError.hasError();
/* Hide selection panel on error */
theSelect.setVisible(!isError);
/* Lock scroll area */
getTable().setEnabled(!isError);
/* Lock Action Buttons */
theActionButtons.setEnabled(!isError);
}
@Override
protected void refreshData() {
/* Obtain the active profile */
OceanusProfile myTask = getView().getActiveTask();
myTask = myTask.startTask("refreshData");
/* Update the selection */
theSelect.refreshData();
/* Set the filter */
theFilter = theSelect.getFilter();
/* Update the list */
updateList();
/* Complete the task */
myTask.end();
}
/**
* Handle filter selection.
*/
private void handleFilterSelection() {
/* Set the filter */
theFilter = theSelect.getFilter();
/* Ensure that columns are correct */
adjustColumns(theSelect.showColumns()
? theSelect.getColumns()
: MoneyWiseAnalysisColumnSet.BALANCE);
/* Set the selection */
final OceanusDateRange myRange = theSelect.getRange();
if (MetisDataDifference.isEqual(myRange, theRange)) {
/* Handle a simple filter change */
theViewerFilter.setObject(theFilter);
updateTableData();
} else {
/* Update new lists */
updateList();
}
}
@Override
protected boolean isFiltered(final MoneyWiseTransaction pRow) {
/* Handle no filter */
if (theFilter == null) {
return false;
}
/* Handle header visibility */
if (pRow.isHeader()) {
return MoneyWiseAnalysisColumnSet.BALANCE.equals(theColumnSet);
}
/* Return visibility of row */
return super.isFiltered(pRow) && !theFilter.filterTransaction(pRow);
}
@Override
public void notifyChanges() {
/* Determine whether we have updates */
final boolean hasUpdates = hasUpdates();
final boolean isItemEditing = theActiveTran.isEditing();
/* Update the table buttons */
theActionButtons.setEnabled(true);
theActionButtons.setVisible(hasUpdates && !isItemEditing);
theSelect.setEnabled(!isItemEditing);
theNewButton.setEnabled(!isItemEditing);
/* Adjust enable of the table */
if (!isItemEditing) {
setEnabled(true);
} else {
setTableEnabled(false);
}
/* Pass call on */
super.notifyChanges();
}
/**
* Update lists.
*/
private void updateList() {
/* Access the transactions */
theTransactions = theAnalysisView.getTransactions();
theRange = theAnalysisView.getRange();
/* If we have data */
if (theTransactions != null) {
MoneyWiseTransaction myHeader = theTransactions.findItemById(AnalysisHeader.ID_VALUE);
if (myHeader == null) {
/* Create the header */
myHeader = new AnalysisHeader(theTransactions);
theTransactions.add(myHeader);
}
/* Notify panel of refresh */
theActiveTran.refreshData();
theActiveTran.updateEditors(theRange);
/* Notify the builder */
theTransactions.getValidator().setRange(theRange);
theTransactions.getValidator().setEditSet(theEditSet);
}
/* Update lists */
getTable().setItems(theTransactions == null ? null : theTransactions.getUnderlyingList());
theActionButtons.setEnabled(true);
theSelect.setEnabled(!hasUpdates());
/* Touch the filter and updateSet */
theViewerFilter.setObject(theFilter);
theViewerAnalysis.setTreeObject(getEditSet());
restoreSelected();
}
@Override
public void cancelEditing() {
super.cancelEditing();
theActiveTran.setEditable(false);
}
/**
* Select transaction.
*
* @param pTran the transaction to select
*/
void selectTran(final MoneyWiseTransaction pTran) {
/* Select the row */
getTable().selectRow(pTran);
}
@Override
protected void handleRewind() {
/* Only action if we are not editing */
if (!theActiveTran.isEditing()) {
/* Handle the reWind */
setEnabled(true);
super.handleRewind();
}
/* Adjust for changes */
notifyChanges();
}
/**
* handle Action Buttons.
*
* @param pEvent the event
*/
private void handleActionButtons(final OceanusEvent<PrometheusUIEvent> pEvent) {
/* Cancel editing */
cancelEditing();
/* Perform the command */
theEditSet.processCommand(pEvent.getEventId(), theError);
/* Adjust for changes */
notifyChanges();
}
/**
* Handle panel state.
*/
private void handlePanelState() {
/* Only action if we are not editing */
if (!theActiveTran.isEditing()) {
/* handle the edit transition */
setEnabled(true);
final MoneyWiseTransaction myTrans = theActiveTran.getSelectedItem();
updateTableData();
if (myTrans != null) {
getTable().selectRow(myTrans);
} else {
restoreSelected();
}
} else {
getTable().cancelEditing();
}
/* Note changes */
notifyChanges();
}
/**
* Obtain the popUpMenu for Accounts.
*
* @param pTrans the transaction
* @param pMenu the menu to build
*/
private void buildAccountMenu(final MoneyWiseTransaction pTrans,
final TethysUIScrollMenu<MoneyWiseTransAsset> pMenu) {
/* Build the menu */
theActiveTran.buildAccountMenu(pMenu, pTrans);
}
/**
* Obtain the popUpMenu for Partner Accounts.
*
* @param pTrans the transaction
* @param pMenu the menu to build
*/
private void buildPartnerMenu(final MoneyWiseTransaction pTrans,
final TethysUIScrollMenu<MoneyWiseTransAsset> pMenu) {
/* Build the menu */
theActiveTran.buildPartnerMenu(pMenu, pTrans);
}
/**
* Build the popUpMenu for categories.
*
* @param pTrans the transaction
* @param pMenu the menu to build
*/
private void buildCategoryMenu(final MoneyWiseTransaction pTrans,
final TethysUIScrollMenu<MoneyWiseTransCategory> pMenu) {
/* Build the menu */
theActiveTran.buildCategoryMenu(pMenu, pTrans);
}
/**
* Build the popUpMenu for categories.
*
* @param pTrans the transaction
* @param pMenu the menu to build
*/
private void buildReturnedMenu(final MoneyWiseTransaction pTrans,
final TethysUIScrollMenu<MoneyWiseTransAsset> pMenu) {
/* Build the menu */
theActiveTran.buildReturnedAccountMenu(pMenu, pTrans);
}
/**
* New item.
*/
private void addNewItem() {
/* Make sure that we have finished editing */
cancelEditing();
/* Create a new profile */
final OceanusProfile myTask = getView().getNewProfile("addNewItem");
/* Create the new transaction */
myTask.startTask("buildItem");
final MoneyWiseValidateTransaction myBuilder = (MoneyWiseValidateTransaction) theTransactions.getValidator();
final MoneyWiseTransaction myTrans = theFilter.buildNewTransaction(myBuilder);
/* If we have one available */
if (myTrans != null) {
/* Add the new item */
myTask.startTask("addToList");
theTransactions.add(myTrans);
myTrans.setNewVersion();
/* Validate the new item and notify of the changes */
myTask.startTask("incrementVersion");
getEditSet().incrementVersion();
/* validate the item */
myTask.startTask("validate");
myTrans.validate();
/* Lock the table */
myTask.startTask("setItem");
theActiveTran.setNewItem(myTrans);
setTableEnabled(false);
}
/* End the task */
myTask.end();
}
/**
* Adjust columns.
*
* @param pSet the set to display.
*/
private void adjustColumns(final MoneyWiseAnalysisColumnSet pSet) {
/* Ignore if we are already the right set */
if (pSet.equals(theColumnSet)) {
return;
}
/* Hide all columns */
final TethysUITableManager<MetisDataFieldId, MoneyWiseTransaction> myTable = getTable();
hideAllColumns();
/* Switch on column set */
switch (pSet) {
case BALANCE:
myTable.getColumn(MoneyWiseTransInfoClass.COMMENTS).setVisible(true);
myTable.getColumn(MoneyWiseTransDataId.DEBIT).setVisible(true);
myTable.getColumn(MoneyWiseTransDataId.CREDIT).setVisible(true);
myTable.getColumn(MoneyWiseTransDataId.BALANCE).setVisible(true);
break;
case STANDARD:
myTable.getColumn(MoneyWiseTransInfoClass.COMMENTS).setVisible(true);
myTable.getColumn(MoneyWiseBasicResource.TRANSACTION_AMOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.TRANSTAG).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.REFERENCE).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.PARTNERAMOUNT).setVisible(true);
break;
case SALARY:
myTable.getColumn(MoneyWiseBasicResource.TRANSACTION_AMOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.TAXCREDIT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.EMPLOYEENATINS).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.EMPLOYERNATINS).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.DEEMEDBENEFIT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.WITHHELD).setVisible(true);
break;
case INTEREST:
myTable.getColumn(MoneyWiseBasicResource.TRANSACTION_AMOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.TAXCREDIT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.WITHHELD).setVisible(true);
break;
case DIVIDEND:
myTable.getColumn(MoneyWiseBasicResource.TRANSACTION_AMOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.TAXCREDIT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.ACCOUNTDELTAUNITS).setVisible(true);
break;
case SECURITY:
myTable.getColumn(MoneyWiseBasicResource.TRANSACTION_AMOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.ACCOUNTDELTAUNITS).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.PARTNERDELTAUNITS).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.DILUTION).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.RETURNEDCASHACCOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.RETURNEDCASH).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.QUALIFYYEARS).setVisible(true);
break;
case ALL:
default:
myTable.getColumn(MoneyWiseTransInfoClass.COMMENTS).setVisible(true);
myTable.getColumn(MoneyWiseBasicResource.TRANSACTION_AMOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.TRANSTAG).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.REFERENCE).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.TAXCREDIT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.EMPLOYERNATINS).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.EMPLOYEENATINS).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.DEEMEDBENEFIT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.WITHHELD).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.ACCOUNTDELTAUNITS).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.PARTNERDELTAUNITS).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.PARTNERAMOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.DILUTION).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.RETURNEDCASHACCOUNT).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.RETURNEDCASH).setVisible(true);
myTable.getColumn(MoneyWiseTransInfoClass.QUALIFYYEARS).setVisible(true);
break;
}
/* Store the column set */
theColumnSet = pSet;
}
/**
* Hide all columns.
*/
private void hideAllColumns() {
final TethysUITableManager<MetisDataFieldId, MoneyWiseTransaction> myTable = getTable();
myTable.getColumn(MoneyWiseTransDataId.DEBIT).setVisible(false);
myTable.getColumn(MoneyWiseTransDataId.CREDIT).setVisible(false);
myTable.getColumn(MoneyWiseTransDataId.BALANCE).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.COMMENTS).setVisible(false);
myTable.getColumn(MoneyWiseBasicResource.TRANSACTION_AMOUNT).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.TRANSTAG).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.REFERENCE).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.TAXCREDIT).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.EMPLOYERNATINS).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.EMPLOYEENATINS).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.DEEMEDBENEFIT).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.WITHHELD).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.ACCOUNTDELTAUNITS).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.PARTNERDELTAUNITS).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.PARTNERAMOUNT).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.DILUTION).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.RETURNEDCASHACCOUNT).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.RETURNEDCASH).setVisible(false);
myTable.getColumn(MoneyWiseTransInfoClass.QUALIFYYEARS).setVisible(false);
}
/**
* Analysis Header class.
*/
private static class AnalysisHeader
extends MoneyWiseTransaction {
/**
* Analysis Header Id.
*/
static final int ID_VALUE = 1;
/**
* Constructor.
*
* @param pList the Transaction list
*/
protected AnalysisHeader(final MoneyWiseTransactionList pList) {
super(pList);
setHeader(true);
setIndexedId(ID_VALUE);
}
}
/**
* Transaction DataIds.
*/
private enum MoneyWiseTransDataId
implements MetisDataFieldId {
/**
* Debit.
*/
DEBIT(MoneyWiseUIResource.STATEMENT_COLUMN_DEBIT),
/**
* Credit.
*/
CREDIT(MoneyWiseUIResource.STATEMENT_COLUMN_CREDIT),
/**
* Balance.
*/
BALANCE(MoneyWiseUIResource.STATEMENT_COLUMN_BALANCE);
/**
* The Value.
*/
private final String theValue;
/**
* Constructor.
*
* @param pKeyName the key name
*/
MoneyWiseTransDataId(final MetisDataFieldId pKeyName) {
theValue = pKeyName.getId();
}
@Override
public String getId() {
return theValue;
}
@Override
public String toString() {
return getId();
}
}
/**
* Transaction Panel.
*/
public static class MoneyWiseStatementPanel
implements TethysUIComponent, OceanusEventProvider<PrometheusDataEvent> {
/**
* Text for DataEntry Title.
*/
private static final String NLS_DATAENTRY = MoneyWiseUIResource.REGISTER_DATAENTRY.getValue();
/**
* Text for Filter DataEntry Title.
*/
private static final String NLS_FILTERDATAENTRY = MoneyWiseUIResource.FILTER_DATAENTRY.getValue();
/**
* Text for Transactions DataEntry Title.
*/
private static final String NLS_TRANSDATAENTRY = MoneyWiseUIResource.TRANSACTION_DATAENTRY.getValue();
/**
* The Event Manager.
*/
private final OceanusEventManager<PrometheusDataEvent> theEventManager;
/**
* The updateSet.
*/
private final PrometheusEditSet theEditSet;
/**
* The analysis data entry.
*/
private final MetisViewerEntry theViewerAnalysis;
/**
* The error panel.
*/
private final MetisErrorPanel theError;
/**
* The table.
*/
private final MoneyWiseTransactionTable theTable;
/**
* The panel.
*/
private final TethysUIBorderPaneManager thePanel;
/**
* Constructor.
*
* @param pView the data view
*/
public MoneyWiseStatementPanel(final MoneyWiseView pView) {
/* Build the Update set and entry */
theEditSet = new PrometheusEditSet(pView);
/* Create the event manager */
theEventManager = new OceanusEventManager<>();
/* Create the top level viewer entry for this view */
final MetisViewerManager myViewer = pView.getViewerManager();
final MetisViewerEntry mySection = pView.getViewerEntry(PrometheusViewerEntryId.VIEW);
final MetisViewerEntry myRegister = myViewer.newEntry(mySection, NLS_DATAENTRY);
final MetisViewerEntry myViewerFilter = myViewer.newEntry(myRegister, NLS_FILTERDATAENTRY);
theViewerAnalysis = myViewer.newEntry(myRegister, NLS_TRANSDATAENTRY);
theViewerAnalysis.setTreeObject(theEditSet);
/* Create the error panel for this view */
theError = pView.getToolkit().getToolkit().newErrorPanel(theViewerAnalysis);
/* Create the table */
theTable = new MoneyWiseTransactionTable(pView, theEditSet, theError, myViewerFilter, theViewerAnalysis);
/* Create the action buttons */
final TethysUIFactory<?> myGuiFactory = pView.getGuiFactory();
/* Create the header panel */
final TethysUIPaneFactory myPanes = myGuiFactory.paneFactory();
final TethysUIBorderPaneManager myHeader = myPanes.newBorderPane();
myHeader.setCentre(theTable.getSelect());
myHeader.setNorth(theError);
myHeader.setEast(theTable.getActionButtons());
/* Create the panel */
thePanel = myPanes.newBorderPane();
thePanel.setNorth(myHeader);
thePanel.setCentre(theTable);
/* Add listeners */
theError.getEventRegistrar().addEventListener(e -> handleErrorPane());
theTable.getActionButtons().getEventRegistrar().addEventListener(this::handleActionButtons);
theTable.getEventRegistrar().addEventListener(PrometheusDataEvent.ADJUSTVISIBILITY, e -> notifyChanges());
theTable.getEventRegistrar().addEventListener(PrometheusDataEvent.GOTOWINDOW, theEventManager::cascadeEvent);
}
@Override
public TethysUIComponent getUnderlying() {
return thePanel;
}
@Override
public void setEnabled(final boolean pEnabled) {
thePanel.setEnabled(pEnabled);
}
@Override
public void setVisible(final boolean pVisible) {
thePanel.setVisible(pVisible);
}
@Override
public OceanusEventRegistrar<PrometheusDataEvent> getEventRegistrar() {
return theEventManager.getEventRegistrar();
}
/**
* Select Statement.
*
* @param pSelect the selection
*/
public void selectStatement(final MoneyWiseStatementSelect pSelect) {
theTable.selectStatement(pSelect);
}
/**
* handleErrorPane.
*/
private void handleErrorPane() {
/* Determine whether we have an error */
final boolean isError = theError.hasError();
/* Hide selection panel on error */
theTable.getSelect().setVisible(!isError);
/* Lock scroll area */
theTable.setEnabled(!isError);
/* Lock Action Buttons */
theTable.getActionButtons().setEnabled(!isError);
}
/**
* handle Action Buttons.
*
* @param pEvent the event
*/
private void handleActionButtons(final OceanusEvent<PrometheusUIEvent> pEvent) {
/* Cancel editing */
theTable.cancelEditing();
/* Perform the command */
theEditSet.processCommand(pEvent.getEventId(), theError);
/* Adjust for changes */
theTable.notifyChanges();
}
/**
* Determine Focus.
*/
public void determineFocus() {
/* Request the focus */
theTable.determineFocus();
/* Focus on the Data entry */
theViewerAnalysis.setFocus();
}
/**
* Call underlying controls to take notice of changes in view/selection.
*/
private void notifyChanges() {
/* Notify listeners */
theEventManager.fireEvent(PrometheusDataEvent.ADJUSTVISIBILITY);
}
/**
* Does the panel have updates?
*
* @return true/false
*/
public boolean hasUpdates() {
return theTable.hasUpdates();
}
/**
* Does the panel have a session?
*
* @return true/false
*/
public boolean hasSession() {
return theTable.hasUpdates();
}
/**
* Does the panel have errors?
*
* @return true/false
*/
public boolean hasErrors() {
return theTable.hasErrors();
}
}
}