com.vaadin.terminal
Class UserError

java.lang.Object
  com.vaadin.terminal.UserError

All Implemented Interfaces:

ErrorMessage, Paintable, Serializable, EventListener

public class UserError
extends Object
implements ErrorMessage

UserError is a controlled error occurred in application. User errors are occur in normal usage of the application and guide the user.

Since:

3.0

Version:

6.8.18

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Field Summary

static int	CONTENT_PREFORMATTED Content mode, where the error contains preformatted text.
static int	CONTENT_TEXT Content mode, where the error contains only plain text.
static int	CONTENT_UIDL Formatted content mode, where the contents is XML restricted to the UIDL 1.0 formatting markups.
static int	CONTENT_XHTML Content mode, where the error contains XHTML.

Fields inherited from interface com.vaadin.terminal.ErrorMessage

CRITICAL, ERROR, INFORMATION, SYSTEMERROR, WARNING

Constructor Summary

UserError(String textErrorMessage)
Creates a textual error message of level ERROR.

UserError(String message, int contentMode, int errorLevel)
Creates a error message with level and content mode.

Method Summary

void	addListener(Paintable.RepaintRequestListener listener) Error messages are inmodifiable and thus listeners are not needed.
String	getDebugId() Get's currently set debug identifier
int	getErrorLevel() Gets the errors level.
void	paint(PaintTarget target) Paints the Paintable into a UIDL stream.
void	removeListener(Paintable.RepaintRequestListener listener) Error messages are inmodifiable and thus listeners are not needed.
void	requestRepaint() Error messages are inmodifiable and thus listeners are not needed.
void	requestRepaintRequests() Request sending of repaint events on any further visible changes.
void	setDebugId(String id) Adds an unique id for component that get's transferred to terminal for testing purposes.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TEXT

public static final int CONTENT_TEXT

Content mode, where the error contains only plain text.

See Also:

Constant Field Values

CONTENT_PREFORMATTED

public static final int CONTENT_PREFORMATTED

Content mode, where the error contains preformatted text.

See Also:

Constant Field Values

CONTENT_UIDL

public static final int CONTENT_UIDL

Formatted content mode, where the contents is XML restricted to the UIDL 1.0 formatting markups.

See Also:

Constant Field Values

CONTENT_XHTML

public static final int CONTENT_XHTML

Content mode, where the error contains XHTML.

See Also:

Constant Field Values

Constructor Detail

UserError

public UserError(String textErrorMessage)

Creates a textual error message of level ERROR.

Parameters:

textErrorMessage - the text of the error message.

UserError

public UserError(String message,
                 int contentMode,
                 int errorLevel)

Creates a error message with level and content mode.

Parameters:

message - the error message.

contentMode - the content Mode.

errorLevel - the level of error.

Method Detail

getErrorLevel

public int getErrorLevel()

Description copied from interface: ErrorMessage

Gets the errors level.

Specified by:

getErrorLevel in interface ErrorMessage

Returns:

the level of error as an integer.

addListener

public void addListener(Paintable.RepaintRequestListener listener)

Description copied from interface: ErrorMessage

Error messages are inmodifiable and thus listeners are not needed. This method should be implemented as empty.

Specified by:

addListener in interface ErrorMessage

Specified by:

addListener in interface Paintable

Parameters:

listener - the listener to be added.

See Also:

Paintable.addListener(Paintable.RepaintRequestListener)

removeListener

public void removeListener(Paintable.RepaintRequestListener listener)

Description copied from interface: ErrorMessage

Error messages are inmodifiable and thus listeners are not needed. This method should be implemented as empty.

Specified by:

removeListener in interface ErrorMessage

Specified by:

removeListener in interface Paintable

Parameters:

listener - the listener to be removed.

See Also:

Paintable.removeListener(Paintable.RepaintRequestListener)

requestRepaint

public void requestRepaint()

Description copied from interface: ErrorMessage

Error messages are inmodifiable and thus listeners are not needed. This method should be implemented as empty.

Specified by:

requestRepaint in interface ErrorMessage

Specified by:

requestRepaint in interface Paintable

See Also:

Paintable.requestRepaint()

paint

public void paint(PaintTarget target)
           throws PaintException

Description copied from interface: Paintable

Paints the Paintable into a UIDL stream. This method creates the UIDL sequence describing it and outputs it to the given UIDL stream.

It is called when the contents of the component should be painted in response to the component first being shown or having been altered so that its visual representation is changed.

Specified by:

paint in interface Paintable

Parameters:

target - the target UIDL stream where the component should paint itself to.

Throws:

PaintException - if the paint operation failed.

requestRepaintRequests

public void requestRepaintRequests()

Description copied from interface: Paintable

Request sending of repaint events on any further visible changes. Normally the paintable only send up to one repaint request for listeners after paint as the paintable as the paintable assumes that the listeners already know about the repaint need. This method resets the assumtion. Paint implicitly does the assumtion reset functionality implemented by this method.

This method is normally used only by the terminals to note paintables about implicit repaints (painting the component without actually invoking paint method).

Specified by:

requestRepaintRequests in interface Paintable

toString

public String toString()

Overrides:

toString in class Object

getDebugId

public String getDebugId()

Description copied from interface: Paintable

Get's currently set debug identifier

Specified by:

getDebugId in interface Paintable

Returns:

current debug id, null if not set

setDebugId

public void setDebugId(String id)

Description copied from interface: Paintable

Adds an unique id for component that get's transferred to terminal for testing purposes. Keeping identifiers unique throughout the Application instance is on programmers responsibility.

Note, that with the current terminal implementation the identifier cannot be changed while the component is visible. This means that the identifier should be set before the component is painted for the first time and kept the same while visible in the client.

Specified by:

setDebugId in interface Paintable

Parameters:

id - A short (< 20 chars) alphanumeric id