import Plugin from 'devapt-core-common/js/plugins/plugin.js'

public class | source

Plugin

Plugins base class.

Constructor Summary

Public Constructor
public	constructor(arg_manager: PluginsManager, arg_name: string, arg_class: string, arg_settings: object, arg_log_context: string \| undefined): nothing Create a plugin instance.

Member Summary

Public Members
public	$version: string Plugin version.
public	is_enabled: boolean Enabled flag.
public	is_plugin: boolean Class type flag.
public	manager: PluginManager Plugins manager.

Method Summary

Public Methods
public abstract	disable(arg_context: object \| undefined): object Disable a plugin.
public abstract	enable(arg_context: object \| undefined): object Enable a plugin.
public	get_browser_plugin_file_url(): string Get plugin js asset files for browser loading.
public	get_version(): string Get the plugin version.

Inherited Summary

From class Loggable
public	$context: string Log context.
public	is_loggable: boolean Class type flag.
public	is_trace_enabled: boolean Trace is enabled for this flag.
private	_logger_manager: LoggerManager Logger manager instance (default undefined)
public	debug(args: string \| array): nothing Trace DEBUG formatted message.
public	disable_trace(): nothing Disable traces.
public	enable_trace(): nothing Enable traces.
public	enter_group(arg_group: string): nothing Trace INFO message on "enter trace group".
public	error(args: string \| array): nothing Trace ERROR formatted message.
public	get_class(): string Define get class name method for non Instance classes.
public	get_context(): string Get instance context.
public	get_logger_manager(): LoggerManager Get logger manager.
public	get_name(): string Define get instance name method for non Instance classes.
public	get_trace(): boolean Get trace flag.
public	info(args: string \| array): nothing Trace INFO formatted message.
public	leave_group(arg_group: string): nothing Trace INFO message on "leave trace group".
public	separate_level_1(): nothing Trace INFO trace level 1 separator.
public	separate_level_2(): nothing Trace INFO trace level 2 separator.
public	separate_level_3(): nothing Trace INFO trace level 3 separator.
public	set_trace(arg_value: boolean): nothing Set trace flag.
public	should_trace(arg_traces_cfg: object): boolean Calculate should trace flag.
public	should_trace_class(arg_traces_cfg: object): boolean Calculate should trace flag for classes.
public	should_trace_collection_item(arg_traces_cfg: object, arg_collection_name: string, arg_this_item_accessor: string): boolean Calculate should trace flag for given collection of names or patterns.
public	should_trace_module(arg_traces_cfg: object): boolean Calculate should trace flag for modules.
public	should_trace_name(arg_traces_cfg: object): boolean Calculate should trace flag for instances names.
public	toggle_trace(): boolean Toggle trace flag.
public	update_trace_enabled(): nothing Update trace enabled flag.
public	warn(args: string \| array): nothing Trace WARN formatted message.

From class Errorable
private	_error_msg: string Error text (default null).
private	_has_error: boolean Has error flag (default false).
public	error(arg_msg: string): nothing Set an error.
public	error_not_implemented() Default helper for "not implemented" error.
public	get_error_msg(): string Get error message.
public	has_error(): boolean Test is an error is set.

From class Settingsable
public	$settings: object \| Immutable.Map Instance settings (default undefined).
public	is_settable: boolean Class type flag.
public	get_setting(arg_name: string \| array, arg_default: any): any Get a value in settings for given key.
public	get_setting_js(arg_name: string \| array, arg_default: any): any Get a value in settings for given key.
public	get_settings(): Immutable.Map Get instance settings.
public	get_settings_js(): Immutable.Map Get instance settings.
public	has_setting(arg_name: string): boolean Test if a key exists in settings.
public	set_setting(arg_name: string, arg_value: any): nothing Set a value in settings for given key.
public	set_settings(arg_settings: Immutable.Map): nothing Set instance settings.

From class Stateable
public	is_stateable: boolean Class type flag.
public	state_path: array State path in runtime state.
private	_initial_state: object Initial state.
private	_runtime: Runtime Runtime isntance.
private	_state_store: StateStore State store.
private	_state_value_listeners: array State changes handlers.
public	dispatch_action(arg_action_type: string \| object, arg_options: object \| undefined): nothing Dispatch a state action.
public	get_initial_state(): Immutable.Map Get initial state, an immutable object from a Redux data store.
public	get_name(): string Get name.
public	get_runtime(): RuntimeBase Get runtime instance.
public	get_state(): Immutable.Map Get current state, an immutable object from a Redux data store.
public	get_state_js(): object Get current state, an immutable object from a Redux data store.
public	get_state_path(): array Get state path into a Redux data store.
public	get_state_store(): object Get state store.
public	get_state_value(arg_key_or_path: string \| array, arg_default_value: any): any Get a state entry.
public	handle_state_change(arg_previous_state: Immutable.Map, arg_new_state: Immutable.Map): nothing Handle component state changes.
public	register_state_value_change_handle(arg_path: string \| array, arg_listener: string \| function): nothing Register a state value change listener.

From class Instance
public	$class: string Instance class name.
public	$id: string Instance id.
public	$name: string Instance name.
public	$type: string Instance collection name.
public	is_instance: boolean Class type flag.
public	is_loaded: boolean Instance is loaded flag.
public	get_class(): string Get instance class.
public	get_descriptor(): object Get instance description: {$type:..., $class:..., $id:..., $name:...}.
public	get_descriptor_string(): string Get instance description string: $type:..., $class:..., $id:..., $name:....
public	get_id(): string Get instance unique id.
public	get_name(): string Get instance unique name.
public	get_type(): string Get instance type.
public	is_browser(): boolean Test if this code run inside a browser.
public	is_server(): boolean Test if this code run on a browser.
public abstract	load(): nothing Load instance settings.

Public Constructors

public constructor(arg_manager: PluginsManager, arg_name: string, arg_class: string, arg_settings: object, arg_log_context: string | undefined): nothing source

Create a plugin instance.

Override:

Instance#constructor

Params:

Name	Type	Attribute	Description
arg_manager	PluginsManager		plugins manager.
arg_name	string		plugin name.
arg_class	string		plugin class name.
arg_settings	object		plugin settings map.
arg_log_context	string \| undefined		optional.

Return:

nothing

Public Members

public $version: string source

Plugin version.

public is_enabled: boolean source

Enabled flag.

public is_plugin: boolean source

Class type flag.

public manager: PluginManager source

Plugins manager.

Public Methods

public abstract disable(arg_context: object | undefined): object source

Disable a plugin.

Params:

Name	Type	Attribute	Description
arg_context	object \| undefined		optional contextual map.

Return:

object

a promise object of a boolean result (success:true, failure:false).

public abstract enable(arg_context: object | undefined): object source

Enable a plugin.

Params:

Name	Type	Attribute	Description
arg_context	object \| undefined		optional contextual map.

Return:

object

a promise object of a boolean result (success:true, failure:false).

public get_browser_plugin_file_url(): string source

Get plugin js asset files for browser loading.

Return:

string

public get_version(): string source

Get the plugin version.

Return:

string

plugin version

Plugin

Extends:

Direct Subclass:

Indirect Subclass:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(arg_manager: PluginsManager, arg_name: string, arg_class: string, arg_settings: object, arg_log_context: string | undefined): nothing source

Override:

Params:

Return:

Public Members

public $version: string source

public is_enabled: boolean source

public is_plugin: boolean source

public manager: PluginManager source

Public Methods

public abstract disable(arg_context: object | undefined): object source

Params:

Return:

public abstract enable(arg_context: object | undefined): object source

Params:

Return:

public get_browser_plugin_file_url(): string source

Return:

public get_version(): string source

Return: