Eclipse Building Commercial-Quality Plug-ins Second Edition

Transcription

1 Eclipse Building Commercial-Quality Plug-ins Second Edition Eric Clayberg Dan Rubel v:addison-wesley Upper Saddle River, NJ Boston Indianapolis San Francisco New York Toronto Montreal London Munich Paris Madrid Capetown Sydney Tokyo Singapore Mexico City

2 Foreword by Skip McGaughey xxxi Foreword by Simon Archer xxxiii Preface xxxv Chapter 1 Using Eclipse Tools Getting Started Getting Eclipse Installation The Eclipse Workbench Perspectives, views, and editors Actions Setting Up Your Environment Workbench preferences Java preferences Importing and exporting preferences 18 ix

3 x Contents 1.4 Creating a Project Using the new Java Project wizard classpath and.project files Using the Java Package wizard Using the Java Class wizard Navigating Open Type dialog Type Hierarchy view Go to Line Outline view Searching File Search Java Search Other Search menu options Working sets Writing Code Java editor Templates Refactoring Local history File extension associations Team Development Using CVS Getting started with CVS Checking out a project from CVS Synchronizing with the repository Comparing and replacing resources CVS Label decorators 53

4 xi 1.9 Running Applications Launching Java applications Launch configurations Introduction to Debugging Setting breakpoints 58 Using the Debug view 60 Using the Variables view 60 Using the Expressions view Introduction to Testing Creating test cases Running test cases Summary 63 Chapter 2 A Simple Plug-in Example The Favorites Plug-in Creating a Plug-in Project New Plug-in Project wizard Define the plug-in Define the view Reviewing the Generated Code The Plug-in manifests The Plug-in dass The Favorites view Building a Product Building manually Building with Apache Ant 83

5 xii Contents 2.5 Installing and Running the Product Debugging the Product Creating a configuration Selecting plug-ins and fragments Launching the Runtime Workbench PDE Views The Plug-in Registry view The Plug-ins view The Plug-in Dependencies view Writing Plug-in Tests Test preparation Creating a Plug-in test project Creating a Plug-in test Running a Plug-in test Uninstalling the Favorites plug-in Summary 98 Chapter 3 Eclipse Infrastructure Structural Overview Plug-in structure Workspace Plug-in Directory or JAR file Link files Hybrid approach Plug-in Manifest Plug-in declaration Plug-in runtime Plug-in dependencies Extensions and extension points 112

6 xiii 3.4 Plug-in Class Startup and shutdown Early plug-in startup Static plug-in resources Plug-in preferences Plug-in configuration files Plugin and AbstractUlPlugin Plug-in Model Platform Plug-ins and Bundles Plug-in extension registry Logging Status objects The Error Log view Eclipse Plug-ins Summary 125 Chapter 4 The Standard Widget Toolkit 127 _ 4.1 SWT History and Goals SWT Widgets Simple stand-alone example Widget lifecycle Widget events Abstract widget classes Top-level classes Useful widgets Menus 166

7 xiv Contents 4.3 Layout Management FillLayout RowLayout GridLayout FormLayout Resource Management Colors Fonts Images Summary 181 Chapter 5 JFace Viewers List-Oriented Viewers Label providers Content providers Viewer sorters Viewer filters StructuredViewer dass ListViewer dass TableViewer dass TreeViewer dass Text Viewers Summary 206 Chapter 6 Actions IAction versus IActionDelegate Workbench Window Actions Defining a workbench window menu Groups in a menu 212

8 xv Defining a menu item and toolbar button Action images Insertion points Creating an action delegate Manually testing the new action Adding a test for the new action Discussion Object Actions Defining an object-based action Action filtering and enablement IObjectActionDelegate Creating an object-based submenu Manually testing the new action Adding a test for the new action View Actions Defining a view context submenu Defining a view context menu action IViewActionDelegate Defining a view toolbar action Defining a view pull-down submenu and action Manually testing the new actions Adding tests for the new actions View context menu identifiers Editor Actions Defining an editor context menu Defining an editor context action IEditorActionDelegate Defining an editor top-level menu Defining an editor top-level action 248

9 xvi Contents Defining an editor toolbar action Adding tests for the new actions Editor context menu identifiers Key Bindings Categories Commands Key bindings Associating commands with actions Keyboard accessibility RFRS Considerations Global action labels (RFRS ) Summary 257 Chapter 7 Views View Declaration Declaring a view category Declaring a view View Part View methods 263 View controls 264 View model 265 Content provider 276 Label provider 277 Viewer sorter 278 Viewer filters 281 View selection View Actions Model actions Context menu 283

10 xvü Toolbar buttons Pull-down menu Keyboard actions Global actions Clipboard actions Drag-and-drop support Inline editing Linking the View Selection provider Adaptable objects Selection listener Opening an editor Saving View State Saving local view information Saving global view information Testing Image Caching Auto-sizing Table Columns RFRS Considerations Views for navigation (RFRS ) Views save immediately (RFRS ) View initialization (RFRS ) View global actions (RFRS ) Persist view state (RFRS ) Register context menus (RFRS ) Action filters for views (RFRS ) Summary 323

11 xviii Contents Chapter 8 Editors Editor Declaration Editor Part Editor methods Editor controls Editor model Content provider Label provider Editing Cell editors Cell modifiers Change listeners Cell validators Editing versus selecting Editor Lifecycle Dirty editors Switching pages Saving content Editor Actions Context menu Editor contributor Undo/Redo Clipboard actions Linking the Editor RFRS Considerations Using an editor to edit or browse (RFRS 3.5.9) Editor lifecycle (RFRS ) Accessing global actions (RFRS ) 371

12 xix Closing when the object is deleted (RFRS ) Synchronize external changes (RFRS ) Registering editor menus (RFRS ) Editor action filters (RFRS ) Unsaved editor modifications (RFRS ) Prefix dirty resources (RFRS ) Editor outline view (RFRS ) Synchronize with outline view (RFRS ) Summary 374 Chapter 9 Resource Change Tracking IResourceChangeListener IResourceChangeEvent IResourceDelta Processing Change Events Batching Change Events Progress Monitor IProgressMonitor Classes for displaying progress Workbench window status bar IProgressService Delayed Changed Events Summary 388 Chapter 10 Perspectives Creating a Perspective Perspective extension point Perspective factories IPageLayout 395

13 xx Contents 10.2 Enhancing an Existing Perspective Adding views and placeholders Adding shortcuts Adding action sets RFRS Considerations Create for Jong-lived tasks (RFRS ) Extend existing perspectives (RFRS ) Add actions to window menu (RFRS ) Summary 404 Chapter 11 Dialogs and Wizards Dialogs SWT dialogs versus JFace dialogs Common SWT dialogs Common JFace dialogs Creating a JFace dialog Dialog units Initial dialog location and size Resizable dialogs Favorites view filter dialog Details dialog Opening a dialog finding a parent shell Wizards IWizard 431 IWizardPage 433 IWizardContainer 434 Nested wizards 435 Launching a wizard 435 Wizard example 439

14 xxi Dialog settings Page content based on selection Page content based on previous page RFRS Considerations Wizard look and feel (RFRS 3.5.2) Open new file in editor (RFRS 3.5.6) New project switches perspective (RFRS 3.5.7) Show new object (RFRS 3.5.8) One-page wizard buttons (RFRS ) Summary 450 Chapter 12 Preference Pages Creating a Preference Page Preference Page APIs FieldEditorPreferencePage Field editors PreferencePage Favorites preference page Validation Nested preference pages Tabbed preference pages Preference APIs Default preferences Accessing preferences Specifying default values programmatically Specifying default values in a file Hooking up the Favorites view Listening for preference changes 474

15 12.4 RFRS Considerations Preferences dialog use (RFRS ) Summary 475 Chapter 13 Properties Creating Properties Favoriteltem properties Resource properties Displaying Properties in the Properties Dialog Declaring a Property page Creating a resource Property page Creating a Favorites item resource page Opening the Properties dialog Displaying Properties in the Properties View Properties view API Favorite properties in the Properties view Property Pages Reused as Preference Pages RFRS Considerations Properties views for quick access (RFRS ) Summary 495 Chapter 14 Builders, Markers, and Natures Builders Declaring a builder IncrementalProjectBuilder Derived resources Associating a builder with a project Invoking builders 512

16 xxiii 14.2 Markers Marker types Creating and deleting markers Marker attributes Marker resolution quick fix Finding markers Natures Declaring a nature Associating builders and natures IProjectNature Required natures Conflicting natures Nature image Associating a nature with a project RFRS Considerations Use builders to convert resources (RFRS 3.8.1) Do not replace existing builders (RFRS 3.8.3) Do not misuse the term "build" (RFRS ) Mark created resources as "derived" (RFRS ) Respond to clean-build requests (RFRS ) Use IResourceProxy when possible (RFRS ) Builders must be added by natures (RFRS ) Summary 537 Chapter 15 Implementing Help Using Help Implementing Help Creating a new help project Plug-in manifest files 547

17 xxiv Contents Table of contents (toc) files Creating HTML content Context-Sensitive Help (F1) Associating context IDs with items IWorkbenchHelpSystem API Creating context-sensitive help content Context extension point Marker help Accessing Help Programmatically Opening a specific help page Opening a Web page Cheat Sheets Using a cheat sheet Creating a simple cheat sheet Adding cheat sheet actions RFRS Considerations Provide help through help system (RFRS 3.7.2) Provide all help via the help system (RFRS ) Context help activated using F1 (RFRS ) Implement active help (RFRS ) Use of stand-alone help (RFRS ) Use of additional documentation (RFRS ) Provide an overview of tasks flow (RFRS ) Illustrate only one task (RFRS ) Provide help link with each step (RFRS ) Summary 574

18 xxv Chapter 16 Internationalization Externalizing the Plug-in Manifest Externalizing Plug-in Strings Using Fragments New Fragment Project wizard Fragment manifest file Fragment project contents Summary 594 Chapter 17 Creating New Extension Points The Extension Point Mechanism Defining an Extension Point Creating an extension point Creating an extension point schema Extension point elements and attributes Extension point element grammar Code Behind an Extension Point Parsing extension information Constructing proxies Creating executable extensions Cleanup Extension Point Documentation Using the Extension Point RFRS Considerations Document extension points (RFRS ) Log errors (RFRS ) Summary 618

19 xxvi Contents Chapter 18 Features, Branding, and Updates Feature Projects Creating a new feature project Feature manifest files Feature manifest editor Branding The about.html file The about.ini file Product branding Update Sites Creating an update site project The site.xml file The update Web site Revisiting the feature manifest Accessing the update site RFRS Considerations Do not override product branding (RFRS 3.1.8) Branded feature visibility (RFRS ) Include attribution information (RFRS ) about.html file contents (RFRS ) Splash screen restrictions (RFRS ) Summary 648 Chapter 19 Building a Product A Brief Introduction to Ant Build projects Build targets Build tasks Build properties 657

20 xxvii <antcall> task macrodef Headless Ant Ant extensions Building the Favorites Product Auto-generated build script Refactoring the Favorites build script Compiling during the build process Single versus multiple binaries Editing with different versions of Eclipse Building against different versions of Eclipse Classpath tools Building against Eclipse Retargeting source code Version checking Building for internationalization Summary 707 Chapter 20 Advanced Topics Advanced Search Reference Projects Accessing Internal Code Eclipse newsgroup Bugzilla Eclipse bug tracking system Options for accessing internal code How Eclipse is different Related plug-ins Using fragments 714

21 xxviii Contents 20.3 Adapters IAdaptable Using adapters Adapter factory IWorkbenchAdapter Opening a Browser or Creating an IWorkbenchBrowserSupport LaunchURL Open Action Types Specified in an Extension Point Parameterized types Referencing a dass in a different plug-in Modifying Eclipse to Find Part Identifiers Modifying the Eclipse base Creating the global action Testing the new utility Submitting the change to Eclipse Label Decorators Declaring a label decorator ILightweightLabelDecorator Decorative label decorators IDecoratorManager Background Tasks Jobs API Plug-in ClassLoaders Early Startup Managing early startup Disabling early startup Rich Client Platform Conclusion 749

22 xxix Appendix A Eclipse Plug-ins and Resources 751 A.1 Plug-ins 751 A.1.1 CodePro AnalytiX and CodePro PlusPak 751 A.1.2 EclipseProfiler 753 A.1.3 EclipseUML 754 A.1.4 MyEclipse Enterprise Workbench 755 A.1.5 WindowBuilder Pro 757 A.1.6 XMLBuddy 759 A.2 Resources 760 A.2.1 Eclipse.org 760 A.2.2 Eclipse Plug-in Central 762 A.2.3 Eclipse plug-in site 762 A.2.4 Eclipse wiki wiki 762 A.2.5 EclipseCon 762 A.2.6 ANTLR plug-in for Eclipse 762 A.2.7 Bugzilla plug-in 762 A.2.8 Coloring editor 762 A.2.9 Eclipse Easter eggs 763 A.2.10 IBM Alphaworks an Eclipse 763 A.2.11 IBM Eclipse research 763 A.2.12 PHP plug-in for Eclipse 763 A.2.13 QNX's Momentics 763 A.2.14 QuickShare: XP programming for Eclipse 763 A.2.15 Sangam: XP programming for Eclipse 763 Appendix B Ready for Rational Software 765 Index 767