[IMP] add note on Widget insertion methods starting widgets themselves

bzr revid: xmo@openerp.com-20110819135454-3qykqkxukzja36yd
This commit is contained in:
Xavier Morel 2011-08-19 15:54:54 +02:00
parent 4e1bcd16f9
commit 2cefb02439
1 changed files with 7 additions and 0 deletions

View File

@ -195,6 +195,13 @@ The new class can then be used in the following manner:
After these two lines have executed (and any promise returned by ``appendTo`` After these two lines have executed (and any promise returned by ``appendTo``
has been resolved if needed), the widget is ready to be used. has been resolved if needed), the widget is ready to be used.
.. note:: the insertion methods will start the widget themselves, and will
return the result of :js:func:`~openerp.base.Widget.start()`.
If for some reason you do not want to call these methods, you will
have to first call :js:func:`~openerp.base.Widget.render()` on the
widget, then insert it into your DOM and start it.
If the widget is not needed anymore (because it's transient), simply terminate If the widget is not needed anymore (because it's transient), simply terminate
it: it: