Packages (OLD)
Packages
Section titled “Packages”UC_FROALA_RTE
Section titled “UC_FROALA_RTE”The package implements an item-type plug-in interfaces to integrate with Oracle APEX. The package exposes serveral PL/SQL API and package variables allowing configuring the plug-in instances on application and page level.
Constants
Section titled “Constants”The package exposes the following constants:
| Constant | Type | Default |
|---|---|---|
| c_toolbar_group_paragraph | VARCHAR2(9) | PARAGRAPHT |
| c_toolbar_group_text | VARCHAR2(4) | TEXT |
| c_toolbar_group_rich | VARCHAR2(4) | RICH |
| c_toolbar_group_misc | VARCHAR2(4) | MISC |
| c_coll_name | VARCHAR2(9) | UC_FROALA |
| c_clob_type_draft | VARCHAR2(5) | DRAFT |
| c_clob_type_onload | VARCHAR2(6) | ONLOAD |
Variables
Section titled “Variables”The package variables can be defined in the plug-in attribute Initialization PL/SQL code. Use the attribute to configure the plug-in features, and the third-party integrations.
-
Configuration
-
Track Changes plug-in
-
Wiris Math Type plug-in
-
WProofReader Web Spellcheck
-
Codox.io
g_disable_rest_enabled_check
Section titled “g_disable_rest_enabled_check”| Type | Default |
|---|---|
BOOLEAN | false |
When true, the plug-in don’t check if a schema is REST enabled.
g_css_style_multilevel_list
Section titled “g_css_style_multilevel_list”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | Boolean | false |
When set to true the experimental CSS rules are added to a page in order to display multi-level number list preserving parent number as prefix.
g_update_include_rowcount
Section titled “g_update_include_rowcount”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | Boolean | false |
When set to true the supporting process plug-in adds automatically UC_FROALA_RTE.g_froala_sqlrowcount for updating CLOB using PL/SQL Code.
g_toolbar_presets_refined
Section titled “g_toolbar_presets_refined”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | Boolean | true |
When set to true the refined toolbar layout is used. To use toolbar layout prior the plug-in 23.2, set this variable to false in the plug-in component settings.
g_warn_about_clob
Section titled “g_warn_about_clob”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | Boolean | false |
When set to true the plug-in checks page item configuration and display error message if page item is not CLOB-enabled. A page item is CLOB-enabled when APEX version is at least 22.2 and page item attribute Session / Data Type is set to CLOB.
g_plug_trackchanges_enable
Section titled “g_plug_trackchanges_enable”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | Boolean | false |
When set to true the third-party plug-in is enabled.
g_plug_trackchanges_group
Section titled “g_plug_trackchanges_group”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | UC_FROALA_RTE.c_toolbar_group_paragraph |
The plug-in button is added to the given group. Use the plug-in constants to reference editor toolbar groups:
UC_FROALA_RTE.c_toolbar_group_paragraphUC_FROALA_RTE.c_toolbar_group_textUC_FROALA_RTE.c_toolbar_group_richUC_FROALA_RTE.c_toolbar_group_misc
g_plug_trackchanges_pos
Section titled “g_plug_trackchanges_pos”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | INTEGER | 1 |
The button position in given group.
g_plug_tui_enable
Section titled “g_plug_tui_enable”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | Boolean | true |
When set to true the third-party plug-in is enabled.
g_plug_wiris_enable
Section titled “g_plug_wiris_enable”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | Boolean | false |
g_plug_wiris_js
Section titled “g_plug_wiris_js”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | NULL |
URL to Math Type JavaScript file.
g_plug_wiris_editor_group
Section titled “g_plug_wiris_editor_group”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | UC_FROALA_RTE.c_toolbar_group_paragraph |
Math Type button opening Math Formulas editor is added to the given group. Use the plug-in constants to reference editor toolbar groups:
UC_FROALA_RTE.c_toolbar_group_paragraphUC_FROALA_RTE.c_toolbar_group_textUC_FROALA_RTE.c_toolbar_group_richUC_FROALA_RTE.c_toolbar_group_misc
g_plug_wiris_editor_pos
Section titled “g_plug_wiris_editor_pos”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | Integer | 1 |
The button position in given group.
g_plug_wiris_chemistry_group
Section titled “g_plug_wiris_chemistry_group”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | UC_FROALA_RTE.c_toolbar_group_paragraph |
Defines in which rich text editor toolbar group, the Wiris Math Type Chemistry Formula editor is available to the end-user.
Use the plug-in constants to reference editor toolbar groups:
UC_FROALA_RTE.c_toolbar_group_paragraphUC_FROALA_RTE.c_toolbar_group_textUC_FROALA_RTE.c_toolbar_group_richUC_FROALA_RTE.c_toolbar_group_misc
g_plug_wiris_chemistry_pos
Section titled “g_plug_wiris_chemistry_pos”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | INTEGER | 1 |
Math Type Wiris button chemistry formula editor position in the rich text editor group defined using g_plug_wiris_chemistry_group.
g_plug_spellcheck_enable
Section titled “g_plug_spellcheck_enable”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | BOOLEAN | false |
When set to true the third-party plug-in is enabled
g_plug_spellcheck_js
Section titled “g_plug_spellcheck_js”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | NULL |
URL to WProofreader Text Checker JavaScript file
g_plug_spellcheck_api
Section titled “g_plug_spellcheck_api”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | NULL |
Valid license key.
g_plug_spellcheck_lang
Section titled “g_plug_spellcheck_lang”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | en_US |
Default language to be checked.
g_plug_spellcheck_ui_lang
Section titled “g_plug_spellcheck_ui_lang”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | en |
Default UI language.
g_plug_spellcheck_theme
Section titled “g_plug_spellcheck_theme”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | gray |
The WProofreader Text Checker theme.
g_plug_spellcheck_badge_enable
Section titled “g_plug_spellcheck_badge_enable”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | BOOLEAN | true |
When set to true the badge let users open the WProofreader settings directly from the rich text editor.
g_plug_spellcheck_badge_lang
Section titled “g_plug_spellcheck_badge_lang”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | BOOLEAN | true |
When set to true the badge let users change language in badge menu.
g_plug_codox_enable
Section titled “g_plug_codox_enable”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | BOOLEAN | false |
When set to true the third-party plug-in is enabled.
g_plug_codox_js
Section titled “g_plug_codox_js”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | NULL |
URL to CODOX.io JavaScript file.
g_plug_codox_css
Section titled “g_plug_codox_css”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | NULL |
URL to CODOX.io CSS file.
g_plug_codox_api
Section titled “g_plug_codox_api”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | NULL |
Valid license key.
g_plug_codox_username
Section titled “g_plug_codox_username”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | NULL |
The current username.
Section titled “The current username.”g_plug_codox_document_id
Section titled “g_plug_codox_document_id”| Package | Type | Default |
|---|---|---|
| UC_FROALA_RTE | VARCHAR2 | NULL |
The unique rich text document ID used to handle collaboration.
PL/SQL API
Section titled “PL/SQL API”See the documentation for all available functions and procedures.
UC_FROALA_SETTINGS
Section titled “UC_FROALA_SETTINGS”The package is used to configure the plug-in access token salt.
Variables
Section titled “Variables”g_froala_access_token
Section titled “g_froala_access_token”| Type | Default |
|---|---|
VARCHAR2(64) | '17273F940549E5B88416BEFDBF9C4BD4CC0E1F98283BA89B4907F6777B853F56' |
The variable is used as an salt for encrypting the plug-in access token.
g_disable_rest_enabled_check
Section titled “g_disable_rest_enabled_check”| Type | Default |
|---|---|
BOOLEAN | false |
When true, the plug-in don’t check if a schema is REST enabled.
g_update_include_rowcount
Section titled “g_update_include_rowcount”| Type | Default |
|---|---|
BOOLEAN | false |
When true, the supporting process plug-in Update (PL/SQL Code) includes plug-in check using UC_FROALA_RTE.g_froala_sqlrowcount after a developer specified PL/SQL code. When false a developer has to include the plug-in variable in the custom PL/SQL code in order to let the plug-in know how many rows in the database were affected by a developer’s PL/SQL code.
UC_FROALA_SAMPLE_REST
Section titled “UC_FROALA_SAMPLE_REST”The package is used by the RESTful service module to handle images.
UC_FROALA_SAMPLE_APP
Section titled “UC_FROALA_SAMPLE_APP”The package is used by the plug-in sample application.
UC_CRYPTO
Section titled “UC_CRYPTO”The package is used to secure the access token.
UC_PLUGINSPRO
Section titled “UC_PLUGINSPRO”The package is used to evaluate the plug-in license.