Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions
• Documentation Accessibility

What's New in This Guide

• New and Changed Features for 12c (12.2.1.3)

1 Introduction to Developing Oracle JDeveloper Extensions

• 1.1 About Developing Oracle JDeveloper Extensions
• 1.2 Developing Extensions with OSGi
  • 1.2.1 Service/Component Platform
  • 1.2.2 Deployment Infrastructure
• 1.3 How JDeveloper Extensions Work
  • 1.3.1 How Extensions are Processed
  • 1.3.2 Registering Extensions and Using Trigger Hooks
  • 1.3.3 How Lazy Initialization Works
• 1.4 Migrating Extensions from Previous Releases
• 1.5 Getting Started With Extension Development
  • 1.5.1 How to Create an Application and Project for Extension Development
  • 1.5.2 How to Develop for a Different JDeveloper Version
  • 1.5.3 Next Steps
• 1.6 Working with the Extension Manifest
  • 1.6.1 Editing the Extension Manifest in the Overview Editor
  • 1.6.2 Editing the Extension Manifest in the Source Editor
• 1.7 Working with the OSGi Manifest
  • 1.7.1 Understanding Dependencies
    • 1.7.1.1 How to Set Dependencies in the Extension Manifest
    • 1.7.1.2 How to Set Dependencies in the OSGi Bundle Profile

2 Developing Extensions in Oracle JDeveloper

• 2.1 About Developing Extensions in Oracle JDeveloper
• 2.2 Use Cases for Developing Extensions
  • 2.2.1 Understanding Rules Based Menu Sensitivity
    • 2.2.1.1 How to Avoid Complex Controller.update() Implementations
  • 2.2.2 How to Use Dynamic Menu Labels and Icons
    • 2.2.2.1 How to Append the Short Name to the Menu Label
  • 2.2.3 How to Construct Dynamic Top Menus
  • 2.2.4 Understanding Node Recognizers
  • 2.2.5 Understanding Content Sets
  • 2.2.6 Understanding Large Extensions
  • 2.2.7 Understanding Technology Scopes
• 2.3 Getting the JDeveloper Look and Feel
• 2.4 Creating JDeveloper Elements
  • 2.4.1 How to Quickly Create JDeveloper Elements
  • 2.4.2 How to Create and Modify Menus
    • 2.4.2.1 Understanding Menus
    • 2.4.2.2 How to Create a Context Menu
    • 2.4.2.3 How to Improve Performance by Registering a Context Menu Listener
    • 2.4.2.4 How to Add Menu Items to an Existing JDeveloper Menu
    • 2.4.2.5 How to Add a Drop-down Button to a Toolbar
  • 2.4.3 Working with Windows and Views
    • 2.4.3.1 Understanding Dockable Windows
    • 2.4.3.2 How to Create Simple Dockable Windows
    • 2.4.3.3 How to Position Dockable Windows
    • 2.4.3.4 How to Add an IDE Listener to a View
    • 2.4.3.5 How to Listen for the Active View
  • 2.4.4 How to Develop Wizards
    • 2.4.4.1 How to Set Up a Wizard Project
    • 2.4.4.2 How to Implement the Wizard Interface
    • 2.4.4.3 How to Add a Wizard to the New Gallery
  • 2.4.5 How to Develop Commands
    • 2.4.5.1 How to Implement the Addin Interface
    • 2.4.5.2 How to Implement a Command
      • 2.4.5.2.1 Handling the Event
      • 2.4.5.2.2 How to Define the undo Method
      • 2.4.5.2.3 How to Define Other Methods
    • 2.4.5.3 How to Define an Action
      • 2.4.5.3.1 How to Obtain an Action
      • 2.4.5.3.2 How to Set Action Values
      • 2.4.5.3.3 How to Extend an Action's Controller
      • 2.4.5.3.4 Extending an Action's Command Class
    • 2.4.5.4 How to Invoke an Addin From a Main Window Menu
    • 2.4.5.5 How to Invoke an Addin From a Context Menu
  • 2.4.6 How to Develop Editors
    • 2.4.6.1 Using Asynchronous Editors
      • 2.4.6.1.1 How Asynchronous Editors Work
  • 2.4.7 How to Develop Explorers
    • 2.4.7.1 How to Create an Explorer
    • 2.4.7.2 How to Register and Initialize a Structure Explorer
    • 2.4.7.3 How to Create a Structure Explorer Element Model
    • 2.4.7.4 How to Update the Structure Explorer
  • 2.4.8 How to Add New Components Window Pages
    • 2.4.8.1 Understanding Components Window Pages
    • 2.4.8.2 How to Declare Static Content for a Components Window
    • 2.4.8.3 How to Declare a Dynamic Component for a Components Window Page
    • 2.4.8.4 How to Provide Help for a Components Window Page
    • 2.4.8.5 How to Augment the Search for a Components Window Item
  • 2.4.9 Understanding Preferences
    • 2.4.9.1 How to Implement Preferences
    • 2.4.9.2 How to Implement the Data Model
    • 2.4.9.3 How to Implement a UI Panel
    • 2.4.9.4 How to Register a UI Panel
    • 2.4.9.5 How to Obtain the Preference Model
    • 2.4.9.6 How to Listen for Changes
  • 2.4.10 Understanding Project Properties
    • 2.4.10.1 How to Share Project Properties
  • 2.4.11 How to Make Changes Undoable
    • 2.4.11.1 How to Make Text Changes Undoable
    • 2.4.11.2 How to Make Commands Undoable
• 2.5 Defining and Using Trigger Hooks
  • 2.5.1 How to Register a <trigger-hook-handler>
  • 2.5.2 How to Define Trigger Hooks for your Extension
  • 2.5.3 How to Retrieve Parsed Information from the ExtensionRegistry
  • 2.5.4 How to Define Rules and Condition Triggers Sections
    • 2.5.4.1 How to Define Rules
    • 2.5.4.2 How to Define Simple Rules
    • 2.5.4.3 Implicitly Available Rules
    • 2.5.4.4 Guidelines for Rules
    • 2.5.4.5 How to Define Composite Rules
    • 2.5.4.6 How to Reference Rules From Hooks
    • 2.5.4.7 How to Validate Rule References and Evaluate Rules
• 2.6 Adding Online Help Support
  • 2.6.1 How to Create the Help System
  • 2.6.2 How to Register the Help System
• 2.7 Adding Print Support
  • 2.7.1 How to Register DocumentPrintFactory
  • 2.7.2 How to Register a View Class to Enable Printing
    • 2.7.2.1 How to Register a PageableFactory implementation for Handling a Node
• 2.8 Creating an Application or Project Template
  • 2.8.1 Defining an Application or Project Template
    • 2.8.1.1 Defining Template Hooks
    • 2.8.1.2 How to Create a Project Template
    • 2.8.1.3 How to Create an Application Template
  • 2.8.2 Registering a Template
    • 2.8.2.1 Registering a Creation Listener
  • 2.8.3 How to Add a Page for a Technology to the New Application or Project Wizard
  • 2.8.4 How to Add Additional Pages to an Application Template

3 Developing with the Extension SDK

• 3.1 About Developing with the Extension SDK
• 3.2 Downloading and Installing the Extension SDK
  • 3.2.1 What Happens When you Install the Extension SDK
  • 3.2.2 Troubleshooting Installing the Extension SDK
• 3.3 Using the Sample Extensions
• 3.4 Running the Sample Projects

4 Testing and Debugging Extensions

• 4.1 About Testing and Debugging Extensions
• 4.2 Debugging Extension Code
  • 4.2.1 How to Run a JDeveloper Extension
  • 4.2.2 How to Debug a JDeveloper Extension
• 4.3 Troubleshooting Debugging

5 Packaging and Deploying Extensions

• 5.1 About Packaging and Deploying Extensions
• 5.2 Packaging the Extension
  • 5.2.1 How to Create the Deployment Profile
  • 5.2.2 How to Create the OSGi Bundle
• 5.3 Deploying an Extension
• 5.4 How to Publish an Extension in an Update Center
  • 5.4.1 Extension bundle.xml Document
  • 5.4.2 Update Center XML Document

A Elements Installed with the Extension SDK

• A.1 Elements Installed in the File System
• A.2 Elements Installed in the IDE

B Uninstalling the Extension SDK

• B.1 About Uninstalling the Extension SDK
• B.2 How to Disable the Extension SDK
• B.3 How to Delete the Sample Application
• B.4 How to Uninstall the Extension SDK