AbstractGridEditing (GXT 4.0.2)

java.lang.Object
- com.sencha.gxt.widget.core.client.grid.editing.AbstractGridEditing<M>

All Implemented Interfaces:

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

Direct Known Subclasses:

GridInlineEditing, GridRowEditing
```
public abstract class AbstractGridEditing<M>
extends Object
implements GridEditing<M>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class AbstractGridEditing.AbstractGridEditingKeyNav

protected class AbstractGridEditing.Handler

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractGridEditing.AbstractGridEditingKeyNav`
`protected class`	`AbstractGridEditing.Handler`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Grid.GridCell`	`activeCell`
`protected boolean`	`bound`
`protected Grid.Callback`	`callback`
`protected ColumnModel<M>`	`columnModel`
`protected Map<ColumnConfig<M,?>,Converter<?,?>>`	`converterMap`
`protected Grid<M>`	`editableGrid`
`protected Map<ColumnConfig<M,?>,IsField<?>>`	`editorMap`
`protected GroupingHandlerRegistration`	`groupRegistration`
`protected AbstractGridEditing.Handler`	`handler`
`protected KeyNav`	`keyNav`
`protected boolean`	`lastValid`
`protected Timer`	`monitorTimer`
`protected ToolTip`	`tooltip`

Constructor Summary

Constructors
Constructor and Description

AbstractGridEditing()

Constructors
Constructor and Description
`AbstractGridEditing()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addBeforeStartEditHandler(BeforeStartEditEvent.BeforeStartEditHandler<M> handler)`
`HandlerRegistration`	`addCancelEditHandler(CancelEditEvent.CancelEditHandler<M> handler)`
`HandlerRegistration`	`addCompleteEditHandler(CompleteEditEvent.CompleteEditHandler<M> handler)`
`<N,O> void`	`addEditor(ColumnConfig<M,N> columnConfig, Converter<N,O> converter, IsField<O> field)` Adds an editor for the given column.
`<N> void`	`addEditor(ColumnConfig<M,N> columnConfig, IsField<N> field)` Adds an editor for the given column.
`HandlerRegistration`	`addStartEditHandler(StartEditEvent.StartEditHandler<M> handler)`
`protected void`	`bindHandler()`
`abstract void`	`cancelEditing()` Cancels an active edit.
`void`	`clearEditors()` Clears the editors.
`abstract void`	`completeEditing()` Completes the active edit.
`protected HandlerManager`	`ensureHandlers()`
`protected KeyNav`	`ensureInternalKeyNav()`
`protected AbstractGridEditing.Handler`	`ensureInternHandler()`
`protected Grid.GridCell`	`findCell(Element target)`
`void`	`fireEvent(<any> event)`
`protected void`	`focusCell(int row, int col)`
`protected void`	`focusGrid()`
`Grid.GridCell`	`getActiveCell()` Returns the active cell.
`ClicksToEdit`	`getClicksToEdit()` Returns the clicks to 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> IsField<O>`	`getEditor(ColumnConfig<M,?> columnConfig)` Returns the editor for the given column.
`protected abstract SafeHtml`	`getErrorHtml()`
`protected void`	`getErrorMessage(IsField<?> field, SafeHtmlBuilder sb, SafeHtml title)`
`int`	`getMonitorPoll()` Returns the interval that the editor is validated.
`protected void`	`handleDoubleEdit(NativeEvent event)`
`protected <N,O> void`	`handleHeaderMouseDown(HeaderMouseDownEvent event)`
`protected void`	`handleSingleEdit(NativeEvent event)`
`protected void`	`hideTooltip()`
`boolean`	`isEditing()` Returns true if editing is active.
`boolean`	`isErrorSummary()` Returns true if a tooltip with an error summary is shown.
`boolean`	`isMonitorValid()` Returns true if valid monitoring is enabled.
`protected abstract boolean`	`isValid()`
`protected void`	`onAttachOrDetach(AttachEvent event)`
`protected void`	`onClick(ClickEvent event)`
`protected void`	`onDoubleClick(DoubleClickEvent event)`
`protected void`	`onEnter(NativeEvent evt)`
`protected void`	`onEsc(NativeEvent evt)`
`protected void`	`onMouseDown(MouseDownEvent event)`
`protected void`	`onMouseUp(MouseUpEvent event)`
`protected void`	`onReconfigure(ReconfigureEvent event)`
`protected void`	`onScroll(ScrollEvent event)`
`void`	`removeEditor(ColumnConfig<M,?> columnConfig)` Removes the editor for the given column.
`void`	`setClicksToEdit(ClicksToEdit clicksToEdit)` Sets the number of clicks to edit (defaults to ONE).
`void`	`setEditableGrid(Grid<M> editableGrid)` Sets the target grid to be edited.
`void`	`setErrorSummary(boolean errorSummary)` True to show a tooltip with an error summary (defaults to true)
`void`	`setMonitorPoll(int monitorPoll)` Sets the polling interval that the row editor validation is run (defaults to 200).
`void`	`setMonitorValid(boolean monitorValid)` True to monitor the valid status of this editor (defaults to true).
`protected abstract void`	`showTooltip(SafeHtml content)`
`protected void`	`startEditing(Element target)` Starts editing for the given cell.
`abstract void`	`startEditing(Grid.GridCell cell)` Starts editing for the given cell.
`protected void`	`startMonitoring()`
`protected void`	`stopMonitoring()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - activeCell
```
protected Grid.GridCell activeCell
```
  - callback
```
protected Grid.Callback callback
```
  - columnModel
```
protected ColumnModel<M> columnModel
```
  - converterMap
```
protected Map<ColumnConfig<M,?>,Converter<?,?>> converterMap
```
  - editableGrid
```
protected Grid<M> editableGrid
```
  - editorMap
```
protected Map<ColumnConfig<M,?>,IsField<?>> editorMap
```
  - groupRegistration
```
protected GroupingHandlerRegistration groupRegistration
```
  - handler
```
protected AbstractGridEditing.Handler handler
```
  - keyNav
```
protected KeyNav keyNav
```
  - bound
```
protected boolean bound
```
  - lastValid
```
protected boolean lastValid
```
  - monitorTimer
```
protected Timer monitorTimer
```
  - tooltip
```
protected ToolTip tooltip
```
- Constructor Detail
  - AbstractGridEditing
```
public AbstractGridEditing()
```
- Method Detail
  - addBeforeStartEditHandler
```
public HandlerRegistration addBeforeStartEditHandler(BeforeStartEditEvent.BeforeStartEditHandler<M> handler)
```
    Specified by:
    
    addBeforeStartEditHandler in interface BeforeStartEditEvent.HasBeforeStartEditHandlers<M>
  - addCancelEditHandler
```
public HandlerRegistration addCancelEditHandler(CancelEditEvent.CancelEditHandler<M> handler)
```
    Specified by:
    
    addCancelEditHandler in interface CancelEditEvent.HasCancelEditHandlers<M>
  - addCompleteEditHandler
```
public HandlerRegistration addCompleteEditHandler(CompleteEditEvent.CompleteEditHandler<M> handler)
```
    Specified by:
    
    addCompleteEditHandler in interface CompleteEditEvent.HasCompleteEditHandlers<M>
  - 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>
    
    Type Parameters:
    
    N - the column data type
    
    O - the field data type
    
    Parameters:
    
    columnConfig - the column config
    
    converter - the converter
    
    field - the field
  - addEditor
```
public <N> void addEditor(ColumnConfig<M,N> columnConfig,
                          IsField<N> field)
```
    Description copied from interface: GridEditing
    
    Adds an editor for the given column.
    
    Specified by:
    
    addEditor in interface GridEditing<M>
    
    Type Parameters:
    
    N - the column data type
    
    Parameters:
    
    columnConfig - the column config
    
    field - the field
  - addStartEditHandler
```
public HandlerRegistration addStartEditHandler(StartEditEvent.StartEditHandler<M> handler)
```
    Specified by:
    
    addStartEditHandler in interface StartEditEvent.HasStartEditHandlers<M>
  - cancelEditing
```
public abstract void cancelEditing()
```
    Description copied from interface: GridEditing
    
    Cancels an active edit.
    
    Specified by:
    
    cancelEditing in interface GridEditing<M>
  - clearEditors
```
public void clearEditors()
```
    Clears the editors.
  - completeEditing
```
public abstract void completeEditing()
```
    Description copied from interface: GridEditing
    
    Completes the active edit.
    
    Specified by:
    
    completeEditing in interface GridEditing<M>
  - fireEvent
```
public void fireEvent(<any> event)
```
  - getActiveCell
```
public Grid.GridCell getActiveCell()
```
    Returns the active cell.
    
    Returns:
    
    the active cell or null if no active edit
  - getClicksToEdit
```
public ClicksToEdit getClicksToEdit()
```
    Returns the clicks to edit.
    
    Returns:
    
    the clicks to edit
  - getConverter
```
public <N,O> Converter<N,O> getConverter(ColumnConfig<M,N> columnConfig)
```
    Description copied from interface: GridEditing
    
    Returns the converter for the given column.
    
    Specified by:
    
    getConverter in interface GridEditing<M>
    
    Type Parameters:
    
    N - the column data type
    
    O - the field data type
    
    Parameters:
    
    columnConfig - the column config
    
    Returns:
    
    the converter
  - getEditableGrid
```
public Grid<M> getEditableGrid()
```
    Description copied from interface: GridEditing
    
    Returns the target grid.
    
    Specified by:
    
    getEditableGrid in interface GridEditing<M>
    
    Returns:
    
    the target grid
  - getEditor
```
public <O> IsField<O> getEditor(ColumnConfig<M,?> columnConfig)
```
    Description copied from interface: GridEditing
    
    Returns the editor for the given column.
    
    Specified by:
    
    getEditor in interface GridEditing<M>
    
    Type Parameters:
    
    O - the field data type
    
    Parameters:
    
    columnConfig - the column config
    
    Returns:
    
    the editor
  - getMonitorPoll
```
public int getMonitorPoll()
```
    Returns the interval that the editor is validated.
    
    Returns:
    
    the interval in ms
  - isEditing
```
public boolean isEditing()
```
    Description copied from interface: GridEditing
    
    Returns true if editing is active.
    
    Specified by:
    
    isEditing in interface GridEditing<M>
    
    Returns:
    
    true if editing
  - isErrorSummary
```
public boolean isErrorSummary()
```
    Returns true if a tooltip with an error summary is shown.
    
    Returns:
    
    true if a tooltip with an error summary is shown
  - isMonitorValid
```
public boolean isMonitorValid()
```
    Returns true if valid monitoring is enabled.
    
    Returns:
    
    the monitor valid state
  - 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>
    
    Parameters:
    
    columnConfig - the column config
  - setClicksToEdit
```
public void setClicksToEdit(ClicksToEdit clicksToEdit)
```
    Sets the number of clicks to edit (defaults to ONE).
    
    Parameters:
    
    clicksToEdit - the clicks to edit
  - 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>
    
    Parameters:
    
    editableGrid - the editable grid
  - setErrorSummary
```
public void setErrorSummary(boolean errorSummary)
```
    True to show a tooltip with an error summary (defaults to true)
    
    Parameters:
    
    errorSummary - true to show an error summary.
  - setMonitorPoll
```
public void setMonitorPoll(int monitorPoll)
```
    Sets the polling interval that the row editor validation is run (defaults to 200).
    
    Parameters:
    
    monitorPoll - the polling interval in ms in that validation is done
  - setMonitorValid
```
public void setMonitorValid(boolean monitorValid)
```
    True to monitor the valid status of this editor (defaults to true).
    
    Parameters:
    
    monitorValid - true to monitor this row editor
  - startEditing
```
public abstract void startEditing(Grid.GridCell cell)
```
    Description copied from interface: GridEditing
    
    Starts editing for the given cell.
    
    Specified by:
    
    startEditing in interface GridEditing<M>
    
    Parameters:
    
    cell - the cell
  - bindHandler
```
protected void bindHandler()
```
  - ensureHandlers
```
protected HandlerManager ensureHandlers()
```
  - ensureInternalKeyNav
```
protected KeyNav ensureInternalKeyNav()
```
  - ensureInternHandler
```
protected AbstractGridEditing.Handler ensureInternHandler()
```
  - findCell
```
protected Grid.GridCell findCell(Element target)
```
  - focusCell
```
protected void focusCell(int row,
                         int col)
```
  - focusGrid
```
protected void focusGrid()
```
  - getErrorHtml
```
protected abstract SafeHtml getErrorHtml()
```
  - getErrorMessage
```
protected void getErrorMessage(IsField<?> field,
                               SafeHtmlBuilder sb,
                               SafeHtml title)
```
  - handleDoubleEdit
```
protected void handleDoubleEdit(NativeEvent event)
```
  - handleHeaderMouseDown
```
protected <N,O> void handleHeaderMouseDown(HeaderMouseDownEvent event)
```
  - handleSingleEdit
```
protected void handleSingleEdit(NativeEvent event)
```
  - hideTooltip
```
protected void hideTooltip()
```
  - isValid
```
protected abstract boolean isValid()
```
  - onAttachOrDetach
```
protected void onAttachOrDetach(AttachEvent event)
```
  - onClick
```
protected void onClick(ClickEvent event)
```
  - onDoubleClick
```
protected void onDoubleClick(DoubleClickEvent event)
```
  - onEnter
```
protected void onEnter(NativeEvent evt)
```
  - onEsc
```
protected void onEsc(NativeEvent evt)
```
  - onMouseDown
```
protected void onMouseDown(MouseDownEvent event)
```
  - onMouseUp
```
protected void onMouseUp(MouseUpEvent event)
```
  - onReconfigure
```
protected void onReconfigure(ReconfigureEvent event)
```
  - onScroll
```
protected void onScroll(ScrollEvent event)
```
  - showTooltip
```
protected abstract void showTooltip(SafeHtml content)
```
  - startEditing
```
protected void startEditing(Element target)
```
    Description copied from interface: GridEditing
    
    Starts editing for the given cell.
    
    Specified by:
    
    startEditing in interface GridEditing<M>
    
    Parameters:
    
    target - the cell
  - startMonitoring
```
protected void startMonitoring()
```
  - stopMonitoring
```
protected void stopMonitoring()
```

Class AbstractGridEditing<M>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

activeCell

callback

columnModel

converterMap

editableGrid

editorMap

groupRegistration

handler

keyNav

bound

lastValid

monitorTimer

tooltip

Constructor Detail

AbstractGridEditing

Method Detail

addBeforeStartEditHandler

addCancelEditHandler

addCompleteEditHandler

addEditor

addEditor

addStartEditHandler

cancelEditing

clearEditors

completeEditing

fireEvent

getActiveCell

getClicksToEdit

getConverter

getEditableGrid

getEditor

getMonitorPoll

isEditing

isErrorSummary

isMonitorValid

removeEditor

setClicksToEdit

setEditableGrid

setErrorSummary

setMonitorPoll

setMonitorValid

startEditing

bindHandler

ensureHandlers

ensureInternalKeyNav

ensureInternHandler

findCell

focusCell

focusGrid

getErrorHtml

getErrorMessage

handleDoubleEdit

handleHeaderMouseDown

handleSingleEdit

hideTooltip

isValid

onAttachOrDetach

onClick

onDoubleClick

onEnter

onEsc

onMouseDown

onMouseUp

onReconfigure

onScroll

showTooltip

startEditing

startMonitoring

stopMonitoring