com.vaadin.ui

Class Grid.CommitErrorEvent

java.lang.Object

java.util.EventObject

com.vaadin.event.ConnectorEvent

com.vaadin.ui.Component.Event

com.vaadin.ui.Grid.CommitErrorEvent

All Implemented Interfaces:

Serializable

Enclosing class:

Grid

public static class Grid.CommitErrorEvent
extends Component.Event

An event which is fired when saving the editor fails

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
CommitErrorEvent(Grid grid, FieldGroup.CommitException cause)

Method Summary

Modifier and Type	Method and Description
void	addErrorColumn(Grid.Column column) Marks that an error indicator should be shown for the editor of a column.
FieldGroup.CommitException	getCause() Retrieves the cause of the failure
Grid	getComponent() Gets the component where the event occurred.
Collection<Grid.Column>	getErrorColumns() Gets all the columns that have been marked as erroneous.
String	getUserErrorMessage() Gets the error message to show to the user.
boolean	isValidationFailure() Checks if validation exceptions caused this error
void	setUserErrorMessage(String userErrorMessage) Sets the error message to show to the user.

Methods inherited from class com.vaadin.event.ConnectorEvent

getConnector

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitErrorEvent

public CommitErrorEvent(Grid grid,
                        FieldGroup.CommitException cause)

Method Detail

getCause

public FieldGroup.CommitException getCause()

Retrieves the cause of the failure

Returns:

the cause of the failure

getComponent

public Grid getComponent()

Description copied from class: Component.Event

Gets the component where the event occurred.

Overrides:

getComponent in class Component.Event

Returns:

the source component of the event

isValidationFailure

public boolean isValidationFailure()

Checks if validation exceptions caused this error

Returns:

true if the problem was caused by a validation error

addErrorColumn

public void addErrorColumn(Grid.Column column)

Marks that an error indicator should be shown for the editor of a column.

Parameters:

column - the column to show an error for

getErrorColumns

public Collection<Grid.Column> getErrorColumns()

Gets all the columns that have been marked as erroneous.

Returns:

an umodifiable collection of erroneous columns

getUserErrorMessage

public String getUserErrorMessage()

Gets the error message to show to the user.

Returns:

error message to show

setUserErrorMessage

public void setUserErrorMessage(String userErrorMessage)

Sets the error message to show to the user.

Parameters:

userErrorMessage - the user error message to set