Package muntjac :: Package data :: Module validator :: Class InvalidValueException
[hide private]
[frames] | no frames]

Class InvalidValueException

source code

              object --+                
                       |                
exceptions.BaseException --+            
                           |            
        exceptions.Exception --+        
                               |        
        exceptions.StandardError --+    
                                   |    
             exceptions.RuntimeError --+
                                       |
                  object --+           |
                           |           |
         util.IEventListener --+       |
                               |       |
   terminal.paintable.IPaintable --+   |
                                   |   |
terminal.error_message.IErrorMessage --+
                                       |
                                      InvalidValueException

Exception that is thrown by a IValidator when a value is invalid.

The default implementation of InvalidValueException does not support HTML in error messages. To enable HTML support, override getHtmlMessage and use the subclass in validators.


Authors:
Vaadin Ltd., Richard Lincoln

Version: 1.1.2

Instance Methods [hide private]
 
__init__(self, message, causes=None)
Constructs a new InvalidValueException with a set of causing validation exceptions.
source code
 
isInvisible(self)
Check if the error message should be hidden.
source code
 
getErrorLevel(self)
Gets the errors level.
source code
 
paint(self, target)
Paints the IPaintable into a UIDL stream.
source code
 
getHtmlMessage(self)
Returns the message of the error in HTML.
source code
 
addListener(self, listener, iface=None)
Error messages are unmodifiable and thus listeners are not needed.
source code
 
addCallback(self, callback, eventType=None, *args) source code
 
removeListener(self, listener, iface=None)
Error messages are inmodifiable and thus listeners are not needed.
source code
 
removeCallback(self, callback, eventType=None) source code
 
requestRepaint(self)
Error messages are inmodifiable and thus listeners are not needed.
source code
 
requestRepaintRequests(self)
Request sending of repaint events on any further visible changes.
source code
 
getDebugId(self)
Get's currently set debug identifier
source code
 
setDebugId(self, idd)
Adds an unique id for component that get's transferred to terminal for testing purposes.
source code
 
getCauses(self)
Returns the InvalidValueExceptions that caused this exception.
source code

Inherited from exceptions.RuntimeError: __new__

Inherited from exceptions.BaseException: __delattr__, __getattribute__, __getitem__, __getslice__, __reduce__, __repr__, __setattr__, __setstate__, __str__, __unicode__

Inherited from object: __format__, __hash__, __reduce_ex__, __sizeof__, __subclasshook__

Class Variables [hide private]

Inherited from terminal.error_message.IErrorMessage: CRITICAL, ERROR, INFORMATION, SYSTEMERROR, WARNING

Properties [hide private]

Inherited from exceptions.BaseException: args, message

Inherited from object: __class__

Method Details [hide private]

__init__(self, message, causes=None)
(Constructor)

source code 

Constructs a new InvalidValueException with a set of causing validation exceptions. The causing validation exceptions are included when the exception is painted to the client.

Parameters:
  • message - The detail message of the problem.
  • causes - One or more InvalidValueExceptions that caused this exception.
Overrides: object.__init__

isInvisible(self)

source code 

Check if the error message should be hidden.

An empty (null or "") message is invisible unless it contains nested exceptions that are visible.

Returns:
true if the error message should be hidden, false otherwise

getErrorLevel(self)

source code 

Gets the errors level.

Returns:
the level of error as an integer.
Overrides: terminal.error_message.IErrorMessage.getErrorLevel
(inherited documentation)

paint(self, target)

source code 

Paints the IPaintable 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.

Parameters:
  • target - the target UIDL stream where the component should paint itself to.
Raises:
Overrides: terminal.paintable.IPaintable.paint
(inherited documentation)

getHtmlMessage(self)

source code 

Returns the message of the error in HTML.

Note that this API may change in future versions.

addListener(self, listener, iface=None)

source code 

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

Parameters:
  • listener - the listener to be added.
Overrides: terminal.paintable.IPaintable.addListener
(inherited documentation)

addCallback(self, callback, eventType=None, *args)

source code 
Overrides: terminal.paintable.IPaintable.addCallback

removeListener(self, listener, iface=None)

source code 

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

Parameters:
  • listener - the listener to be removed.
Overrides: terminal.paintable.IPaintable.removeListener
(inherited documentation)

removeCallback(self, callback, eventType=None)

source code 
Overrides: terminal.paintable.IPaintable.removeCallback

requestRepaint(self)

source code 

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

Overrides: terminal.paintable.IPaintable.requestRepaint
(inherited documentation)

requestRepaintRequests(self)

source code 

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).

Overrides: terminal.paintable.IPaintable.requestRepaintRequests
(inherited documentation)

getDebugId(self)

source code 

Get's currently set debug identifier

Returns:
current debug id, null if not set
Overrides: terminal.paintable.IPaintable.getDebugId
(inherited documentation)

setDebugId(self, idd)

source code 

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.

Parameters:
  • idd - A short (< 20 chars) alphanumeric id
Overrides: terminal.paintable.IPaintable.setDebugId
(inherited documentation)

getCauses(self)

source code 

Returns the InvalidValueExceptions that caused this exception.

Returns:
An array containing the InvalidValueExceptions that caused this exception. Returns an empty array if this exception was not caused by other exceptions.