Standard attributes

The plug-in implements the following standard page item APEX plug-in attributes:

Is a Visible Widget
Standard Form Element
Has Element Attributes
Has Placeholder Attribute
Session State Changeable
Has Source Attributes
Has “Initialization JavaScript Code” Attribute
Has Read Only Attribute

Advanced

The tables below present Oracle APEX item attributes supported by the plug-in.

Attribute	Supported
CSS Classes	:heavy_check_mark:
Custom Attributes	:heavy_check_mark:
Pre Text	:heavy_check_mark:
Post Text	:heavy_check_mark:
Warn on Unsaved Changes	:heavy_check_mark:
JavaScript Initialization Code	:heavy_check_mark:

CSS Classes

The given classes are applied to the plug-in text area on which the editor is initialized.

Custom Attributes

The given attributes are applied to the plug-in text area on which the editor is initialized.

Pre Text

The given HTML is displayed above the rich text editor.

Post Text

The given HTML is displayed below the rich text editor.

Warn on Unsaved Changes

When enabled, the plug-in checks if the rich text document has changed before unloading a page. The attribute is also supported on a page level.

Initialization JavaScript Code

The attribute must define anonymous JavaScript function returning JSON object configuring the editor. The anonymous function accepts only one parameter pOptions. The parameter is JSON object containing default options. The function must return modified options used to initialize the editor.

Syntax

function( pOptions ) {
  return pOptions;
}

Example

The example code below overrides default plug-in validation for image upload allowing only JPG images below 30KB.

function( pOptions ) {
  pOptions.imageAllowedTypes = ["jpeg","jpg"];
  pOptions.imageMaxSize = 1024*30;
  return pOptions;
}

:::tip JavaScript options

The plug-in customization guidelines covers some of options that can be customized using this dynamic action. The full list of JavaScript options can be found in Froala API documentation.

:::

Appearance

The table below describes what appearance attributes are supported by the plug-in.

Attribute	Supported
Template	:warning:
Template Options	:warning:
CSS Classes	:heavy_check_mark:
Format Mask	:x:
Value Placeholder	:heavy_check_mark:

Template

The plug-in supports all native item templates (except the Floating template).

Template Options

All template options are supported except:

Common / Stretch Form Item
Common / Size

CSS Classes

Supported by Oracle APEX native theme template for page items.

Format Mask

Not applicable to the plug-in.

Value Placeholder

The given value is used displayed in the editor working area when empty.

:::tip dynamic action supported

The value can be also set using dynamic action Placeholder Text.

:::

Validation

A standard page item validation Value Required is supported.

The plug-in supports HTML5 validation on page submission. If a document is empty, the validation result is presented to the end user, and the page submission is terminated.

Source

The table below describes what Source attributes the plug-in supports.

Attribute	Supported
Form Region	:heavy_check_mark:
Type	:warning:
Used	:heavy_check_mark:
Maintain Session State	:heavy_check_mark:

Form Region

The native Oracle APEX form component is fully supported for Oracle APEX 22.2 onwards. For prior APEX releases, the supporting process plug-in is required to load, insert and update a document (CLOB) in the database.

:::tip Oracle APEX 19.2

Implement the plug-in in Oracle APEX before 22.2 using the plug-in implementation guidelines.

:::

Type value

The table below presents supported attribute values.

Value	Supported
Static Value	:heavy_check_mark:
Database Column	:heavy_check_mark:
Item	:heavy_check_mark:
SQL Query (return single value)	:heavy_check_mark:
SQL Query (return colon separated value)	:x:
PL/SQL Expression	:heavy_check_mark:
PL/SQL Function Body	:heavy_check_mark:
Preferences	:x:
NULL	:heavy_check_mark:

Used

The attribute used is supported, and the plug-in relies on Oracle APEX handling.

The attribute used is supported, but the plug-in relies on it’s own session state handling.

Maintain Session State

The attribute maintain session state is supported, and the plug-in relies on Oracle APEX handling.

Default

The attribute default is supported, and the plug-in relies on Oracle APEX handling.

Read Only

When an item attribute evaluation is true, the plug-in renders only the CLOB content and loads required CSS files to display a rich HTML text with the same formatting as while editing a document.