|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--PTPortletServices
PTPortletServices object constructor
Defined in PTPortletServices.js
Field Summary |
|
public
var
|
func
|
public
var
|
id
|
public
var
|
regEvents
|
private
var
|
WindowEventURN
WindowEventURN |
public
static
var
|
VERSION
VERSION |
public
static
var
|
initialized
|
private
static
var
|
_eventListenerCount
_eventListenerCount |
Constructor Summary |
|
PTPortletServices
()
|
Method Summary |
|
public
function
|
ClearSessionState(sNamespaceURN, sName)
DEPRECATED
Clear name/value pair from session state |
public
function
|
ClearWindowEvent(eventListenerID)
Clears a window event |
public
function
|
GetSessionState(sNamespaceURN, sName)
DEPRECATED
Retrieve name/value pair from session state |
public
function
|
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 |
public
function
|
PutSessionState(sNamespaceURN, sName, objValue)
DEPRECATED
Store name/value pair in session state |
public
function
|
RaiseEvent(sNamespaceURN, eventName, objEventArgs)
Raise event, notifying PCC that an event occurred |
public
function
|
RaiseWindowEvent(objEventArgs)
Raise window event |
public
function
|
RegisterForEvent(namespaceURN, eventName, sFunction)
Register an event with PCC |
public
function
|
RegisterForWindowEvent(eventName, sFunction)
Register for window event |
public
function
|
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 |
public
function
|
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 |
public
function
|
_eventListener(func)
|
private
function
|
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. |
Field Detail |
public
var func
public
var id
public
var regEvents
private
var WindowEventURN
public
static
var VERSION
public
static
var initialized
private
static
var _eventListenerCount
Constructor Detail |
function PTPortletServices()
Method Detail |
public
function
ClearSessionState(sNamespaceURN, sName)
sNamespaceURN
- Page URN
sName
- Name of state variable
public
function
ClearWindowEvent(eventListenerID)
eventListenerID
- The opaque id of the event, as initially assigned and returned by the RegisterForEvent / RegisterForWindowEvent methods (integer)
public
function
GetSessionState(sNamespaceURN, sName)
sNamespaceURN
- Page URN
sName
- Name of state variable
public
function
IsEventRegistered(namespaceURN, eventName, sFunction)
namespaceURN
- Namespace URN
eventName
- Name of event type to call
sFunction
- Name of function, or reference to function
public
function
PutSessionState(sNamespaceURN, sName, objValue)
sNamespaceURN
- Page URN
sName
- Name of state variable
objValue
- Value of state variable
public
function
RaiseEvent(sNamespaceURN, eventName, objEventArgs)
sNamespaceURN
- Page URN
eventName
- Name of event type to call
objEventArgs
- Arguments to pass to event function, optional
public
function
RaiseWindowEvent(objEventArgs)
objEventArgs
- Arguments to pass to event function, optional
public
function
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
public
function
RegisterForWindowEvent(eventName, sFunction)
eventName
- Name of event type to call
sFunction
- Name of function, or reference to function, to be called
public
function
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
public
function
RegisterOnceForWindowEvent(eventName, sFunction)
eventName
- Name of event type to call
sFunction
- Name of function, or reference to function, to be called
namespaceURN
- Namespace URN
public
function
_eventListener(func)
private
function
InitializeEvents()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |