import {DocsBrowser} from './scripts/docbrowser/docbrowser.js'

public class | source

DocsBrowser

Extends:

HTMLElement → UIBase → DocsBrowser

Static Method Summary

Static Public Methods
public static	define(): {"tagname": string, "style": string}
public static	newSTRUCT(): *

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	contentDiv: *
public	currentPath: string
public	editMode: boolean
public	header: *
public	history: *
public	pathuxBaseURL: *
public	root: *
public	saveReq: number
public	saveReqStart: *
public	serverapi: *
public	tinymce: *

Private Members
private	_doDocInit: boolean
private	_last_save: *
private	_prefix: *

Method Summary

Public Methods
public	disableLinks()
public	enableLinks()
public	execCommand()
public	getDocPath(): *
public	go(dir: *)
public	init()
public	initDoc(): *
public	load(url: *)
public	loadSTRUCT(reader: *)
public	loadSource(data: *)
public	makeHeader()
public	makeHeader_intern()
public	patchImage(img: *)
public	patchImageTags()
public	queueSave()
public	report(message: , color: , timeout: *)
public	save()
public	setCSS()
public	setEditMode(state: *)
public	toMarkdown(): *
public	undoPost(label: *)
public	undoPre()
public	update()
public	updateCurrentPath()

Inherited Summary

From class UIBase
public static	createElement(name: , internal: boolean):
public static	define() Defines core attributes of the class
public static	getDPI(): * DEPRECATED
public static	getIconEnum(): *
public static	getInternalName(name: ):
public static	internalRegister(cls: *)
public static	prefix(name: ):
public static	register(cls: *)
public static	setDefault(element: ):
public get	background: *
public set	background
public get	ctx: *
public set	ctx
public get	description: *
public set	description
public get	disabled: *
public set	disabled
public get	internalDisabled: *
public set	internalDisabled
public get	modalRunning: *
public get	parentWidget: *
public set	parentWidget
public get	useDataPathUndo: boolean
public set	useDataPathUndo causes calls to setPathValue to go through toolpath app.datapath_set(path="" newValueJSON="")
public get	useNativeToolTips: *
public set	useNativeToolTips
private get	_reportCtxName: *
public	class_default_overrides: {}
public	default_overrides: {}
public	hidden: *
public	my_default_overrides: {}
public	packflag: *
public	pathUndoGen: number
public	shadow: *
public	tabIndex: number
public	title: *
public	visibleToPick: boolean
private	__background: *
private	__cbs: *[]
private	__disabledState: boolean
private	_active_animations: *[]
private	_checkTheme: boolean
private	_client_disabled_set: *
private	_clipboard_events: boolean
private	_clipboard_keydown: *
private	_clipboard_keyend: *
private	_clipboard_keystart: *
private	_clipboard_over: boolean
private	_ctx: *
private	_description: *
private	_description_final: *
private	_disdata: *
private	_flashcolor: *
private	_flashtimer: *
private	_has_own_tooltips: *
private	_id: *
private	_init_done: boolean
private	_internalDisabled: boolean
private	_lastPathUndoGen: number
private	_last_clipboard_keyevt: *
private	_last_description: *
private	_last_theme_update_key: *
private	_modaldata: *
private	_modalstack: *[]
private	_override_class: *
private	_parentWidget: *
private	_screenStyleTag: *
private	_screenStyleUpdateHash: number
private	_textBoxEvents: boolean
private	_themeOverride: *
private	_tool_tip_abort_delay: *
private	_tooltip_ref: *
private	_tooltip_timer: *
private	_useDataPathUndo: *
private	_useNativeToolTips: *
private	_useNativeToolTips_set: boolean
private	_wasAddedToNodeAtSomeTime: boolean
public	abortAnimations()
public	abortToolTips(delayMs: number): *
public	addEventListener(type: , cb: , options: ):
public	animate(_extra_handlers: {}): * returns a new Animator instance
public	appendChild(child: ):
public	calcZ(): number
public	checkInit(): *
public	checkThemeUpdate(): boolean
public	clipboardCopy() set havePickClipboard to true in define() to enable mouseover pick clipboarding
public	clipboardPaste()
public	connectedCallback()
public	destroy()
public	doOnce(func: , timeout: )
public	findArea(): *
public	flash(color: , rect_element: , timems: number, autoFocus: boolean)
public	float(x: number, y: number, zindex: , positionKey: ): *
public	flushSetCSS()
public	flushUpdate(force: boolean)
public	formatNumber(value: , args: {}):
public	genBoxCSS(subkey: ):
public	getClassDefault(key: , checkForMobile: boolean, defaultval: ): *
public	getDPI(): * try to use this method
public	getDefault(key: , checkForMobile: boolean, defaultval: ): *
public	getDefault_intern(key: , checkForMobile: boolean, defaultval: ): *
public	getElementById(id: ):
public	getPathDescription(ctx: , path: ): *
public	getPathMeta(ctx: , path: ): *
public	getPathValue(ctx: , path: ): *
public	getScreen(): *
public	getStyle(): *
public	getStyleClass(): string
public	getSubDefault(key: , subkey: , backupkey: , defaultval: ): * get a sub style from a theme style class.
public	getTotalRect(): *
public	getWinHeight(): *
public	getWinWidth(): *
public	getZoom(): number
public	hasClassDefault(key: ):
public	hasDefault(key: ):
public	hide(sethide: boolean)
public	init()
public	isDead(): boolean
public	loadData(obj: ): for saving ui state.
public	loadJSON(obj: *)
public	noMargins(): *
public	noMarginsOrPadding(): *
public	noPadding(): *
public	on_disabled()
public	on_enabled()
public	on_remove()
public	on_resize(newsize: *)
public	onadd()
public	overrideClass(style: *)
public	overrideClassDefault(style: , key: , val: *)
public	overrideDefault(key: , val: , localOnly: boolean): *
public	overrideTheme(theme: ):
public	parseNumber(value: , args: {}):
public	pickElement(x: , y: , args: {}, marginy: number, nodeclass: , excluded_classes: ): *
public	popModal()
public	popReportContext()
public	pushModal(handlers: , autoStopPropagation: boolean, pointerId: , pointerElem: ):
public	pushReportContext(key: *)
public	regenTabOrder(): * find owning screen and tell it to update the global tab order
public	remove(trigger_on_destroy: boolean)
public	removeChild(child: *, trigger_on_destroy: boolean)
public	removeEventListener(type: , cb: , options: ):
public	replaceChild(newnode: , node: ): boolean
public	saveData(): {} for saving ui state.
public	setBoxCSS(subkey: *)
public	setCSS(setBG: boolean)
public	setPathValue(ctx: , path: , val: *)
public	setPathValueUndo(ctx: , path: , val: *)
public	setUndo(val: ):
public	swapWith(b: *): boolean
public	toJSON(): *
public	traverse(type_or_set: ):
public	undoBreakPoint()
public	unhide()
public	update()
public	updateToolTipHandlers()
public	updateToolTips()
private	__updateDisable(val: *)
private	_clipboardHotkeyInit()
private	_doMobileDefault(key: , val: ): *
private	_ensureChildrenCtx()
private	_flash_focus() child classes can override this to prevent focus on flash
private	_forEachChildWidget(cb: , thisvar: ) Iterates over all child widgets, including ones that might be inside of normal DOM nodes.
private	_init(): boolean
private	_ondestroy()

Static Public Methods

public static define(): {"tagname": string, "style": string} source

Defines core attributes of the class

Override:

UIBase#define

Return:

{"tagname": string, "style": string}

public static newSTRUCT(): * source

Return:

Public Constructors

public constructor() source

Override:

UIBase#constructor

Public Members

public contentDiv: * source

public currentPath: string source

public editMode: boolean source

public header: * source

public history: * source

public pathuxBaseURL: * source

public root: * source

public saveReq: number source

public saveReqStart: * source

public serverapi: * source

public tinymce: * source

Private Members

private _doDocInit: boolean source

private _last_save: * source

private _prefix: * source

Public Methods

public disableLinks() source

public enableLinks() source

public execCommand() source

public getDocPath(): * source

Return:

public go(dir: *) source

Params:

Name	Type	Attribute	Description
dir	*

public init() source

Override:

UIBase#init

public initDoc(): * source

Return:

public load(url: *) source

Params:

Name	Type	Attribute	Description
url	*

public loadSTRUCT(reader: *) source

Params:

Name	Type	Attribute	Description
reader	*

public loadSource(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public makeHeader() source

public makeHeader_intern() source

public patchImage(img: *) source

Params:

Name	Type	Attribute	Description
img	*

public patchImageTags() source

public queueSave() source

public report(message: , color: , timeout: *) source

Params:

Name	Type	Attribute	Description
message	*
color	*	optional default: undefined
timeout	*	optional default: undefined

public save() source

public setCSS() source

Override:

UIBase#setCSS

public setEditMode(state: *) source

Params:

Name	Type	Attribute	Description
state	*

public toMarkdown(): * source

Return:

public undoPost(label: *) source

Params:

Name	Type	Attribute	Description
label	*

DocsBrowser

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static define(): {"tagname": string, "style": string} source

Override:

Return:

public static newSTRUCT(): * source

Return:

Public Constructors

public constructor() source

Override:

Public Members

public contentDiv: * source

public currentPath: string source

public editMode: boolean source

public header: * source

public history: * source

public pathuxBaseURL: * source

public root: * source

public saveReq: number source

public saveReqStart: * source

public serverapi: * source

public tinymce: * source

Private Members

private _doDocInit: boolean source

private _last_save: * source

private _prefix: * source

Public Methods

public disableLinks() source

public enableLinks() source

public execCommand() source

public getDocPath(): * source

Return:

public go(dir: *) source

Params:

public init() source

Override:

public initDoc(): * source

Return:

public load(url: *) source

Params:

public loadSTRUCT(reader: *) source

Params:

public loadSource(data: *) source

Params:

public makeHeader() source

public makeHeader_intern() source

public patchImage(img: *) source

Params:

public patchImageTags() source

public queueSave() source

public report(message: *, color: *, timeout: *) source

Params:

public save() source

public setCSS() source

Override:

public setEditMode(state: *) source

Params:

public toMarkdown(): * source

Return:

public undoPost(label: *) source

Params:

public undoPre() source

public update() source

Override:

public updateCurrentPath() source

public report(message: , color: , timeout: *) source