|
Object: sapphire.cc |
Description
LabVantage API for JavaScript code completion.
File
WEB-CORE\scripts\sapphirecc.js
Properties
| Property | Type | Description |
| visible | Boolean | Determines whether the code completion element is visible or not. |
| insertPoint | Integer | Text insert point. |
| element | Object | Text element on which code competition is active. |
| searchString | String | Text entry string. |
| editor | Object | Editor dialog object. |
show |
Functionality
Shows the code completion object.
Parameters
| Parameter | Type | Description |
| IaPoint | Integer Array | X and Y coordinate. |
| oElement | Object | Text element on which the object is used. |
Returns
None.
render |
Functionality
Renders the code completion object.
Parameters
| Parameter | Type | Description |
| oDiv | String | DIV tag in which to render the object. |
| sSearchString | String | Search string to use. |
Returns
None.
selectClick |
Functionality
Used for a click event.
Parameters
None.
Returns
None.
selectDblClick |
Functionality
Used for a double-click event.
Parameters
None.
Returns
None.
close |
Functionality
Closes the code completion object.
Parameters
None.
Returns
None.
textEntry |
Functionality
Enters text into the specified text element.
Parameters
| Parameter | Type | Description |
| oElement | Object | Text element. |
| iKeyCode | Integer | Key code for the entered character. |
| sChar | String | Entered character. |
Returns
None.
keyDown |
Functionality
Used for a key down event.
Parameters
None.
Returns
None.
keyPress |
Functionality
Used for a key press event.
Parameters
None.
Returns
None.
getGlobalObjects |
Functionality
Gets an object array of global JavaScript objects that exist in the current page.
Parameters
None.
Returns
Object Array.
getDateMembers |
Functionality
Gets an object array of JavaScript objects that exist in the Date object.
Parameters
None.
Returns
Object Array.
getMathMembers |
Functionality
Gets an object array of JavaScript objects that exist in the Math object.
Parameters
None.
Returns
Object Array.
getArrayMembers |
Functionality
Gets an object array of JavaScript objects that exist in the Array object.
Parameters
None.
Returns
Object Array.
getStringMembers |
Functionality
Gets an object array of JavaScript objects that exist in the String object.
Parameters
None.
Returns
Object Array.
getScreenMembers |
Functionality
Gets an object array of JavaScript objects that exist in the Screen object.
Parameters
None.
Returns
Object Array.
getDocumentMembers |
Functionality
Gets an object array of JavaScript objects that exist in the Document object.
Parameters
None.
Returns
Object Array.
getWindowMembers |
Functionality
Gets an object array of JavaScript objects that exist in the current Window object.
Parameters
None.
Returns
Object Array.
getElementMembers |
Functionality
Gets an object array of JavaScript objects that exist in the specified HTML element object.
Parameters
| Parameter | Type | Description |
| oElement | Object | HTML element object. |
Returns
Object Array.
selectSelected |
Functionality
Selects the selected code completion item.
Parameters
None.
Returns
None.
moveSelectionDown |
Functionality
Moves the selected item down in the code completion object.
Parameters
None.
Returns
None.
moveSelectionUp |
Functionality
Moves the selected item up in the code completion object.
Parameters
None.
Returns
None.
closeEditor |
Functionality
Closes the editor dialog.
Parameters
| Parameter | Type | Description |
| oFrame | Object | Frame from which to call close methods. |
| sFieldName | String | Name of the field in which the value result is placed. |
Returns
None.
closeEditorCallback |
Functionality
Callback method for closeEditor.
Parameters
| Parameter | Type | Description |
| oDialog | Object | Dialog object. |
| lResult | Boolean | Confirm dialog result. |
Returns
None.
okEditor |
Functionality
Operates the OK button on the editor dialog.
Parameters
| Parameter | Type | Description |
| oFrame | Object | Frame from which to call ok methods. |
| sFieldName | String | Name of the field in whcih the value result is placed. |
Returns
None.
openEditor |
Functionality
Opens the JS editor with code completion. Can also be used as a script editor.
Parameters
| Parameter | Type | Description |
| sFieldName | String | Name of the field in which the value result is placed. |
| lFormat | Boolean | Set to true (default) to format the entered script. Set to false to not format the string. |
| stitle | String | title for the editor. |
| lRemoveGroovy | Boolean | Set to true to remove the Groovy expression syntax around the string. Set to false (default) to leave the string alone. |
Returns
None.