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

Type Parameters:
M - the model type
All Superinterfaces:
BeforeStartEditEvent.HasBeforeStartEditHandlers<M>, CancelEditEvent.HasCancelEditHandlers<M>, CompleteEditEvent.HasCompleteEditHandlers<M>, HasHandlers, StartEditEvent.HasStartEditHandlers<M>
All Known Implementing Classes:
AbstractGridEditing, GridInlineEditing, GridRowEditing

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

Defines the interface for classes that support grid editing.

See Also:
GridInlineEditing, GridRowEditing

Method Summary
<N,O> void
addEditor(ColumnConfig<M,N> columnConfig, Converter<N,O> converter, Field<O> field)
          Adds an editor for the give column.
<N> void
addEditor(ColumnConfig<M,N> columnConfig, Field<N> field)
          Adds an editor for the given column.
 void cancelEditing()
          Cancels an active edit.
 void completeEditing()
          Completes the active edit.
<N,O> Converter<N,O>
getConverter(ColumnConfig<M,N> columnConfig)
          Returns the converter for the given column.
 Grid<M> getEditableGrid()
          Returns the target grid.
<O> Field<O>
getEditor(ColumnConfig<M,?> columnConfig)
          Returns the editor for the given column.
 boolean isEditing()
          Returns true if editing is active.
 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 startEditing(Grid.GridCell cell)
          Starts editing for the given cell.
 
Methods inherited from interface com.sencha.gxt.widget.core.client.event.BeforeStartEditEvent.HasBeforeStartEditHandlers
addBeforeStartEditHandler
 
Methods inherited from interface com.sencha.gxt.widget.core.client.event.StartEditEvent.HasStartEditHandlers
addStartEditHandler
 
Methods inherited from interface com.sencha.gxt.widget.core.client.event.CompleteEditEvent.HasCompleteEditHandlers
addCompleteEditHandler
 
Methods inherited from interface com.sencha.gxt.widget.core.client.event.CancelEditEvent.HasCancelEditHandlers
addCancelEditHandler
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Method Detail

addEditor

<N,O> void addEditor(ColumnConfig<M,N> columnConfig,
                     Converter<N,O> converter,
                     Field<O> field)
Adds an editor for the give column.

Parameters:
columnConfig - the column config
converter - the converter
field - the field

addEditor

<N> void addEditor(ColumnConfig<M,N> columnConfig,
                   Field<N> field)
Adds an editor for the given column.

Parameters:
columnConfig - the column config
field - the field

cancelEditing

void cancelEditing()
Cancels an active edit.


completeEditing

void completeEditing()
Completes the active edit.


getConverter

<N,O> Converter<N,O> getConverter(ColumnConfig<M,N> columnConfig)
Returns the converter for the given column.

Parameters:
columnConfig - the column config
Returns:
the converter

getEditableGrid

Grid<M> getEditableGrid()
Returns the target grid.

Returns:
the target grid

getEditor

<O> Field<O> getEditor(ColumnConfig<M,?> columnConfig)
Returns the editor for the given column.

Parameters:
columnConfig - the column config
Returns:
the editor

isEditing

boolean isEditing()
Returns true if editing is active.

Returns:
true if editing

removeEditor

void removeEditor(ColumnConfig<M,?> columnConfig)
Removes the editor for the given column.

Parameters:
columnConfig - the column config

setEditableGrid

void setEditableGrid(Grid<M> editableGrid)
Sets the target grid to be edited.

Parameters:
editableGrid - the editable grid

startEditing

void startEditing(Grid.GridCell cell)
Starts editing for the given cell.

Parameters:
cell - the cell


Copyright © 2012. All Rights Reserved.