Namespace org.visab.gui

This package contains (currently) prototypical implementations for the revised / enriched GUI of VISAB.

The new GUI needs to meet different requirements than the legacy one. To support different games and make the application actually scalable VISAB will feature the MVVM (Model, View, Viewmodel) pattern. The basic idea is to have a view that is actually only responsible for displaying the information as an access point. The viewmodel is directly connected with the view by "databinding" which enables both of these objects to always have the same value. Furthermore the viewmodel handles modifications to the UI status when information changes. At least there should be a model connected to the viewmodel to further abstract all business logic from the actual views. Any processing of information or access to other sources shall be handled by this underlying model. MVVMFX GitHub project

Classes

AppMain

The javafx application.

DialogHelper

Helper class for showing dialogs and views from the viewmodel without violating the MVVM pattern. Every class inheriting ViewModelBase has an instance of the DialogHelper.

DynamicViewLoader

The DynamicViewLoader provides methods for loading visualizer views based on a given game name. Views may be loaded from a transmission session or from a file. As a basis for deciding which view should be loaded, the mappings defined in the json configuration file are used.

GeneralScope

General scope that can be injected into viewmodels whose views are loaded by the DialogHelper. Its purpose is to provide access to events of the stage that the view is living in. Currenlty used only for reacting to the OnStageClosing event.

ResourceHelper

Class containing constants and helper methods for obtaining resources from the resource directory. Used mainly by the views, but is also used for loading configuration files.

ShowViewConfiguration

Configuration for showing views from the viewmodel via the dialog helper.

UiHelper

Class containing Helper methods for modifying the Ui.

ViewModelBase

The base viewmodel implementation should be used instead of implementing ViewModel yourself.