1 /* 2 * Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package javafx.scene.control.cell; 27 28 import javafx.beans.property.ObjectProperty; 29 import javafx.beans.property.SimpleObjectProperty; 30 import javafx.scene.control.TextField; 31 import javafx.scene.control.TreeTableCell; 32 import javafx.scene.control.TreeTableColumn; 33 import javafx.util.Callback; 34 import javafx.util.StringConverter; 35 import javafx.util.converter.DefaultStringConverter; 36 37 /** 38 * A class containing a {@link TableCell} implementation that draws a 39 * {@link TextField} node inside the cell. 40 * 41 * <p>By default, the TextFieldTableCell is rendered as a {@link Label} when not 42 * being edited, and as a TextField when in editing mode. The TextField will, by 43 * default, stretch to fill the entire table cell. 44 * 45 * @param <T> The type of the elements contained within the TreeTableColumn. 46 * @since JavaFX 8.0 47 */ 48 public class TextFieldTreeTableCell<S,T> extends TreeTableCell<S,T> { 49 50 /*************************************************************************** 51 * * 52 * Static cell factories * 53 * * 54 **************************************************************************/ 55 56 /** 57 * Provides a {@link TextField} that allows editing of the cell content when 58 * the cell is double-clicked, or when 59 * {@link javafx.scene.control.TreeTableView#edit(int, javafx.scene.control.TreeTableColumn)} is called. 60 * This method will only work on {@link TreeTableColumn} instances which are of 61 * type String. 62 * 63 * @return A {@link Callback} that can be inserted into the 64 * {@link TreeTableColumn#cellFactoryProperty() cell factory property} of a 65 * TreeTableColumn, that enables textual editing of the content. 66 */ 67 public static <S> Callback<TreeTableColumn<S,String>, TreeTableCell<S,String>> forTreeTableColumn() { 68 return forTreeTableColumn(new DefaultStringConverter()); 69 } 70 71 /** 72 * Provides a {@link TextField} that allows editing of the cell content when 73 * the cell is double-clicked, or when 74 * {@link javafx.scene.control.TreeTableView#edit(int, javafx.scene.control.TreeTableColumn) } is called. 75 * This method will work on any {@link TreeTableColumn} instance, regardless of 76 * its generic type. However, to enable this, a {@link StringConverter} must 77 * be provided that will convert the given String (from what the user typed 78 * in) into an instance of type T. This item will then be passed along to the 79 * {@link TreeTableColumn#onEditCommitProperty()} callback. 80 * 81 * @param converter A {@link StringConverter} that can convert the given String 82 * (from what the user typed in) into an instance of type T. 83 * @return A {@link Callback} that can be inserted into the 84 * {@link TreeTableColumn#cellFactoryProperty() cell factory property} of a 85 * TreeTableColumn, that enables textual editing of the content. 86 */ 87 public static <S,T> Callback<TreeTableColumn<S,T>, TreeTableCell<S,T>> forTreeTableColumn( 88 final StringConverter<T> converter) { 89 return list -> new TextFieldTreeTableCell<S,T>(converter); 90 } 91 92 93 /*************************************************************************** 94 * * 95 * Fields * 96 * * 97 **************************************************************************/ 98 99 private TextField textField; 100 101 102 103 /*************************************************************************** 104 * * 105 * Constructors * 106 * * 107 **************************************************************************/ 108 109 /** 110 * Creates a default TextFieldTreeTableCell with a null converter. Without a 111 * {@link StringConverter} specified, this cell will not be able to accept 112 * input from the TextField (as it will not know how to convert this back 113 * to the domain object). It is therefore strongly encouraged to not use 114 * this constructor unless you intend to set the converter separately. 115 */ 116 public TextFieldTreeTableCell() { 117 this(null); 118 } 119 120 /** 121 * Creates a TextFieldTreeTableCell that provides a {@link TextField} when put 122 * into editing mode that allows editing of the cell content. This method 123 * will work on any TreeTableColumn instance, regardless of its generic type. 124 * However, to enable this, a {@link StringConverter} must be provided that 125 * will convert the given String (from what the user typed in) into an 126 * instance of type T. This item will then be passed along to the 127 * {@link TreeTableColumn#onEditCommitProperty()} callback. 128 * 129 * @param converter A {@link StringConverter converter} that can convert 130 * the given String (from what the user typed in) into an instance of 131 * type T. 132 */ 133 public TextFieldTreeTableCell(StringConverter<T> converter) { 134 this.getStyleClass().add("text-field-tree-table-cell"); 135 setConverter(converter); 136 } 137 138 139 140 /*************************************************************************** 141 * * 142 * Properties * 143 * * 144 **************************************************************************/ 145 146 // --- converter 147 private ObjectProperty<StringConverter<T>> converter = 148 new SimpleObjectProperty<StringConverter<T>>(this, "converter"); 149 150 /** 151 * The {@link StringConverter} property. 152 */ 153 public final ObjectProperty<StringConverter<T>> converterProperty() { 154 return converter; 155 } 156 157 /** 158 * Sets the {@link StringConverter} to be used in this cell. 159 */ 160 public final void setConverter(StringConverter<T> value) { 161 converterProperty().set(value); 162 } 163 164 /** 165 * Returns the {@link StringConverter} used in this cell. 166 */ 167 public final StringConverter<T> getConverter() { 168 return converterProperty().get(); 169 } 170 171 172 173 /*************************************************************************** 174 * * 175 * Public API * 176 * * 177 **************************************************************************/ 178 179 /** {@inheritDoc} */ 180 @Override public void startEdit() { 181 if (! isEditable() 182 || ! getTreeTableView().isEditable() 183 || ! getTableColumn().isEditable()) { 184 return; 185 } 186 super.startEdit(); 187 188 if (isEditing()) { 189 if (textField == null) { 190 textField = CellUtils.createTextField(this, getConverter()); 191 } 192 193 CellUtils.startEdit(this, getConverter(), null, null, textField); 194 } 195 } 196 197 /** {@inheritDoc} */ 198 @Override public void cancelEdit() { 199 super.cancelEdit(); 200 CellUtils.cancelEdit(this, getConverter(), null); 201 } 202 203 /** {@inheritDoc} */ 204 @Override public void updateItem(T item, boolean empty) { 205 super.updateItem(item, empty); 206 CellUtils.updateItem(this, getConverter(), null, null, textField); 207 } 208 }