RealObjects edit-on Pro Integration Manual Next

RealObjects edit-on Pro Integration Manual

Version 5.2 (5.2.221)

Copyright © 2000-2008 RealObjects GmbH Saarbrücken, Germany

Table of Contents

Introduction
I. Basic Integration
1. Integrating edit-on Pro in a Web Page
1.1. Inserting the Editor Into a Web Page
1.2. Importing and Exporting Content from the Editor
2. Configuring edit-on Pro
3. Adjusting the User Interface
3.1. Defining Actions
3.2. Defining the Toolbar
3.2.1. Defining Custom Drop-Down Boxes
3.3. Defining the Pull Down Menu
3.4. Defining the Context Menu
4. Exchanging Data
4.1. JavaScript API Considerations
4.2. Content Sources
4.3. Handling of Legacy Content
II. Advanced Integration
1. Custom actions
1.1. Custom JavaScript actions
1.2. Custom URL actions
1.3. Custom Java actions
2. edit-on Pro CSS Extensions
2.1. Read-Only Content
2.2. Read-Only Elements
2.3. Dynamically Populating the Context Menu Using CSS
2.4. Controlling the display of Custom Elements
3. Direct HTTP Connection API
4. Localizing edit-on Pro
4.1. The locale Property
4.2. Custom Localization
5. Accessibility
6. The Clean-Up Process
6.1. Types of Clean-Up Processes
6.2. Configuring Custom Clean-Up Processes
6.2.1. Customizing the Client Side Clean-Up Process
6.2.2. Customizing a Server Side Clean-Up Process
6.3. Clean-up Process Flow Charts
6.3.1. Clean-Up Process when Content is Imported
6.3.2. Clean-Up Process when Content is Exported
6.4. Configuring Drag & Drop
6.4.1. Available Drag & Drop Handlers
6.4.2. Customizing Drag & Drop
7. Using Custom DTDs
7.1. Specifying a Custom DocType
7.2. Defining custom tags
8. Template Based Editing
9. Managing Embedded Files
9.1. Uploading and Inserting Files Using WebDAV
9.2. Uploading Files Using HTTP Connections
9.3. Using the JavaScript API to Trigger the File Upload
10. Creating Custom Dialogs
10.1. Overview
10.2. Implementing a Custom Dialog
10.2.1. Interfacing with edit-on Pro
10.2.2. Interacting with EOPDATA
10.2.3. Interacting with Custom Dialogs Derived from Custom Actions
10.3. Deploying a Custom Dialog
11. Using VersioTrack
11.1. Comparing Documents
11.2. Comparison Mode
11.3. Comparison Mode 101
11.4. Ignoring Changes
12. Event Handlers
13. Configuring the Table Autoformat Feature
14. Preloading the Applet and JVM
III. Reference
1. Configuration File
2. JavaScript API
2.1. JavaScript Configuration API
2.2. JavaScript API / Java API
3. User Interface Configuration
3.1. Structure
3.1.1. Elements Defining Actions
3.1.2. Elements Defining the Pull Down Menu and Context Menu
3.1.3. Elements Defining The Toolbar
3.2. Actions
4. CSS Reference
4.1. Style Sheets Supported by edit-on Pro
4.1.1. Font properties
4.1.2. Color and background properties
4.1.3. Text properties
4.1.4. Box properties
4.1.5. List properties
4.1.6. Table properties
4.2. edit-on Pro CSS Extensions
4.2.1. Style Properties Controling the Behaviour of Custom Tags
4.2.2. Style Properties Affecting the Display of Elements
4.2.3. Style Properties Controling the Display of CSS Classes in Editor Dialogs
4.2.4. Style Properties Controling the Display in Comparison Mode
5. Clean-up Class and Form Fields
5.1. Methods and Properties of the Client Side Clean-Up Base Class
5.1.1. Base class
5.1.2. Methods
5.1.3. Properties
5.2. Form Fields Sent to the Server by the Server Side Clean-Up Process
6. Keys Available in EOPDATA for each Action

List of Tables

II.1. Overview of ACTIONS and their corresponding configuration

List of Examples

I.1. Importing the edit-on Pro JavaScript library
I.2. Creating an instance of edit-on Pro
I.3. Setting the codebase and loading the editor
I.4. Loading content into the editor using the JavaScript API
I.5. Retrieving content from the editor using the JavaScript API
I.6. Loading a configuration file
I.7. Setting and enforcing the maximum number of characters in a document
I.8. The elements fontsizes and fontsize
I.9. Loading a user interface configuration file
I.10. Defining an action
I.11. Simple toolbar definition
I.12. Simple custom drop down box
I.13. Simple pull down menu
I.14. Simple context menu
I.15. Using JavaScript functions at run-time
I.16. Loading a content fragment using a form field
I.17. Loading content from an URL
II.1. The insertDate function
II.2. Defining the custom JavaScript action INSERTDATE
II.3. Defining a toolbar button calling the custom action INSERTDATE
II.4. Defining a custom URL action
II.5. Defining a custom Java action
II.6. Declaring the content inside an element as read-only content
II.7. Declaring read-only elements
II.8. Enabling the TABLEPROPERTIES action in the context menu
II.9. Using Styles Controlling the Display of Elements
II.10. Setting sethtmldataurl and gethtmldataurl
II.11. Sample gethtmldataurl handlers
II.12. Configuring a custom client side clean-up process in the configuration file
II.13. Extending the com.realobjects.eop.bean.custom.CleanUpProcess class
II.14. Configuring a custom server-side clean-up process in the configuration file
II.15. Sample server-side clean-up process script
II.16. Configuring the drag & drop handler
II.17. Specifying a custom DocType in a document or template
II.18. Specifying a public DocType in a document or template
II.19. Sample eopcustomelements.dtd
II.20. Specifying a template in the configuration file
II.21. Enabling upload and insert dialogs
II.22. Activating WebDAV in the configuration file
II.23. Configuring the file base
II.24. Activating the HTTP POST upload mechanism in the configuration file
II.25. Sample server side script handling the image upload (PHP)
II.26. Using the uploadToRepository() function
II.27. Using Java API methods in a custom dialog
II.28. Overwriting the LINK action
   Next
   Introduction