AbstractPageRenderer
Base class for implementations of the {@linkcode PageRenderer} interface.
Kind: global class
- AbstractPageRenderer
- new AbstractPageRenderer(factory, Helper, ReactDOM, dispatcher, settings)
- ._factory :
PageRendererFactory
- ._Helper :
Vendor.$Helper
- ._ReactDOM :
Vendor.ReactDOM
- ._dispatcher :
Dispatcher
- ._settings :
Object.<string, \*>
- ._reactiveView :
React.Component
- .mount()
- .update()
- .unmount()
- .clearState()
- .setState()
- ._generateViewProps(view, [state]) ⇒
Object.<string, \*>
- ._getWrappedPageView(controller, view, routeOptions)
- ._getDocumentView(documentView) ⇒
function
new AbstractPageRenderer(factory, Helper, ReactDOM, dispatcher, settings)
Initializes the abstract page renderer.
Param | Type | Description |
---|---|---|
factory | PageRendererFactory |
Factory for receive $Utils to view. |
Helper | vendor.$Helper |
The IMA.js helper methods. |
ReactDOM | vendor.ReactDOM |
React framework instance, will be used to render the page. |
dispatcher | Dispatcher |
Dispatcher fires events to app. |
settings | Object.<string, \*> |
Application settings for the current application environment. |
abstractPageRenderer._factory : PageRendererFactory
Factory for receive $Utils to view.
Kind: instance property of AbstractPageRenderer
Access: protected
abstractPageRenderer._Helper : Vendor.$Helper
The IMA.js helper methods.
Kind: instance property of AbstractPageRenderer
Access: protected
abstractPageRenderer._ReactDOM : Vendor.ReactDOM
Rect framework instance, used to render the page.
Kind: instance property of AbstractPageRenderer
Access: protected
abstractPageRenderer._dispatcher : Dispatcher
Dispatcher fires events to app.
Kind: instance property of AbstractPageRenderer
abstractPageRenderer._settings : Object.<string, \*>
Application setting for the current application environment.
Kind: instance property of AbstractPageRenderer
Access: protected
abstractPageRenderer._reactiveView : React.Component
Kind: instance property of AbstractPageRenderer
Access: protected
abstractPageRenderer.mount()
Kind: instance abstract method of AbstractPageRenderer
abstractPageRenderer.update()
Kind: instance method of AbstractPageRenderer
abstractPageRenderer.unmount()
Kind: instance method of AbstractPageRenderer
abstractPageRenderer.clearState()
Kind: instance method of AbstractPageRenderer
abstractPageRenderer.setState()
Kind: instance method of AbstractPageRenderer
abstractPageRenderer._generateViewProps(view, [state]) ⇒ Object.<string, \*>
Generate properties for view from state.
Kind: instance method of AbstractPageRenderer
Access: protected
Param | Type | Default | Description |
---|---|---|---|
view | function |
The page view React component to wrap. | |
[state] | Object.<string, \*> |
{} |
abstractPageRenderer._getWrappedPageView(controller, view, routeOptions)
Returns wrapped page view component with managed root view and view adapter.
Kind: instance method of AbstractPageRenderer
Param | Type | Description |
---|---|---|
controller | ControllerDecorator |
|
view | function |
|
routeOptions | Object |
The current route options. |
abstractPageRenderer._getDocumentView(documentView) ⇒ function
Returns the class constructor of the specified document view component.
Kind: instance method of AbstractPageRenderer
Returns: function
- The constructor of the document
view component.
Param | Type | Description |
---|---|---|
documentView | function | string |
The namespace path pointing to the document view component, or the constructor of the document view component. |