Package muntjac :: Package terminal :: Module composite_error_message :: Class CompositeErrorMessage
[hide private]
[frames] | no frames]

Class CompositeErrorMessage

source code

         object --+            
                  |            
util.IEventListener --+        
                      |        
   paintable.IPaintable --+    
                          |    
error_message.IErrorMessage --+
                              |
                             CompositeErrorMessage

Class for combining multiple error messages together.


Author: Vaadin Ltd.

Version: 1.1.2

Instance Methods [hide private]
 
__init__(self, errorMessages)
Constructor for CompositeErrorMessage.
source code
 
getErrorLevel(self)
The error level is the largest error level in.
source code
 
addErrorMessage(self, error)
Adds a error message into this composite message.
source code
 
iterator(self)
Gets Error Iterator.
source code
 
paint(self, target)
Paints the IPaintable into a UIDL stream.
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
 
__str__(self)
Returns a comma separated list of the error messages.
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

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, errorMessages)
(Constructor)

source code 

Constructor for CompositeErrorMessage.

Parameters:
  • errorMessages - the Collection of error messages that are listed together. At least one message is required.
Overrides: object.__init__

getErrorLevel(self)

source code 

The error level is the largest error level in.

Returns:
the level of error as an integer.
Overrides: error_message.IErrorMessage.getErrorLevel

See Also: muntjac.terminal.IErrorMessage.getErrorLevel

addErrorMessage(self, error)

source code 

Adds a error message into this composite message. Updates the level field.

Parameters:
  • error - the error message to be added. Duplicate errors are ignored.

iterator(self)

source code 

Gets Error Iterator.

Returns:
the error iterator.

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: paintable.IPaintable.paint

See Also: IPaintable.paint

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: paintable.IPaintable.addListener
(inherited documentation)

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

source code 
Overrides: 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: paintable.IPaintable.removeListener
(inherited documentation)

removeCallback(self, callback, eventType=None)

source code 
Overrides: 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: 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: paintable.IPaintable.requestRepaintRequests
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 

Returns a comma separated list of the error messages.

Returns:
comma separated list of error messages.
Overrides: object.__str__

getDebugId(self)

source code 

Get's currently set debug identifier

Returns:
current debug id, null if not set
Overrides: 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: paintable.IPaintable.setDebugId
(inherited documentation)