import StatedDom from 'devapt-core-browser/js/base/component/stated_dom.js'

public class | source

StatedDom

Extends:

js/base/component/rendered_dom.js~RenderedDom → BoundDom → StatedDom

Direct Subclass:

Component

Indirect Subclass:

AttributesTable, Container, Dock, DockItem, InputField, LogsTable, RecordsTable, Table, TableTree, Tabs, Topology, Tree

Constructor Summary

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

Member Summary

Public Members
public	is_stated_dom: boolean

Private Members
private	_children_components: *
private	_dom_element: *
private	_ready_promise: *

Method Summary

Public Methods
public	clear(): Promise Clear component to initial values.
public	dispatch_update_state_action(arg_new_state: Immutable.Map): nothing Dispatch update state action.
public	dispatch_update_state_value_action(arg_path: array \| string, arg_value: any): nothing Dispatch update state action.
public	get_children_component(): array Get view children components.
public	get_named_stream(arg_stream_name: string): Stream \| undefined Get a named stream.
public	register_and_render_inside_from_json(arg_options: object): nothing Render a component inside this element from a json description.
public	register_from_json(arg_options: object): nothing Register a component description from a json content.
public	render_inside_from_json(arg_name: string, arg_json_desc: object): nothing Render a component inside this element from a json description.
public	update(): Promise Update view with current state.
public	update_children(): Promise Update view with current state.

Private Methods
private	_update(): *

Inherited Summary

From class BoundDom
public	is_bound_dom: boolean
public	store_unsubscribe: *
private	_bindings: {}
private	_is_loaded: boolean
public	init_bindings(): nothing Init bindings.
public	load(arg_state: Immutable.Map \| undefined): nothing \| Promise Load and apply a component configuration.
public	unload(): nothing Unload a component configuration.

Public Constructors

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

Creates an instance of StatedDom.

Override:

BoundDom#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_stated_dom: boolean source

Private Members

private _children_components: * source

private _dom_element: * source

private _ready_promise: * source

Public Methods

public clear(): Promise source

Clear component to initial values.

Return:

Promise

public dispatch_update_state_action(arg_new_state: Immutable.Map): nothing source

Dispatch update state action.

Params:

Name	Type	Attribute	Description
arg_new_state	Immutable.Map		new state Immutable Map.

Return:

nothing

public dispatch_update_state_value_action(arg_path: array | string, arg_value: any): nothing source

Dispatch update state action.

Params:

Name	Type	Attribute	Description
arg_path	array \| string		component state path.
arg_value	any		component state value.

Return:

nothing

public get_children_component(): array source

Get view children components.

Return:

array

list of Component.

public get_named_stream(arg_stream_name: string): Stream | undefined source

Get a named stream.

Params:

Name	Type	Attribute	Description
arg_stream_name	string		stream name.

Return:

Stream | undefined

found stream.

public register_and_render_inside_from_json(arg_options: object): nothing source

Render a component inside this element from a json description.

Params:

Name	Type	Attribute	Description
arg_options	object		json source configuration.

Return:

nothing

public register_from_json(arg_options: object): nothing source

Params:

Name	Type	Attribute	Description
arg_options	object		json source configuration.

Return:

nothing

public render_inside_from_json(arg_name: string, arg_json_desc: object): nothing source

Render a component inside this element from a json description.

Params:

Name	Type	Attribute	Description
arg_name	string		component name.
arg_json_desc	object		component description.

StatedDom

Extends:

Direct Subclass:

Indirect Subclass:

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_stated_dom: boolean source

Private Members

private _children_components: * source

private _dom_element: * source

private _ready_promise: * source

Public Methods

public clear(): Promise source

Return:

public dispatch_update_state_action(arg_new_state: Immutable.Map): nothing source

Params:

Return:

public dispatch_update_state_value_action(arg_path: array | string, arg_value: any): nothing source

Params:

Return:

public get_children_component(): array source

Return:

public get_named_stream(arg_stream_name: string): Stream | undefined source

Params:

Return:

public register_and_render_inside_from_json(arg_options: object): nothing source

Params:

Return:

public register_from_json(arg_options: object): nothing source

Params:

Return:

public render_inside_from_json(arg_name: string, arg_json_desc: object): nothing source

Params:

Return:

public update(): Promise source

Return:

public update_children(): Promise source

Return:

Private Methods

private _update(): * source

Return: