com.vaadin.client.widget.grid.EditorHandler Maven / Gradle / Ivy
Show all versions of vaadin-client Show documentation
/*
* Copyright 2000-2016 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.client.widget.grid;
import java.util.Collection;
import com.google.gwt.user.client.ui.Widget;
import com.vaadin.client.widgets.Grid;
import com.vaadin.client.widgets.Grid.Editor;
/**
* An interface for binding widgets and data to the grid row editor. Used by the
* editor to support different row types, data sources and custom data binding
* mechanisms.
*
* @param
* the row data type
*
* @since 7.4
* @author Vaadin Ltd
*/
public interface EditorHandler {
/**
* A request class passed as a parameter to the editor handler methods. The
* request is callback-based to facilitate usage with remote or otherwise
* asynchronous data sources.
*
* An implementation must call either {@link #success()} or {@link #fail()},
* according to whether the operation was a success or failed during
* execution, respectively.
*
* @param
* the row data type
*/
public interface EditorRequest {
/**
* Returns the index of the row being requested.
*
* @return the row index
*/
public int getRowIndex();
/**
* Returns the index of the column being focused.
*
* @return the column index
*/
public int getColumnIndex();
/**
* Returns the row data related to the row being requested.
*
* @return the row data
*/
public T getRow();
/**
* Returns the grid instance related to this editor request.
*
* @return the grid instance
*/
public Grid getGrid();
/**
* Returns the editor widget used to edit the values of the given
* column.
*
* @param column
* the column whose widget to get
* @return the widget related to the column
*/
public Widget getWidget(Grid.Column column);
/**
* Informs Grid that the editor request was a success.
*/
public void success();
/**
* Informs Grid that an error occurred while trying to process the
* request.
*
* @see Editor#setEditorError(String, Collection)
*/
public void failure();
/**
* Informs Grid that an error occurred while trying to process the
* request. This method is a short-hand for calling {@link #failure()}
* and {@link Editor#setEditorError(String, Collection)}
*
* @param errorMessage
* and error message to show to the user, or
* null to not show any message.
* @param errorColumns
* a collection of columns for which an error indicator
* should be shown, or null if no columns should
* be marked as erroneous.
*
* @see Editor#setEditorError(String, Collection)
*/
public default void failure(String errorMessage,
Collection> errorColumns) {
failure();
getGrid().getEditor().setEditorError(errorMessage, errorColumns);
}
/**
* Checks whether the request is completed or not.
*
* @return true iff the request is completed
*/
public boolean isCompleted();
}
/**
* Binds row data to the editor widgets. Called by the editor when it is
* opened for editing.
*
* The implementation must call either
* {@link EditorRequest#success()} or
* {@link EditorRequest#failure(String, Collection)} to signal a successful
* or a failed (respectively) bind action.
*
* @param request
* the data binding request
*
* @see Grid#editRow(int)
*/
public void bind(EditorRequest request);
/**
* Called by the editor when editing is cancelled. This method may have an
* empty implementation in case no special processing is required.
*
* In contrast to {@link #bind(EditorRequest)} and
* {@link #save(EditorRequest)}, any calls to
* {@link EditorRequest#success()} or
* {@link EditorRequest#failure(String, Collection)} have no effect on the
* outcome of the cancel action. The editor is already closed when this
* method is called.
*
* @param request
* the cancel request
* @param afterBeingSaved
* if {@code true} then this method is called to close editor
* after save action, otherwise it represents a cancel action
*
* @see Grid#cancelEditor()
*/
public void cancel(EditorRequest request, boolean afterBeingSaved);
/**
* Commits changes in the currently active edit to the data source. Called
* by the editor when changes are saved.
*
* The implementation must call either
* {@link EditorRequest#success()} or {@link EditorRequest#fail()} to signal
* a successful or a failed (respectively) save action.
*
* @param request
* the save request
*
* @see Grid#saveEditor()
*/
public void save(EditorRequest request);
/**
* Returns a widget instance that is used to edit the values in the given
* column. A null return value means the column is not editable.
*
* @param column
* the column whose values should be edited
* @return the editor widget for the column or null if the column is not
* editable
*/
public Widget getWidget(Grid.Column column);
}