import RenderedDDom from 'devapt-core-browser/js/base/component/rendered_dom.js'

public class | source

RenderedDDom

Extends:

devapt-core-common/dist/js/base/stateable~Stateable → Dom → RenderedDDom

Constructor Summary

Public Constructor
public	constructor(arg_runtime: RuntimeBase, arg_state: Immutable.Map, arg_log_context: string): nothing Creates an instance of RenderedDom.

Member Summary

Public Members
public	is_breadcrumbs: boolean
public	is_menubar: boolean
public	is_rendered_dom: boolean

Private Members
private	_assets_dependancies: *[]
private	_assets_promise: *
private	_is_visible: boolean
private	_ready_promise: *

Method Summary

Public Methods
public	add_assets_dependancy(arg_asset_id: string): nothing Add assets dependancy.
public	destroy(): Promise Destroy component DOM element.
public	get_assets_dependancies(): array Get assets dependancies.
public	get_assets_promise(): Promise Get assets promises.
public	init_assets(): nothing Init assets promises.
public	process_rendering_vnode(arg_rendering_result: , arg_credentials: ) PROCESS RENDERING VNODE: CREATE OR UPDATE DOM ELEMENT.
public	render(arg_force: boolean): Promise Render component DOM element.
public	save_rendering(): nothing Save rendering virtul node.
public	update_size(): nothing Update component size with its content.

Private Methods
private	_render(arg_force: ):

Inherited Summary

From class Dom
public	is_dom: boolean
private	_is_visible: boolean
private	_name: *
private	_rendering: *
private	_visiblility: *
public	clear_dom_text(): nothing DOM element manipulation:clear dom element text value.
public	clear_dom_value(): nothing DOM element manipulation:clear dom element value.
public	get_dom_attr(arg_attr_name: string): string DOM element manipulation:get dom element attribute.
public	get_dom_element(): Element Get DOM element.
public	get_dom_id(): string Get DOM id.
public	get_dom_parent(): Element Get parent element.
public	get_dom_text(): string DOM element manipulation:get dom element text.
public	get_dom_value(): string DOM element manipulation:get dom element value.
public	get_dom_vnode(): VNode Get DOM Virtual Node.
public	get_name(): string Get name.
public	has_dom_element(): boolean Test DOM Element instance.
public	has_dom_parent(arg_element: Element): boolean Test if component element has given parent element.
public	has_dom_vnode(): boolean Test DOM Virtual Node.
public	hide(): nothing Hide component.
public	is_visible(arg_check: boolean): boolean Get visibility.
public	on_dom_event(arg_dom_event: , arg_dom_selector: , arg_handler: , arg_data: , arg_debug: boolean): nothing Mount dom event handler.
public	set_dom_attr(arg_attr_name: string, arg_attr_value: string): nothing DOM element manipulation:set dom element attribute value.
public	set_dom_element(arg_element: Element): nothing Set DOM element.
public	set_dom_parent(arg_parent_element: Element): nothing Set given parent element.
public	set_dom_parent_of(arg_component: Component): nothing Set given parent element.
public	set_dom_text(arg_text_value: string): nothing DOM element manipulation:set dom element text value.
public	set_dom_value(arg_value: string): nothing DOM element manipulation:set dom element value.
public	set_dom_vnode(arg_vnode: VNode): nothing Set DOM Virtual Node.
public	show(): nothing Show component.
public	toggle(): nothing Toggle component visbility.
private	_get_dom_text(arg_element: ):

Public Constructors

public constructor(arg_runtime: RuntimeBase, arg_state: Immutable.Map, arg_log_context: string): nothing source

Creates an instance of RenderedDom.

Override:

Dom#constructor

Params:

Name	Type	Attribute	Description
arg_runtime	RuntimeBase		client runtime.
arg_state	Immutable.Map		component initial state.
arg_log_context	string		context of traces of this instance (optional).

Return:

nothing

Public Members

public is_breadcrumbs: boolean source

public is_menubar: boolean source

public is_rendered_dom: boolean source

Private Members

private _assets_dependancies: *[] source

private _assets_promise: * source

private _is_visible: boolean source

Override:

Dom#_is_visible

private _ready_promise: * source

Public Methods

public add_assets_dependancy(arg_asset_id: string): nothing source

Add assets dependancy.

Params:

Name	Type	Attribute	Description
arg_asset_id	string		asset element id.

Return:

nothing

public destroy(): Promise source

Destroy component DOM element.

Return:

Promise

public get_assets_dependancies(): array source

Get assets dependancies.

Return:

array

public get_assets_promise(): Promise source

Get assets promises.

Return:

Promise

public init_assets(): nothing source

Init assets promises.

Return:

nothing

public process_rendering_vnode(arg_rendering_result: , arg_credentials: ) source

PROCESS RENDERING VNODE: CREATE OR UPDATE DOM ELEMENT.

Params:

Name	Type	Attribute	Description
arg_rendering_result	*
arg_credentials	*

public render(arg_force: boolean): Promise source

Render component DOM element.

Params:

Name	Type	Attribute	Description
arg_force	boolean		should force creation of a new VNode if a previous rendering exists.

Return:

Promise

Promise of this to chain promises.

public save_rendering(): nothing source

Save rendering virtul node. Update component VNode with current component HTML.

Return:

nothing

public update_size(): nothing source

Update component size with its content.

Return:

nothing

Private Methods

private _render(arg_force: ): source

Params:

Name	Type	Attribute	Description
arg_force	*

RenderedDDom

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(arg_runtime: RuntimeBase, arg_state: Immutable.Map, arg_log_context: string): nothing source

Override:

Params:

Return:

Public Members

public is_breadcrumbs: boolean source

public is_menubar: boolean source

public is_rendered_dom: boolean source

Private Members

private _assets_dependancies: *[] source

private _assets_promise: * source

private _is_visible: boolean source

Override:

private _ready_promise: * source

Public Methods

public add_assets_dependancy(arg_asset_id: string): nothing source

Params:

Return:

public destroy(): Promise source

Return:

public get_assets_dependancies(): array source

Return:

public get_assets_promise(): Promise source

Return:

public init_assets(): nothing source

Return:

public process_rendering_vnode(arg_rendering_result: *, arg_credentials: *) source

Params:

public render(arg_force: boolean): Promise source

Params:

Return:

public save_rendering(): nothing source

Return:

public update_size(): nothing source

Return:

Private Methods

private _render(arg_force: *): * source

Params:

Return:

public process_rendering_vnode(arg_rendering_result: , arg_credentials: ) source

private _render(arg_force: ): source