Package muntjac :: Package addon :: Package csstools :: Module render_info :: Class RenderInfo
[hide private]
[frames] | no frames]

Class RenderInfo

source code

object --+
         |
        RenderInfo

Class for fetching render information from the client side widgets.


Authors:
jouni@vaadin.com, Richard Lincoln
Instance Methods [hide private]
 
__init__(self, obj)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
getProperty(self, prop) source code

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

Class Methods [hide private]
 
get(cls, c, cb, *props)
Initiate a request to get the render information for a given component.
source code
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

get(cls, c, cb, *props)
Class Method

source code 

Initiate a request to get the render information for a given component.

The information can be for example the exact pixel size and position, the font size, visibility, margin, padding or border of the component in the browser. See possible values from the {@link CssProperty} enumerable.

The information will be delivered asynchronously from the client, and passed as a parameter to the callback method.

You can limit the amount of properties transmitted over the connection by passing the desired property names as the last parameter for the method.

Parameters:
  • c - The component whose render information you wish to get.
  • cb - The callback object which will receive the information when it is available.
  • props - Optional. The list of CSS properties you wish to get from the client (limit the amount of transferred data). You can pass any type of objects here, the __str__() method will be used to convert them to actual property names. Preferably use the CssProperty enumerable for feasible values.

__init__(self, obj)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)