Class PTPortalPage

Object
   |
   +--PTPortalPage

class PTPortalPage

A client-side object wrapper for the Portal Page. Contains methods for retrieving PTPortlet instances that are on the page.
Defined in PTPortalPage.js

Field Detail

createdOn

<private> <static> Object createdOn

createdOn

portlets

<private> <static> Object portlets

portlets

TYPE_ADMIN_EDITOR_PAGE

<static> Object TYPE_ADMIN_EDITOR_PAGE

TYPE_ADMIN_EDITOR_PAGE

TYPE_ADMIN_PAGE

<static> Object TYPE_ADMIN_PAGE

TYPE_ADMIN_PAGE

TYPE_COMMUNITY_PAGE

<static> Object TYPE_COMMUNITY_PAGE

TYPE_COMMUNITY_PAGE

TYPE_MY_PAGE

<static> Object TYPE_MY_PAGE

TYPE_MY_PAGE

TYPE_NON_HOSTED_DISPLAY_MODE

<static> Object TYPE_NON_HOSTED_DISPLAY_MODE

TYPE_NON_HOSTED_DISPLAY_MODE

PTPortalPage

PTPortalPage()

PTPortalPage singleton constructor

addPortlet

<static>  <private> void addPortlet(portlet)

Adds a portlet to the portlets array, overwriting existing one if it exists. There is no need to call this method directly -- the constructor for PTPortlet calls this automatically.

Parameters:
portlet - Portlet to add (PTPortlet object)

getPortletByGUID

<static> PTPortlet getPortletByGUID(guid)

Returns a single portlet, given a GUID.

Parameters:
guid - GUID of Portlet being requested (string)

Returns:
PTPortlet object

getPortletByID

<static> PTPortlet getPortletByID(id)

Returns a single portlet, given an ID.

Parameters:
guid - ID of Portlet being requested (string)

Returns:
PTPortlet object

getPortletByName

<static> PTPortlet getPortletByName(name)

Returns a single portlet, given a name.

NOTE: There is no restriction against having multiple portlets on the same page which have the same name, so portlet lookup by name in these cases is not guaranteed to achieve expected results. Also, internationalization of portlets may result in failed lookups unless the name argument matches exactly the internationalized name.

Parameters:
name - Name of Portlet being requested (string)

Returns:
PTPortlet object

getPortlets

<static> Array getPortlets()

Returns a hash of all the portlets on the page, keyed by portlet id.

Returns:
Array of PTPortlet objects