|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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 Summary | |
<private> <static> Object |
createdOn
createdOn |
<private> <static> Object |
portlets
portlets |
<static> Object |
TYPE_ADMIN_EDITOR_PAGE
TYPE_ADMIN_EDITOR_PAGE |
<static> Object |
TYPE_ADMIN_PAGE
TYPE_ADMIN_PAGE |
<static> Object |
TYPE_COMMUNITY_PAGE
TYPE_COMMUNITY_PAGE |
<static> Object |
TYPE_MY_PAGE
TYPE_MY_PAGE |
<static> Object |
TYPE_NON_HOSTED_DISPLAY_MODE
TYPE_NON_HOSTED_DISPLAY_MODE |
Constructor Summary | |
PTPortalPage
()
PTPortalPage singleton constructor |
Method Summary | |
<static> <private> void
|
addPortlet(portlet)
Adds a portlet to the portlets array, overwriting existing one if it exists. |
<static> PTPortlet
|
getPortletByGUID(guid)
Returns a single portlet, given a GUID. |
<static> PTPortlet
|
getPortletByID(id)
Returns a single portlet, given an ID. |
<static> PTPortlet
|
getPortletByName(name)
Returns a single portlet, given a name. |
<static> Array
|
getPortlets()
Returns a hash of all the portlets on the page, keyed by portlet id. |
Field Detail |
<private> <static> Object createdOn
<private> <static> Object portlets
<static> Object TYPE_ADMIN_EDITOR_PAGE
<static> Object TYPE_ADMIN_PAGE
<static> Object TYPE_COMMUNITY_PAGE
<static> Object TYPE_MY_PAGE
<static> Object TYPE_NON_HOSTED_DISPLAY_MODE
Constructor Detail |
PTPortalPage()
Method Detail |
<static> <private> void addPortlet(portlet)
portlet
- Portlet to add (PTPortlet object)
<static> PTPortlet getPortletByGUID(guid)
guid
- GUID of Portlet being requested (string)
<static> PTPortlet getPortletByID(id)
guid
- ID of Portlet being requested (string)
<static> PTPortlet getPortletByName(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.
name
- Name of Portlet being requested (string)
<static> Array getPortlets()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |