Package muntjac :: Package addon :: Package canvas :: Module canvas :: Class Canvas
[hide private]
[frames] | no frames]

Class Canvas

source code

                          object --+                
                                   |                
                 util.IEventListener --+            
                                       |            
           terminal.paintable.IPaintable --+        
                                           |        
                              object --+   |        
                                       |   |        
  terminal.variable_owner.IVariableOwner --+        
                                           |        
                              object --+   |        
                                       |   |        
             terminal.sizeable.ISizeable --+        
                                           |        
                     ui.component.IComponent --+    
                                               |    
                                  object --+   |    
                                           |   |    
event.method_event_source.IMethodEventSource --+    
                                               |    
         ui.abstract_component.AbstractComponent --+
                                                   |
                                                  Canvas

Server side component for the VCanvas widget.

Instance Methods [hide private]
 
__init__(self)
Constructs a new IComponent.
source code
 
createLinearGradient(self, name, x0, y0, x1, y1) source code
 
createRadialGradient(self, name, x0, y0, r0, x1, y1, r1) source code
 
cubicCurveTo(self, cp1x, cp1y, cp2x, cp2y, x, y) source code
 
drawImage(self, *args) source code
 
fill(self) source code
 
fillRect(self, startX, startY, width, height) source code
 
lineTo(self, x, y) source code
 
moveTo(self, x, y) source code
 
quadraticCurveTo(self, cpx, cpy, x, y) source code
 
rect(self, startX, startY, width, height) source code
 
rotate(self, angle) source code
 
setGradientFillStyle(self, gradient) source code
 
setFillStyle(self, *args) source code
 
setLineCap(self, lineCap) source code
 
setLineJoin(self, lineJoin) source code
 
setLineWidth(self, width) source code
 
setMiterLimit(self, miterLimit) source code
 
setGradientStrokeStyle(self, gradient) source code
 
setColorStrokeStyle(self, color) source code
 
strokeRect(self, startX, startY, width, height) source code
 
transform(self, m11, m12, m21, m22, dx, dy) source code
 
arc(self, x, y, radius, startAngle, endAngle, antiClockwise) source code
 
translate(self, x, y) source code
 
scale(self, x, y) source code
 
stroke(self) source code
 
saveContext(self) source code
 
restoreContext(self) source code
 
setBackgroundColor(self, rgb) source code
 
setStrokeColor(self, rgb) source code
 
beginPath(self) source code
 
clear(self) source code
 
reset(self) source code
 
paintContent(self, target)
Paints any needed component-specific things to the given UIDL stream.
source code
 
changeVariables(self, source, variables)
Called when one or more variables handled by the implementing class are changed.
source code
 
setStrokeStyle(self, r, g, b) source code
 
setGlobalAlpha(self, alpha) source code
 
closePath(self) source code
 
setGlobalCompositeOperation(self, mode) source code
 
addColorStop(self, gradient, offset, color) source code
 
addListener(self, listener, iface=None)
Registers a new (generic) component event listener for the component:
source code
 
removeListener(self, listener, iface=None)
Removes a previously registered component event listener from this component.
source code
 
fireMouseDown(self, x, y) source code
 
fireMouseUp(self, x, y) source code

Inherited from ui.abstract_component.AbstractComponent: __getstate__, __setstate__, addCallback, addStyleName, attach, childRequestedRepaint, detach, fireComponentErrorEvent, fireComponentEvent, fireEvent, fireRequestRepaintEvent, focus, getApplication, getCSSHeight, getCSSWidth, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isReadOnly, isVisible, paint, parseStringSize, registerCallback, registerListener, removeCallback, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidthUnits, withdrawCallback, withdrawListener

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

Class Variables [hide private]
  CLIENT_WIDGET = None
hash(x)
  TYPE_MAPPING = 'org.vaadin.hezamu.canvas.Canvas'
  BEVEL = 'BEVEL'
  BUTT = 'BUTT'
  DESTINATION_OVER = 'DESTINATION_OVER'
  SOURCE_OVER = 'SOURCE_OVER'
  MITER = 'MITER'
  TRANSPARENT = 'TRANSPARENT'
  ROUND = 'ROUND'
  SQUARE = 'SQUARE'

Inherited from ui.abstract_component.AbstractComponent: SIZE_PATTERN

Inherited from terminal.sizeable.ISizeable: SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS, UNIT_SYMBOLS

Instance Variables [hide private]
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

Constructs a new IComponent.

Overrides: object.__init__
(inherited documentation)

paintContent(self, target)

source code 

Paints any needed component-specific things to the given UIDL stream. The more general paint method handles all general attributes common to all components, and it calls this method to paint any component-specific attributes to the UIDL stream.

Parameters:
  • target - the target UIDL stream where the component should paint itself to
Raises:
Overrides: ui.abstract_component.AbstractComponent.paintContent
(inherited documentation)

changeVariables(self, source, variables)

source code 

Called when one or more variables handled by the implementing class are changed.

Parameters:
  • source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.
  • variables - the Mapping from variable names to new variable values.
Overrides: terminal.variable_owner.IVariableOwner.changeVariables
(inherited documentation)

addListener(self, listener, iface=None)

source code 

Registers a new (generic) component event listener for the component:

 class Listening(CustomComponent, IListener):

     # Stored for determining the source of an event
     ok = None

     status = None  # For displaying info about the event

     def __init__(self):
         layout = VerticalLayout()

         # Some miscellaneous component
         name = TextField("Say it all here")
         name.addListener(self)
         name.setImmediate(true)
         layout.addComponent(name)

         # Handle button clicks as generic events instead
         # of Button.ClickEvent events
         ok = new Button("OK")
         ok.addListener(self)
         layout.addComponent(ok)

         # For displaying information about an event
         status = new Label("")
         layout.addComponent(status)

         setCompositionRoot(layout)


     def componentEvent(event):
         # Act according to the source of the event
         if (event.getSource() == ok):
             getWindow().showNotification("Click!")

         status.setValue("Event from " +
                 event.getSource().__class__.__name__
                 + ": " + event.__class__.__name__)


 listening = Listening()
 layout.addComponent(listening)
Parameters:
  • listener - the new IListener to be registered.
Raises:
  • ValueError - unless method has a match in object
Overrides: event.method_event_source.IMethodEventSource.addListener
(inherited documentation)

removeListener(self, listener, iface=None)

source code 

Removes a previously registered component event listener from this component.

Parameters:
  • listener - the listener to be removed.
Overrides: event.method_event_source.IMethodEventSource.removeListener
(inherited documentation)