Zimlet JavaScript API Reference - ZmPortlet

Class ZmPortlet


Extends ZmItem.

This class provides the implementation for portlet for use in the portal application.

Defined in: ZmPortlet.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmPortlet(list, id, def)
Method Summary
Method Attributes Method Name and Description
 
Refreshes the portlet.
 
setContent(content)
Sets the content.
 
Sets the content url.
 
setPaused(paused)
Sets the portlet to "paused".
 
Sets the refresh interval.
Methods borrowed from class ZmItem:
cache, canAddTag, clear, create, deleteLocal, flagLocal, getById, getDefaultDndAction, getFolderId, getRestUrl, getTagImageFromIds, getTagImageInfo, hasTag, isReadOnly, isShared, modify, move, moveLocal, removeAllTagsLocal, rename, setFlag, tagLocal
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmPortlet(list, id, def)
Parameters:
{ZmList} list
the list that contains this item (may be null)
{String} id
the portlet id
{Object} def
the portlet definition
See:
ZmPortalApp
Method Detail
refresh()
Refreshes the portlet.

setContent(content)
Sets the content.
Parameters:
{String} content
the content

setContentUrl(url)
Sets the content url.
Parameters:
{String} url
the content url

setPaused(paused)
Sets the portlet to "paused".
Parameters:
{Boolean} paused
if true, pause the portlet

setRefreshInterval(interval)
Sets the refresh interval.
Parameters:
{int} interval
the refresh interval (in milliseconds)

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:36 GMT-0400 (EDT)