Skip to main content

Standard attributes

The plug-in implements the following standard 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.

AttributeSupported
CSS Classesicon_check_16px
Custom Attributesicon_check_16px
Pre Texticon_check_16px
Post Texticon_check_16px
Warn on Unsaved Changesicon_check_16px
JavaScript Initialization Codeicon_check_16px

CSS Classes​

The given classes are applied to the plug-in text area.

The CSS classes can customize the rich text editor using a supporting dynamic action plug-in. The dynamic action can be defined on the same page as an item implementing the plug-in or in an application global page.

Custom Attributes​

The given attributes are applied to the plug-in textarea used to initialize the Froala rich text editor - the textarea input is not visible.

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 the page level.

Initialization JavaScript Code​

The attribute value must be an anonymous JavaScript function accepting only one parameter, pOptions (JSON object), and must return a valid JSON object.

The returned JSON object is used to

  • configure the rich text editor (using the Froala Java Script options)
  • configure the plug-in features, for example, update & upload workflow.

Froala Rich Text Editor Options​

The example JavaScript function below overrides three rich text editor options. The Froala rich text editor can be customized using 200+ Java Script options.

function( pOptions ) {
  pOptions.imagePaste      = false; // disable pasting images from clipboard
  pOptions.imageResize     = false; // disable image resizing
  pOptions.imageAddNewLine = false; // disable adding a new line after inserting an image
  
  // return overriden options
  return pOptions;
}

Update & Upload Workflow​

The example JavaScript function below configures the plug-in update & upload workflow to ignore all issues when downloading and uploading images.

function( pOptions ) {
  pOptions.upload = {
    "whenDownloadFails": uc.froala.C_CONTINUE, // or uc.froala.C_CANCEL, uc.froala.C_CONFIRM
    "whenUploadFails"  : uc.froala.C_CONTINUE, // or uc.froala.C_CANCEL, uc.froala.C_CONFIRM
    "whenFinishAnyErr" : uc.froala.C_CONTINUE  // or uc.froala.C_CANCEL, uc.froala.C_CONTINUE
  }
  
  return pOptions;
}

To learn more about the plug-in update & upload workflow, go to the Item plug-in \ Upload images.

Appearance​

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

AttributeSupported
Template(warning)
Template Options(warning)
CSS Classesicon_check_16px
Format Maskicon_check_16px
Value Placeholdericon_check_16px

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 as the Froala JavaScript option placeholderText.

Validation​

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

AttributeSupported
Value Requiredicon_check_16px

Value Required​

The plug-in supports HTML5 validation on page submission. If a rich text HTML 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.

AttributeSupported
Form Regionicon_check_16px
Type(warning)
Usedicon_check_16px
Maintain Session Stateicon_check_16px

Form Region​

The Oracle APEX form component is supported starting with the plug-in version 23.2.

In Oracle APEX before 22.2, the supporting process plug-ins must be used to load, insert, and update CLOB values in the database.

Type value​

The table below presents supported attribute values.

ValueSupported
Static Valueicon_check_16px
Database Columnicon_check_16px
Itemicon_check_16px
SQL Query (return single value)icon_check_16px
SQL Query (return colon separated value)icon_check_16px
PL/SQL Expressionicon_check_16px
PL/SQL Function Bodyicon_check_16px
Preferencesicon_check_16px
NULLicon_check_16px

The plug-in relies on Oracle APEX support for these attributes.

Used​

The table below presents supported attribute values.

Source \ Used valueSupported
Always, replacing any existing value in session stateicon_check_16px
Only when current value in session state is nullicon_check_16px

Always, replacing any existing value in session state

When selecting this option, the plug-in overrides the CLOB value in the session state using a value delivered from an item source attribute.

Only when current value in session state is null

When this option is selected, and the CLOB in the plug-in session state is NULL, then the value delivered by an item source attribute is used.

Maintain Session State​

Supported, the plug-in relies on the Oracle APEX handling the attribute.

Default​

Supported, the plug-in relies on the Oracle APEX handling the attribute.

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.