import LayoutSimple from 'devapt-core-browser/js/base/layout/layout_simple.js'

public class | source

LayoutSimple

Extends:

devapt-core-common/dist/js/base/loggable~Loggable → NameTypeSettingsLoggable → Layout → LayoutSimple

Constructor Summary

Public Constructor
public	constructor(arg_runtime: object, arg_settings: object, arg_log_context: string \| undefined): nothing Creates an instance of LayoutSimple:a simple layout with a content element which contains a menubar, a breadcrumbs, a separator and a main view.

Member Summary

Public Members
public	is_breadcrumbs: boolean
public	is_menubar: boolean
public	is_simple_layout: boolean

Private Members
private	_content_element: *
private	_content_id: string

Method Summary

Public Methods
public	get_content_element(): Element Get page content element.
public	init_content_element(): Element Init page content element.
public	process_rendering_result(arg_rendering_result: RenderingResult, -: array): * Process a RenderingResult instance.
public	render_page_content(arg_components: object): Promise Render page content with components names.
public	render_page_content_vnode(arg_vnode: VNode, arg_rendering_result: RenderingResult, arg_credentials: Credentials): array Render page content with a global VNode.
public	switch(arg_previous_component: Component, arg_target_component_name: string, arg_is_menubar: boolean, arg_is_breadcrumbs: boolean): Promise Switch previously displayed component with target component.

Inherited Summary

From class NameTypeSettingsLoggable
public	is_name_type_settings_loggable: boolean
private	_runtime: *
private	_settings: *
private	_ui: *
public	get_name(): string Get instance name.
public	get_router(): Router Get router.
public	get_runtime(): ClientRuntime Get runtime.
public	get_settings(): string Get instance settings.
public	get_state_store(): Store Get runtime state store.
public	get_type(): string Get instance type.
public	get_ui(): UI Get UI.
public	is_valid(): boolean Check if instance settings is valid.

From class Layout
public	is_layout: boolean
public	clear_page_content(): Promise Clear page content components.
public	render_page_content(): Promise Render page content components.

Public Constructors

public constructor(arg_runtime: object, arg_settings: object, arg_log_context: string | undefined): nothing source

Creates an instance of LayoutSimple:a simple layout with a content element which contains a menubar, a breadcrumbs, a separator and a main view.

Override:

Layout#constructor

Params:

Name	Type	Attribute	Description
arg_runtime	object		runtime.
arg_settings	object		instance settings.
arg_log_context	string \| undefined		context of traces of this instance (optional).

Return:

nothing

Public Members

public is_breadcrumbs: boolean source

public is_menubar: boolean source

public is_simple_layout: boolean source

Private Members

private _content_element: * source

private _content_id: string source

Public Methods

public get_content_element(): Element source

Get page content element.

Return:

Element

public init_content_element(): Element source

Init page content element.

Return:

Element

public process_rendering_result(arg_rendering_result: RenderingResult, -: array): * source

Process a RenderingResult instance.

Params:

Name	Type	Attribute	Description
arg_rendering_result	RenderingResult		rendering result.
-	array		rendered components.

Return:

public render_page_content(arg_components: object): Promise source

Render page content with components names.

Override:

Layout#render_page_content

Params:

Name	Type	Attribute	Description
arg_components	object		components to display: { view:'', menubar:'', breadcrumbs:'' }

Return:

Promise

public render_page_content_vnode(arg_vnode: VNode, arg_rendering_result: RenderingResult, arg_credentials: Credentials): array source

Render page content with a global VNode.

Params:

Name	Type	Attribute	Description
arg_vnode	VNode		rendered virtual dom node.
arg_rendering_result	RenderingResult		rendering result associated with given vnode.
arg_credentials	Credentials		user session credentials.

Return:

array

array of rendered Component instances.

public switch(arg_previous_component: Component, arg_target_component_name: string, arg_is_menubar: boolean, arg_is_breadcrumbs: boolean): Promise source

Switch previously displayed component with target component.

Params:

Name	Type	Attribute	Description
arg_previous_component	Component		previous component instance.
arg_target_component_name	string		target component name.
arg_is_menubar	boolean		target component is a menubar?
arg_is_breadcrumbs	boolean		target component is a breadcrumbs?

Return:

Promise

Promise of { switch:false, component:arg_previous_component }