|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Object | +--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 Summary | |
<static> <final> Object |
VERSION
|
| Constructor Summary | |
PTPortletServices
()
PTPortletServices object constructor |
|
| Method Summary | |
void
|
ClearSessionState(sNamespaceURN, sName)
Clear name/value pair from session state |
Boolean
|
ClearWindowEvent(eventListenerID)
Clears a window event |
Object
|
GetSessionState(sNamespaceURN, sName)
Retrieve name/value pair from session state |
Boolean
|
IsEventRegistered(namespaceURN, eventName, sFunction)
Checks to see if a given function signature has already been registered as a callback for a given namespace and event |
void
|
PutSessionState(sNamespaceURN, sName, objValue)
Store name/value pair in session state |
void
|
RaiseEvent(sNamespaceURN, eventName, objEventArgs)
Raise event, notifying PCC that an event occurred |
void
|
RaiseWindowEvent(objEventArgs)
Raise window event |
Number
|
RegisterForEvent(namespaceURN, eventName, sFunction)
Register an event with PCC |
Number
|
RegisterForWindowEvent(eventName, sFunction)
Register for window event |
Number
|
RegisterOnceForEvent(namespaceURN, eventName, sFunction)
Register an event with PCC, if and only if an identical event function has not already been registered for a given namespace and event |
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 |
| Field Detail |
<static> <final> Object VERSION
| Constructor Detail |
PTPortletServices()
| Method Detail |
void ClearSessionState(sNamespaceURN, sName)
sNamespaceURN - Page URN
sName - Name of state variable
Boolean ClearWindowEvent(eventListenerID)
eventListenerID - The opaque id of the event, as initially assigned and returned by the RegisterForEvent / RegisterForWindowEvent methods (integer)
Object GetSessionState(sNamespaceURN, sName)
sNamespaceURN - Page URN
sName - Name of state variable
Boolean IsEventRegistered(namespaceURN, eventName, sFunction)
namespaceURN - Namespace URN
eventName - Name of event type to call
sFunction - Name of function, or reference to function
void PutSessionState(sNamespaceURN, sName, objValue)
sNamespaceURN - Page URN
sName - Name of state variable
objValue - Value of state variable
void RaiseEvent(sNamespaceURN, eventName, objEventArgs)
sNamespaceURN - Page URN
eventName - Name of event type to call
objEventArgs - Arguments to pass to event function, optional
void RaiseWindowEvent(objEventArgs)
objEventArgs - Arguments to pass to event function, optional
Number RegisterForEvent(namespaceURN, eventName, sFunction)
namespaceURN - Namespace URN
eventName - Name of event type to call
sFunction - Name of function, or reference to function, to be called
Number RegisterForWindowEvent(eventName, sFunction)
eventName - Name of event type to call
sFunction - Name of function, or reference to function, to be called
Number RegisterOnceForEvent(namespaceURN, eventName, sFunction)
namespaceURN - Namespace URN
eventName - Name of event type to call
sFunction - Name of function, or reference to function, to be called
Number RegisterOnceForWindowEvent(eventName, sFunction)
eventName - Name of event type to call
sFunction - Name of function, or reference to function, to be called
namespaceURN - Namespace URN
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||