Class PTPortlet

Object
   |
   +--PTPortlet

class PTPortlet

PTPortlet object constructor

Defined in PTPortlet.js


Field Summary

  public var containerID
          The id attribute of the portlet's corresponding HTML element (string)
  public var gatewayPrefixURL
          The URL of the gateway prefix (string)
  public var guid
          The portlet object's global unique id (string)
  public var id
          The portlet object's id (string)
  public var isCollapsed
          Whether or not the portlet is currently collapsed (boolean, optional)
  public var name
          The portlet's internationalized name (string)
  public var refreshInterval
          The portlet's refresh interval, in milliseconds (integer, optional)
  public var refreshURL
          The URL to use for refreshing the portlet (string, optional)
  public var remoteBaseURL
          The base URL of the portlet's remote server (string)
  public var remoteRequestURL
          The fully qualified URL of the portlet's web service (string)
  public var responseErrorHandler
          The handler to call when a response error occurs, if the default behavior is undesirable (string or function reference, optional)
  public var responseErrors
          An array of response error objects.
  public var responsePostProcHandler
          The handler to call after calling the response handler (string or function reference, optional)
  public var responsePreProcHandler
          The handler to call before calling the response handler.
  public var secureGatewayPrefixURL
          The secure URL of the gateway prefix (string)
  private var _eventListeners
          A hash of namespaces containing eventListener handlers and eventListenerIDs
  private var _refreshTimeout
          The window.setTimeout key of the last window.setTimeout set for this portlet.
  public static var VERSION
          Version number (integer)
  private static var SESSION_PREF_NAME_PREFIX
          Prefix appended to session pref names for http transmission (string)
 

Constructor Summary

PTPortlet (id, guid, name, containerID, remoteRequestURL, remoteBaseURL, gatewayPrefixURL, secureGatewayPrefixURL, isCollapsed, refreshURL, refreshInterval)
           
 

Method Summary

  public static function getPortletByGUID(guid)
           Returns a single portlet, given an GUID
  public static function getPortletByID(id)
           Returns a single portlet, given an ID
  public static function 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.
  public static function getSessionPref(name)
           Get a single session pref
  public static function getSessionPrefs(names)
           Get multiple session prefs
  public static function setSessionPref(name,value)
           Set a single session pref
  public static function setSessionPrefs(hash)
           Set multiple session prefs
  private static function _getSessionPrefsFromXML(xmlDoc)
           Returns a hash of name/value pairs when passed a valid session prefs XML Document.
  private static function _postSetSessionPrefs(postContent)
           Posts request to set session prefs on server
  private static function _processGetSessionPrefs(postContent)
           Posts request to get session prefs from server and returns session prefs as a hash
  public function clearEvent(eventName,eventNamespace)
           Clears the event listener for an event
  public function clearRefreshInterval()
           Sets the refreshInterval of the portlet to 0 and clears any current refresh timers.
  public function deleteSessionPref(name)
           Deletes a single session pref
  public function deleteSessionPrefs(array)
           Deletes multiple session prefs
  public function formGetRefresh(form)
           Requests updated content from the server by submitting a form GET request
  public function formPostRefresh(form)
           Requests updated content from the server by submitting a form POST request
  public function formRefresh(form)
           Requests updated content from the server by submitting a form
  public function getRefreshInterval()
           Returns the refreshInterval of the portlet
  public function getRefreshURL()
           Returns the refresh URL of the portlet
  public function raiseEvent(eventName,eventArgs,eventNamespace)
           Raise an new event
  public function refresh(url)
           Refresh the portlet content from the server, using URL if provided
  public function refreshOnEvent(eventName,eventNamespace)
           Associate portlet refresh action with a specific event
  public function registerForEvent(eventName,eventCallback,eventNamespace)
           Register to be notified of an event
  public function setInnerHTML(html)
           Sets the innerHTML of the portlet from a string
  public function setRefreshInterval(refreshInterval,startNewRefreshTimer)
           Sets the refreshInterval of the portlet
  public function setRefreshURL(url)
           Sets the refresh URL of the portlet
  private function _clearRefreshTimer()
           Clears the refresh timer
  private function _createGetRefreshRequest(url,form)
           Create and invoke a refresh request to the server using GET
  private function _createPostRefreshRequest(url,form)
           Create and invoke a refresh request to the server using POST
  private function _handleResponseErrorXML(xmlDoc,response)
           Process error XML returned by the portal
  private function _refreshErrorHandler(response)
           Handles responses to refresh requests by examining them for errors
  private function _startRefreshTimer()
           Starts the refresh timer, first clearing out any previously set refresh timer for this portlet.
  private function transformURL(url)
           Transform a URL to be gatewayed

Field Detail

containerID

public var containerID

gatewayPrefixURL

public var gatewayPrefixURL

guid

public var guid

id

public var id

isCollapsed

public var isCollapsed

name

public var name

refreshInterval

public var refreshInterval

refreshURL

public var refreshURL

remoteBaseURL

public var remoteBaseURL

remoteRequestURL

public var remoteRequestURL

responseErrorHandler

public var responseErrorHandler

responseErrors

public var responseErrors

responsePostProcHandler

public var responsePostProcHandler

responsePreProcHandler

public var responsePreProcHandler

secureGatewayPrefixURL

public var secureGatewayPrefixURL

_eventListeners

private var _eventListeners

_refreshTimeout

private var _refreshTimeout

VERSION

public static var VERSION

SESSION_PREF_NAME_PREFIX

private static var SESSION_PREF_NAME_PREFIX

Constructor Detail

PTPortlet

function PTPortlet(id, guid, name, containerID, remoteRequestURL, remoteBaseURL, gatewayPrefixURL, secureGatewayPrefixURL, isCollapsed, refreshURL, refreshInterval)

Method Detail

getPortletByGUID

  public static function getPortletByGUID(guid)

getPortletByID

  public static function getPortletByID(id)

getPortletByName

  public static function getPortletByName(name)

getSessionPref

  public static function getSessionPref(name)

getSessionPrefs

  public static function getSessionPrefs(names)

setSessionPref

  public static function setSessionPref(name,value)

setSessionPrefs

  public static function setSessionPrefs(hash)

_getSessionPrefsFromXML

  private static function _getSessionPrefsFromXML(xmlDoc)

_postSetSessionPrefs

  private static function _postSetSessionPrefs(postContent)

_processGetSessionPrefs

  private static function _processGetSessionPrefs(postContent)

clearEvent

  public function clearEvent(eventName,eventNamespace)

clearRefreshInterval

  public function clearRefreshInterval()

deleteSessionPref

  public function deleteSessionPref(name)

deleteSessionPrefs

  public function deleteSessionPrefs(array)

formGetRefresh

  public function formGetRefresh(form)

formPostRefresh

  public function formPostRefresh(form)

formRefresh

  public function formRefresh(form)

getRefreshInterval

  public function getRefreshInterval()

getRefreshURL

  public function getRefreshURL()

raiseEvent

  public function raiseEvent(eventName,eventArgs,eventNamespace)

refresh

  public function refresh(url)

refreshOnEvent

  public function refreshOnEvent(eventName,eventNamespace)

registerForEvent

  public function registerForEvent(eventName,eventCallback,eventNamespace)

setInnerHTML

  public function setInnerHTML(html)

setRefreshInterval

  public function setRefreshInterval(refreshInterval,startNewRefreshTimer)

setRefreshURL

  public function setRefreshURL(url)

_clearRefreshTimer

  private function _clearRefreshTimer()

_createGetRefreshRequest

  private function _createGetRefreshRequest(url,form)

_createPostRefreshRequest

  private function _createPostRefreshRequest(url,form)

_handleResponseErrorXML

  private function _handleResponseErrorXML(xmlDoc,response)

_refreshErrorHandler

  private function _refreshErrorHandler(response)

_startRefreshTimer

  private function _startRefreshTimer()

transformURL

  private function transformURL(url)