From 6ed909f2c61f7d434d1c91549dcda27cfa3698a8 Mon Sep 17 00:00:00 2001 From: Johannes Dahlström Date: Mon, 15 Dec 2014 16:31:26 +0200 Subject: Change "editor row" to just "editor" in method names and javadoc (#13334) Change-Id: Idafdbe3d71a38a979e1eeb07c527f66ce61ccfa9 --- .../com/vaadin/shared/ui/grid/EditorClientRpc.java | 55 ++++++++++++++++++++ .../vaadin/shared/ui/grid/EditorRowClientRpc.java | 55 -------------------- .../vaadin/shared/ui/grid/EditorRowServerRpc.java | 58 ---------------------- .../com/vaadin/shared/ui/grid/EditorServerRpc.java | 58 ++++++++++++++++++++++ .../com/vaadin/shared/ui/grid/GridColumnState.java | 2 +- .../src/com/vaadin/shared/ui/grid/GridState.java | 4 +- 6 files changed, 116 insertions(+), 116 deletions(-) create mode 100644 shared/src/com/vaadin/shared/ui/grid/EditorClientRpc.java delete mode 100644 shared/src/com/vaadin/shared/ui/grid/EditorRowClientRpc.java delete mode 100644 shared/src/com/vaadin/shared/ui/grid/EditorRowServerRpc.java create mode 100644 shared/src/com/vaadin/shared/ui/grid/EditorServerRpc.java (limited to 'shared') diff --git a/shared/src/com/vaadin/shared/ui/grid/EditorClientRpc.java b/shared/src/com/vaadin/shared/ui/grid/EditorClientRpc.java new file mode 100644 index 0000000000..c083252754 --- /dev/null +++ b/shared/src/com/vaadin/shared/ui/grid/EditorClientRpc.java @@ -0,0 +1,55 @@ +/* + * Copyright 2000-2014 Vaadin Ltd. + * + * Licensed under the Apache License, Version 2.0 (the "License"); you may not + * use this file except in compliance with the License. You may obtain a copy of + * the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. + */ +package com.vaadin.shared.ui.grid; + +import com.vaadin.shared.communication.ClientRpc; + +/** + * An RPC interface for the grid editor server-to-client communications. + * + * @since + * @author Vaadin Ltd + */ +public interface EditorClientRpc extends ClientRpc { + + /** + * Tells the client to open the editor and bind data to it. + * + * @param rowIndex + * the index of the edited row + */ + void bind(int rowIndex); + + /** + * Tells the client to cancel editing and hide the editor. + * + * @param rowIndex + * the index of the edited row + */ + void cancel(int rowIndex); + + /** + * Confirms a pending {@link EditorServerRpc#bind(int) bind request} + * sent by the client. + */ + void confirmBind(); + + /** + * Confirms a pending {@link EditorServerRpc#save(int) save request} + * sent by the client. + */ + void confirmSave(); +} diff --git a/shared/src/com/vaadin/shared/ui/grid/EditorRowClientRpc.java b/shared/src/com/vaadin/shared/ui/grid/EditorRowClientRpc.java deleted file mode 100644 index c72f767f3c..0000000000 --- a/shared/src/com/vaadin/shared/ui/grid/EditorRowClientRpc.java +++ /dev/null @@ -1,55 +0,0 @@ -/* - * Copyright 2000-2014 Vaadin Ltd. - * - * Licensed under the Apache License, Version 2.0 (the "License"); you may not - * use this file except in compliance with the License. You may obtain a copy of - * the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations under - * the License. - */ -package com.vaadin.shared.ui.grid; - -import com.vaadin.shared.communication.ClientRpc; - -/** - * An RPC interface for the grid editor row server-to-client communications. - * - * @since - * @author Vaadin Ltd - */ -public interface EditorRowClientRpc extends ClientRpc { - - /** - * Tells the client to open the editor row and bind data to it. - * - * @param rowIndex - * the index of the edited row - */ - void bind(int rowIndex); - - /** - * Tells the client to cancel editing and hide the editor row. - * - * @param rowIndex - * the index of the edited row - */ - void cancel(int rowIndex); - - /** - * Confirms a pending {@link EditorRowServerRpc#bind(int) bind request} sent - * by the client. - */ - void confirmBind(); - - /** - * Confirms a pending {@link EditorRowServerRpc#save(int) save request} sent - * by the client. - */ - void confirmSave(); -} diff --git a/shared/src/com/vaadin/shared/ui/grid/EditorRowServerRpc.java b/shared/src/com/vaadin/shared/ui/grid/EditorRowServerRpc.java deleted file mode 100644 index 8215e8963c..0000000000 --- a/shared/src/com/vaadin/shared/ui/grid/EditorRowServerRpc.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Copyright 2000-2014 Vaadin Ltd. - * - * Licensed under the Apache License, Version 2.0 (the "License"); you may not - * use this file except in compliance with the License. You may obtain a copy of - * the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations under - * the License. - */ -package com.vaadin.shared.ui.grid; - -import com.vaadin.shared.communication.ServerRpc; - -/** - * An RPC interface for the grid editor row client-to-server communications. - * - * @since - * @author Vaadin Ltd - */ -public interface EditorRowServerRpc extends ServerRpc { - - /** - * Asks the server to open the editor row and bind data to it. When a bind - * request is sent, it must be acknowledged with a - * {@link EditorRowClientRpc#confirmBind() confirm call} before the client - * can open the editor. - * - * @param rowIndex - * the index of the edited row - */ - void bind(int rowIndex); - - /** - * Asks the server to save unsaved changes in the editor row to the data - * source. When a save request is sent, it must be acknowledged with a - * {@link EditorRowClientRpc#confirmSave() confirm call}. - * - * @param rowIndex - * the index of the edited row - */ - void save(int rowIndex); - - /** - * Tells the server to cancel editing. When sending a cancel request, the - * client does not need to wait for confirmation by the server before hiding - * the editor row. - * - * @param rowIndex - * the index of the edited row - */ - void cancel(int rowIndex); -} diff --git a/shared/src/com/vaadin/shared/ui/grid/EditorServerRpc.java b/shared/src/com/vaadin/shared/ui/grid/EditorServerRpc.java new file mode 100644 index 0000000000..57df691547 --- /dev/null +++ b/shared/src/com/vaadin/shared/ui/grid/EditorServerRpc.java @@ -0,0 +1,58 @@ +/* + * Copyright 2000-2014 Vaadin Ltd. + * + * Licensed under the Apache License, Version 2.0 (the "License"); you may not + * use this file except in compliance with the License. You may obtain a copy of + * the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. + */ +package com.vaadin.shared.ui.grid; + +import com.vaadin.shared.communication.ServerRpc; + +/** + * An RPC interface for the grid editor client-to-server communications. + * + * @since + * @author Vaadin Ltd + */ +public interface EditorServerRpc extends ServerRpc { + + /** + * Asks the server to open the editor and bind data to it. When a bind + * request is sent, it must be acknowledged with a + * {@link EditorClientRpc#confirmBind() confirm call} before the client + * can open the editor. + * + * @param rowIndex + * the index of the edited row + */ + void bind(int rowIndex); + + /** + * Asks the server to save unsaved changes in the editor to the data source. + * When a save request is sent, it must be acknowledged with a + * {@link EditorClientRpc#confirmSave() confirm call}. + * + * @param rowIndex + * the index of the edited row + */ + void save(int rowIndex); + + /** + * Tells the server to cancel editing. When sending a cancel request, the + * client does not need to wait for confirmation by the server before hiding + * the editor. + * + * @param rowIndex + * the index of the edited row + */ + void cancel(int rowIndex); +} diff --git a/shared/src/com/vaadin/shared/ui/grid/GridColumnState.java b/shared/src/com/vaadin/shared/ui/grid/GridColumnState.java index 34e6fb4cfd..11cb133fa5 100644 --- a/shared/src/com/vaadin/shared/ui/grid/GridColumnState.java +++ b/shared/src/com/vaadin/shared/ui/grid/GridColumnState.java @@ -53,7 +53,7 @@ public class GridColumnState implements Serializable { /** * The connector for the field used to edit cells in this column when the - * editor row is active. + * editor interface is active. */ public Connector editorConnector; diff --git a/shared/src/com/vaadin/shared/ui/grid/GridState.java b/shared/src/com/vaadin/shared/ui/grid/GridState.java index 4cf834c4f0..1f98431caf 100644 --- a/shared/src/com/vaadin/shared/ui/grid/GridState.java +++ b/shared/src/com/vaadin/shared/ui/grid/GridState.java @@ -138,8 +138,8 @@ public class GridState extends AbstractComponentState { /** Directions for each sorted column */ public SortDirection[] sortDirs = new SortDirection[0]; - /** The enabled state of the editor row */ - public boolean editorRowEnabled = false; + /** The enabled state of the editor interface */ + public boolean editorEnabled = false; /** Whether row data might contain generated row styles */ public boolean hasRowStyleGenerator; -- cgit v1.2.3