com.sencha.gxt.widget.core.client.grid.editing

Class GridRowEditing<M>

java.lang.Object

com.sencha.gxt.widget.core.client.grid.editing.AbstractGridEditing<M>

com.sencha.gxt.widget.core.client.grid.editing.GridRowEditing<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

BeforeStartEditEvent.HasBeforeStartEditHandlers<M>, CancelEditEvent.HasCancelEditHandlers<M>, CompleteEditEvent.HasCompleteEditHandlers<M>, StartEditEvent.HasStartEditHandlers<M>, GridEditing<M>

public class GridRowEditing<M>
extends AbstractGridEditing<M>

Displays an editor for all cells in a row and allows all fields in row to be edited at the same time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GridRowEditing.DefaultRowEditorMessages
protected class	GridRowEditing.Handler
static interface	GridRowEditing.RowEditorAppearance
protected class	GridRowEditing.RowEditorComponent
static interface	GridRowEditing.RowEditorMessages

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.grid.editing.AbstractGridEditing

AbstractGridEditing.AbstractGridEditingKeyNav

Field Summary

Fields

Modifier and Type	Field and Description
protected GridRowEditing.RowEditorMessages	messages
protected Map<ColumnConfig<M,?>,<any>>	renderers
protected WidgetComponent	toolTipAlignWidget

Fields inherited from class com.sencha.gxt.widget.core.client.grid.editing.AbstractGridEditing

activeCell, bound, callback, columnModel, converterMap, editableGrid, editorMap, groupRegistration, handler, keyNav, lastValid, monitorTimer, tooltip

Constructor Summary

Constructors

Constructor and Description
GridRowEditing(Grid<M> editableGrid) Creates a new row editing instance.

Method Summary

Modifier and Type	Method and Description
<N,O> void	addEditor(ColumnConfig<M,N> columnConfig, Converter<N,O> converter, IsField<O> field) Adds an editor for the given column.
<N> void	addRenderer(ColumnConfig<M,N> columnConfig, <any> renderer) Adds a SafeHtml renderer for the given column.
protected void	bindHandler()
void	cancelEditing() Cancels an active edit.
void	completeEditing() Completes the active edit.
protected GridRowEditing.RowEditorComponent	createRowEditor()
protected <N,O> void	doCompleteEditing(ColumnConfig<M,N> c)
protected <N,O> IsWidget	doStartEditing(ColumnConfig<M,N> c, M value)
protected GridRowEditing.Handler	ensureInternHandler()
ButtonBar	getButtonBar() Returns the row editor button bar with the Cancel and Save buttons.
TextButton	getCancelButton() Returns the cancel button.
protected SafeHtml	getErrorHtml()
GridRowEditing.RowEditorMessages	getMessages() Returns the row editor messages.
TextButton	getSaveButton() Returns the save button.
protected boolean	isValid()
protected void	onEnter(NativeEvent evt)
protected void	onScroll(ScrollEvent event)
protected void	positionButtons()
void	removeEditor(ColumnConfig<M,?> columnConfig) Removes the editor for the given column.
void	setEditableGrid(Grid<M> editableGrid) Sets the target grid to be edited.
void	setMessages(GridRowEditing.RowEditorMessages messages) Sets the row editor messages.
protected void	showTooltip(SafeHtml msg)
void	startEditing(Grid.GridCell cell) Starts editing for the given cell.
protected void	verifyLayout()

Methods inherited from class com.sencha.gxt.widget.core.client.grid.editing.AbstractGridEditing

addBeforeStartEditHandler, addCancelEditHandler, addCompleteEditHandler, addEditor, addStartEditHandler, clearEditors, ensureHandlers, ensureInternalKeyNav, findCell, fireEvent, focusCell, focusGrid, getActiveCell, getClicksToEdit, getConverter, getEditableGrid, getEditor, getErrorMessage, getErrorMessage, getMonitorPoll, handleHeaderMouseDown, hideTooltip, isEditing, isErrorSummary, isMonitorValid, onAttachOrDetach, onClick, onDoubleClick, onEsc, onMouseDown, onMouseUp, onReconfigure, setClicksToEdit, setErrorSummary, setMonitorPoll, setMonitorValid, startMonitoring, stopMonitoring

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

messages

protected GridRowEditing.RowEditorMessages messages

toolTipAlignWidget

protected WidgetComponent toolTipAlignWidget

renderers

protected Map<ColumnConfig<M,?>,<any>> renderers

Constructor Detail

GridRowEditing

public GridRowEditing(Grid<M> editableGrid)

Creates a new row editing instance.

Parameters:

editableGrid - the target grid

Method Detail

addEditor

public <N,O> void addEditor(ColumnConfig<M,N> columnConfig,
                            Converter<N,O> converter,
                            IsField<O> field)

Description copied from interface: GridEditing

Adds an editor for the given column.

Specified by:

addEditor in interface GridEditing<M>

Overrides:

addEditor in class AbstractGridEditing<M>

Parameters:

columnConfig - the column config

converter - the converter

field - the field

addRenderer

public <N> void addRenderer(ColumnConfig<M,N> columnConfig,
                            <any> renderer)

Adds a SafeHtml renderer for the given column. This allows a value to be rendered in a customized way, rather than the default of calling toString on the column's value.

Parameters:

columnConfig - the column to render in this way

renderer - how to render the column's value as html

cancelEditing

public void cancelEditing()

Description copied from interface: GridEditing

Cancels an active edit.

Specified by:

cancelEditing in interface GridEditing<M>

Specified by:

cancelEditing in class AbstractGridEditing<M>

completeEditing

public void completeEditing()

Description copied from interface: GridEditing

Completes the active edit.

Specified by:

completeEditing in interface GridEditing<M>

Specified by:

completeEditing in class AbstractGridEditing<M>

getButtonBar

public ButtonBar getButtonBar()

Returns the row editor button bar with the Cancel and Save buttons. This can be used to add a button.

• Add a custom button to the button bar.
• Get the model with Grid.getSelectionModel()
• Close the editing with cancelEditing()

 // example creating a delete button
 TextButton deleteBtn = new TextButton("Delete");
 deleteBtn.addSelectHandler(new SelectEvent.SelectHandler() {
   public void onSelect(SelectEvent event) {
     // close the editing
     editing.cancelEditing();
     // get the model
     StateModel item = grid.getSelectionModel().getSelectedItem();
   }
 });
 ButtonBar buttonBar = rowEditing.getButtonBar();
 buttonBar.add(deleteBtn);
 

Returns:

the ButtonBar.

getCancelButton

public TextButton getCancelButton()

Returns the cancel button.

Returns:

the cancel button

getMessages

public GridRowEditing.RowEditorMessages getMessages()

Returns the row editor messages.

Returns:

the messages

getSaveButton

public TextButton getSaveButton()

Returns the save button.

Returns:

the save button

removeEditor

public void removeEditor(ColumnConfig<M,?> columnConfig)

Description copied from interface: GridEditing

Removes the editor for the given column.

Specified by:

removeEditor in interface GridEditing<M>

Overrides:

removeEditor in class AbstractGridEditing<M>

Parameters:

columnConfig - the column config

setEditableGrid

public void setEditableGrid(Grid<M> editableGrid)

Description copied from interface: GridEditing

Sets the target grid to be edited.

Specified by:

setEditableGrid in interface GridEditing<M>

Overrides:

setEditableGrid in class AbstractGridEditing<M>

Parameters:

editableGrid - the editable grid

setMessages

public void setMessages(GridRowEditing.RowEditorMessages messages)

Sets the row editor messages.

Parameters:

messages - the messages

startEditing

public void startEditing(Grid.GridCell cell)

Description copied from interface: GridEditing

Starts editing for the given cell.

Specified by:

startEditing in interface GridEditing<M>

Overrides:

startEditing in class AbstractGridEditing<M>

Parameters:

cell - the cell

bindHandler

protected void bindHandler()

Overrides:

bindHandler in class AbstractGridEditing<M>

createRowEditor

protected GridRowEditing.RowEditorComponent createRowEditor()

doCompleteEditing

protected <N,O> void doCompleteEditing(ColumnConfig<M,N> c)

doStartEditing

protected <N,O> IsWidget doStartEditing(ColumnConfig<M,N> c,
                                        M value)

ensureInternHandler

protected GridRowEditing.Handler ensureInternHandler()

Overrides:

ensureInternHandler in class AbstractGridEditing<M>

getErrorHtml

protected SafeHtml getErrorHtml()

Specified by:

getErrorHtml in class AbstractGridEditing<M>

isValid

protected boolean isValid()

Specified by:

isValid in class AbstractGridEditing<M>

onEnter

protected void onEnter(NativeEvent evt)

Overrides:

onEnter in class AbstractGridEditing<M>

onScroll

protected void onScroll(ScrollEvent event)

Overrides:

onScroll in class AbstractGridEditing<M>

positionButtons

protected void positionButtons()

showTooltip

protected void showTooltip(SafeHtml msg)

Specified by:

showTooltip in class AbstractGridEditing<M>

verifyLayout

protected void verifyLayout()