32 lines
42 KiB
HTML
32 lines
42 KiB
HTML
<html>
|
||
<head>
|
||
</head>
|
||
<body style="background: transparent;">
|
||
<script src="scripts/docstrap.lib.js"></script>
|
||
<script src="scripts/lunr.min.js"></script>
|
||
<script src="scripts/fulltext-search.js"></script>
|
||
|
||
<script type="text/x-docstrap-searchdb">
|
||
{"global.html":{"id":"global.html","title":"Global","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Global Members beanIconClass the icon class for bean edit views Source: xcf/manager/DriverManager.js defaultScope the default scope for new items Source: xcf/manager/DriverManager.js driverScopes array of driver store scopes : TODO : tbr Source: xcf/manager/DriverManager.js groupType Bean group type Source: xcf/manager/DriverManager.js itemMetaTitleField The name of the CI in the meta database for the title or name. Source: xcf/manager/DriverManager.js itemType Bean item type Source: xcf/manager/DriverManager.js Methods addDeviceInstance(device, driver) Parameters: Name Type Description device driver Source: xcf/manager/DriverManager.js onDeviceMessage(evt) Secondary entry for incoming device messages. This is a regular callbackfor the system event xcf.types.EVENTS.ON_DEVICE_MESSAGE emitted by theDeviceManager. It comes with the device info, a driver instance and theunfiltered device message. This function is primarily in charge to : split the message by a delimiter (driver settings) pass the device messages to the actual driver pass the device message to blox4. Parameters: Name Type Description evt Source: xcf/manager/DriverManager.js onNewDriverScopeCreated(scope) Callback when a blox scope has been created. This is being used to deserialize the driver's CI meta settings into a blox scope : variables, commands Parameters: Name Type Description scope Source: xcf/manager/DriverManager.js × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Modules Classes DriverBase module:xcf/manager/DeviceManager module:xcf/model/Device × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Classes Classes DriverBase module:xcf/manager/DeviceManager module:xcf/model/Device × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated "Control Freak" Driver - API - DocumentationGot to the general documentation here × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"module-xcf.driver.DriverBase.html":{"id":"module-xcf.driver.DriverBase.html","title":"Class: DriverBase","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Class: DriverBase DriverBase new DriverBase() Driver Base Class Please read module:xide/types Online docs: http://rawgit.com/mc007/xcfnode/tree/master/out Source: xcf/driver/DriverBase.js × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"module-xcf_driver_DriverBase.html":{"id":"module-xcf_driver_DriverBase.html","title":"Module: xcf/driver/DriverBase","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Module: xcf/driver/DriverBase Source: xcf/driver/DriverBase.js Members <inner> lineBreak :string Type: string Default Value: \\r Source: xcf/driver/DriverBase.js <inner> options :object The information about the device in this structure: Type: object Source: xcf/driver/DriverBase.js Example { driver:"Marantz/MyMarantz.js", host:"102.123.23.23" port:23, protocol:"tcp" scope:"system_drivers" } <inner> responseSettings :object responseSettings contains the constants for receiving data from a deviceits being set at initialization time and has this structure: Type: object Source: xcf/driver/DriverBase.js Example { start:false, startString:'' cTypeByte:false, //construction type 'Per Byte' cTypePacket:false, //construction type 'Per Packet' cTypeDelimiter:true, //construction type 'Per Delimiter' cTypeCount:false, //construction type 'Per Count' delimiter:'', //the delimiter count:10 //packet count } <inner> sendSettings :object sendSettings contains the constants for receiving and sending data to a deviceits being set at initialization time and has this structure: Type: object Source: xcf/driver/DriverBase.js Example { constants:{ end:'\\r', start:'', }, send:{ interval:500, mode:true|false, //true=onReply | false=Interval onReply:'\\n', timeout:500 } } Methods <inner> getLineBreak() Deal with Javascript special characters, indexOf("\\n") fails otherwise Source: xcf/driver/DriverBase.js Returns: Type string <inner> getLineBreakSend() Deal with Javascript special characters, indexOf("\\n") fails otherwise Source: xcf/driver/DriverBase.js Returns: Type string <inner> getVariable(title) Return a variable's value Parameters: Name Type Description title string the name of the variable Source: xcf/driver/DriverBase.js Returns: the value of the variable Type string <inner> log(level, type, message, data) Method to add a logging message. Parameters: Name Type Description level string This can be error, warning, info, trace or custom type string An additional string, by default this is set to "Device" message string The message it self data object An optional object/data you want to include Source: xcf/driver/DriverBase.js Example // for instance you want to log any incoming message in a custom way, you need to overwrite 'sendMessage' in // your base class like this: onMessage: function (data) { this.log('info', 'my marantz', 'Marantz Driver Message: ' + data.message, { some: 'extra', message: data }); this.inherited(arguments); //important, call BaseDriver::onMessage! } <inner> onMessage(data) Standard callback when we have a message from the device we're bound to (specified in profile). put the message in the incoming queue, tag it as 'unread' in case we have messages to send and we are in 'onReply' mode, trigger outgoing queue Parameters: Name Type Description data Object : Message Struct build by the device manager Properties Name Type Description device Object : Device info Properties Name Type Description host String : The host port String : The host's port protocol String : The host's protocol message String : RAW message, untreated Source: xcf/driver/DriverBase.js Example // for instance you might update the "Volume" Variable within onMessage: onMessage:function(data){ var value = data.message; var volume = 0; if (value.indexOf('MV') != -1 && value.indexOf('MVMAX') == -1) { var _volume = value.substring(2, value.length); _volume = parseInt(_volume.substring(0, 2)); if (!isNaN(_volume)) { this.setVariable('Volume', _volume); volume = _volume; } } // do something else with volume: this.log('info',null,'Did update volume to ' + volume); //important, call BaseDriver::onMessage! this.inherited(arguments); } <inner> prepareMessage(msg) Surround command with 'start' and 'end' constant, specified in the command settingsof the driver. Parameters: Name Type Description msg Source: xcf/driver/DriverBase.js Returns: Type * | string | String <inner> sendMessage(msg, now, src, id) Send message send a string to the device. Basing on the send settings this message will be queued or sendon reply. Parameters: Name Type Description msg string the string to send now string force sending now! src string the id of the source block id string the id of the send job Source: xcf/driver/DriverBase.js <inner> setVariable(title, value) Set a variable's value Parameters: Name Type Description title string the name of the variable value string the new value Source: xcf/driver/DriverBase.js <inner> split(str) Splits a message string from the device server into an array of messages. Its using 'responseSettings' Parameters: Name Type Description str Source: xcf/driver/DriverBase.js Returns: Type Array.<string> <inner> start() Main entry when this instance is started Source: xcf/driver/DriverBase.js Returns: Type boolean × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"module-xcf_manager_DeviceManager.html":{"id":"module-xcf_manager_DeviceManager.html","title":"Module: xcf/manager/DeviceManager","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Module: xcf/manager/DeviceManager new (require("xcf/manager/DeviceManager"))() Common base class, for server and client. Source: xcf/manager/DeviceManager.js Methods <inner> createDriverInstance(deviceInfo, driverBase, device) Creates a driver instance per device Parameters: Name Type Description deviceInfo module:xide/types~DeviceInfo The device info driverBase module:xcf/driver/DriverBase The driver base class device module:xcf/model/Device The device model item Source: xcf/manager/DeviceManager.js <inner> getDeviceByHost(host, port) Return device by host and port Parameters: Name Type Description host string port string Source: xcf/manager/DeviceManager.js Returns: Type module:xcf/model/Device | null <inner> getDeviceById(id) Returns a device by id Parameters: Name Type Description id string Source: xcf/manager/DeviceManager.js Returns: Type module:xcf/model/Device | null <inner> getDevices(enabledOnly, addDriver) Get all enabled devices Parameters: Name Type Description enabledOnly addDriver Source: xcf/manager/DeviceManager.js Returns: Type Array.<module:xcf/model/Device> <inner> getDevicesByDriverId(id) Returns all devices by driver id Parameters: Name Type Description id string the driver id Source: xcf/manager/DeviceManager.js Returns: Type Array.<module:xcf/model/Device> <inner> getDeviceStatusIcon(item) Return the device's status icon Parameters: Name Type Description item module:xcf/model/Device The device Source: xcf/manager/DeviceManager.js Returns: an icon class string Type string <inner> getItemById(itemId) Return device model item by device id Parameters: Name Type Description itemId Source: xcf/manager/DeviceManager.js Returns: The device Type module:xcf/model/Device <inner> getMetaValue(item, name) Parameters: Name Type Description item module:xcf/model/Device the device name string the name of the CI Source: xcf/manager/DeviceManager.js Returns: Type string | int | object | null <inner> onDeviceStarted(driverInstance, deviceStoreItem, driver) Callback when we are connected to a device.We use this to fire all looping blocks Parameters: Name Type Description driverInstance module:xcf/driver/DriverBase the instance of the driver deviceStoreItem module:xcf/model/Device the device model item driver module:xcf/model/Driver the driver model item Source: xcf/manager/DeviceManager.js <inner> stopDevice(item) Stops a device with a device model item Parameters: Name Type Description item module:xcf/model/Device | string Source: xcf/manager/DeviceManager.js <inner> toDeviceControlInfo(item) Return handy info for a device Parameters: Name Type Description item module:xcf/model/Device Source: xcf/manager/DeviceManager.js Returns: Type module:xide/types~DeviceInfo × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"module-xcf_model_Device.html":{"id":"module-xcf_model_Device.html","title":"Module: xcf/model/Device","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Module: xcf/model/Device new (require("xcf/model/Device"))() Source: xcf/model/Device.js Members <inner> state :module:xide/types~DEVICE_STATE Type: module:xide/types~DEVICE_STATE Source: xcf/model/Device.js See: module:xide/types/DEVICE_STATE Methods <inner> getBlockScope() Returns the block scope of the a driver's instance Source: xcf/model/Device.js Returns: Type module:xblox/model/Scope <inner> getDriver() Return the driver model item Source: xcf/model/Device.js Returns: Type module:xcf/model/Driver | null <inner> getDriverInstance() Returns the driver instance Source: xcf/model/Device.js Returns: Type model:xcf/driver/DriverBase <inner> getMetaValue(title) Return a value by field from the meta database Parameters: Name Type Description title Source: xcf/model/Device.js Returns: Type string | int | boolean | null <inner> getStateIcon(state) Return the internal state icon Parameters: Name Type Description state Source: xcf/model/Device.js Returns: Type string | null <inner> setMetaValue(title) Set a value in the meta database Parameters: Name Type Description title string The name of the CI Source: xcf/model/Device.js Returns: Type void | null <inner> setState(state, silent) Set the state Parameters: Name Type Description state silent Source: xcf/model/Device.js Module: xcf/model/Device Model for a device. It extends the base model classand acts a source. new (require("xcf/model/Device"))() Source: xcf/model/Device.js Extends module:xide/mixins/EventedMixin module:xide/data/Model module:xide/data/Source Members <inner> state :module:xide/types~DEVICE_STATE Type: module:xide/types~DEVICE_STATE Source: xcf/model/Device.js See: module:xide/types/DEVICE_STATE Methods <inner> getBlockScope() Returns the block scope of the a driver's instance Source: xcf/model/Device.js Returns: Type module:xblox/model/Scope <inner> getDriver() Return the driver model item Source: xcf/model/Device.js Returns: Type module:xcf/model/Driver | null <inner> getDriverInstance() Returns the driver instance Source: xcf/model/Device.js Returns: Type model:xcf/driver/DriverBase <inner> getMetaValue(title) Return a value by field from the meta database Parameters: Name Type Description title Source: xcf/model/Device.js Returns: Type string | int | boolean | null <inner> getStateIcon(state) Return the internal state icon Parameters: Name Type Description state Source: xcf/model/Device.js Returns: Type string | null <inner> setMetaValue(title) Set a value in the meta database Parameters: Name Type Description title string The name of the CI Source: xcf/model/Device.js Returns: Type void | null <inner> setState(state, silent) Set the state Parameters: Name Type Description state silent Source: xcf/model/Device.js × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"module-xcf_model_Driver.html":{"id":"module-xcf_model_Driver.html","title":"Module: xcf/model/Driver","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Module: xcf/model/Driver Model for a driver. It extends the base model classand acts a source. Source: xcf/model/Driver.js Extends module:xide/mixins/EventedMixin module:xide/data/Model module:xide/data/Source Methods <inner> getMetaValue(title) Return a value by field from the meta database Parameters: Name Type Description title Source: xcf/model/Driver.js Returns: Type string | int | boolean | null <inner> getParent() Return the parent folder Source: xcf/model/Driver.js Returns: Type module:xcf/model/Driver <inner> setMetaValue(title) Set a value in the meta database Parameters: Name Type Description title string The name of the CI Source: xcf/model/Driver.js Returns: Type void | null Module: xcf/model/Driver Source: xcf/model/Driver.js Methods <inner> getMetaValue(title) Return a value by field from the meta database Parameters: Name Type Description title Source: xcf/model/Driver.js Returns: Type string | int | boolean | null <inner> getParent() Return the parent folder Source: xcf/model/Driver.js Returns: Type module:xcf/model/Driver <inner> setMetaValue(title) Set a value in the meta database Parameters: Name Type Description title string The name of the CI Source: xcf/model/Driver.js Returns: Type void | null × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"module-xcf_model_Variable.html":{"id":"module-xcf_model_Variable.html","title":"Module: xcf/model/Variable","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Module: xcf/model/Variable Model for a variable. It extends the base model classand acts a source. Source: xcf/model/Variable.js Extends module:xblox/model/Variables/Variable module:xide/mixins/EventedMixin module:xide/data/Model module:xide/data/Source Members <inner> name The name of the variable Source: xcf/model/Variable.js <inner> value The value of the variable Source: xcf/model/Variable.js Module: xcf/model/Variable Source: xcf/model/Variable.js Members <inner> name The name of the variable Source: xcf/model/Variable.js <inner> value The value of the variable Source: xcf/model/Variable.js × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "},"module-xide_types.html":{"id":"module-xide_types.html","title":"Module: xide/types","body":" Documentation Modules xcf/driver/DriverBasexcf/manager/DeviceManagerxcf/model/Devicexcf/model/Driverxcf/model/Variablexide/types Classes xcf.driver.DriverBase Global addDeviceInstancebeanIconClassdefaultScopedriverScopesgroupTypeitemMetaTitleFielditemTypeonDeviceMessageonNewDriverScopeCreated Module: xide/types Source: xcf/types/Types.js Members <static> types.ACTION :string Enumeration to define an Action command Type: string Properties: Name Type Default Description LAYOUT string View/Layout COLUMNS string View/Columns SELECTION string File/Select CLIPBOARD string Edit/Clipboard UNDO string Edit/Undo REDO string Edit/Redo CLIPBOARD_COPY string Edit/Clipboard/Copy CLIPBOARD_PASTE string Edit/Clipboard/Paste CLIPBOARD_CUT string Edit/Clipboard/Cut COPY string File/Copy MOVE string File/Move RENAME string File/Rename DELETE string File/Delete OPEN string File/Open EDIT string File/Edit SAVE string File/Save SEARCH string File/Search TOOLBAR string View/Show/Toolbar STATUSBAR string View/Show/Statusbar BREADCRUMB string View/Show/Breadcrumb HEADER string View/Show/Header DOWNLOAD string File/Download DOWNLOAD_TO string File/downloadTo INFO string File/Info COMPRESS string File/Compress RELOAD string File/Reload UPLOAD string File/Upload PREVIEW string File/Preview OPEN_IN string File/Open In INSERT_IMAGE string insertImage COPY_PASTE string copypaste DND string dnd OPTIONS string options NEW_FILE string File/New/New File NEW_DIRECTORY string File/New/New Folder GET_CONTENT string get SET_CONTENT string set FIND string File/Find CUSTOM string custom PERMA_LINK string permaLink ADD_MOUNT string ADD_MOUNT REMOVE_MOUNT string REMOVE_MOUNT EDIT_MOUNT string EDIT_MOUNT PERSPECTIVE string PERSPECTIVE RUN string File/Run GO_UP string Navigation/Go Up STOP string File/Stop CLOSE string View/Close FULLSCREEN string View/Fullscreen OPEN_IN_TAB string File/OpenInNewTab SOURCE string Navigation/Source RIBBON string View/Show/Ribbon MAIN_MENU string View/Show/MainMenu NAVIGATION string View/Show/Navigation BASH_CONSOLE string File/Console/Bash JS_CONSOLE string File/Console/JS PHP_CONSOLE string File/Console/PHP CONSOLE string File/Console/PHP SIZE_STATS string View/Show/SizeStats WELCOME string Window/Welcome Source: xide/types/Types.js <static> types.DEVICE_PROPERTY Keys to define protocol meta properties Properties: Name Type Default Description CF_DEVICE_DRIVER Driver CF_DEVICE_HOST Host CF_DEVICE_PORT Port CF_DEVICE_PROTOCOL Protocol CF_DEVICE_TITLE Title CF_DEVICE_ID Id CF_DEVICE_ENABLED Enabled CF_DEVICE_OPTIONS Options CF_DEVICE_DRIVER_OPTIONS DriverOptions Source: xcf/types/Types.js <static> types.DEVICE_STATE :String Enumeration to define a device's status Type: String Properties: Name Type Default Description CONNECTING String DeviceIsConnecting CONNECTED String DeviceIsConnected SYNCHRONIZING String DeviceIsSynchronizing READY String DeviceIsReady DISCONNECTED String DeviceIsDisconnected DISABLED String DeviceIsDisabled Source: xcf/types/Types.js <static> types.DRIVER_FLAGS :int Bitmask or flags for device about its driver Type: int Properties: Name Type Default Description RUNS_ON_SERVER int 2 Mark the driver for "server side" DEBUG int 4 Source: xcf/types/Types.js <static> types.DRIVER_PROPERTY Keys to define a driver meta property Properties: Name Type Default Description CF_DRIVER_NAME CF_DRIVER_NAME CF_DRIVER_ICON CF_DRIVER_ICON CF_DRIVER_CLASS CF_DRIVER_CLASS CF_DRIVER_ID CF_DRIVER_ID CF_DRIVER_COMMANDS CF_DRIVER_COMMANDS CF_DRIVER_VARIABLES CF_DRIVER_VARIABLES CF_DRIVER_RESPONSES CF_DRIVER_RESPONSES Source: xcf/types/Types.js <static> types.ECIType :string A 'Configurable Information's ("CI") type information. Every CI has this information. You canre-composite new types with ECIType.STRUCTURE. However all 'beans' (rich objects) in the system all displayed through a set of CIs,also called the CIS (Configurable Information Set). There are many types already : Each ECIType has mapped widgets, BOOL : checkbox, STRING: Text-Areay and so forth. Type: string Properties: Name Type Default Description BOOL int 0 BOX int 1 COLOUR int 2 ENUMERATION int 3 FILE int 4 FLAGS int 5 FLOAT int 6 INTEGER int 7 MATRIX int 8 OBJECT int 9 REFERENCE int 10 QUATERNION int 11 RECTANGLE int 12 STRING int 13 VECTOR int 14 VECTOR2D int 15 VECTOR4D int 16 ICON int 17 IMAGE int 18 BANNER int 19 LOGO int 20 STRUCTURE int 21 BANNER2 int 22 ICON_SET int 23 SCRIPT int 24 EXPRESSION int 25 RICHTEXT int 26 ARGUMENT int 27 JSON_DATA int 28 EXPRESSION_EDITOR int 29 WIDGET_REFERENCE int 30 DOM_PROPERTIES int 31 BLOCK_REFERENCE int 32 BLOCK_SETTINGS int 33 FILE_EDITOR int 34 END int 35 UNKNOWN int -1 Source: xide/types/Types.js <static> types.EVENTS :string Events of xide.* Type: string Properties: Name Type Default Description SAVE_LAYOUT string layoutSave RESTORE_LAYOUT string layoutRestore When the layout is being restored, See wcDocker.restore ON_FILE_CHANGED string fileChanged ON_FILE_DELETED string fileDeleted ON_NODE_SERVICE_STORE_READY string onNodeServiceStoreReady ON_CREATED_MANAGER string onCreatedManager ON_CI_UPDATE string onCIUpdate ON_CREATED_WIDGET string onWidgetCreated ON_WIDGET_READY string onWidgetReady ON_MAIN_VIEW_READY string onMainViewReady ON_MAIN_MENU_READY string onMainMenuReady ON_MAIN_MENU_OPEN string onMainMenuOpen ON_VIEW_REMOVED string onViewRemoved ON_VIEW_SHOW string onViewShow ON_VIEW_HIDE string onViewHide ON_VIEW_ADDED string onViewAdded ON_ITEM_SELECTED string onItemSelected ON_ITEM_REMOVED string onItemRemoved ON_ITEM_CLOSED string onItemClosed ON_ITEM_ADDED string onItemAdded ON_ITEM_MODIFIED string onItemModified ON_ACTION_CHANGE_CONTEXT string onChangeActionContext ON_ACTION_CONTEXT_CHANGED string onActionContextChanged ON_CONTAINER_ADDED string onContainerAdded ON_CONTAINER_REMOVED string onContainerRemoved ON_REMOVE_CONTAINER string onRemoveContainer ON_CONTAINER_REPLACED string onContainerReplaced ON_CONTAINER_SPLIT string onContainerSplit ON_CLIPBOARD_COPY string onClipboardCopy ON_CLIPBOARD_PASTE string onClipboardPaste ON_CLIPBOARD_CUT string onClipboardCut ON_MODULE_RELOADED string onModuleReloaded Event to notify classes about a reloaded module ON_MODULE_UPDATED string onModuleUpdated RESIZE string onResize ERROR string onError STATUS string onStatus ON_FILE_STORE_READY string onFileStoreReady ON_DID_OPEN_ITEM string onDidOpenItem ON_SHOW_PANEL string onShowPanel IMAGE_LOADED string imageLoaded IMAGE_ERROR string imageError UPLOAD_BEGIN string uploadBegin UPLOAD_PROGRESS string uploadProgress UPLOAD_FINISH string uploadFinish UPLOAD_FAILED string uploadFailed ON_CONTEXT_MENU_OPEN string onContextMenuOpen ON_PLUGIN_LOADED string onPluginLoaded ON_PLUGIN_READY string onPluginReady ALL_PLUGINS_READY string onAllPluginsReady REGISTER_EDITOR string registerEditor REGISTER_ACTION string registerAction SET_ITEM_ACTIONS string onSetItemsActions ON_RENDER_ACTIONS string onRenderActions ON_FILE_CONTENT_CHANGED string onFileContentChanged ON_PANEL_CLOSED string onPanelClosed ON_PANEL_CREATED string onPanelCreated ON_COPY_BEGIN string onCopyBegin ON_COPY_END string onCopyEnd ON_DELETE_BEGIN string onDeleteBegin ON_DELETE_END string onDeleteEnd ON_MOVE_BEGIN string onMoveBegin ON_MOVE_END string onMoveEnd ON_CHANGED_CONTENT string onChangedContent ON_COMPRESS_BEGIN string onCompressBegin ON_COMPRESS_END string onCompressEnd ON_CREATE_EDITOR_BEGIN string onCreateEditorBegin ON_CREATE_EDITOR_END string onCreateEditorEnd ON_EXPRESSION_EDITOR_ADD_FUNCTIONS string onExpressionEditorAddFunctions ON_ACE_READY string onACEReady ON_SERVER_LOG_MESSAGE string onServerLogMessage ON_CLIENT_LOG_MESSAGE string onClientLogMessage ON_DID_RENDER_COLLECTION string onDidRenderCollection ON_COMPONENT_READY string onComponentReady ON_ALL_COMPONENTS_LOADED string onAllComponentsLoaded ON_APP_READY string onAppReady ON_CREATE_STORE string onCreateStore ON_STORE_CREATED string onStoreCreated ON_STORE_CHANGED string onStoreChanged ON_STATUS_MESSAGE string onStatusMessage ON_OPEN_VIEW string onOpenView ON_VIEW_MAXIMIZE_START string onViewMaximizeStart ON_VIEW_MAXIMIZE_END string onViewMaximizeEnd Source: xide/types/Types.js <static> types.ITEM_TYPE :string Stub for registered bean types. This value is needed to let the UI switch between configurations per such type.At the very root is the bean action context which may include more contexts. Type: string Properties: Name Type Default Description FILE string BTFILE Bean type 'file' is handled by the xfile package WIDGET string WIDGET Bean type 'widget' is handled by the xide/ve and davinci package BLOCK string BLOCK Bean type 'block' is handled by the xblox package TEXT string TEXT Bean type 'text' is used for text editors Source: xide/types/Types.js <static> types.MESSAGE_SOURCE Enumeration to define a source type for variable change. Properties: Name Type Default Description DEVICE DEVICE GUI GUI BLOX BLOX CODE CODE Source: xcf/types/Types.js <static> types.PROTOCOL_PROPERTY Keys to define protocol meta properties Properties: Name Type Default Description CF_PROTOCOL_TITLE Title CF_PROTOCOL_ICON CF_PROTOCOL_ICON CF_PROTOCOL_CLASS CF_PROTOCOL_CLASS CF_PROTOCOL_ID CF_PROTOCOL_ID CF_PROTOCOL_COMMANDS CF_PROTOCOL_COMMANDS CF_PROTOCOL_VARIABLES CF_PROTOCOL_VARIABLES CF_PROTOCOL_RESPONSES CF_PROTOCOL_RESPONSES Source: xcf/types/Types.js <inner, constant> MAIN_MENU_KEYS :Integer.<module:xide/types~MAIN_MENU_KEYS> Set of keys in the main menu Type: Integer.<module:xide/types~MAIN_MENU_KEYS> Source: xide/types/Types.js <inner, constant> RESOURCE_VARIABLES :Array.<module:xide/types~RESOURCE_VARIABLES> All client resources are through variables on the server side. Here the minimum variables for an xjs application. Type: Array.<module:xide/types~RESOURCE_VARIABLES> Source: xide/types/Types.js <inner, constant> SERVICE_STATUS :Integer.<module:xide/types~SERVICE_STATUS> Possible Node-JS service status modes. Type: Integer.<module:xide/types~SERVICE_STATUS> Source: xide/types/Types.js <inner, constant> VIEW_SPLIT_MODE :Array.<module:xide/types~ViewSplitMode> Possible split modes for rich editors with preview or live coding views. Type: Array.<module:xide/types~ViewSplitMode> Source: xide/types/Types.js <inner, constant> WIDGET_REFERENCE_MODE :Array.<module:xide/types~WidgetReferenceMode> WIDGET_REFERENCE_MODE enumerates possible modes to resolve a string expressioninto instances. There are a few CI based widgets subclassed from xide/widgets/Referenced.The reference structure consist out of this mode and that expression. Type: Array.<module:xide/types~WidgetReferenceMode> Source: xide/types/Types.js Type Definitions DeviceInfo Type: object Properties: Name Type Description host string The IP address port string The port scope string The scope of the device driverId string The id of the driver protocol string The protocol, ie: tcp, serial,.. id string The device model id title string The title of the device serverSide boolean The driver runs server side only driverOptions module:xide/types~DRIVER_FLAGS The driver flags Source: xide/types/Types.js Module: xide/types All the package's constants and enums in C style structures. Source: xide/types/Types.js Members <static> types.ACTION :string Enumeration to define an Action command Type: string Properties: Name Type Default Description LAYOUT string View/Layout COLUMNS string View/Columns SELECTION string File/Select CLIPBOARD string Edit/Clipboard UNDO string Edit/Undo REDO string Edit/Redo CLIPBOARD_COPY string Edit/Clipboard/Copy CLIPBOARD_PASTE string Edit/Clipboard/Paste CLIPBOARD_CUT string Edit/Clipboard/Cut COPY string File/Copy MOVE string File/Move RENAME string File/Rename DELETE string File/Delete OPEN string File/Open EDIT string File/Edit SAVE string File/Save SEARCH string File/Search TOOLBAR string View/Show/Toolbar STATUSBAR string View/Show/Statusbar BREADCRUMB string View/Show/Breadcrumb HEADER string View/Show/Header DOWNLOAD string File/Download DOWNLOAD_TO string File/downloadTo INFO string File/Info COMPRESS string File/Compress RELOAD string File/Reload UPLOAD string File/Upload PREVIEW string File/Preview OPEN_IN string File/Open In INSERT_IMAGE string insertImage COPY_PASTE string copypaste DND string dnd OPTIONS string options NEW_FILE string File/New/New File NEW_DIRECTORY string File/New/New Folder GET_CONTENT string get SET_CONTENT string set FIND string File/Find CUSTOM string custom PERMA_LINK string permaLink ADD_MOUNT string ADD_MOUNT REMOVE_MOUNT string REMOVE_MOUNT EDIT_MOUNT string EDIT_MOUNT PERSPECTIVE string PERSPECTIVE RUN string File/Run GO_UP string Navigation/Go Up STOP string File/Stop CLOSE string View/Close FULLSCREEN string View/Fullscreen OPEN_IN_TAB string File/OpenInNewTab SOURCE string Navigation/Source RIBBON string View/Show/Ribbon MAIN_MENU string View/Show/MainMenu NAVIGATION string View/Show/Navigation BASH_CONSOLE string File/Console/Bash JS_CONSOLE string File/Console/JS PHP_CONSOLE string File/Console/PHP CONSOLE string File/Console/PHP SIZE_STATS string View/Show/SizeStats WELCOME string Window/Welcome Source: xide/types/Types.js <static> types.DEVICE_PROPERTY Keys to define protocol meta properties Properties: Name Type Default Description CF_DEVICE_DRIVER Driver CF_DEVICE_HOST Host CF_DEVICE_PORT Port CF_DEVICE_PROTOCOL Protocol CF_DEVICE_TITLE Title CF_DEVICE_ID Id CF_DEVICE_ENABLED Enabled CF_DEVICE_OPTIONS Options CF_DEVICE_DRIVER_OPTIONS DriverOptions Source: xcf/types/Types.js <static> types.DEVICE_STATE :String Enumeration to define a device's status Type: String Properties: Name Type Default Description CONNECTING String DeviceIsConnecting CONNECTED String DeviceIsConnected SYNCHRONIZING String DeviceIsSynchronizing READY String DeviceIsReady DISCONNECTED String DeviceIsDisconnected DISABLED String DeviceIsDisabled Source: xcf/types/Types.js <static> types.DRIVER_FLAGS :int Bitmask or flags for device about its driver Type: int Properties: Name Type Default Description RUNS_ON_SERVER int 2 Mark the driver for "server side" DEBUG int 4 Source: xcf/types/Types.js <static> types.DRIVER_PROPERTY Keys to define a driver meta property Properties: Name Type Default Description CF_DRIVER_NAME CF_DRIVER_NAME CF_DRIVER_ICON CF_DRIVER_ICON CF_DRIVER_CLASS CF_DRIVER_CLASS CF_DRIVER_ID CF_DRIVER_ID CF_DRIVER_COMMANDS CF_DRIVER_COMMANDS CF_DRIVER_VARIABLES CF_DRIVER_VARIABLES CF_DRIVER_RESPONSES CF_DRIVER_RESPONSES Source: xcf/types/Types.js <static> types.ECIType :string A 'Configurable Information's ("CI") type information. Every CI has this information. You canre-composite new types with ECIType.STRUCTURE. However all 'beans' (rich objects) in the system all displayed through a set of CIs,also called the CIS (Configurable Information Set). There are many types already : Each ECIType has mapped widgets, BOOL : checkbox, STRING: Text-Areay and so forth. Type: string Properties: Name Type Default Description BOOL int 0 BOX int 1 COLOUR int 2 ENUMERATION int 3 FILE int 4 FLAGS int 5 FLOAT int 6 INTEGER int 7 MATRIX int 8 OBJECT int 9 REFERENCE int 10 QUATERNION int 11 RECTANGLE int 12 STRING int 13 VECTOR int 14 VECTOR2D int 15 VECTOR4D int 16 ICON int 17 IMAGE int 18 BANNER int 19 LOGO int 20 STRUCTURE int 21 BANNER2 int 22 ICON_SET int 23 SCRIPT int 24 EXPRESSION int 25 RICHTEXT int 26 ARGUMENT int 27 JSON_DATA int 28 EXPRESSION_EDITOR int 29 WIDGET_REFERENCE int 30 DOM_PROPERTIES int 31 BLOCK_REFERENCE int 32 BLOCK_SETTINGS int 33 FILE_EDITOR int 34 END int 35 UNKNOWN int -1 Source: xide/types/Types.js <static> types.EVENTS :string Events of xide.* Type: string Properties: Name Type Default Description SAVE_LAYOUT string layoutSave RESTORE_LAYOUT string layoutRestore When the layout is being restored, See wcDocker.restore ON_FILE_CHANGED string fileChanged ON_FILE_DELETED string fileDeleted ON_NODE_SERVICE_STORE_READY string onNodeServiceStoreReady ON_CREATED_MANAGER string onCreatedManager ON_CI_UPDATE string onCIUpdate ON_CREATED_WIDGET string onWidgetCreated ON_WIDGET_READY string onWidgetReady ON_MAIN_VIEW_READY string onMainViewReady ON_MAIN_MENU_READY string onMainMenuReady ON_MAIN_MENU_OPEN string onMainMenuOpen ON_VIEW_REMOVED string onViewRemoved ON_VIEW_SHOW string onViewShow ON_VIEW_HIDE string onViewHide ON_VIEW_ADDED string onViewAdded ON_ITEM_SELECTED string onItemSelected ON_ITEM_REMOVED string onItemRemoved ON_ITEM_CLOSED string onItemClosed ON_ITEM_ADDED string onItemAdded ON_ITEM_MODIFIED string onItemModified ON_ACTION_CHANGE_CONTEXT string onChangeActionContext ON_ACTION_CONTEXT_CHANGED string onActionContextChanged ON_CONTAINER_ADDED string onContainerAdded ON_CONTAINER_REMOVED string onContainerRemoved ON_REMOVE_CONTAINER string onRemoveContainer ON_CONTAINER_REPLACED string onContainerReplaced ON_CONTAINER_SPLIT string onContainerSplit ON_CLIPBOARD_COPY string onClipboardCopy ON_CLIPBOARD_PASTE string onClipboardPaste ON_CLIPBOARD_CUT string onClipboardCut ON_MODULE_RELOADED string onModuleReloaded Event to notify classes about a reloaded module ON_MODULE_UPDATED string onModuleUpdated RESIZE string onResize ERROR string onError STATUS string onStatus ON_FILE_STORE_READY string onFileStoreReady ON_DID_OPEN_ITEM string onDidOpenItem ON_SHOW_PANEL string onShowPanel IMAGE_LOADED string imageLoaded IMAGE_ERROR string imageError UPLOAD_BEGIN string uploadBegin UPLOAD_PROGRESS string uploadProgress UPLOAD_FINISH string uploadFinish UPLOAD_FAILED string uploadFailed ON_CONTEXT_MENU_OPEN string onContextMenuOpen ON_PLUGIN_LOADED string onPluginLoaded ON_PLUGIN_READY string onPluginReady ALL_PLUGINS_READY string onAllPluginsReady REGISTER_EDITOR string registerEditor REGISTER_ACTION string registerAction SET_ITEM_ACTIONS string onSetItemsActions ON_RENDER_ACTIONS string onRenderActions ON_FILE_CONTENT_CHANGED string onFileContentChanged ON_PANEL_CLOSED string onPanelClosed ON_PANEL_CREATED string onPanelCreated ON_COPY_BEGIN string onCopyBegin ON_COPY_END string onCopyEnd ON_DELETE_BEGIN string onDeleteBegin ON_DELETE_END string onDeleteEnd ON_MOVE_BEGIN string onMoveBegin ON_MOVE_END string onMoveEnd ON_CHANGED_CONTENT string onChangedContent ON_COMPRESS_BEGIN string onCompressBegin ON_COMPRESS_END string onCompressEnd ON_CREATE_EDITOR_BEGIN string onCreateEditorBegin ON_CREATE_EDITOR_END string onCreateEditorEnd ON_EXPRESSION_EDITOR_ADD_FUNCTIONS string onExpressionEditorAddFunctions ON_ACE_READY string onACEReady ON_SERVER_LOG_MESSAGE string onServerLogMessage ON_CLIENT_LOG_MESSAGE string onClientLogMessage ON_DID_RENDER_COLLECTION string onDidRenderCollection ON_COMPONENT_READY string onComponentReady ON_ALL_COMPONENTS_LOADED string onAllComponentsLoaded ON_APP_READY string onAppReady ON_CREATE_STORE string onCreateStore ON_STORE_CREATED string onStoreCreated ON_STORE_CHANGED string onStoreChanged ON_STATUS_MESSAGE string onStatusMessage ON_OPEN_VIEW string onOpenView ON_VIEW_MAXIMIZE_START string onViewMaximizeStart ON_VIEW_MAXIMIZE_END string onViewMaximizeEnd Source: xide/types/Types.js <static> types.ITEM_TYPE :string Stub for registered bean types. This value is needed to let the UI switch between configurations per such type.At the very root is the bean action context which may include more contexts. Type: string Properties: Name Type Default Description FILE string BTFILE Bean type 'file' is handled by the xfile package WIDGET string WIDGET Bean type 'widget' is handled by the xide/ve and davinci package BLOCK string BLOCK Bean type 'block' is handled by the xblox package TEXT string TEXT Bean type 'text' is used for text editors Source: xide/types/Types.js <static> types.MESSAGE_SOURCE Enumeration to define a source type for variable change. Properties: Name Type Default Description DEVICE DEVICE GUI GUI BLOX BLOX CODE CODE Source: xcf/types/Types.js <static> types.PROTOCOL_PROPERTY Keys to define protocol meta properties Properties: Name Type Default Description CF_PROTOCOL_TITLE Title CF_PROTOCOL_ICON CF_PROTOCOL_ICON CF_PROTOCOL_CLASS CF_PROTOCOL_CLASS CF_PROTOCOL_ID CF_PROTOCOL_ID CF_PROTOCOL_COMMANDS CF_PROTOCOL_COMMANDS CF_PROTOCOL_VARIABLES CF_PROTOCOL_VARIABLES CF_PROTOCOL_RESPONSES CF_PROTOCOL_RESPONSES Source: xcf/types/Types.js <inner, constant> MAIN_MENU_KEYS :Integer.<module:xide/types~MAIN_MENU_KEYS> Set of keys in the main menu Type: Integer.<module:xide/types~MAIN_MENU_KEYS> Source: xide/types/Types.js <inner, constant> RESOURCE_VARIABLES :Array.<module:xide/types~RESOURCE_VARIABLES> All client resources are through variables on the server side. Here the minimum variables for an xjs application. Type: Array.<module:xide/types~RESOURCE_VARIABLES> Source: xide/types/Types.js <inner, constant> SERVICE_STATUS :Integer.<module:xide/types~SERVICE_STATUS> Possible Node-JS service status modes. Type: Integer.<module:xide/types~SERVICE_STATUS> Source: xide/types/Types.js <inner, constant> VIEW_SPLIT_MODE :Array.<module:xide/types~ViewSplitMode> Possible split modes for rich editors with preview or live coding views. Type: Array.<module:xide/types~ViewSplitMode> Source: xide/types/Types.js <inner, constant> WIDGET_REFERENCE_MODE :Array.<module:xide/types~WidgetReferenceMode> WIDGET_REFERENCE_MODE enumerates possible modes to resolve a string expressioninto instances. There are a few CI based widgets subclassed from xide/widgets/Referenced.The reference structure consist out of this mode and that expression. Type: Array.<module:xide/types~WidgetReferenceMode> Source: xide/types/Types.js Type Definitions DeviceInfo Type: object Properties: Name Type Description host string The IP address port string The port scope string The scope of the device driverId string The id of the driver protocol string The protocol, ie: tcp, serial,.. id string The device model id title string The title of the device serverSide boolean The driver runs server side only driverOptions module:xide/types~DRIVER_FLAGS The driver flags Source: xide/types/Types.js × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-04-19T01:48:48+02:00 using the DocStrap template. "}}
|
||
</script>
|
||
|
||
<script type="text/javascript">
|
||
$(document).ready(function() {
|
||
Searcher.init();
|
||
});
|
||
|
||
$(window).on("message", function(msg) {
|
||
var msgData = msg.originalEvent.data;
|
||
|
||
if (msgData.msgid != "docstrap.quicksearch.start") {
|
||
return;
|
||
}
|
||
|
||
var results = Searcher.search(msgData.searchTerms);
|
||
|
||
window.parent.postMessage({"results": results, "msgid": "docstrap.quicksearch.done"}, "*");
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|