Class AC.pss.ComponentRenderer
Extends
AC.pss.EmptyRenderer.
Component renderer. This class is responsible for rendering a component.
Defined in: PssUtility.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
<static> |
AC.pss.ComponentRenderer.constructor(componentConfiguration)
Default constructor.
|
<static> |
AC.pss.ComponentRenderer.destroyComponent(superiorContributionId, launchPoint)
Destroys this component.
|
<static> |
AC.pss.ComponentRenderer.launchSubCompCallback(subComponent)
Callback function invoked after renderIt().
|
onSend()
Handles user's 'send' action.
|
|
<static> |
AC.pss.ComponentRenderer.renderComponent(superiorContributionId, launchPoint)
Renders this component.
|
<static> |
AC.pss.ComponentRenderer.renderIt()
Renders this component.
|
<static> |
AC.pss.ComponentRenderer.swap()
Swaps the superior contribution for this component.
|
<static> |
AC.pss.ComponentRenderer.swapCallback(msg)
Callback function for swapping.
|
- Methods borrowed from class AC.pss.EmptyRenderer:
- getComponentConfiguration
Method Detail
<static>
AC.pss.ComponentRenderer.constructor(componentConfiguration)
Default constructor.
- Parameters:
- componentConfiguration
- the component configuration
<static>
AC.pss.ComponentRenderer.destroyComponent(superiorContributionId, launchPoint)
Destroys this component.
- Parameters:
- superiorContributionId
- the superior contribution id
- launchPoint
- the launch point
- Returns:
- void
<static>
AC.pss.ComponentRenderer.launchSubCompCallback(subComponent)
Callback function invoked after renderIt(). This function creates a popup window and renders the subcomponent into it.
- Parameters:
- subComponent
- the sub-component
- Returns:
- void
onSend()
Handles user's 'send' action. If this component is configured to swap, this handler will invoke a swap.
- Returns:
- void
<static>
AC.pss.ComponentRenderer.renderComponent(superiorContributionId, launchPoint)
Renders this component.
- Parameters:
- superiorContributionId
- the superior contribution id
- launchPoint
- The object that triggered or invoked the rendering of this component. There are times where it is necessary for a component to know information about where it was invoked from. This is accomplished by calling back to a method on the launchPoint.
- Returns:
- void
<static>
AC.pss.ComponentRenderer.renderIt()
Renders this component.
- Returns:
- void
<static>
AC.pss.ComponentRenderer.swap()
Swaps the superior contribution for this component. This will cause the component to reload itself with a new superior contribution.
- Returns:
- void
<static>
AC.pss.ComponentRenderer.swapCallback(msg)
Callback function for swapping. This function registers the component to listen on a specific swapping channel
so that the server can keep track of which clients are subscribed to which superior contributions.
- Parameters:
- msg
- the message
- Returns:
- void