Class PTPortletServices

Object
   |
   +--PTPortletServices

class PTPortletServices

Also known as the PCC, this is a utility class for event-handling multiplexing, and session variable storage. Allows multiple portlets to share the same global event-handlers and session variables.

Usage:	
 	document.PCC.RaiseEvent('mynamespace', 'submitsurvey');
	document.PCC.GetSessionState('mysessionstate');
	document.PCC.RegisterForEvent('mynamespace', 'submitsurvey', 'handleSubmitSurvey');
 

Field Detail

_portletID

<private> Object _portletID

func

<private> Object func

id

<private> Object id

regEvents

<private> Object regEvents

Create an array to hold the registered events. This is at the page level, so we'll overwrite any existing value (there shouldn't be one.)

WindowEventURN

<private> Object WindowEventURN

WindowEventURN

_eventListenerCount

<private> <static> Object _eventListenerCount

_eventListenerCount

_SESSION_STATE_COOKIE

<private> <static> Object _SESSION_STATE_COOKIE

_SESSION_STATE_COOKIE

initialized

<private> <static> Object initialized

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTPortletServices

PTPortletServices()

PTPortletServices object constructor

_eventListener

 <private> void _eventListener(func)

ClearSessionState

void ClearSessionState(sNamespaceURN, sName)

Clear name/value pair from session state

Parameters:
sNamespaceURN - Page URN
sName - Name of state variable

Deprecated Use PTPortlet.deleteSessionPref() instead.

ClearWindowEvent

Boolean ClearWindowEvent(eventListenerID)

Clears a window event

Parameters:
eventListenerID - The opaque id of the event, as initially assigned and returned by the RegisterForEvent / RegisterForWindowEvent methods (integer)

Returns:
true if the event was cleared

GetSessionState

Object GetSessionState(sNamespaceURN, sName)

Retrieve name/value pair from session state

Parameters:
sNamespaceURN - Page URN
sName - Name of state variable

Returns:
the session state value or null

Deprecated Use PTPortlet.getSessionPref() instead.

InitializeEvents

 <private> void InitializeEvents()

Iterates over common window and document event handlers and registers them with the PCC if they are defined and aren't already registered with the PCC.

IsEventRegistered

Boolean IsEventRegistered(namespaceURN, eventName, sFunction, _portletID)

Checks to see if a given function signature has already been registered as a callback for a given namespace and event

Parameters:
namespaceURN - Namespace URN
eventName - Name of event type to call
sFunction - Name of function, or reference to function

Returns:
true if the event is registered

PutSessionState

void PutSessionState(sNamespaceURN, sName, objValue)

Store name/value pair in session state

Parameters:
sNamespaceURN - Page URN
sName - Name of state variable
objValue - Value of state variable

Deprecated Use PTPortlet.setSessionPref() instead.

RaiseEvent

void RaiseEvent(sNamespaceURN, eventName, objEventArgs)

Raise event, notifying PCC that an event occurred

Parameters:
sNamespaceURN - Page URN
eventName - Name of event type to call
objEventArgs - Arguments to pass to event function, optional

RaiseWindowEvent

void RaiseWindowEvent(objEventArgs)

Raise window event

Parameters:
objEventArgs - Arguments to pass to event function, optional

RegisterForEvent

Number RegisterForEvent(namespaceURN, eventName, sFunction, _portletID)

Register an event with PCC

Parameters:
namespaceURN - Namespace URN
eventName - Name of event type to call
sFunction - Name of function, or reference to function, to be called

Returns:
Unique eventListener id

RegisterForWindowEvent

Number RegisterForWindowEvent(eventName, sFunction)

Register for window event

Parameters:
eventName - Name of event type to call
sFunction - Name of function, or reference to function, to be called

Returns:
Unique eventListener id

RegisterOnceForEvent

Number RegisterOnceForEvent(namespaceURN, eventName, sFunction, _portletID)

Register an event with PCC, if and only if an identical event function has not already been registered for a given namespace and event

Parameters:
namespaceURN - Namespace URN
eventName - Name of event type to call
sFunction - Name of function, or reference to function, to be called

Returns:
Unique eventListener id, or undefined if event already has identical registration

RegisterOnceForWindowEvent

Number RegisterOnceForWindowEvent(eventName, sFunction)

Register a window event with PCC, if and only if an identical event function has not already been registered for a given namespace and event

Parameters:
eventName - Name of event type to call
sFunction - Name of function, or reference to function, to be called
namespaceURN - Namespace URN

Returns:
Unique eventListener id, or undefined if event already has identical registration