Constructor
new module:caplin/presenter/component/PresenterComponent(sTemplateId, vPresentationModel, sConfig)
Constructs a new instance of
PresenterComponent
.
Instances of PresenterComponent
can also be created from an XML snippet using the following
methods:
module:caplin/presenter/component/PresenterComponentFactory#getViewerComponentFromXml
module:caplin/component/ComponentFactory#createComponent
Parameters:
Name | Type | Description |
---|---|---|
sTemplateId |
String | The id of a template to render the presentation model with. |
vPresentationModel |
Object | A presentation model instance, or the name of a presentation model class that can be constructed. |
sConfig |
String | Optional string configuration passed into the presentation model constructor. |
- Implements:
Methods
-
addComponentLifecycleListener(oListener)
-
Add a component life-cycle event listener.
Parameters:
Name Type Description oListener
module:caplin/component/ComponentLifecycleEvents The listener being registered. -
deserialize(sPresenterData)
-
Extracts the data inside the presenter tag and gives it to the PresentationModel for deserialization. Only has affect if the Presentation Model implements
module:br/presenter/SerializablePresentationModel
.Parameters:
Name Type Description sPresenterData
String The presenter xml node in string format -
getPresentationModel()
-
Retrieve the presentation model being displayed by this component.
-
isViewAttached()
-
Returns
true
oncemodule:caplin/component/ComponentLifecycleEvents#onOpen
has fired, and the element returned frommodule:caplin/presenter/component/PresenterComponent#getElement
has been attached to the page. -
isViewBound()
-
Returns
true
if the element is part of the view, otherwise returnsfalse
. -
removeComponentLifecycleListener(oListener)
-
Remove a previously registered component life-cycle event listener.
Parameters:
Name Type Description oListener
module:caplin/component/ComponentLifecycleEvents The listener being removed.