Custom attributes
Application
The plug-in exposes four application attributes with a standard configuration for all the plug-in instances across all pages. These attributes define URLs to RESTful services handling images (browsing, uploading, and deleting).
Application attributes can be overridden at the item level in the page designer. See component attribute Settings \ Override Application Attributes
Image Upload URL
Type | Required | Dependent on |
---|---|---|
Text | Yes | None |
The given URL has to reference the RESTful service module handler uploading images.
The default value #DEFAULT_REST_URL_UPLOAD#
is replaced with the URL generated by the plug-in to the sample REST module ucfroalasamplerest and REST module template upload. The URL is generated differently depending on an application attribute Friendly URLs.
When friendly URLs enabled
The URL is generated from {X-APEX-BASE}{DEFAULT_REST_MODULE}/{DEFAULT_UPLOAD_TEMPLATE}
where:
{X-APEX-BASE}
- the result ofowa_util.get_cgi_env('X-APEX-BASE')
{DEFAULT_REST_MODULE}
- the sample REST module ucfroalasamplerest{DEFAULT_UPLOAD_TEMPLATE}
- the sample REST module template upload
When friendly URLs are disabled
The URL is generated from {HOST}{ORDS_ALIAS}/{DEFAULT_REST_MODULE}/{DEFAULT_UPLOAD_TEMPLATE}
where:
{HOST}
- the result ofapex_util.host_url('SCRIPT');
{ORDS_ALIAS}
- the result ofselect nvl(pattern, lower(parsing_schema)) as ords_alias from user_ords_schemas;
{DEFAULT_REST_MODULE}
- the sample REST module named ucfroalasamplerest{DEFAULT_UPLOAD_TEMPLATE}
- the sample REST module template named upload
You can also use #DEFAULT_REST_URL_MODULE#
to return the REST URL to the sample REST module, which must be followed with the template name.
Examples:
#DEFAULT_REST_URL_UPLOAD#
#DEFAULT_REST_URL_MODULE#upload
http://www.apexrnd.be/ords192/bostrowski/ucfroalasamplerest/upload
Image Browse URL
Type | Required | Dependent on |
---|---|---|
Text | Yes | None |
The given URL has to reference RESTful service module handler browsing images.
The default value #DEFAULT_REST_URL_BROWSE#
is replaced with the URL generated by the plug-in to the sample REST module ucfroalasamplerest and the handler template browse. The URL is generated differently depending on an application attribute Friendly URLs.
When friendly URLs enabled
The URL is generated from {X-APEX-BASE}{DEFAULT_REST_MODULE}/{DEFAULT_BROWSE_TEMPLATE}
where:
{X-APEX-BASE}
- the result ofowa_util.get_cgi_env('X-APEX-BASE')
{DEFAULT_REST_MODULE}
- the sample REST module ucfroalasamplerest{DEFAULT_BROWSE_TEMPLATE}
- the sample REST module template browse
When friendly URLs are disabled
The URL is generated from {HOST}{ORDS_ALIAS}/{DEFAULT_REST_MODULE}/{DEFAULT_BROWSE_TEMPLATE}
where:
{HOST}
- the result ofapex_util.host_url('SCRIPT');
{ORDS_ALIAS}
- the result ofselect nvl(pattern, lower(parsing_schema)) as ords_alias from user_ords_schemas;
{DEFAULT_REST_MODULE}
- the sample REST module ucfroalasamplerest{DEFAULT_BROWSE_TEMPLATE}
- the sample REST module template browse
You can also use #DEFAULT_REST_URL_MODULE#
to return the REST URL to the sample REST module, which must be followed with the template name.
Examples:
#DEFAULT_REST_URL_BROWSE#
#DEFAULT_REST_URL_MODULE#browse
http://www.apexrnd.be/ords192/bostrowski/ucfroalasamplerest/browse
Image Delete URL
Type | Required | Dependent on |
---|---|---|
Text | Yes | None |
The given URL has to reference the RESTful service module handler deleting images.
The default value #DEFAULT_REST_URL_DELETE#
is replaced with the URL generated by the plug-in to the sample REST module ucfroalasamplerest
and template delete
. The URL is generated differently depending on an application attribute Friendly URLs.
When friendly URLs enabled
The URL is generated from {X-APEX-BASE}{DEFAULT_REST_MODULE}/{DEFAULT_DELETE_TEMPLATE}
where:
{X-APEX-BASE}
- the result ofowa_util.get_cgi_env('X-APEX-BASE')
{DEFAULT_REST_MODULE}
- the sample REST module ucfroalasamplerest{DEFAULT_DELETE_TEMPLATE}
- the sample REST module template delete
When friendly URLs are disabled
The URL is generated from {HOST}{ORDS_ALIAS}/{DEFAULT_REST_MODULE}/{DEFAULT_DELETE_TEMPLATE}
where:
{HOST}
- the result ofapex_util.host_url('SCRIPT');
{ORDS_ALIAS}
- the result ofselect nvl(pattern, lower(parsing_schema)) as ords_alias from user_ords_schemas;
{DEFAULT_REST_MODULE}
- the sample REST module ucfroalasamplerest{DEFAULT_DELETE_TEMPLATE}
- the sample REST module template delete
You can also use #DEFAULT_REST_URL_MODULE#
to return the REST URL to the sample REST module, which must be followed with the template name.
Examples:
#DEFAULT_REST_URL_DELETE#
#DEFAULT_REST_URL_MODULE#delete
http://www.apexrnd.be/ords192/bostrowski/ucfroalasamplerest/delete
Image GET URL
Type | Required | Dependent on |
---|---|---|
Text | Yes | None |
The given URL has to reference the RESTful service module handler fetching images.
The default value #DEFAULT_REST_URL_GET#
is replaced with the URL generated by the plug-in to the sample REST module ucfroalasamplerest
and template get
. The URL is generated differently depending on an application attribute Friendly URLs.
When friendly URLs enabled
The URL is generated from {X-APEX-BASE}{DEFAULT_REST_MODULE}/{DEFAULT_GET_TEMPLATE}
where:
{X-APEX-BASE}
- the result ofowa_util.get_cgi_env('X-APEX-BASE')
{DEFAULT_REST_MODULE}
- the sample REST module ucfroalasamplerest{DEFAULT_GET_TEMPLATE}
- the sample REST module template get
When friendly URLs are disabled
The URL is generated from {HOST}{ORDS_ALIAS}/{DEFAULT_REST_MODULE}/{DEFAULT_GET_TEMPLATE}
where:
{HOST}
- the result ofapex_util.host_url('SCRIPT');
{ORDS_ALIAS}
- the result ofselect nvl(pattern, lower(parsing_schema)) as ords_alias from user_ords_schemas;
{DEFAULT_REST_MODULE}
- the sample REST module ucfroalasamplerest{DEFAULT_GET_TEMPLATE}
- the sample REST module template get
You can also use #DEFAULT_REST_URL_MODULE#
to return the REST URL to the sample REST module, which must be followed with the template name.
Examples:
#DEFAULT_REST_URL_GET#
#DEFAULT_REST_URL_MODULE#get/
http://www.apexrnd.be/ords192/bostrowski/ucfroalasamplerest/get/
Initialization PL/SQL Code
Type | Required | Dependent on |
---|---|---|
PL/SQL Code | No | None |
The given PL/SQL code is evaluated when the plug-in instance is rendered by Oracle APEX engine. The plug-in package UC_FROALA_RTE variables can be used to enable third-party integrations and configure the instance.
Learn more about plug-in variables in documentation Item Plug-in \ Database objects \ UC_FROALA_RTE.
Component
The plug-in exposes the following component attributes at the item level in the APEX page designer.
Settings
Type | Required | Dependent on |
---|---|---|
Checkbox | No | None |
The available options are the following:
- Enable Browser Built-in Spell Check
- Enable Sticky Toolbar
- Expand height to fit rich text
- Override Application Attributes
- Validate CLOB Checksum on Page Submit
Enable Browser Built-in Spell Check
Based on the checkbox state, a built-in browser spell check is enabled or disabled.
State | Result |
---|---|
Checked | A browser built-in spell check is enabled |
Not checked | A browser built-in spell check is disabled |
Enable Sticky Toolbar
Based on the checkbox state, the plug-in editor toolbar is sticky while scrolling a page. A top offset of the toolbar can be set using the plug-in item attribute Toolbar Top Offset.
State | Result |
---|---|
Checked | The Froala editor toolbar is frozen when the end-user scrolls a page. |
Not checked | The Froala editor toolbar's top position is not affected when the end user scrolls the page. |
Expand height to fit rich text
Based on the checkbox state, the editor expand it's height to fit rich text.
State | Result |
---|---|
Checked | The Froala editor height expands along with rich text |
Not checked | The Froala height is fixed based on the height attribute. |
Override Application Attributes
Based on the checkbox state, the plug-in uses an application scope attributes values or allows a developer to specify new values on an item level.
State | Result |
---|---|
Checked | A developer has to specify a new URL(s) to RESTful service handlers. |
Not checked | An application scope attribute values are used. |
The following application attributes can be overridden:
- Image Upload URL,
- Image Browse URL,
- Image Delete URL
- Image GET URL
Validate CLOB Checksum on Page Submit
Based on the checkbox state, the plug-in performs the built-in plug-in validation on the CLOB
contents each time a page is submitted. Additionally, you can specify on which page-submit requests the plug-in performs built-in checksum validation. See the documentation for Validation Request(s) attribute.
State | Result |
---|---|
Checked | The plug-in performs built-in validation on the CLOB each time the page is submitted. |
Not checked | The plug-in doesn't perform built-in validation on the CLOB . |
Learm more about CLOB checksum validation in Item Plug-in \ Oracle APEX integration \ Validation.
Validation Request(s)
Type | Required | Dependent on |
---|---|---|
Text | No | Settings / Validate CLOB Checksum On Page Submit |
Use this attribute to restrict the built-in plug-in validation to the given comma-separated list of page submit requests. Leaving this attribute blank will execute built-in validation on each page submission.
When left empty, the plug-in performs validation on each page-submit request.
Toolbar
Type | Required | Dependent on |
---|---|---|
Select list | Yes | None |
The attribute defines what toolbar preset is applied to the Froala editor.
The available options are:
- Basic
- Intermediate
- Full
About the toolbar
The plug-in implements the toolbar buttons using the Froala toolbar groups: Paragraph, Text, Rich, and Misc. Each group contains a set of Froala buttons. The number of buttons varies depending on the selected toolbar preset: Basic, Intermediate, or Full.
The plug-in allows easy toolbar customization through:
- APEX item attributes \ Advanced \ JavaScript Initialization Code
- dynamic action \ the supporting plug-in
The tables below describe the buttons available in the specific group and selected toolbar preset.
Paragraph
The group Paragraph presents the following buttons for each toolbar preset.
Button ID | Basic | Intermediate | Full |
---|---|---|---|
paragraphFormat | |||
fontFamily | |||
fontSize | |||
formatOL | |||
formatUL | |||
align | |||
lineHeight | |||
outdent | |||
indent | |||
quote |
Text
The group Text presents the following buttons for each toolbar preset.
Button ID | Basic | Intermediate | Full |
---|---|---|---|
bold | |||
strikeThrough | |||
clearFormatting | |||
textColor | |||
backgroundColor | |||
underline | |||
italic | |||
superscript | |||
subscript | |||
inlineClass | |||
inlineStyle |
Rich
The group Rich presents the following buttons for each toolbar preset.
Button ID | Basic | Intermediate | Full |
---|---|---|---|
insertLink | |||
insertImage | |||
insertTable | |||
insertHR | |||
specialCharacters | |||
fontAwesome | |||
emoticons | |||
insertVideo |
Misc
The group Misc presents the following buttons for each toolbar preset.
Button | Basic | Intermediate | Full |
---|---|---|---|
undo | |||
fullscreen | |||
redo | |||
getPDF | |||
selectAll | |||
html |
Toolbar customization
Use the supporting dynamic action plug-in United Codes Rich Text Editor Pro (Extend) to customize the toolbar using dynamic actions defined on the Oracle APEX global page.
The toolbar can also be customized using the plug-in attribute JavaScript Initialization Code and the Froala option toolbarButtons.
Toolbar Top Offset
Type | Required | Dependent on |
---|---|---|
Number | Yes | Settings \ Enable Sticky Toolbar |
When the Froala Toolbar is set to be sticky, the toolbar top offset can be set using this attribute.
The default value is 48px
, which is the default height of the Universal Theme header bar in the page template.
Height
Type | Required | Dependent on |
---|---|---|
Number | No | Settings \ Enable Sticky Toolbar |
This attribute allows you to set the height (in pixels) of the editor. The given value is used to set the height property. Keep in mind that the height doesn't include the toolbar and the footer of the editor - it is only applied to the working area.
Upload Image(s) on Request(s)
Type | Required | Dependent on |
---|---|---|
Text | No | None |
The attribute accepts comma-separated page-submit requests.
When specified, the plug-in uploads images only for the given requests. Otherwise, images remain in CLOB
content as they were embedded and are not uploaded using plug-in REST on page submission.
Image Upload URL
Type | Required | Dependent on |
---|---|---|
Text | No | Settings \ Override Application Attributes |
Attribute value overrides the application scope of the plug-in settings for the selected item.
To learn more, read the description for the attribute in the section Application above.
Image Browse URL
Type | Required | Dependent on |
---|---|---|
Text | No | Settings \ Override Application Attributes |
Attribute value overrides the application scope of the plug-in settings for the selected item.
To learn more, read the description for the attribute in the section Application above.
Image Delete URL
Type | Required | Dependent on |
---|---|---|
Text | No | Settings \ Override Application Attributes |
Attribute value overrides the application scope of the plug-in settings for the selected item.
To learn more, read the description for the attribute in the section Application above.
Image GET URL
Type | Required | Dependent on |
---|---|---|
Text | No | Settings \ Override Application Attributes |
Attribute value overrides the application scope of the plug-in settings for the selected item.
To learn more, read the description for the attribute in the section Application above.
Initialization PL/SQL Code
Type | Required | Dependent on |
---|---|---|
PL/SQL Code | No | None |
The given PL/SQL code is evaluated when the plug-in instance is rendered by Oracle APEX overriding initialization PL/SQL code defined on application level using component settings. The plug-in package UC_FROALA_RTE variables can be used to enable third-party integrations and configure the instance.
Learn more about plug-in variables in documentation Item Plug-in \ Database objects \ UC_FROALA_RTE.