org.diirt.javafx.graphene.BaseGraphApp Maven / Gradle / Ivy
/**
* Copyright (C) 2010-18 diirt developers. See COPYRIGHT.TXT
* All rights reserved. Use is subject to license terms. See LICENSE.TXT
*/
package org.diirt.javafx.graphene;
import javafx.application.Application;
import javafx.beans.property.ReadOnlyProperty;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.geometry.Insets;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.ComboBox;
import javafx.scene.control.Label;
import javafx.scene.layout.BorderPane;
import javafx.scene.layout.ColumnConstraints;
import javafx.scene.layout.GridPane;
import javafx.scene.layout.Priority;
import javafx.stage.Stage;
/**
* Allows the user to select some form of data (e.g. a Gaussian wave or a sine
* wave), and graphs it with some available configurations (e.g. modifying the
* interpolation scheme).
*
* To produce a custom graph app, e.g. a BubbleGraphApp, you first extend the
* BaseGraphApp. You must also create a custom graph view, e.g. a BubbleGraphView,
* by extending the BaseGraphView. Details on how to create the BaseGraphView
* are available in the documentation for that class. When you have the BaseGraphView, you
* can override the getGraphView() method to return that.
*
*
* Then, you add some data formulae to the app, using
*
*
* addDataFormulae( "[formula 1]", "[formula 2]" , ... )
*
*
* This can be done by overriding the start() method and adding the data formulae
* there
*
* @see BaseGraphView
* @see ConfigurationDialog
* @author mjchao
*/
abstract public class BaseGraphApp extends Application {
private final DataSelectionPanel pnlData = new DataSelectionPanel();
private BaseGraphView pnlGraph;
private MessagePanel pnlError;
abstract public BaseGraphView getGraphView();
@Override
public void start( Stage stage ) throws Exception {
this.pnlGraph = getGraphView();
this.pnlError = new MessagePanel( pnlGraph.lastExceptionProperty() );
BorderPane mainPanel = new BorderPane();
mainPanel.setTop( this.pnlData );
mainPanel.setCenter( this.pnlGraph );
mainPanel.setBottom( this.pnlError );
//allow components to shrink
this.pnlData.setMinSize( 0 , 0 );
this.pnlGraph.setMinSize( 0 , 0 );
this.pnlError.setMinSize( 0 , 0 );
Scene scene = new Scene( mainPanel );
stage.setTitle( "diirt - BaseGraphApp" );
stage.setScene( scene );
stage.setWidth( 500 );
stage.setHeight( 500 );
stage.show();
}
/**
* Adds the given data formulae to the list of acceptable data formulae
* for this graphing application.
*
* @param formulae the formulae to add
*/
public void addDataFormulae( String... formulae ) {
for ( String s : formulae ) {
this.pnlData.addDataFormulae( s );
}
}
/**
* Panel allowing the user to select some data to graph.
*/
private class DataSelectionPanel extends BorderPane {
/**
* the allowed data formulae are stored here and the user can
* select from this list
*/
final private Label lblData = new Label( "Data:" );
final private ComboBox cboSelectData = new ComboBox();
final private Button cmdConfigure = new Button( "Configure..." );
public DataSelectionPanel() {
this.setPadding( new Insets( 5 , 5 , 5 , 5 ) );
GridPane pnlCenter = new GridPane();
pnlCenter.setHgap( 5 );
this.cboSelectData.setPrefWidth( 0 );
pnlCenter.addRow( 0 , this.lblData , this.cboSelectData , this.cmdConfigure );
ColumnConstraints allowResize = new ColumnConstraints();
allowResize.setHgrow( Priority.ALWAYS );
ColumnConstraints noResize = new ColumnConstraints();
pnlCenter.getColumnConstraints().addAll( noResize , allowResize , noResize );
this.setCenter( pnlCenter );
//allow the combo box to stretch out and fill panel completely
this.cboSelectData.setMaxSize( Double.MAX_VALUE , Double.MAX_VALUE );
this.cboSelectData.setEditable( true );
//watches for when the user selects a new data formula
cboSelectData.valueProperty().addListener( new ChangeListener< String >() {
@Override
public void changed(ObservableValue observable, String oldValue, String newValue) {
pnlGraph.setFormula(newValue);
}
});
this.cmdConfigure.setOnAction( new EventHandler< ActionEvent >() {
@Override
public void handle(ActionEvent event) {
openConfigurationPanel();
}
});
}
/**
* Adds the given data formulae objects to the list of acceptable
* data formulae.
*
* @param f the data formula objects to add
*/
final public void addDataFormulae( String... s ) {
this.cboSelectData.getItems().addAll( s );
if ( cboSelectData.getItems().size() > 0 ) {
this.cboSelectData.setValue( this.cboSelectData.getItems().get( 0 ) );
}
}
}
/**
* Shows the configuration panel that allows the user to configure properties
* of the graph, such as its interpolation scheme or its x column. Override
* this to show custom configuration panels for specific graph types.
*/
public void openConfigurationPanel() {
// TODO: we should have BaseGraphView have a standard openConfigurationDialog
//do nothing, by default
}
/**
* Panel for displaying any messages that may be received from the data
* source.
*/
private class MessagePanel extends BorderPane {
final private Label lblMessage = new Label();
final private ReadOnlyProperty< Exception > lastException;
public MessagePanel( ReadOnlyProperty< Exception > lastException ) {
this.setCenter( lblMessage );
this.lastException = lastException;
this.lastException.addListener( new ChangeListener< Exception >() {
@Override
public void changed(ObservableValue observable, Exception oldValue, Exception newValue) {
setMessage( newValue == null? "" : newValue.getMessage() );
}
});
}
public void setMessage( String message ) {
this.lblMessage.setText( message );
}
}
}