Class PTPortlet

Object
   |
   +--PTPortlet

class PTPortlet

A client-side object wrapper for a Portlet. Contains methods for accessing portlet attributes, in-place-refresh of portlet content, firing and listening for portlet events, and the getting/setting of session preferences.

Usage:	
 	var myportlet = PTPortlet.getPortletByID(227);
	myportlet.setSessionPref('mypref', 'myprefvalue');
	myportlet.refresh('nextpage.jsp');
 

Field Detail

containerID

String containerID

The id attribute of the portlet's corresponding HTML element

gatewayPrefixURL

String gatewayPrefixURL

The URL of the gateway prefix

guid

String guid

The portlet object's global unique id

id

String id

The portlet object's id

isCollapsed

Boolean isCollapsed

Whether or not the portlet is currently collapsed (optional)

name

String name

The portlet's internationalized name

refreshInterval

Number refreshInterval

The portlet's refresh interval, in milliseconds (optional)

refreshURL

String refreshURL

The URL to use for refreshing the portlet (optional)

remoteBaseURL

String remoteBaseURL

The base URL of the portlet's remote server

remoteRequestURL

String remoteRequestURL

The fully qualified URL of the portlet's web service

responseErrorHandler

Object responseErrorHandler

The handler to call when a response error occurs, if the default behavior is undesirable (string or function reference, optional)

responseErrors

Array responseErrors

An array of response error objects. Each object contains name-value pairs describing the particulars of the response error.

responsePostProcHandler

Object responsePostProcHandler

The handler to call after calling the response handler (string or function reference, optional)

responsePreProcHandler

Object responsePreProcHandler

The handler to call before calling the response handler. Returning false from this handler cancels the call to the response handler. (string or function reference, optional)

secureGatewayPrefixURL

String secureGatewayPrefixURL

The secure URL of the gateway prefix

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTPortlet

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

PTPortlet object constructor

Parameters:
id - The portlet object's id (string)
guid - The portlet object's global unique id (string)
name - The portlet's internationalized name (string)
containerID - The id attribute of the portlet's corresponding HTML element (string)
remoteRequestURL - The fully qualified URL of the portlet's web service (string)
remoteBaseURL - The base URL of the portlet's remote server (string)
gatewayPrefixURL - The URL of the gateway prefix (string)
secureGatewayPrefixURL - The secure URL of the gateway prefix (string)
isCollapsed - Whether or not the portlet is currently collapsed (boolean, optional)
refreshURL - The URL to use for refreshing the portlet (string, optional)
refreshInterval - The portlet's refresh interval, in milliseconds (integer, optional)
responsePreProcHandler - The handler to call before calling the response handler. Returning false from this handler cancels the call to the response handler. (string or function reference, optional).

Important: Most in-place refresh actions are already making use of the responsePreProcHandler to inspect the response for errors before proceeding. If you wish to override the responsePreProcHandler for a portlet, make sure to add in an explicit call to _refreshErrorHandler and pass in the response to check for errors manually; otherwise default error-handling for your portlet's in-place refresh activities will be disabled.

responsePostProcHandler - The handler to call after calling the response handler (string or function reference, optional) Author Patrick Corcoran

clearEvent

void clearEvent(eventName,eventNamespace)

Clears the event listener for an event

Parameters:
eventName - The name of the event to clear (string)
eventNamespace - The namespace for the event (string, optional)

clearRefreshInterval

void clearRefreshInterval()

Sets the refreshInterval of the portlet to 0 and clears any current refresh timers.

deleteSessionPref

PTHTTPPOSTRequest deleteSessionPref(name)

Deletes a single session pref

Parameters:
name - The name of the pref to be deleted (string)

Returns:
Request object which was invoked (PTHTTPPOSTRequest)

deleteSessionPrefs

PTHTTPPOSTRequest deleteSessionPrefs(array)

Deletes multiple session prefs

Parameters:
array - Array of named values to be deleted (Array)

Returns:
Request object which was invoked (PTHTTPPOSTRequest)

formGetRefresh

void formGetRefresh(form,requestHeaders)

Requests updated content from the server by submitting a form GET request

Parameters:
form - Specifies the form to submit via GET. This method will accept a form name, a form id, or a reference to the form object. Note that form elements of type FILE, IMAGE, and SUBMIT are ignored. If you need the value for a SUBMIT element to be passed to the server, you should create a HIDDEN element whose name and value are equivalent to the SUBMIT element, and the HIDDEN element will be passed through in its place.
requestHeaders - Headers to set in the HTTP request (associative array, optional)

formPostRefresh

void formPostRefresh(form,requestHeaders)

Requests updated content from the server by submitting a form POST request

Parameters:
form - Specifies the form to submit via POST. This method will accept a form name, a form id, or a reference to the form object. Note that form elements of type FILE, IMAGE, and SUBMIT are ignored. If you need the value for a SUBMIT element to be passed to the server, you should create a HIDDEN element whose name and value are equivalent to the SUBMIT element, and the HIDDEN element will be passed through in its place.
requestHeaders - Headers to set in the HTTP request (associative array, optional)

formRefresh

Object formRefresh(form,requestHeaders)

Requests updated content from the server by submitting a form

Parameters:
form - Specifies the form to submit. This method will accept a form name, a form id, or a reference to the form object. Note that form elements of type FILE, IMAGE, and SUBMIT are ignored. If you need the value for a SUBMIT element to be passed to the server, you should create a HIDDEN element whose name and value are equivalent to the SUBMIT element, and the HIDDEN element will be passed through in its place.
requestHeaders - Headers to set in the HTTP request (associative array, optional)

getRefreshInterval

Number getRefreshInterval()

Returns the refreshInterval of the portlet, in milliseconds.

Returns:
millisecond refresh interval

getRefreshURL

String getRefreshURL()

Returns the refresh URL of the portlet

Returns:
a URL string

raiseEvent

void raiseEvent(eventName,eventArgs,eventNamespace)

Raise an new event

Parameters:
eventName - The name of the event to be raised (string)
eventArgs - A hash of arguments to be passed with the event (object, optional)
eventNamespace - The namespace for the event (string, optional)

refresh

Object refresh(url,requestHeaders)

Refresh the portlet content from the server. The most basic form of refresh() takes no arguments and simply refreshes the portlet from the current value of its refreshURL property. More advanced usage of the refresh method will take a url argument, which will refresh the portlet using this new URL as its refresh location. Please note two important points regarding using custom URLs:

1. If the URL being called is supposed to be in the portlet's gateway space but has not yet been converted to use a gateway URL, it will be necessary to call the transformURL method on this URL before passing it into the refresh method.
2. If the URL being called does not reside on the identical internet domain, host, and port as the portlet being refreshed, then because of standard browser security policies it will be necessary for the external URL to reside within the gateway space of the portlet and for the external URL to be transformed before being called, as per above. (Otherwise, the refresh method will only work once for this external URL and all subsequent attempts to change the content will result in a security exception.)

Parameters:
url - URL to use for refreshing content (string, optional)
requestHeaders - Headers to set in the HTTP request (associative array, optional)

refreshOnEvent

void refreshOnEvent(eventName,eventNamespace)

Associate portlet refresh action with a specific event

Parameters:
eventName - The name of the event which triggers refresh action (string)
eventNamespace - The namespace for the event (string, optional)

registerForEvent

void registerForEvent(eventName,eventCallback,eventNamespace)

Register to be notified of an event

Parameters:
eventName - The name of the event (string)
eventCallback - The name of a function or a reference to a function which serves as a callback when the event is triggered (string or function)
eventNamespace - The namespace for the event (string, optional)

setInnerHTML

void setInnerHTML(html)

Sets the innerHTML of the portlet from a string

Parameters:
html - The html to be rendered (string)

setRefreshInterval

void setRefreshInterval(refreshInterval)

Sets the refreshInterval of the portlet (in milliseconds) and resets the refresh counter to zero. Setting a refreshInterval less than 1000ms (1 second) is not recommended. Shorter intervals can precipitate race conditions between server and client.

Parameters:
refreshInterval - (integer)

setRefreshURL

String setRefreshURL(url)

Sets the refresh URL of the portlet

Parameters:
url - to set as refreshURL

transformURL

String transformURL(url)

Transform a URL to be gatewayed

Parameters:
url - The URL to be gatewayed (string)

Returns:
a gatewayed URL

getPortletByGUID

<static> PTPortlet getPortletByGUID(guid)

Returns a single portlet, given an 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. Also, internationalization of portlets may result in unexpected results unless the name lookup matches exactly the internationalized name.

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

Returns:
PTPortlet object

getSessionPref

<static> String getSessionPref(name)

Get a single session pref Undefined pref returns empty string.

Parameters:
name - The name of the pref to be retrieved (string)

Returns:
string

getSessionPrefs

<static> Hash getSessionPrefs(names)

Get multiple session prefs Undefined prefs return empty string.

Parameters:
names - The names of the prefs to be retrieved (Array of strings)

Returns:
Associative array of name/value pairs.

setSessionPref

<static> PTHTTPPOSTRequest setSessionPref(name,value)

Set a single session pref

Parameters:
name - The name of the pref to be set (string)
value - The value of the pref to be set (string)

Returns:
Request object which was invoked (PTHTTPPOSTRequest)

setSessionPrefs

<static> PTHTTPPOSTRequest setSessionPrefs(hash)

Set multiple session prefs

Parameters:
hash - Associative array of name/value pairs to be set (string)

Returns:
Request object which was invoked (PTHTTPPOSTRequest)