Facefull

Facefull

new Facefull()

Description:
  • Main facefull class.
Source:

Members

Circlebars :array

Description:
  • Circlebars associative array. Use data-circlebarname HTML tag to set element name.
Source:
Circlebars associative array. Use data-circlebarname HTML tag to set element name.
Type:
  • array

Comboboxes :array

Description:
  • Comboboxes associative array. Use data-comboboxname HTML tag to set element name.
Source:
Comboboxes associative array. Use data-comboboxname HTML tag to set element name.
Type:
  • array

Counters :array

Description:
  • Counters associative array. Use data-countername HTML tag to set element name.
Source:
Counters associative array. Use data-countername HTML tag to set element name.
Type:
  • array

DropAreas :array

Description:
  • Drop areas associative array. Use data-dropname HTML tag to set element name.
Source:
Drop areas associative array. Use data-dropname HTML tag to set element name.
Type:
  • array

HotkeyHolders :array

Description:
  • Hotkey holders associative array. Use data-hotkeyholdername HTML tag to set element name.
Source:
Hotkey holders associative array. Use data-hotkeyholdername HTML tag to set element name.
Type:
  • array

ItemPickers :array

Description:
  • Item pickers associative array. Use data-itempickername HTML tag to set element name.
Source:
Item pickers associative array. Use data-itempickername HTML tag to set element name.
Type:
  • array

Lists :array

Description:
  • Lists associative array. Use data-listname HTML tag to set element name.
Source:
Lists associative array. Use data-listname HTML tag to set element name.
Type:
  • array
Description:
  • Main menu object.
Source:
Main menu object.
Type:
  • null

PopupMenus :array

Description:
  • Popup menus associative array. Use data-popupmenu HTML tag to set element name.
Source:
Popup menus associative array. Use data-popupmenu HTML tag to set element name.
Type:
  • array

Scrollboxes :array

Description:
  • Scrollboxes associative array. Use data-scrollboxname HTML tag to set element name.
Source:
Scrollboxes associative array. Use data-scrollboxname HTML tag to set element name.
Type:
  • array

Subpages :array

Description:
  • Subpages associative array. Use data-subpagename HTML tag to set element name.
Source:
Subpages associative array. Use data-subpagename HTML tag to set element name.
Type:
  • array

Tabs :array

Description:
  • Tabs associative array. Use data-tabsname HTML tag to set element name.
Source:
Tabs associative array. Use data-tabsname HTML tag to set element name.
Type:
  • array

Themes :ThemeManager

Description:
  • Theme management system that provides the easiest way to control application styles.
Source:
Theme management system that provides the easiest way to control application styles.
Type:

Tooltips :array

Description:
  • Tooltips associative array.
Source:
Tooltips associative array.
Type:
  • array

Viewports :ViewportManager

Description:
  • Viewport manager system that provides control display modes on different devices.
Source:
Viewport manager system that provides control display modes on different devices.
Type:

Methods

doCSSLoad(file)

Description:
  • Loads CSS by filename.
Source:
Parameters:
Name Type Description
file

doCSSUnload(file)

Description:
  • Unloads CSS by filename.
Source:
Parameters:
Name Type Description
file

doCloseAllSubpages()

Description:
  • Close all opened subpages.
Source:

doCloseGlobalPopupMenu()

Description:
  • Close all popup menus.
Source:

doEventHandle(comm, data)

Description:
  • Handles an incoming bridge event.
Source:
Parameters:
Name Type Description
comm
data

doEventHandlerAttach(comm, handler)

Description:
  • Attaches an event handler to the bridge event name.
Source:
Parameters:
Name Type Description
comm
handler

doEventSend(comm, data, params)

Description:
  • Sends event to the bridge. The behavior depends on the bridge mode. If the 'params' parameter is not specified, the current global bridge mode is used.
Source:
Parameters:
Name Type Description
comm Command to send to the bridge.
data Data to send to the bridge.
params Object Example: {type: "backend", event_ok: "", event_err: ""} Available type: `native`: uses title tag to pass event name and data across the bridge. Default for `native` bridge mode. `electron`: uses embedded method 'window.facefull_bridge.send' to pass event name and data across the bridge. Default for `electron` bridge mode. `backend`: sends data via POST request. Additional params: {event_ok: event_name_on_success, event_err: event_name_on_error}. Default for `web` bridge mode. `local`: uses local event loop to run event handler.

doEventSendEx(comm, data)

Description:
  • Sends event to the bridge. Uses 'facefullio' script message handler to pass event name and data across the bridge.
Source:
Parameters:
Name Type Description
comm Command to send to the bridge.
data Data to send to the bridge.

doHex2String(hexdata) → {string}

Description:
  • Decodes HEX string to UTF-8 text.
Source:
Parameters:
Name Type Description
hexdata
Returns:
Type
string

doIncludeScript(file)

Description:
  • Include script file by filename.
Source:
Parameters:
Name Type Description
file

doInit(params)

Description:
  • Starts Facefull initialization.
Source:
Parameters:
Name Type Description
params Parameters list: 'mode': 'native'|'electron'|'web' (default: 'native'), 'disable_context_menu': true|false (default: false)

doUpdateAllScrollboxes()

Description:
  • Update scrollbars on all scrollboxes.
Source:

getBridgeMode()

Description:
  • Get bridge mode.
Source:

getColorFromGrid(id)

Description:
  • Returns HEX color string from predefined color circular list.
Source:
Parameters:
Name Type Description
id

isNative() → {boolean}

Description:
  • Is native mode.
Source:
Returns:
Type
boolean

setBridgeMode(mode)

Description:
  • Change bridge mode.
Source:
Parameters:
Name Type Description
mode string Set bridge mode: 'native'|'electron'|'web' (default: 'native')