- Source:
- API-4.1.js, line 10
Methods
eventshandler()
Events handler object.
- Source:
- API-4.1.js, line 1321
registerBrowserVisible(callback)
Create an event listener on the browser visible state.
The callback will get two boolean parameter :
- pVisible : The visible state of the browser.
- pNewDocument : If the document is a new one since the last call of the callback.
The button showing the Web Panel when clicked will internally set the visible state to false before true.
Beware, due to the loading state of the browser at the moment of the callback avoid using alert in the callback.
As the browser persist on document close this event is not unregistered when calling unregisterEventsHandler.
Only one callback can be registered on this event at a time.
Parameters:
Name | Type | Description |
---|---|---|
callback |
function | Javascript function called when a new document is open. |
- Source:
- API-4.1.js, line 1218
registerDataColumnChange(callback, dataTableName)
Create an event listener for managing data column collection of a given data table.
The callback will get three parameter :
- The first one defining the event occuring would be a string in :
- "add" : When a new data table is added to the document.
- "rename" : When a data table is renamed.
- "remove" : When a data table is removed from the document.
- The second parameter will be the current name of the data table.
- The third parameter will be an array containing the list of the column in the data table.
As for every event registering method it is best to call unregisterEventsHandler on unload or at the start of the next page to avoid call to discarded javascript function.
Parameters:
Name | Type | Description |
---|---|---|
callback |
function | Javascript function called when a modification happens on the document. |
dataTableName |
string | Data table name to listen. |
- Source:
- API-4.1.js, line 1276
registerDataTableChange(callback)
Create an event listener for managing data table collection.
The callback will get two parameter :
- The first one defining the event occuring would be a string in :
- "add" : When a new data table is added to the document.
- "rename" : When a data table is renamed.
- "remove" : When a data table is removed from the document.
- The second parameter will be an array containing the list of the data table currently in the document.
As for every event registering method it is best to call unregisterEventsHandler on unload or at the start of the next page to avoid call to discarded javascript function.
Parameters:
Name | Type | Description |
---|---|---|
callback |
function | Javascript function called when a modification happens on the document. |
- Source:
- API-4.1.js, line 1246
registerEventsHandler2(eventshandler, datatable, marking, getdata)
Creates an event listener for managing markings and highlighting.
As for every event registering method it is best to call unregisterEventsHandler on unload or at the start of the next page to avoid call to discarded javascript function.
Parameters:
Name | Type | Description |
---|---|---|
eventshandler |
string | Instance ID for the eventshandler object. |
datatable |
string | The datatable name to handle. Can be null. |
marking |
string | The marking name to handle. Can be null. |
getdata |
boolean | Get data when the registered listener is handled. |
- Source:
- API-4.1.js, line 1301
unregisterEventHandler(datatable, marking)
Removes specific event listener.
Parameters:
Name | Type | Description |
---|---|---|
datatable |
string | The datatable name to unregister the event from. Can be null. |
marking |
string | The marking name to unregister the event from. Can be null. |
- Source:
- API-4.1.js, line 1345
unregisterEventHandler(datatable)
Removes listener on the data table (only work on column listener at the moment).
Parameters:
Name | Type | Description |
---|---|---|
datatable |
string | The datatable name to unregister the event from. Cannot be null. |
- Source:
- API-4.1.js, line 1360
unregisterEventsHandler()
Kills event listener process.
- Source:
- API-4.1.js, line 1374