mirror of
https://github.com/DanilaFe/abacus
synced 2024-12-23 16:00:09 -08:00
Add comments to the JavaFX codebase
This commit is contained in:
parent
189e51c05d
commit
4be4ffd57a
|
@ -6,6 +6,10 @@ import javafx.scene.Parent;
|
||||||
import javafx.scene.Scene;
|
import javafx.scene.Scene;
|
||||||
import javafx.stage.Stage;
|
import javafx.stage.Stage;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The main application class for JavaFX responsible for loading
|
||||||
|
* and displaying the fxml file.
|
||||||
|
*/
|
||||||
public class AbacusApplication extends Application {
|
public class AbacusApplication extends Application {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
|
|
@ -11,9 +11,19 @@ import org.nwapw.abacus.number.NumberInterface;
|
||||||
import org.nwapw.abacus.tree.TreeNode;
|
import org.nwapw.abacus.tree.TreeNode;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The controller for the abacus FX UI, responsible
|
||||||
|
* for all the user interaction.
|
||||||
|
*/
|
||||||
public class AbacusController {
|
public class AbacusController {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constant string that is displayed if the text could not be lexed or parsed.
|
||||||
|
*/
|
||||||
private static final String ERR_SYNTAX = "Syntax Error";
|
private static final String ERR_SYNTAX = "Syntax Error";
|
||||||
|
/**
|
||||||
|
* Constant string that is displayed if the tree could not be reduced.
|
||||||
|
*/
|
||||||
private static final String ERR_EVAL = "Evaluation Error";
|
private static final String ERR_EVAL = "Evaluation Error";
|
||||||
|
|
||||||
@FXML
|
@FXML
|
||||||
|
@ -31,8 +41,15 @@ public class AbacusController {
|
||||||
@FXML
|
@FXML
|
||||||
private Button inputButton;
|
private Button inputButton;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The list of history entries, created by the users.
|
||||||
|
*/
|
||||||
private ObservableList<HistoryModel> historyData;
|
private ObservableList<HistoryModel> historyData;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The abacus instance used for calculations and all
|
||||||
|
* other main processing code.
|
||||||
|
*/
|
||||||
private Abacus abacus;
|
private Abacus abacus;
|
||||||
|
|
||||||
@FXML
|
@FXML
|
||||||
|
|
|
@ -6,8 +6,17 @@ import javafx.scene.input.MouseEvent;
|
||||||
import java.awt.*;
|
import java.awt.*;
|
||||||
import java.awt.datatransfer.StringSelection;
|
import java.awt.datatransfer.StringSelection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A cell that copies its value to the clipboard
|
||||||
|
* when double clicked.
|
||||||
|
* @param <S> The type of the table view generic type.
|
||||||
|
* @param <T> The type of the value contained in the cell.
|
||||||
|
*/
|
||||||
public class CopyableCell<S, T> extends TableCell<S, T> {
|
public class CopyableCell<S, T> extends TableCell<S, T> {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new copyable cell.
|
||||||
|
*/
|
||||||
public CopyableCell(){
|
public CopyableCell(){
|
||||||
addEventFilter(MouseEvent.MOUSE_CLICKED, event -> {
|
addEventFilter(MouseEvent.MOUSE_CLICKED, event -> {
|
||||||
if(event.getClickCount() == 2){
|
if(event.getClickCount() == 2){
|
||||||
|
|
|
@ -3,12 +3,33 @@ package org.nwapw.abacus.fx;
|
||||||
import javafx.beans.property.SimpleStringProperty;
|
import javafx.beans.property.SimpleStringProperty;
|
||||||
import javafx.beans.property.StringProperty;
|
import javafx.beans.property.StringProperty;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The data model used for storing history entries.
|
||||||
|
*/
|
||||||
public class HistoryModel {
|
public class HistoryModel {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The property used for displaying the column
|
||||||
|
* for the user input.
|
||||||
|
*/
|
||||||
private final StringProperty input;
|
private final StringProperty input;
|
||||||
|
/**
|
||||||
|
* The property used for displaying the column
|
||||||
|
* that contains the parsed input.
|
||||||
|
*/
|
||||||
private final StringProperty parsed;
|
private final StringProperty parsed;
|
||||||
|
/**
|
||||||
|
* The property used for displaying the column
|
||||||
|
* that contains the program output.
|
||||||
|
*/
|
||||||
private final StringProperty output;
|
private final StringProperty output;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new history model with the given variables.
|
||||||
|
* @param input the user input
|
||||||
|
* @param parsed the parsed input
|
||||||
|
* @param output the program output.
|
||||||
|
*/
|
||||||
public HistoryModel(String input, String parsed, String output){
|
public HistoryModel(String input, String parsed, String output){
|
||||||
this.input = new SimpleStringProperty();
|
this.input = new SimpleStringProperty();
|
||||||
this.parsed = new SimpleStringProperty();
|
this.parsed = new SimpleStringProperty();
|
||||||
|
@ -18,23 +39,47 @@ public class HistoryModel {
|
||||||
this.output.setValue(output);
|
this.output.setValue(output);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the input property.
|
||||||
|
* @return the input property.
|
||||||
|
*/
|
||||||
public StringProperty inputProperty() {
|
public StringProperty inputProperty() {
|
||||||
return input;
|
return input;
|
||||||
}
|
}
|
||||||
|
/**
|
||||||
|
* Gets the input.
|
||||||
|
* @return the input.
|
||||||
|
*/
|
||||||
public String getInput() {
|
public String getInput() {
|
||||||
return input.get();
|
return input.get();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the parsed input property.
|
||||||
|
* @return the parsed input property.
|
||||||
|
*/
|
||||||
public StringProperty parsedProperty() {
|
public StringProperty parsedProperty() {
|
||||||
return parsed;
|
return parsed;
|
||||||
}
|
}
|
||||||
|
/**
|
||||||
|
* Gets the parsed input.
|
||||||
|
* @return the parsed input.
|
||||||
|
*/
|
||||||
public String getParsed() {
|
public String getParsed() {
|
||||||
return parsed.get();
|
return parsed.get();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the output property.
|
||||||
|
* @return the output property.
|
||||||
|
*/
|
||||||
public StringProperty outputProperty() {
|
public StringProperty outputProperty() {
|
||||||
return output;
|
return output;
|
||||||
}
|
}
|
||||||
|
/**
|
||||||
|
* Gets the program output.
|
||||||
|
* @return the output.
|
||||||
|
*/
|
||||||
public String getOutput() {
|
public String getOutput() {
|
||||||
return output.get();
|
return output.get();
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue
Block a user