com.vaadin.v7.shared.ui.grid.EditorClientRpc Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.v7.shared.ui.grid;
import java.util.List;
import com.vaadin.shared.communication.ClientRpc;
/**
* An RPC interface for the grid editor server-to-client communications.
*
* @since 7.4
* @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.
*
* @param bindSucceeded
* true if the bind action was successful
*/
void confirmBind(boolean bindSucceeded);
/**
* Confirms a pending {@link EditorServerRpc#save(int) save request} sent by
* the client.
*
* @param saveSucceeded
* true if the save action was successful
* @param errorMessage
* the error message to show the user
* @param errorColumnsIds
* a list of column keys that should get error markers, or
* null if there should be no error markers
*/
void confirmSave(boolean saveSucceeded, String errorMessage,
List errorColumnsIds);
}