import DisplayCommand from 'devapt-core-browser/js/commands/display_command.js'

public class | source

DisplayCommand

Extends:

devapt-core-common/dist/js/base/loggable~Loggable → NameTypeSettingsLoggable → Command → DisplayCommand

Display command class.

Example:


	API
		->do():Promise - do display.
		->undo():Promise - undo display and display history previous content.

Constructor Summary

Public Constructor
public	constructor(arg_runtime: object, arg_settings: object, arg_log_context: string): nothing Creates an instance of DisplayCommand.

Member Summary

Public Members
public	is_display_command: boolean

Method Summary

Public Methods
public	get_route(): string Get route.
public	get_target_route(): string Get target route.
public	is_valid(): boolean Check if command settings is valid.

Private Methods
private	_do(): Promise Do command.
private	_undo(): Promise Undo command.

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 Command
public	is_command: boolean
public	do(): Promise Do command.
public	undo(): Promise Undo command.
private	_do(): Promise Do command.
private	_undo(): Promise Undo command.

Public Constructors

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

Creates an instance of DisplayCommand.

A DisplayCommand configuration is a simple object with:

Common attributes:

    - name:string - command unique name.
    - type:string - type of commnand from command factory known types list (example: display).
    - label:string - displayable short descriptive string.
    - url or route:string : route to display content.

Middleware route attributes:

    - middleware:string - middleware name to call on server side.

Browser route attributes:

    - view:string - view name to render on browser side.
    - menubar:string - menubar name to render on browser side (optional).

Override:

Command#constructor

Params:

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