Skip to content
This repository was archived by the owner on Dec 19, 2021. It is now read-only.

Commit d03c70d

Browse files
OctogonapusPeterJohnson
Octogonapus
authored and
PeterJohnson
committed
Partial fix for #64 editable array elements (#66)
* Added drag and drop to arrays * Added documentation and tests Partially fixes #64.
1 parent c17a759 commit d03c70d

21 files changed

+956
-132
lines changed

‎src/main/java/edu/wpi/first/outlineviewer/controller/MainWindowController.java

+19-15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package edu.wpi.first.outlineviewer.controller;
22

3+
import com.google.common.primitives.Bytes;
34
import edu.wpi.first.networktables.NetworkTableEntry;
45
import edu.wpi.first.networktables.NetworkTableValue;
56
import edu.wpi.first.networktables.PersistentException;
@@ -18,29 +19,29 @@
1819
import edu.wpi.first.outlineviewer.view.dialog.AddStringArrayDialog;
1920
import edu.wpi.first.outlineviewer.view.dialog.AddStringDialog;
2021
import edu.wpi.first.outlineviewer.view.dialog.PreferencesDialog;
22+
import java.io.File;
23+
import java.io.IOException;
24+
import java.util.Arrays;
25+
import java.util.List;
26+
import java.util.function.BiConsumer;
27+
import java.util.stream.Collectors;
2128
import javafx.beans.property.ReadOnlyStringWrapper;
2229
import javafx.fxml.FXML;
30+
import javafx.scene.control.Alert;
31+
import javafx.scene.control.ButtonType;
32+
import javafx.scene.control.ContextMenu;
33+
import javafx.scene.control.MenuItem;
34+
import javafx.scene.control.SelectionMode;
35+
import javafx.scene.control.SeparatorMenuItem;
2336
import javafx.scene.control.TreeItem;
2437
import javafx.scene.control.TreeTableColumn;
25-
import javafx.scene.control.SelectionMode;
26-
import javafx.scene.control.TreeTableView;
2738
import javafx.scene.control.TreeTableRow;
28-
import javafx.scene.control.ContextMenu;
29-
import javafx.scene.control.SeparatorMenuItem;
30-
import javafx.scene.control.MenuItem;
31-
import javafx.scene.control.ButtonType;
32-
import javafx.scene.control.Alert;
39+
import javafx.scene.control.TreeTableView;
3340
import javafx.scene.control.cell.TreeItemPropertyValueFactory;
3441
import javafx.scene.input.KeyCode;
3542
import javafx.scene.input.MouseEvent;
3643
import javafx.scene.layout.Pane;
3744
import javafx.stage.FileChooser;
38-
39-
import java.io.File;
40-
import java.io.IOException;
41-
import java.util.Arrays;
42-
import java.util.List;
43-
import java.util.function.BiConsumer;
4445
import javafx.stage.Modality;
4546
import javafx.stage.StageStyle;
4647

@@ -229,7 +230,7 @@ private List<MenuItem> createTableMenuItems(NetworkTableTreeRow networkTableTree
229230
networkTableTreeRow.getKey(),
230231
new AddNumberArrayDialog(),
231232
(key, value) -> NetworkTableUtilities.getNetworkTableInstance()
232-
.getEntry(key).setNumberArray((Number[]) Arrays.stream(value).boxed().toArray()));
233+
.getEntry(key).setNumberArray(Arrays.stream(value).boxed().toArray(Double[]::new)));
233234

234235
MenuItem boolArray = createContextMenuItem("Add boolean array",
235236
networkTableTreeRow.getKey(),
@@ -241,7 +242,10 @@ private List<MenuItem> createTableMenuItems(NetworkTableTreeRow networkTableTree
241242
networkTableTreeRow.getKey(),
242243
new AddBytesDialog(),
243244
(key, value) -> NetworkTableUtilities.getNetworkTableInstance()
244-
.getEntry(key).setRaw(value));
245+
.getEntry(key)
246+
.setRaw(Bytes.toArray(
247+
Arrays.stream(value).collect(Collectors.toList())
248+
)));
245249

246250
return Arrays.asList(string, number, bool,
247251
new SeparatorMenuItem(),

‎src/main/java/edu/wpi/first/outlineviewer/view/DraggableCell.java

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
package edu.wpi.first.outlineviewer.view;
2+
3+
import java.util.ArrayList;
4+
import java.util.List;
5+
import javafx.collections.FXCollections;
6+
import javafx.scene.control.ListCell;
7+
import javafx.scene.input.ClipboardContent;
8+
import javafx.scene.input.DataFormat;
9+
import javafx.scene.input.DragEvent;
10+
import javafx.scene.input.Dragboard;
11+
import javafx.scene.input.TransferMode;
12+
13+
/**
14+
* A drag-and-drop enabled ListCell. Uses drag events and the Dragboard to move elements around.
15+
* Elements which are drag-and-dropped onto another element will be inserted into that spot in the
16+
* list.
17+
* @param <T> Content type
18+
*/
19+
public class DraggableCell<T> extends ListCell<T> {
20+
21+
private static final DataFormat T_FORMAT = new DataFormat("GENERIC");
22+
23+
public DraggableCell() {
24+
ListCell<T> thisCell = this;
25+
26+
setOnDragDetected(event -> {
27+
if (getItem() == null) {
28+
return;
29+
}
30+
31+
Dragboard dragboard = startDragAndDrop(TransferMode.MOVE);
32+
ClipboardContent content = new ClipboardContent();
33+
content.put(T_FORMAT, getItem());
34+
dragboard.setContent(content);
35+
event.consume();
36+
});
37+
38+
setOnDragOver(event -> {
39+
if (event.getGestureSource() != thisCell && event.getDragboard().hasContent(T_FORMAT)) {
40+
event.acceptTransferModes(TransferMode.MOVE);
41+
}
42+
43+
event.consume();
44+
});
45+
46+
setOnDragEntered(event -> {
47+
if (event.getGestureSource() != thisCell && event.getDragboard().hasContent(T_FORMAT)) {
48+
setOpacity(0.3);
49+
}
50+
});
51+
52+
setOnDragExited(event -> {
53+
if (event.getGestureSource() != thisCell && event.getDragboard().hasContent(T_FORMAT)) {
54+
setOpacity(1);
55+
}
56+
});
57+
58+
setOnDragDropped(event -> {
59+
if (getItem() == null) {
60+
return;
61+
}
62+
63+
Dragboard db = event.getDragboard();
64+
boolean success = false;
65+
66+
if (db.hasContent(T_FORMAT)) {
67+
//Unchecked because Dragboard removes type information. In reality, this is fine
68+
T content = (T) db.getContent(T_FORMAT);
69+
70+
//We need to make our own List here and not use the given ObservableList because some types
71+
//cause the implementation of add to throw an UnsupportedOperationException
72+
List<T> items = new ArrayList<>(getListView().getItems());
73+
int draggedIdx = items.indexOf(content);
74+
int thisIdx = items.indexOf(getItem());
75+
76+
items.remove(draggedIdx);
77+
items.add(thisIdx, content);
78+
getListView().setItems(FXCollections.observableList(items));
79+
80+
success = true;
81+
}
82+
83+
event.setDropCompleted(success);
84+
event.consume();
85+
});
86+
87+
setOnDragDone(DragEvent::consume);
88+
}
89+
90+
}

‎src/main/java/edu/wpi/first/outlineviewer/view/EditableTextFieldListCell.java

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
package edu.wpi.first.outlineviewer.view;
2+
3+
import javafx.beans.property.ObjectProperty;
4+
import javafx.beans.property.SimpleObjectProperty;
5+
import javafx.scene.control.Cell;
6+
import javafx.scene.control.ListView;
7+
import javafx.scene.control.TextField;
8+
import javafx.scene.input.KeyCode;
9+
10+
public class EditableTextFieldListCell<T> extends DraggableCell<IndexedValue<T>> {
11+
private TextField textField;
12+
private final ObjectProperty<IndexedStringConverter<T>> converter
13+
= new SimpleObjectProperty<>(this, "converter");
14+
15+
@SuppressWarnings("PMD.ConstructorCallsOverridableMethod")
16+
public EditableTextFieldListCell(IndexedStringConverter<T> converter) {
17+
this.getStyleClass().add("text-field-list-cell");
18+
setConverter(converter);
19+
20+
//Java does this in startEdit for some reason. We need to add a change listener to the focused
21+
//property here so we need to make the text field early
22+
textField = createTextField(this, getConverter());
23+
textField.focusedProperty().addListener((observable, oldValue, newValue) -> {
24+
if (!newValue) {
25+
commitEdit(converter.fromString(getIndex(), textField.getText()));
26+
}
27+
});
28+
}
29+
30+
public final ObjectProperty<IndexedStringConverter<T>> converterProperty() {
31+
return converter;
32+
}
33+
34+
public final void setConverter(IndexedStringConverter<T> value) {
35+
converterProperty().set(value);
36+
}
37+
38+
public final IndexedStringConverter<T> getConverter() {
39+
return converterProperty().get();
40+
}
41+
42+
@Override
43+
public void startEdit() {
44+
if (!isEditable() || !getListView().isEditable()) {
45+
return;
46+
}
47+
super.startEdit();
48+
49+
if (isEditing()) {
50+
if (textField == null) {
51+
textField = createTextField(this, getConverter());
52+
}
53+
54+
if (textField != null) {
55+
textField.setText(getItemText(this, getConverter()));
56+
}
57+
setText(null);
58+
59+
setGraphic(textField);
60+
61+
if (textField != null) {
62+
textField.selectAll();
63+
// requesting focus so that key input can immediately go into the
64+
// TextField (see RT-28132)
65+
textField.requestFocus();
66+
}
67+
}
68+
}
69+
70+
public TextField getTextField() {
71+
return textField;
72+
}
73+
74+
@Override
75+
public void cancelEdit() {
76+
setText(textField.getText());
77+
super.cancelEdit();
78+
setText(getItemText(this, getConverter()));
79+
setGraphic(null);
80+
}
81+
82+
@Override
83+
public void commitEdit(IndexedValue<T> newValue) {
84+
if (!isEditing() && !newValue.equals(getItem())) {
85+
ListView<IndexedValue<T>> list = getListView();
86+
87+
if (list != null) {
88+
//Pulled from the super method
89+
list.fireEvent(new ListView.EditEvent<>(
90+
list,
91+
ListView.editCommitEvent(),
92+
newValue,
93+
list.getEditingIndex()));
94+
}
95+
}
96+
97+
super.commitEdit(newValue);
98+
}
99+
100+
@Override
101+
public void updateItem(IndexedValue<T> item, boolean empty) {
102+
super.updateItem(item, empty);
103+
final IndexedStringConverter<T> converter1 = getConverter();
104+
if (isEmpty()) {
105+
setText(null);
106+
setGraphic(null);
107+
} else {
108+
if (isEditing()) {
109+
if (textField != null) {
110+
textField.setText(getItemText(this, converter1));
111+
}
112+
setText(null);
113+
114+
setGraphic(textField);
115+
} else {
116+
setText(getItemText(this, converter1));
117+
setGraphic(null);
118+
}
119+
}
120+
}
121+
122+
private String getItemText(Cell<IndexedValue<T>> cell, IndexedStringConverter<T> converter) {
123+
if (converter == null) {
124+
if (cell.getItem() == null) {
125+
return "";
126+
} else {
127+
return cell.getItem().getValue().toString();
128+
}
129+
} else {
130+
if (cell.getItem() == null) {
131+
return "";
132+
} else {
133+
return converter.toString(new IndexedValue<>(getIndex(), cell.getItem().getValue()));
134+
}
135+
}
136+
}
137+
138+
private TextField createTextField(final Cell<IndexedValue<T>> cell,
139+
final IndexedStringConverter<T> converter) {
140+
final TextField textField = new TextField(getItemText(cell, converter));
141+
142+
// Use onAction here rather than onKeyReleased (with check for Enter),
143+
// as otherwise we encounter RT-34685
144+
textField.setOnAction(event -> {
145+
if (converter == null) {
146+
throw new IllegalStateException(
147+
"Attempting to convert text input into Object, but provided "
148+
+ "StringConverter is null. Be sure to set a StringConverter "
149+
+ "in your cell factory.");
150+
}
151+
cell.commitEdit(converter.fromString(cell.getItem().getIndex(), textField.getText()));
152+
event.consume();
153+
});
154+
textField.setOnKeyReleased(t -> {
155+
if (t.getCode() == KeyCode.ESCAPE) {
156+
cell.cancelEdit();
157+
t.consume();
158+
}
159+
});
160+
return textField;
161+
}
162+
163+
}

‎src/main/java/edu/wpi/first/outlineviewer/view/IndexedStringConverter.java

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
package edu.wpi.first.outlineviewer.view;
2+
3+
import javafx.util.StringConverter;
4+
5+
/**
6+
* A StringConverter that also requires an index to convert from a String to a T. This class works
7+
* hand-in-hand with IndexedValue.
8+
* @param <T> Data conversion type
9+
*/
10+
public abstract class IndexedStringConverter<T> extends StringConverter<IndexedValue<T>> {
11+
12+
/**
13+
* Converts the object provided into its string form.
14+
* Format of the returned string is defined by the specific converter.
15+
* @return a string representation of the object passed in.
16+
*/
17+
public abstract String toString(IndexedValue<T> object);
18+
19+
/**
20+
* Converts the string provided into an object defined by the specific converter.
21+
* Format of the string and type of the resulting object is defined by the specific converter.
22+
* @return an object representation of the string passed in.
23+
*/
24+
public abstract IndexedValue<T> fromString(Integer index, String string);
25+
26+
}

0 commit comments

Comments
 (0)