org.controlsfx.samples.spreadsheet.HelloSpreadsheetView Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of controlsfx-samples Show documentation
Show all versions of controlsfx-samples Show documentation
High quality UI controls and other tools to complement the core JavaFX distribution
The newest version!
/**
* Copyright (c) 2013, 2016 ControlsFX
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of ControlsFX, any associated website, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL CONTROLSFX BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.controlsfx.samples.spreadsheet;
import java.awt.Desktop;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.time.LocalDate;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javafx.beans.value.ChangeListener;
import javafx.beans.value.ObservableValue;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.geometry.Insets;
import javafx.scene.Node;
import javafx.scene.control.Alert;
import javafx.scene.control.CheckBox;
import javafx.scene.control.Hyperlink;
import javafx.scene.control.Label;
import javafx.scene.control.SelectionMode;
import javafx.scene.control.Slider;
import javafx.scene.image.Image;
import javafx.scene.image.ImageView;
import javafx.scene.layout.GridPane;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;
import org.controlsfx.ControlsFXSample;
import org.controlsfx.control.spreadsheet.GridBase;
import org.controlsfx.control.spreadsheet.Picker;
import org.controlsfx.control.spreadsheet.SpreadsheetCell;
import org.controlsfx.control.spreadsheet.SpreadsheetCellBase;
import org.controlsfx.control.spreadsheet.SpreadsheetCellType;
import org.controlsfx.control.spreadsheet.SpreadsheetView;
import org.controlsfx.samples.Utils;
/**
*
* Build the UI and launch the Application
*/
public class HelloSpreadsheetView extends ControlsFXSample {
public static void main(String[] args) {
launch(args);
}
private SpreadsheetView spreadSheetView;
private StackPane centerPane;
private final CheckBox rowHeader = new CheckBox();
private final CheckBox columnHeader = new CheckBox();
private final CheckBox selectionMode = new CheckBox();
private final CheckBox displaySelection = new CheckBox();
private final CheckBox editable = new CheckBox();
@Override
public String getSampleName() {
return "SpreadsheetView";
}
@Override
public String getSampleDescription() {
return "The SpreadsheetView is a control similar to the JavaFX TableView control "
+ "but with different functionalities and use cases. The aim is to have a "
+ "powerful grid where data can be written and retrieved.\n\n"
+ "Here you have an example where some information about fictive "
+ "companies are displayed. They have different type and format.\n\n"
+ "After that, some random generated cells are displayed with some span.\n\n"
+ "Don't forget to right-click on headers and cells to discover some features.";
}
@Override
public String getControlStylesheetURL() {
return "/org/controlsfx/samples/spreadsheetSample.css";
}
@Override
public Node getPanel(Stage stage) {
spreadSheetView = new SpreadsheetViewExample();
centerPane = new StackPane(spreadSheetView);
return centerPane;
}
@Override
public Node getControlPanel() {
return buildCommonControlGrid();
}
@Override
public String getJavaDocURL() {
return Utils.JAVADOC_BASE + "org/controlsfx/control/spreadsheet/SpreadsheetView.html";
}
/**
* Build a common control Grid with some options on the left to control the
* SpreadsheetViewInternal
*
* @param gridType
*
* @param spreadsheetView
* @return
*/
private GridPane buildCommonControlGrid() {
final GridPane grid = new GridPane();
grid.setHgap(5);
grid.setVgap(5);
grid.setPadding(new Insets(5, 5, 5, 5));
int row = 0;
// row header
Label rowHeaderLabel = new Label("Row header: ");
rowHeaderLabel.getStyleClass().add("property");
grid.add(rowHeaderLabel, 0, row);
rowHeader.setSelected(true);
spreadSheetView.setShowRowHeader(true);
grid.add(rowHeader, 1, row++);
rowHeader.selectedProperty().addListener(new ChangeListener() {
@Override
public void changed(ObservableValue arg0, Boolean arg1, Boolean arg2) {
spreadSheetView.setShowRowHeader(arg2);
}
});
// column header
Label columnHeaderLabel = new Label("Column header: ");
columnHeaderLabel.getStyleClass().add("property");
grid.add(columnHeaderLabel, 0, row);
columnHeader.setSelected(true);
spreadSheetView.setShowColumnHeader(true);
grid.add(columnHeader, 1, row++);
columnHeader.selectedProperty().addListener(new ChangeListener() {
@Override
public void changed(ObservableValue arg0, Boolean arg1, Boolean arg2) {
spreadSheetView.setShowColumnHeader(arg2);
}
});
// editable
Label editableLabel = new Label("Editable: ");
editableLabel.getStyleClass().add("property");
grid.add(editableLabel, 0, row);
editable.setSelected(true);
spreadSheetView.setEditable(true);
grid.add(editable, 1, row++);
spreadSheetView.editableProperty().bind(editable.selectedProperty());
//Row Header width
Label rowHeaderWidth = new Label("Row header width: ");
rowHeaderWidth.getStyleClass().add("property");
grid.add(rowHeaderWidth, 0, row);
Slider slider = new Slider(15, 100, 30);
spreadSheetView.rowHeaderWidthProperty().bind(slider.valueProperty());
grid.add(slider, 1, row++);
//Zoom
Label zoom = new Label("Zoom: ");
zoom.getStyleClass().add("property");
grid.add(zoom, 0, row);
Slider sliderZoom = new Slider(0.25, 2, 1);
spreadSheetView.zoomFactorProperty().bindBidirectional(sliderZoom.valueProperty());
grid.add(sliderZoom, 1, row++);
// Multiple Selection
Label selectionModeLabel = new Label("Multiple selection: ");
selectionModeLabel.getStyleClass().add("property");
grid.add(selectionModeLabel, 0, row);
selectionMode.setSelected(true);
grid.add(selectionMode, 1, row++);
selectionMode.selectedProperty().addListener(new ChangeListener() {
@Override
public void changed(ObservableValue arg0, Boolean arg1, Boolean isSelected) {
spreadSheetView.getSelectionModel().clearSelection();
spreadSheetView.getSelectionModel().setSelectionMode(isSelected ? SelectionMode.MULTIPLE : SelectionMode.SINGLE);
}
});
// Display selection
Label displaySelectionLabel = new Label("Display selection: ");
displaySelectionLabel.getStyleClass().add("property");
grid.add(displaySelectionLabel, 0, row);
displaySelection.setSelected(true);
grid.add(displaySelection, 1, row++);
displaySelection.selectedProperty().addListener(new ChangeListener() {
@Override
public void changed(ObservableValue arg0, Boolean arg1, Boolean isSelected) {
spreadSheetView.getGrid().setDisplaySelection(isSelected);
spreadSheetView.getSelectionModel().clearSelection();
}
});
return grid;
}
public class SpreadsheetViewExample extends SpreadsheetView {
/**
* List for custom cells
*/
private final List companiesList = Arrays.asList("", "ControlsFX", "Aperture Science",
"Rapture", "Ammu-Nation", "Nuka-Cola", "Pay'N'Spray", "Umbrella Corporation");
private final List countryList = Arrays.asList("China", "France", "New Zealand",
"United States", "Germany", "Canada");
private final List logoList = Arrays.asList("", "ControlsFX.png", "apertureLogo.png",
"raptureLogo.png", "ammunationLogo.JPG", "nukaColaLogo.png", "paynsprayLogo.jpg", "umbrellacorporation.png");
private final List webSiteList = Arrays.asList("", "http://fxexperience.com/controlsfx/",
"http://aperturescience.com/", "", "http://fr.gta.wikia.com/wiki/Ammu-Nation",
"http://e-shop.nuka-cola.eu/", "http://fr.gta.wikia.com/wiki/Pay_%27n%27_Spray",
"http://www.umbrellacorporation.net/");
public SpreadsheetViewExample() {
int rowCount = 31; //Will be re-calculated after if incorrect.
int columnCount = 8;
GridBase grid = new GridBase(rowCount, columnCount);
grid.setRowHeightCallback(new GridBase.MapBasedRowHeightFactory(generateRowHeight()));
buildGrid(grid);
setGrid(grid);
generatePickers();
getFixedRows().add(0);
getColumns().get(0).setFixed(true);
getColumns().get(1).setPrefWidth(250);
getStylesheets().add(Utils.class.getResource("spreadsheetSample.css").toExternalForm());
}
/**
* Add some pickers into the SpreadsheetView in order to give some
* information.
*/
private void generatePickers() {
getRowPickers().put(0, new Picker() {
@Override
public void onClick() {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setContentText("This row contains several fictive companies. "
+ "The cells are not editable.\n"
+ "A custom tooltip is applied for the first cell.");
alert.show();
}
});
getRowPickers().put(1, new Picker() {
@Override
public void onClick() {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setContentText("This row contains cells that can only show a list.");
alert.show();
}
});
getRowPickers().put(2, new Picker() {
@Override
public void onClick() {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setContentText("This row contains cells that display some dates.");
alert.show();
}
});
getRowPickers().put(3, new Picker() {
@Override
public void onClick() {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setContentText("This row contains some Images displaying logos of the companies.");
alert.show();
}
});
getRowPickers().put(4, new Picker() {
@Override
public void onClick() {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setContentText("This row contains Double editable cells. "
+ "Except for ControlsFX compagny where it's a String.");
alert.show();
}
});
getRowPickers().put(5, new Picker("picker-label", "picker-label-exclamation") {
@Override
public void onClick() {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setContentText("This row contains Double editable cells with "
+ "a special format (%). Some cells also have "
+ "a little icon next to their value.");
alert.show();
}
});
getColumnPickers().put(0, new Picker("picker-label", "picker-label-security") {
@Override
public void onClick() {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setContentText("Each cell of this column (except for the "
+ "separator in the middle) has a particular css "
+ "class for changing its color.\n");
alert.show();
}
});
}
/**
* Specify a custom row height.
*
* @return
*/
private Map generateRowHeight() {
Map rowHeight = new HashMap<>();
rowHeight.put(1, 100.0);
return rowHeight;
}
/**
* Randomly generate a {@link SpreadsheetCell}.
*/
private SpreadsheetCell generateCell(int row, int column, int rowSpan, int colSpan) {
SpreadsheetCell cell;
List cityList = Arrays.asList("Shanghai", "Paris", "New York City", "Bangkok",
"Singapore", "Johannesburg", "Berlin", "Wellington", "London", "Montreal");
final double random = Math.random();
if (random < 0.25) {
cell = SpreadsheetCellType.LIST(countryList).createCell(row, column, rowSpan, colSpan,
countryList.get((int) (Math.random() * 6)));
} else if (random >= 0.25 && random < 0.5) {
cell = SpreadsheetCellType.STRING.createCell(row, column, rowSpan, colSpan,
cityList.get((int) (Math.random() * 10)));
} else if (random >= 0.5 && random < 0.75) {
cell = generateNumberCell(row, column, rowSpan, colSpan);
} else {
cell = generateDateCell(row, column, rowSpan, colSpan);
}
// Styling for preview
if (row % 5 == 0) {
cell.getStyleClass().add("five_rows");
}
return cell;
}
/**
* Generate a Date Cell with a random format.
*
* @param row
* @param column
* @param rowSpan
* @param colSpan
* @return
*/
private SpreadsheetCell generateDateCell(int row, int column, int rowSpan, int colSpan) {
SpreadsheetCell cell = SpreadsheetCellType.DATE.createCell(row, column, rowSpan, colSpan, LocalDate.now()
.plusDays((int) (Math.random() * 10)));
final double random = Math.random();
if (random < 0.25) {
cell.setFormat("EEEE d");
} else if (random < 0.5) {
cell.setFormat("dd/MM :YY");
} else {
cell.setFormat("dd/MM/YYYY");
}
return cell;
}
/**
* Generate a Number Cell with a random format.
*
* @param row
* @param column
* @param rowSpan
* @param colSpan
* @return
*/
private SpreadsheetCell generateNumberCell(int row, int column, int rowSpan, int colSpan) {
final double random = Math.random();
SpreadsheetCell cell;
if (random < 0.3) {
cell = SpreadsheetCellType.INTEGER.createCell(row, column, rowSpan, colSpan,
Math.round((float) Math.random() * 100));
} else {
cell = SpreadsheetCellType.DOUBLE.createCell(row, column, rowSpan, colSpan,
(double) Math.round((Math.random() * 100) * 100) / 100);
final double randomFormat = Math.random();
if (randomFormat < 0.25) {
cell.setFormat("#,##0.00" + "\u20AC");
} else if (randomFormat < 0.5) {
cell.setFormat("0.###E0 km/h");
} else {
cell.setFormat("0.###E0");
}
}
return cell;
}
/**
* Generate a Double Cell
*
* @param row
* @param column
* @param rowSpan
* @param colSpan
* @return
*/
private SpreadsheetCell generateDoubleCell(int row, int column, int rowSpan, int colSpan) {
final double random = Math.random();
SpreadsheetCell cell;
cell = SpreadsheetCellType.DOUBLE.createCell(row, column, rowSpan, colSpan,
(double) Math.round((random * 100) * 100) / 100);
return cell;
}
/**
* Return a List of SpreadsheetCell displaying the companies.
*
* @param grid
* @param row
* @return
*/
private ObservableList getCompanies(GridBase grid, int row) {
final ObservableList companies = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, 0, 1, 1, "Company : ");
((SpreadsheetCellBase) cell).setTooltip("This cell displays a custom toolTip.");
cell.setEditable(false);
companies.add(cell);
for (int column = 1; column < grid.getColumnCount(); ++column) {
cell = SpreadsheetCellType.STRING.createCell(row, column, 1, 1,
companiesList.get(column));
cell.setEditable(false);
cell.getStyleClass().add("compagny");
companies.add(cell);
}
return companies;
}
/**
* Return a row with some countries.
*
* @param grid
* @param row
* @return
*/
private ObservableList getCountries(GridBase grid, int row) {
final ObservableList countries = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, 0, 1, 1, "Countries");
cell.setEditable(false);
cell.getStyleClass().add("first-cell");
countries.add(cell);
for (int column = 1; column < grid.getColumnCount(); ++column) {
cell = SpreadsheetCellType.LIST(countryList).createCell(row, column, 1, 1,
countryList.get((int) (Math.random() * 6)));
countries.add(cell);
}
return countries;
}
/**
* Return a row with some dates.
*
* @param grid
* @param row
* @return
*/
private ObservableList getStartDate(GridBase grid, int row) {
final ObservableList startDate = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, 0, 1, 1, "Start day");
cell.setEditable(false);
cell.getStyleClass().add("first-cell");
startDate.add(cell);
for (int column = 1; column < grid.getColumnCount(); ++column) {
startDate.add(generateDateCell(row, column, 1, 1));
}
return startDate;
}
/**
* Return a row with some Images.
*
* @param grid
* @param row
* @return
*/
private ObservableList getLogos(GridBase grid, int row) {
final ObservableList logos = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, 0, 1, 1, "Logo");
cell.setEditable(false);
cell.getStyleClass().add("first-cell");
logos.add(cell);
for (int column = 1; column < grid.getColumnCount(); ++column) {
cell = SpreadsheetCellType.STRING.createCell(row, column, 1, 1, null);
cell.setGraphic(new ImageView(new Image(Utils.class.getResourceAsStream(logoList.get(column)))));
cell.getStyleClass().add("logo");
cell.setEditable(false);
logos.add(cell);
}
return logos;
}
/**
* Return a row with Double.
*
* @param grid
* @param row
* @return
*/
private ObservableList getIncome(GridBase grid, int row) {
final ObservableList incomes = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, 0, 1, 1, "Income");
cell.setEditable(false);
cell.getStyleClass().add("first-cell");
incomes.add(cell);
SpreadsheetCell cell2 = SpreadsheetCellType.STRING.createCell(row, 1, 1, 1, "It's over 9000!");
incomes.add(cell2);
for (int column = 2; column < grid.getColumnCount(); ++column) {
cell = generateDoubleCell(row, column, 1, 1);
cell.setFormat("#,##0.00" + "\u20AC");
incomes.add(cell);
}
return incomes;
}
/**
* Return a row with Double.
*
* @param grid
* @param row
* @return
*/
private ObservableList getIncrease(GridBase grid, int row) {
final ObservableList increase = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, 0, 1, 1, "Increase");
cell.setEditable(false);
cell.getStyleClass().add("first-cell");
increase.add(cell);
for (int column = 1; column < grid.getColumnCount(); ++column) {
cell = SpreadsheetCellType.DOUBLE.createCell(row, column, 1, 1, (double) Math.random());
if (column % 2 == 1) {
cell.setGraphic(new ImageView(new Image(Utils.class.getResourceAsStream("exclamation.png"))));
}
cell.setFormat("#" + "%");
increase.add(cell);
}
return increase;
}
/**
* Return a List with Integer.
*
* @param grid
* @param row
* @return
*/
private ObservableList getEmployees(GridBase grid, int row) {
final ObservableList employees = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, 0, 1, 1, "Number of employees");
cell.setEditable(false);
cell.getStyleClass().add("first-cell");
employees.add(cell);
for (int column = 1; column < grid.getColumnCount(); ++column) {
cell = SpreadsheetCellType.INTEGER.createCell(row, column, 1, 1,
Math.round((float) Math.random() * 10));
employees.add(cell);
}
return employees;
}
/**
* Return a row with some URL.
*
* @param grid
* @param row
* @return
*/
private ObservableList getWebSite(GridBase grid, int row) {
final ObservableList employees = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, 0, 1, 1, "WebSite ");
cell.setEditable(false);
cell.getStyleClass().add("first-cell");
employees.add(cell);
for (int column = 1; column < grid.getColumnCount(); ++column) {
cell = SpreadsheetCellType.STRING.createCell(row, column, 1, 1, null);
Hyperlink link = new Hyperlink(webSiteList.get(column));
Desktop desktop = Desktop.isDesktopSupported() ? Desktop.getDesktop() : null;
URI uri;
try {
uri = new URI(link.getText());
if (desktop != null && desktop.isSupported(Desktop.Action.BROWSE)) {
link.setOnAction(new EventHandler() {
@Override
public void handle(ActionEvent t) {
try {
desktop.browse(uri);
} catch (IOException ex) {
}
}
});
}
} catch (URISyntaxException ex) {
}
cell.setGraphic(link);
cell.setEditable(false);
employees.add(cell);
}
return employees;
}
/**
* Return a row with blank non editable cell.
*
* @param grid
* @param row
* @return
*/
private ObservableList getSeparator(GridBase grid, int row) {
final ObservableList separator = FXCollections.observableArrayList();
for (int column = 0; column < grid.getColumnCount(); ++column) {
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(row, column, 1, 1, "");
cell.setEditable(false);
cell.getStyleClass().add("separator");
separator.add(cell);
}
return separator;
}
/**
* Build the grid.
*
* @param grid
*/
private void buildGrid(GridBase grid) {
ObservableList> rows = FXCollections.observableArrayList();
int rowIndex = 0;
rows.add(getCompanies(grid, rowIndex++));
rows.add(getCountries(grid, rowIndex++));
rows.add(getStartDate(grid, rowIndex++));
rows.add(getLogos(grid, rowIndex++));
rows.add(getIncome(grid, rowIndex++));
rows.add(getIncrease(grid, rowIndex++));
rows.add(getEmployees(grid, rowIndex++));
rows.add(getWebSite(grid, rowIndex++));
//Separators
rows.add(getSeparator(grid, rowIndex++));
rows.add(getSeparator(grid, rowIndex++));
rows.add(getSeparator(grid, rowIndex++));
for (int i = rowIndex; i < rowIndex + 1000; ++i) {
final ObservableList randomRow = FXCollections.observableArrayList();
SpreadsheetCell cell = SpreadsheetCellType.STRING.createCell(i, 0, 1, 1, "Random " + (i + 1));
cell.getStyleClass().add("first-cell");
randomRow.add(cell);
for (int column = 1; column < grid.getColumnCount(); column++) {
randomRow.add(generateCell(i, column, 1, 1));
}
rows.add(randomRow);
}
grid.setRows(rows);
grid.getRows().get(15).get(1).getStyleClass().add("span");
grid.spanRow(2, 15, 1);
grid.spanColumn(2, 15, 1);
grid.getRows().get(18).get(1).getStyleClass().add("span");
grid.spanColumn(4, 18, 1);
grid.getRows().get(19).get(1).getStyleClass().add("span");
grid.spanRow(3, 19, 1);
}
}
}