Events
AOE exposes browser events that can be bound using APEX dynamic actions. AOE's events are triggered on the DOM node with the class attribute set to uc-aoe--widget.
AOE After Save As
The event ucaoeafteractionsaveas is triggered when the AOE REST handler finishes saving a document as a new file. Saving a document as a new file result can be distinguished by this.data.success property.
The event is triggered along with this.data described in the table below.
| Property | Type | Description |
|---|---|---|
| this.data.success | Boolean | When it is set to true the update was successful. When it is set to false a document wasn't updated. |
| this.data.document | JSON | JSON object containing a loaded document meta-data returned by the plug-in REST handler |
| this.data.document.lastUpdate | String | The date of a document's last update time in the format YYYY-MM-DD HH24:MI:SS |
| this.data.document.size | Number | A document size in bytes |
| this.data.document.filename | String | A document current filename |
| this.data.document.version | Number | A document current version |
| this.data.document.pksColumns | String | The column(s) name(s) defined as primary key(s). For the default table it is always ID. For a custom table, it is the value defined in region attribute Primary Key(s) Column(s). For custom PL/SQL it is always null. |
| this.data.document.pksValues | String | The current value(s) of primary key(s) stored in APEX Session State for item(s) defined in the plug-in region attribute Item(s) Containing Primary Key(s) Value(s). |
AOE After Update
The event ucaoeafteractionsave is triggered when the AOE REST handler finishes processing an update. Update results can be distinguished by the this.data.success property.
The event is triggered along with this.data described in the table below.
| Property | Type | Description |
|---|---|---|
| this.data.success | Boolean | When it is set to true the update was successful. When it is set to false a document wasn't updated. |
| this.data.document | JSON | JSON object containing a loaded document meta-data returned by the plug-in REST handler |
| this.data.document.lastUpdate | String | The date of a document's last update time in the format YYYY-MM-DD HH24:MI:SS |
| this.data.document.size | Number | A document size in bytes |
| this.data.document.filename | String | A document current filename |
| this.data.document.version | Number | A document current version |
| this.data.document.pksColumns | String | The column(s) name(s) defined as primary key(s). For the default table, it is always ID. For a custom table it is the value defined in region attribute Primary Key(s) Column(s). For custom PL/SQL it is always null. |
| this.data.document.pksValues | String | The current value(s) of primary key(s) stored in APEX Session State for item(s) defined in the plug-in region attribute Item(s) Containing Primary Key(s) Value(s). |
AOE After Rename
The event ucaoeafteractionrename is triggered when the AOE REST handler finishes renaming a document. Update results can be distinguished by this.data.success property.
The event is triggered along with this.data described in the table below.
| Property | Type | Description |
|---|---|---|
| this.data.success | Boolean | When it is set to true the update was successful. When it is set to false a document wasn't updated. |
| this.data.document | JSON | JSON object containing a loaded document meta-data returned by the plug-in REST handler |
| this.data.document.lastUpdate | String | The date of a document's last update time in the format YYYY-MM-DD HH24:MI:SS |
| this.data.document.size | Number | A document size in bytes |
| this.data.document.filename | String | A document current filename |
| this.data.document.version | Number | A document current version |
| this.data.document.pksColumns | String | The column(s) name(s) defined as primary key(s). For the default table it is always ID. For a custom table it is the value defined in region attribute Primary Key(s) Column(s). For custom PL/SQL it is always null. |
| this.data.document.pksValues | String | The current value(s) of primary key(s) stored in APEX Session State for item(s) defined in the plug-in region attribute Item(s) Containing Primary Key(s) Value(s). |
AOE Before Save As
The event ucaoebeforeactionsaveas is triggered when the end-user updates a document.
The event doesn't provide any data - this.data is set to undefined.
AOE Before Update
The event ucaoebeforeactionsave is triggered when the end-user updates a document.
The event doesn't provide any data - this.data is set to undefined.
AOE Document Closed
The event ucaoeadocumentclosed is triggered when a document is closed by the end-user.
The event doesn't provide any data - this.data is set to undefined.
AOE Document Loaded
The event ucaoedocumentloaded is triggered every time a document is successfully loaded into AOE.
The event is triggered along with the data described in the table below.
| Property | Type | Description |
|---|---|---|
| this.data.document | JSON | JSON object containing a loaded document meta-data returned by the plug-in REST handler |
| this.data.document.lastUpdate | String | The date of a document's last update time in the format YYYY-MM-DD HH24:MI:SS |
| this.data.document.size | Number | A document size in bytes |
| this.data.document.filename | String | A document current filename |
| this.data.document.version | Number | A document current version |
| this.data.document.pksColumns | String | The column(s) name(s) defined as primary key(s). For the default table it is always ID. For a custom table, it is the value defined in region attribute Primary Key(s) Column(s). For custom PL/SQL, it is always null. |
| this.data.document.pksValues | String | The current value(s) of primary key(s) stored in APEX Session State for item(s) defined in the plug-in region attribute Item(s) Containing Primary Key(s) Value(s). |
AOE Initialized (Editor)
The event ucaoeinitialized is triggered when the AOE editor is fully loaded with the requested document.
The event doesn't provide any data - this.data is set to undefined.
AOE Initialized (Widget)
The event ucaoewidgetinit is triggered when the plug-in jQuery widget is fully loaded.
The event doesn't provide any data - this.data is set to undefined.