Content of file DefaultMainScreenPresentationControl.java
/*
* *********************************************************************************************************************
*
* SteelBlue: DCI User Interfaces
* http://tidalwave.it/projects/steelblue
*
* Copyright (C) 2015 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
*
* *********************************************************************************************************************
*
* 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.
*
* *********************************************************************************************************************
*
* git clone https://bitbucket.org/tidalwave/steelblue-src
* git clone https://github.com/tidalwave-it/steelblue-src
*
* *********************************************************************************************************************
*/
package it.tidalwave.role.ui.javafx.example.large.mainscreen.impl;
import javax.annotation.Nonnull;
import javax.annotation.PostConstruct;
import javax.inject.Inject;
import java.nio.file.Path;
import java.nio.file.Paths;
import it.tidalwave.role.Aggregate;
import it.tidalwave.role.ui.BoundProperty;
import it.tidalwave.role.ui.Displayable;
import it.tidalwave.role.ui.PresentationModel;
import it.tidalwave.role.ui.PresentationModelAggregate;
import it.tidalwave.role.ui.Selectable;
import it.tidalwave.role.ui.UserAction;
import it.tidalwave.role.ui.UserActionProvider;
import it.tidalwave.role.ui.Visible;
import it.tidalwave.role.ui.javafx.example.large.data.Dao;
import it.tidalwave.role.ui.javafx.example.large.data.SimpleDciEntity;
import it.tidalwave.role.ui.javafx.example.large.data.SimpleEntity;
import it.tidalwave.role.ui.javafx.example.large.mainscreen.MainScreenPresentation;
import it.tidalwave.role.ui.javafx.example.large.mainscreen.MainScreenPresentation.Bindings;
import it.tidalwave.role.ui.javafx.example.large.mainscreen.MainScreenPresentationControl;
import static it.tidalwave.util.Parameters.r;
import static it.tidalwave.util.ui.UserNotificationWithFeedback.*;
import static it.tidalwave.role.ui.Presentable._Presentable_;
import static it.tidalwave.role.ui.spi.PresentationModelCollectors.toCompositePresentationModel;
/***********************************************************************************************************************
*
* @stereotype Control
*
* @author Fabrizio Giudici (Fabrizio.Giudici@tidalwave.it)
*
**********************************************************************************************************************/
public class DefaultMainScreenPresentationControl implements MainScreenPresentationControl
{
private static final Path USER_HOME = Paths.get(System.getProperty("user.home"));
// The presentation is injected by the infrastructure in form of its interface.
@Inject
private MainScreenPresentation presentation;
// As usual, also other required objects can be injected.
@Inject
private Dao dao;
// For each button on the presentation that can do something, a UserAction is provided.
private final UserAction buttonAction = UserAction.of(this::onButtonPressed,
Displayable.of("Press me"));
private final UserAction actionDialogOk = UserAction.of(this::onButtonDialogOkPressed,
Displayable.of("Dialog with ok"));
private final UserAction actionDialogCancelOk = UserAction.of(this::onButtonDialogOkCancelPressed,
Displayable.of("Dialog with ok/cancel"));
private final UserAction actionPickFile = UserAction.of(this::onButtonPickFilePressed,
Displayable.of("Pick file"));
private final UserAction actionPickDirectory = UserAction.of(this::onButtonPickDirectoryPressed,
Displayable.of("Pick directory"));
private final Bindings bindings = Bindings.builder()
.buttonAction(buttonAction)
.actionDialogOk(actionDialogOk)
.actionDialogCancelOk(actionDialogCancelOk)
.actionPickFile(actionPickFile)
.actionPickDirectory(actionPickDirectory)
.build();
// Then there can be a set of variables that represent the internal state of the control.
private int status = 1;
/*******************************************************************************************************************
*
* At {@link PostConstruct} time the control just performs the binding to the presentation.
*
******************************************************************************************************************/
@PostConstruct
private void initialize()
Avoid unused private methods such as 'initialize()'.
Unused Private Method detects when a private method is declared but is unused.
public class Something {
private void foo() {} // unused
}
{
presentation.bind(bindings);
}
/*******************************************************************************************************************
*
* {@inheritDoc}
*
* This method demonstrates the typical idiom for populating data:
*
* 1. A dao is called to provide raw data - let's say in form of collections;
* 2. Objects in the collection are transformed into PresentationModels.
* 3. The PresentationModels are then passed to the presentation.
*
******************************************************************************************************************/
@Override
public void start()
{
presentation.showUp();
final var entities1 = dao.getSimpleEntities();
final var entities2 = dao.getDciEntities();
final var files = dao.getFiles();
final var pm1 = entities1.stream().map(this::pmFor).collect(toCompositePresentationModel());
final var pm2 = entities2.stream().map(this::pmFor).collect(toCompositePresentationModel());
final var pm3 = files.stream().map(item -> item.as(_Presentable_).createPresentationModel())
.collect(toCompositePresentationModel(r(Visible.INVISIBLE)));
presentation.populate(pm1, pm2, pm3);
}
/*******************************************************************************************************************
*
* Factory method for the PresentationModel of SimpleEntity instances.
*
* It aggregates a few extra roles into the PresentationModel that are used by the control, such as callbacks
* for action associated to the context menu. Also a Displayable role is usually injected to control the rendering
* of entities.
*
******************************************************************************************************************/
@Nonnull
private PresentationModel pmFor (@Nonnull final SimpleEntity entity)
{
final Selectable selectable = () -> onSelected(entity);
final var action1 = UserAction.of(() -> action1(entity), Displayable.of("Action 1"));
final var action2 = UserAction.of(() -> action2(entity), Displayable.of("Action 2"));
final var action3 = UserAction.of(() -> action3(entity), Displayable.of("Action 3"));
return PresentationModel.of(entity, r(Displayable.of("Item #" + entity.getName()),
selectable,
UserActionProvider.of(action1, action2, action3)));
}
/*******************************************************************************************************************
*
* Factory method for the PresentationModel of SimpleDciEntity instances.
*
******************************************************************************************************************/
@Nonnull
private PresentationModel pmFor (@Nonnull final SimpleDciEntity entity)
{
// FIXME: column names
final Aggregate<PresentationModel> aggregate = PresentationModelAggregate.newInstance()
.withPmOf("C1", r(Displayable.of(entity.getName())))
.withPmOf("C2", r(Displayable.of("" + entity.getAttribute1())))
.withPmOf("C3", r(Displayable.of("" + entity.getAttribute2())));
final Selectable selectable = () -> onSelected(entity);
final var action1 = UserAction.of(() -> action1(entity), Displayable.of("Action 1"));
final var action2 = UserAction.of(() -> action2(entity), Displayable.of("Action 2"));
final var action3 = UserAction.of(() -> action3(entity), Displayable.of("Action 3"));
// No explicit Displayable here, as the one inside SimpleDciEntity is used.
return PresentationModel.of(entity, r(aggregate, selectable, UserActionProvider.of(action1, action2, action3)));
}
// Below simple business methonds, as per usual business.
/*******************************************************************************************************************
*
******************************************************************************************************************/
private void onButtonPressed()
{
presentation.notify("Button pressed");
status++;
bindings.textProperty.set(Integer.toString(status));
}
/*******************************************************************************************************************
*
******************************************************************************************************************/
private void onButtonDialogOkPressed()
{
presentation.notify(notificationWithFeedback()
.withCaption("Notification")
.withText("Now press the button")
.withFeedback(feedback().withOnConfirm(() -> presentation.notify("Pressed ok"))));
}
/*******************************************************************************************************************
*
******************************************************************************************************************/
private void onButtonDialogOkCancelPressed()
{
presentation.notify(notificationWithFeedback()
.withCaption("Notification")
.withText("Now press the button")
.withFeedback(feedback().withOnConfirm(() -> presentation.notify("Pressed ok"))
.withOnCancel(() -> presentation.notify("Pressed cancel"))));
}
/*******************************************************************************************************************
*
* This method demonstrates how to pick a file name by using the proper UI dialog.
*
******************************************************************************************************************/
private void onButtonPickFilePressed()
{
final var selectedFile = new BoundProperty<>(USER_HOME);
presentation.pickFile(selectedFile,
notificationWithFeedback()
.withCaption("Pick a file")
.withFeedback(feedback().withOnConfirm(() -> presentation.notify("Selected file: " + selectedFile.get()))
.withOnCancel(() -> presentation.notify("Selection cancelled"))));
}
/*******************************************************************************************************************
*
* This method demonstrates how to pick a directory name by using the proper UI dialog.
*
******************************************************************************************************************/
private void onButtonPickDirectoryPressed()
{
final var selectedFolder = new BoundProperty<>(USER_HOME);
presentation.pickDirectory(selectedFolder,
notificationWithFeedback()
.withCaption("Pick a directory")
.withFeedback(feedback().withOnConfirm(() -> presentation.notify("Selected folder: " + selectedFolder.get()))
.withOnCancel(() -> presentation.notify("Selection cancelled"))));
}
/*******************************************************************************************************************
*
******************************************************************************************************************/
private void onSelected (@Nonnull final Object object)
{
presentation.notify("Selected " + object);
}
/*******************************************************************************************************************
*
******************************************************************************************************************/
private void action1 (@Nonnull final Object object)
{
presentation.notify("Action 1 on " + object);
}
/*******************************************************************************************************************
*
******************************************************************************************************************/
private void action2 (@Nonnull final Object object)
{
presentation.notify("Action 2 on " + object);
}
/*******************************************************************************************************************
*
******************************************************************************************************************/
private void action3 (@Nonnull final Object object)
{
presentation.notify("Action 3 on " + object);
}
}
![[Jenkins]](/ci/static/0840cea4/images/svgs/logo.svg){kind=logo}
