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

Class AbstractGridEditing<M>

java.lang.Object

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

All Implemented Interfaces:

HasHandlers, 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>

Constructor Summary

Constructors

Constructor and Description
AbstractGridEditing()

Method Summary

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)
abstract void	cancelEditing() Cancels an active edit.
void	clearEditors() Clears the editors.
abstract void	completeEditing() Completes the active edit.
void	fireEvent(GwtEvent<?> event)
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.
int	getMonitorPoll() Returns the interval that the editor is validated.
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.
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).
abstract void	startEditing(Grid.GridCell cell) Starts editing for the given cell.

Methods inherited from class java.lang.Object

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

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>

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>

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(GwtEvent<?> event)

Specified by:

fireEvent in interface HasHandlers

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>

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>

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