Oracle® Fusion Middleware Developing Extensions for Oracle JDeveloper 12c (12.1.2) E23013-01 June 2013 Documentation for Oracle JDeveloper users that describes how to develop downloadable extensions to JDeveloper, adding plug-in capabilities to support internal teams, or as part of third-party applications. Oracle Fusion Middleware Developing Extensions for Oracle JDeveloper, 12c (12.1.2) E23013-01 Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Primary Author: Catherine Pickersgill Contributing Author: John Brock This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Contents Preface ................................................................................................................................................................ vii Audience...................................................................................................................................................... vii Documentation Accessibility.................................................................................................................... vii Related Documents .................................................................................................................................... vii Conventions ................................................................................................................................................ vii What's New in This Guide........................................................................................................................ ix New and Changed Features for 12c (12.1.2)............................................................................................ ix 1 Introduction to Developing Oracle JDeveloper Extensions 1.1 About Developing Oracle JDeveloper Extensions ................................................................. 1-1 1.2 Developing Extensions with OSGi .......................................................................................... 1-3 1.2.1 Service/Component Platform............................................................................................ 1-3 1.2.2 Deployment Infrastructure................................................................................................. 1-4 1.3 How JDeveloper Extensions Work........................................................................................... 1-4 1.3.1 How Extensions are Processed .......................................................................................... 1-5 1.3.2 Registering Extensions and Using Trigger Hooks.......................................................... 1-5 1.3.3 How Lazy Initialization Works ......................................................................................... 1-7 1.4 Migrating Extensions from Previous Releases ....................................................................... 1-8 1.5 Getting Started With Extension Development ....................................................................... 1-9 1.5.1 How to Create an Application and Project for Extension Development..................... 1-9 1.5.2 How to Develop for a Different JDeveloper Version .................................................. 1-10 1.5.3 Next Steps .......................................................................................................................... 1-10 1.6 Working with the Extension Manifest .................................................................................. 1-10 1.6.1 Editing the Extension Manifest in the Overview Editor............................................. 1-11 1.6.2 Editing the Extension Manifest in the Source Editor................................................... 1-12 1.7 Working with the OSGi Manifest .......................................................................................... 1-12 1.7.1 Understanding Dependencies ........................................................................................ 1-13 1.7.1.1 How to Set Dependencies in the Extension Manifest........................................... 1-13 1.7.1.2 How to Set Dependencies in the OSGi Bundle Profile......................................... 1-13 2 Developing Extensions in Oracle JDeveloper 2.1 About Developing Extensions in Oracle JDeveloper............................................................. 2-1 2.2 Use Cases for Developing Extensions...................................................................................... 2-1 2.2.1 Understanding Rules Based Menu Sensitivity................................................................ 2-1 iii 2.2.1.1 How to Avoid Complex Controller.update() Implementations............................ 2-2 2.2.2 How to Use Dynamic Menu Labels and Icons ................................................................ 2-4 2.2.2.1 How to Append the Short Name to the Menu Label .............................................. 2-4 2.2.3 How to Construct Dynamic Top Menus .......................................................................... 2-4 2.2.4 Understanding Node Recognizers .................................................................................... 2-5 2.2.5 Understanding Content Sets .............................................................................................. 2-5 2.2.6 Understanding Large Extensions ...................................................................................... 2-6 2.2.7 Understanding Technology Scopes................................................................................... 2-7 2.3 Getting the JDeveloper Look and Feel..................................................................................... 2-7 2.4 How to Create JDeveloper Elements........................................................................................ 2-9 2.4.1 How to Quickly Create JDeveloper Elements ................................................................. 2-9 2.4.2 How to Create and Modify Menus ................................................................................ 2-10 2.4.2.1 Understanding Menus .............................................................................................. 2-10 2.4.2.2 How to Create a Context Menu............................................................................... 2-10 2.4.2.3 How to Improve Performance by Registering a Context Menu Listener.......... 2-12 2.4.2.4 How to Add Menu Items to an Existing JDeveloper Menu ................................ 2-13 2.4.2.5