Skip to main content

Rich Text Editor for Oracle APEX

table of contents

What is the plug-in Rich Text Editor Pro?​

The Rich Text Editor Pro by United Codes is an Oracle APEX page item plug-in integrating the popular Froala WYSIWYG editor as an alternative to the native Oracle APEX rich text editor.

image-20240213182639786

What does WYSIWYG mean?​

WYSIWYG stands for "What You See Is What You Get." It refers to a user interface that allows content creators to see a document's layout as it will appear in its final form while editing it.

What are the plug-in key features?​

The Rich Text Editor Pro key features are the following:

  1. can be used with APEX native form component
  2. support for CLOB values across all Oracle APEX versions starting with APEX 19.2
  3. support for inline images (base64 encoded images)
  4. uploading images using RESTful service module when it is desired on page submission or on demand using dynamic actions
  5. support for maintaining uplaoded images in the PL/SQL context
  6. customizations can be applied using different interfaces
    1. PL/SQL configuration for all application pages (application component settings)
    2. PL/SQL configuration for specific instance (page item configuration)
    3. dynamic action defined on specific page and APEX global page
    4. page item attributes
  7. tracking changes in rich text documents
  8. easy and fast image editting using TOAST UI Image Editor
  9. third-party integrations

Can I test the the plug-in without installing it?​

Yes, you can explore the Rich Text Editor Pro through our online sample application. Here's what you can do with the sample application:

  • Witness the plug-in in action.
  • Experiment with the supporting process plug-in, which loads and updates rich text documents as CLOB values.
  • Explore examples showcasing how the plug-in can enhance your Oracle APEX applications.

Access the most recent plug-in sample application here: Rich Text Editor Pro Sample Application.

Can I format text using a Rich Text Editor Pro?​

An any other WYSIWYG edutir, the Rich Text Editor Pro enables your Oracle APEX application users to:

  • add images to rich text document
  • add hyperlinks
  • format text into ordered an unordered lists
  • create tables
  • format text using paragrapgh styles, custom fonts and other text formatting needed in creating rich text documents

How to customize the editor's toolbar buttons?​

The plug-in toolbar can be customized using:

How to integrate the plug-in into Oracle APEX application?​

The plug-in can be installed in existing application in two scenarios: manual installation using DDL script and sample application installation for Oracle APEX 19.2 and 22.2.

Once the plug-in is installed in APEX scheme it's ready to be used in your APEX application and it's easy as creating a new page item or page process. While the plug-in can be used as an alternative for native rich text editor in Oracle APEX 22.2 onwards, implementing the plug-in in APEX 19.2 requires using the supporting process plug-in handling CLOB values larger than 32,768 characters.

Can the plug-in be used with native form component in Oracle APEX 19.2?​

Yes, but since Oracle APEX session state supports CLOB values starting with version 22.2, the CLOB handling must be implemented using the supporting process plug-in. The guidelines on how to implement the plug-in in Oracle APEX 19.2 covers topic on how to enable native form support using the supporting process plug-in.

Can the plug-in be used as an alternative for native APEX rich text editor?​

Yes, but for Oracle APEX version prior to 22.2, the CLOB support must be implementing using the supporting process plug-in or the plug-in PL/SQL API.

Is the rich text editor compatible with mobile devices?​

Yes, the Rich Text Editor Pro can be used on mobile devices. It might be handy to adjust the toolbar to the end-users needs, but it is also possible using page item attribute JavaScript Initialization Code or using the supporting dynamic action plug-in.

For more information on how to customize the Rich Text Editor Pro toolbar read the answer to question How to customize the editor's toolbar buttons?

Can I use the plug-in to create HTML emails with images?​

Yes, you can use the Rich Text Editor Pro to create HTML emails with images. One of the key features of the Rich Text Editor Pro is its ability to upload images seamlessly using the built-in image upload functionality.

Email providers often have limitations on embedding images directly into emails. However, with the Rich Text Editor Pro, you can easily upload images from your local device or external sources and incorporate them into your HTML email content.

This means that you can create visually appealing and engaging HTML emails with images directly within the editor. Once uploaded, the images can be embedded into your email content, allowing you to design professional-looking emails without the need for complex HTML coding.

Furthermore, the Rich Text Editor Pro's intuitive interface makes it easy to format text, add hyperlinks, and customize the layout of your email content. Whether you're creating newsletters, announcements, or promotional emails, the Rich Text Editor Pro provides a convenient solution for crafting visually stunning HTML emails with ease.

Inspect and test our sample application example page Send rich text e-mail from Oracle APEX allowing you to send e-mail directly from an APEX application using uploaded images.

Does the plug-ins support spell checking and autocorrect features?​

The Rich Text Editor Pro supports spell checking and autocorrect features through multiple avenues. See the possible options below.

The editor can leverage the spell check functionality provided by modern web browsers. This enables users to detect and correct spelling errors as they type, utilizing the browser's native spell checking capabilities.

Can I collaborate with others in real-time using the rich text editor?​

Yes, the Rich Text Editor Pro supports real-time collaboration through integration with codox.io, a third-party plugin. With codox.io, multiple users can collaborate simultaneously on the same rich text document, allowing for seamless teamwork and live editing sessions. Users can see changes made by others in real-time, making collaboration efficient and interactive. This feature enhances productivity and enables teams to work together effectively on documents, making it an ideal solution for collaborative projects and group editing tasks.

What are the plug-in benefits compared to native rich text editor?​

  1. Support for CLOB Handling: The Rich Text Editor Pro resolves the limitations of the Oracle APEX session state for page items, which struggles with CLOB values exceeding 32,767 characters in Oracle APEX prior to 22.2. Using the plug-in, developers can manage rich text documents of any length, providing flexibility and scalability.
  2. Image Upload Functionality: Unlike the native editor, the Rich Text Editor Pro includes built-in support for uploading images using the Oracle APEX RESTful service. This feature simplifies the process of adding images to rich text documents, enhancing the visual appeal and content richness. Moreover, developers can handle uploaded images using the PL/SQL page process. This capability allows developers to save references between uploaded images and the rich text CLOB values stored in the database, enabling seamless management of multimedia content within applications.
  3. Integration with Third-Party Plugins: The Rich Text Editor Pro seamlessly integrates with third-party plugins such as codox.io for real-time collaboration, WProofreader WebSpellChecker for advanced spell checking, and TOAST UI Image Editor for image editing capabilities. With TOAST UI Image Editor, end-users can edit images directly in the browser, adding text, shapes, cropping, resizing, rotating, and more. This integration enhances user engagement and empowers users to create visually compelling content without the need for external editing tools.
  4. Enhanced User Experience: With its intuitive interface and advanced features, the Rich Text Editor Pro offers an enhanced user experience compared to the native editor. Features like real-time collaboration, spell checking, and image uploading contribute to a more efficient and productive editing process.
  5. Compatibility and Flexibility: The Rich Text Editor Pro is compatible with Oracle APEX 19.2 onwards, providing developers with a flexible and versatile solution for creating rich text documents. Its compatibility ensures smooth integration with existing APEX applications, allowing for seamless adoption and integration.

In summary, the Rich Text Editor Pro offers significant advantages over the native Oracle APEX rich text editor, providing developers with enhanced functionality, improved user experience, and greater flexibility in managing rich text content within their applications.

Is there a way to track changes made to documents using the rich text editor?​

Yes, the Rich Text Editor Pro includes a free plug-in called "Track Changes" that allows users to monitor and review modifications made to documents. This functionality provides transparency and accountability, making it easier to collaborate on documents and track the evolution of content over time.

The "Track Changes" feature records edits, insertions, deletions, and formatting changes made to the document. Users can review these changes, accept or reject modifications, and add comments to provide context for specific revisions.

Enabling "Track Changes" enhances document collaboration, facilitates version control, and ensures accuracy and integrity in document management processes.