MoneyWiseXPayeeAnalysisSelect.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.atlas.ui.controls;
import io.github.tonywasher.joceanus.oceanus.date.OceanusDateRange;
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.metis.data.MetisDataDifference;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.buckets.MoneyWiseXAnalysis;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.buckets.MoneyWiseXAnalysisPayeeBucket;
import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.buckets.MoneyWiseXAnalysisPayeeBucket.MoneyWiseXAnalysisPayeeBucketList;
import io.github.tonywasher.joceanus.moneywise.atlas.views.MoneyWiseXAnalysisFilter;
import io.github.tonywasher.joceanus.moneywise.atlas.views.MoneyWiseXAnalysisFilter.MoneyWiseXAnalysisPayeeFilter;
import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseBasicDataType;
import io.github.tonywasher.joceanus.prometheus.views.PrometheusDataEvent;
import io.github.tonywasher.joceanus.tethys.api.base.TethysUIComponent;
import io.github.tonywasher.joceanus.tethys.api.base.TethysUIConstant;
import io.github.tonywasher.joceanus.tethys.api.base.TethysUIEvent;
import io.github.tonywasher.joceanus.tethys.api.button.TethysUIScrollButtonManager;
import io.github.tonywasher.joceanus.tethys.api.control.TethysUILabel;
import io.github.tonywasher.joceanus.tethys.api.factory.TethysUIFactory;
import io.github.tonywasher.joceanus.tethys.api.menu.TethysUIScrollItem;
import io.github.tonywasher.joceanus.tethys.api.menu.TethysUIScrollMenu;
import io.github.tonywasher.joceanus.tethys.api.pane.TethysUIBoxPaneManager;
import java.util.Iterator;
/**
* Payee Analysis Selection.
*/
public class MoneyWiseXPayeeAnalysisSelect
implements MoneyWiseXAnalysisFilterSelection, OceanusEventProvider<PrometheusDataEvent> {
/**
* Text for Payee Label.
*/
private static final String NLS_PAYEE = MoneyWiseBasicDataType.PAYEE.getItemName();
/**
* The Event Manager.
*/
private final OceanusEventManager<PrometheusDataEvent> theEventManager;
/**
* The panel.
*/
private final TethysUIBoxPaneManager thePanel;
/**
* The select button.
*/
private final TethysUIScrollButtonManager<MoneyWiseXAnalysisPayeeBucket> theButton;
/**
* Payee menu.
*/
private final TethysUIScrollMenu<MoneyWiseXAnalysisPayeeBucket> thePayeeMenu;
/**
* The active payee bucket list.
*/
private MoneyWiseXAnalysisPayeeBucketList thePayees;
/**
* The state.
*/
private MoneyWisePayeeState theState;
/**
* The savePoint.
*/
private MoneyWisePayeeState theSavePoint;
/**
* Constructor.
*
* @param pFactory the GUI factory
*/
protected MoneyWiseXPayeeAnalysisSelect(final TethysUIFactory<?> pFactory) {
/* Create the button */
theButton = pFactory.buttonFactory().newScrollButton(MoneyWiseXAnalysisPayeeBucket.class);
/* Create Event Manager */
theEventManager = new OceanusEventManager<>();
/* Create the label */
final TethysUILabel myLabel = pFactory.controlFactory().newLabel(NLS_PAYEE + TethysUIConstant.STR_COLON);
/* Define the layout */
thePanel = pFactory.paneFactory().newHBoxPane();
thePanel.addSpacer();
thePanel.addNode(myLabel);
thePanel.addNode(theButton);
/* Create initial state */
theState = new MoneyWisePayeeState();
theState.applyState();
/* Access the menus */
thePayeeMenu = theButton.getMenu();
/* Create the listeners */
final OceanusEventRegistrar<TethysUIEvent> myRegistrar = theButton.getEventRegistrar();
myRegistrar.addEventListener(TethysUIEvent.NEWVALUE, e -> handleNewPayee());
theButton.setMenuConfigurator(e -> buildPayeeMenu());
}
@Override
public TethysUIComponent getUnderlying() {
return thePanel;
}
@Override
public OceanusEventRegistrar<PrometheusDataEvent> getEventRegistrar() {
return theEventManager.getEventRegistrar();
}
@Override
public MoneyWiseXAnalysisPayeeFilter getFilter() {
return theState.getFilter();
}
@Override
public boolean isAvailable() {
return thePayees != null
&& !thePayees.isEmpty();
}
/**
* Create SavePoint.
*/
public void createSavePoint() {
/* Create the savePoint */
theSavePoint = new MoneyWisePayeeState(theState);
}
/**
* Restore SavePoint.
*/
public void restoreSavePoint() {
/* Restore the savePoint */
theState = new MoneyWisePayeeState(theSavePoint);
/* Apply the state */
theState.applyState();
}
@Override
public void setEnabled(final boolean bEnabled) {
/* Pass call on to button */
theButton.setEnabled(bEnabled && isAvailable());
}
@Override
public void setVisible(final boolean pVisible) {
thePanel.setVisible(pVisible);
}
/**
* Set analysis.
*
* @param pAnalysis the analysis.
*/
public void setAnalysis(final MoneyWiseXAnalysis pAnalysis) {
/* Access buckets */
thePayees = pAnalysis.getPayees();
/* Obtain the current payee */
MoneyWiseXAnalysisPayeeBucket myPayee = theState.getPayee();
/* Switch to versions from the analysis */
myPayee = myPayee != null
? thePayees.getMatchingPayee(myPayee.getPayee())
: thePayees.getDefaultPayee();
/* Set the payee */
theState.setThePayee(myPayee);
theState.setDateRange(pAnalysis.getDateRange());
theState.applyState();
}
@Override
public void setFilter(final MoneyWiseXAnalysisFilter<?, ?> pFilter) {
/* If this is the correct filter type */
if (pFilter instanceof MoneyWiseXAnalysisPayeeFilter myFilter) {
/* Obtain the filter bucket */
MoneyWiseXAnalysisPayeeBucket myPayee = myFilter.getBucket();
/* Obtain equivalent bucket */
myPayee = thePayees.getMatchingPayee(myPayee.getPayee());
/* Set the payee */
theState.setThePayee(myPayee);
theState.setDateRange(myFilter.getDateRange());
theState.applyState();
}
}
/**
* Handle new Payee.
*/
private void handleNewPayee() {
/* Select the new Payee */
if (theState.setPayee(theButton.getValue())) {
theState.applyState();
theEventManager.fireEvent(PrometheusDataEvent.SELECTIONCHANGED);
}
}
/**
* Build Payee menu.
*/
private void buildPayeeMenu() {
/* Reset the popUp menu */
thePayeeMenu.removeAllItems();
/* Record active item */
TethysUIScrollItem<MoneyWiseXAnalysisPayeeBucket> myActive = null;
final MoneyWiseXAnalysisPayeeBucket myCurr = theState.getPayee();
/* Loop through the available payee values */
final Iterator<MoneyWiseXAnalysisPayeeBucket> myIterator = thePayees.iterator();
while (myIterator.hasNext()) {
final MoneyWiseXAnalysisPayeeBucket myBucket = myIterator.next();
/* Create a new MenuItem and add it to the popUp */
final TethysUIScrollItem<MoneyWiseXAnalysisPayeeBucket> myItem = thePayeeMenu.addItem(myBucket);
/* If this is the active bucket */
if (myBucket.equals(myCurr)) {
/* Record it */
myActive = myItem;
}
}
/* Ensure active item is visible */
if (myActive != null) {
myActive.scrollToItem();
}
}
/**
* SavePoint values.
*/
private final class MoneyWisePayeeState {
/**
* The active PayeeBucket.
*/
private MoneyWiseXAnalysisPayeeBucket thePayee;
/**
* The dateRange.
*/
private OceanusDateRange theDateRange;
/**
* The active filter.
*/
private MoneyWiseXAnalysisPayeeFilter theFilter;
/**
* Constructor.
*/
private MoneyWisePayeeState() {
}
/**
* Constructor.
*
* @param pState state to copy from
*/
private MoneyWisePayeeState(final MoneyWisePayeeState pState) {
/* Initialise state */
thePayee = pState.getPayee();
theDateRange = pState.getDateRange();
theFilter = pState.getFilter();
}
/**
* Obtain the Payee Bucket.
*
* @return the Payee
*/
private MoneyWiseXAnalysisPayeeBucket getPayee() {
return thePayee;
}
/**
* Obtain the dateRange.
*
* @return the dateRange
*/
private OceanusDateRange getDateRange() {
return theDateRange;
}
/**
* Obtain the Filter.
*
* @return the Filter
*/
private MoneyWiseXAnalysisPayeeFilter getFilter() {
return theFilter;
}
/**
* Set new Payee.
*
* @param pPayee the Payee
* @return true/false did a change occur
*/
private boolean setPayee(final MoneyWiseXAnalysisPayeeBucket pPayee) {
/* Adjust the selected payee */
if (!MetisDataDifference.isEqual(pPayee, thePayee)) {
setThePayee(pPayee);
return true;
}
return false;
}
/**
* Set the Payee.
*
* @param pPayee the Payee
*/
private void setThePayee(final MoneyWiseXAnalysisPayeeBucket pPayee) {
/* Store the payee */
thePayee = pPayee;
if (thePayee != null) {
theFilter = new MoneyWiseXAnalysisPayeeFilter(thePayee);
theFilter.setDateRange(theDateRange);
} else {
theFilter = null;
}
}
/**
* Set the dateRange.
*
* @param pRange the dateRange
*/
private void setDateRange(final OceanusDateRange pRange) {
/* Store the dateRange */
theDateRange = pRange;
if (theFilter != null) {
theFilter.setDateRange(theDateRange);
}
}
/**
* Apply the State.
*/
private void applyState() {
/* Adjust the lock-down */
setEnabled(true);
theButton.setValue(thePayee);
}
}
}