Javahelp System User's Guide I Table of Contents 1 Javahelptm System User's Guide Javahelp 2.0 − February 2004

Total Page:16

File Type:pdf, Size:1020Kb

Javahelp System User's Guide I Table of Contents 1 Javahelptm System User's Guide Javahelp 2.0 − February 2004 TM JavaHelp 2.0 System User's Guide Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054 U.S.A. 650−960−1300 Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Sun, Sun Microsystems, the Sun Logo, Solaris, Java, the Java Coffee Cup Logo, J2SE, Java Foundation Classes (J.F.C.), Java Plug−in and JavaHelp are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON−INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software Clause at DFARS 252.227−7013 (Oct. 1988) and FAR 52.227−19 (c) (June 1987). JavaHelp System User's Guide i Table of Contents 1 JavaHelpTM System User's Guide JavaHelp 2.0 − February 2004.............................................................1 1.1 Keeping in Touch..............................................................................................................................1 1.1.1 Feedback...............................................................................................................................1 1.1.2 Mailing List.............................................................................................................................2 1.1.3 Discussion group (JAVAHELP−INTEREST)..........................................................................2 2 The JavaHelp 2.0 Release..............................................................................................................................3 2.1 Contents of the Release...................................................................................................................3 2.2 Requirements...................................................................................................................................4 2.3 New Features and Changes in JavaHelp 2.0...................................................................................4 2.3.1 Installation Packages..............................................................................................................4 2.3.2 Running the JavaHelp Viewer.................................................................................................4 2.3.3 JDK 1.1 is no longer supported...............................................................................................4 2.3.4 Change to API for Accessing Frames.....................................................................................4 2.3.5 Multi−Topic Printing.................................................................................................................5 2.3.6 Comprehensive Merging Options............................................................................................5 2.3.7 New Views in Help Viewer......................................................................................................5 2.3.8 Specifying View (Navigator) Icons or Text..............................................................................5 2.3.9 Presentation Controls..............................................................................................................5 2.3.10 Customizable Toolbar Support in Helpset File......................................................................5 2.3.11 Server−Based JavaHelp.......................................................................................................6 2.3.12 Helpset File has an Implementation Section.........................................................................6 2.3.13 Dynamic Context−Sensitive Help for Components...............................................................6 2.4 Demonstration Programs..................................................................................................................6 2.4.1 IDE Demo................................................................................................................................7 2.4.2 Object Demo...........................................................................................................................8 2.4.3 API Viewer..............................................................................................................................8 2.4.4 Merge Demo...........................................................................................................................9 2.4.5 Newmerge Demo....................................................................................................................9 2.4.6 Browser Demo........................................................................................................................9 2.4.7 Search Example......................................................................................................................9 2.4.8 Localized Helpsets..................................................................................................................9 2.5 Sample Helpsets.............................................................................................................................10 2.5.1 JavaHelp System User's Guide.............................................................................................10 2.5.2 History of the Holidays..........................................................................................................10 2.5.3 IDE Demo..............................................................................................................................10 2.5.4 ..............................................................................................................................................10 2.5.5 Localized Helpsets................................................................................................................11 2.5.6 ..............................................................................................................................................11 2.5.7 ..............................................................................................................................................11 2.6 The JavaHelp Libraries and Tools..................................................................................................11 2.6.1 Libraries................................................................................................................................11 2.6.2 Tools.....................................................................................................................................12 2.7 Limitations and Bugs......................................................................................................................12 2.7.1 HTML Viewer........................................................................................................................12 2.7.2 Full−text Search....................................................................................................................14 2.7.3 Context Sensitive Help..........................................................................................................14 2.7.4 Other Bugs............................................................................................................................15 2.8 List of Files in the JavaHelp 2.0 Release........................................................................................15 3 JavaHelp System Overview.........................................................................................................................19 3.1 Introduction.....................................................................................................................................19 3.2 JavaHelp System Features.............................................................................................................20 3.2.1 Help Viewers.........................................................................................................................20 JavaHelp System User's Guide i ii JavaHelp System User's Guide Table of Contents 3 JavaHelp System Overview 3.2.2 Table of Contents..................................................................................................................21 3.2.3 Index.....................................................................................................................................21 3.2.4 Full−Text Search...................................................................................................................21 3.2.5 Compression and Encapsulation..........................................................................................21 3.2.6 Embeddable Help Windows..................................................................................................21 3.2.7 Context−Sensitive Help.........................................................................................................21 3.2.8 Flexible Packaging................................................................................................................21 3.2.9 Customization.......................................................................................................................22 3.2.10 Merging...............................................................................................................................22
Recommended publications
  • Rich Internet Applications
    Rich Internet Applications (RIAs) A Comparison Between Adobe Flex, JavaFX and Microsoft Silverlight Master of Science Thesis in the Programme Software Engineering and Technology CARL-DAVID GRANBÄCK Department of Computer Science and Engineering CHALMERS UNIVERSITY OF TECHNOLOGY UNIVERSITY OF GOTHENBURG Göteborg, Sweden, October 2009 The Author grants to Chalmers University of Technology and University of Gothenburg the non-exclusive right to publish the Work electronically and in a non-commercial purpose make it accessible on the Internet. The Author warrants that he/she is the author to the Work, and warrants that the Work does not contain text, pictures or other material that violates copyright law. The Author shall, when transferring the rights of the Work to a third party (for example a publisher or a company), acknowledge the third party about this agreement. If the Author has signed a copyright agreement with a third party regarding the Work, the Author warrants hereby that he/she has obtained any necessary permission from this third party to let Chalmers University of Technology and University of Gothenburg store the Work electronically and make it accessible on the Internet. Rich Internet Applications (RIAs) A Comparison Between Adobe Flex, JavaFX and Microsoft Silverlight CARL-DAVID GRANBÄCK © CARL-DAVID GRANBÄCK, October 2009. Examiner: BJÖRN VON SYDOW Department of Computer Science and Engineering Chalmers University of Technology SE-412 96 Göteborg Sweden Telephone + 46 (0)31-772 1000 Department of Computer Science and Engineering Göteborg, Sweden, October 2009 Abstract This Master's thesis report describes and compares the three Rich Internet Application !RIA" frameworks Adobe Flex, JavaFX and Microsoft Silverlight.
    [Show full text]
  • Java Programming Standards & Reference Guide
    Java Programming Standards & Reference Guide Version 3.2 Office of Information & Technology Department of Veterans Affairs Java Programming Standards & Reference Guide, Version 3.2 REVISION HISTORY DATE VER. DESCRIPTION AUTHOR CONTRIBUTORS 10-26-15 3.2 Added Logging Sid Everhart JSC Standards , updated Vic Pezzolla checkstyle installation instructions and package name rules. 11-14-14 3.1 Added ground rules for Vic Pezzolla JSC enforcement 9-26-14 3.0 Document is continually Raymond JSC and several being edited for Steele OI&T noteworthy technical accuracy and / PD Subject Matter compliance to JSC Experts (SMEs) standards. 12-1-09 2.0 Document Updated Michael Huneycutt Sr 4-7-05 1.2 Document Updated Sachin Mai L Vo Sharma Lyn D Teague Rajesh Somannair Katherine Stark Niharika Goyal Ron Ruzbacki 3-4-05 1.0 Document Created Sachin Sharma i Java Programming Standards & Reference Guide, Version 3.2 ABSTRACT The VA Java Development Community has been establishing standards, capturing industry best practices, and applying the insight of experienced (and seasoned) VA developers to develop this “Java Programming Standards & Reference Guide”. The Java Standards Committee (JSC) team is encouraging the use of CheckStyle (in the Eclipse IDE environment) to quickly scan Java code, to locate Java programming standard errors, find inconsistencies, and generally help build program conformance. The benefits of writing quality Java code infused with consistent coding and documentation standards is critical to the efforts of the Department of Veterans Affairs (VA). This document stands for the quality, readability, consistency and maintainability of code development and it applies to all VA Java programmers (including contractors).
    [Show full text]
  • Exceptions and Libraries
    9/7/2016 Exceptions and Libraries RS 9.3, 6.4 Some slides created by Marty Stepp http://www.cs.washington.edu/143/ Edited by Sarah Heckman CSC216: Programming Concepts –Java © NC State CSC216 Faculty 1 Exceptions • exception: An object representing an error or unusual condition. – unchecked exceptions: One that does not have to be handled for the program to compile – checked exception: One that must be handled for the program to compile. • What are some unchecked and checked exceptions? • What may cause unchecked or checked exceptions? • For any checked exception, you must either: –also throw that exception yourself – catch (handle) the exception CSC216: Programming Concepts –Java © NC State CSC216 Faculty 2 1 9/7/2016 Throwing an exception public type name(params) throws type { • throws clause: Keywords on a method's header that states that the method may generate an exception. – You only need to list the checked exceptions for compilation – Good form to list all exceptions (including unchecked exceptions) –Example: public class ReadFile { public static void main(String[] args) throws FileNotFoundException { } "I hereby announce that this method might throw an exception, and the caller must accept the consequences if it happens." CSC216: Programming Concepts –Java © NC State CSC216 Faculty 3 Catching an exception try { statement(s); } catch (ExceptionType name) { code to handle the exception } – The try code executes – at least one statement should potentially cause an exception • A method call that throws an exception – If the exception
    [Show full text]
  • Perspectives on Free and Open Source Software.Pdf
    Perspectives on Free and Open Source Software Perspectives on Free and Open Source Software edited by Joseph Feller, Brian Fitzgerald, Scott A. Hissam, and Karim R. Lakhani The MIT Press Cambridge, Massachusetts London, England © 2005 Massachusetts Institute of Technology All rights reserved. No part of this book may be reproduced in any form by any electronic or mechanical means (including photocopying, recording, or information storage and retrieval) without permission in writing from the publisher. MIT Press books may be purchased at special quantity discounts for business or sales promotional use. For information, please e-mail [email protected] or write to Special Sales Department, The MIT Press, 5 Cambridge Center, Cambridge, MA 02142. This book was set in Stone sans and Stone serif by SNP Best-set Typesetter Ltd., Hong Kong. Printed and bound in the United States of America. Library of Congress Cataloging-in-Publication Data Perspectives on free and open source software / edited by Joseph Feller . [et al.]. p. cm. Includes bibliographical references and index. ISBN 0-262-06246-1 (alk. paper) 1. Shareware (Computer software) 2. Open source software. 3. Computer software—Development. I. Feller, Joseph, 1972– QA76.76.S46P47 2005 005.36—dc22 2004064954 10987654321 My love, thanks and humble apologies go to my very patient and supportive family: Carol, Caelen, Damien, and Dylan. JF Arís as Gaeilge: Buíochas mór le mo chlann, Máire, Pól agus Eimear. Is mór agam an iarracht a rinne sibh ar mo shon. BF With heartfelt warmth, I dedicate this book to my wife, Jacqueline, and my two sons, Derek and Zachery, who bring meaning to everything I do.
    [Show full text]
  • This Hands-On Book Shows Readers Why and How Common Java Development Problems Can Be Solved by Using New Aspect-Oriented Program
    AspectJ Cookbook By Russell Miles Publisher: O'Reilly Pub Date: December 2004 ISBN: 0-596-00654-3 Pages: 354 Table of • Contents • Index • Reviews Reader This hands-on book shows readers why and how common Java • Reviews development problems can be solved by using new Aspect-oriented • Errata programming (AOP) techniques. With a wide variety of code recipes for • Academic solving day-to-day design and coding problems using AOP's unique approach, AspectJ Cookbook demonstrates that AOP is more than just a concept; it's a development process that will benefit users in an immediate and visible manner. AspectJ Cookbook By Russell Miles Publisher: O'Reilly Pub Date: December 2004 ISBN: 0-596-00654-3 Pages: 354 Table of • Contents • Index • Reviews Reader • Reviews • Errata • Academic Copyright Preface Audience About This Book Assumptions This Book Makes Conventions Used in This Book Using the Code Examples We'd Like to Hear from You Safari Enabled Acknowledgments Chapter 1. Aspect Orientation Overview Section 1.1. A Brief History of Aspect Orientation Section 1.2. AspectJ Section 1.3. A Definition of Aspect Orientation Section 1.4. Where to Go for More Information Chapter 2. Getting Started with AspectJ Introduction Recipe 2.1. Installing AspectJ Recipe 2.2. Developing a Simple Aspect Recipe 2.3. Compiling an Aspect and Multiple Java Files Recipe 2.4. Weaving Aspects into Jars Recipe 2.5. Weaving Aspects at Load Time Recipe 2.6. Generating Javadoc Documentation Recipe 2.7. Compiling an AspectJ Project Using Eclipse Recipe 2.8. Selecting the Aspects That Are Woven in a Build Within Eclipse Recipe 2.9.
    [Show full text]
  • JDK 9 Outreach JDK 9 Outreach
    JDK 9 Outreach JDK 9 Outreach JDK 9 Outreach Introduction Caveat Lector JDK 9 Features The Little Things JDK 9 Early Access Builds Look for unrecognized VM options Run jdeps on your code Update your dependencies Cross compilation for older platform versions Testing Your Code JDK 9 changes that may affect your code Added OCSP Stapling for TLS Multi-Release JAR Files Parser API for Nashorn Prepare for v53 class files Prepare JavaFX UI Controls & CSS APIs for Modularization Validate JVM Command-Line Flag Arguments XML Catalogs Platform-Specific Desktop Features Changed Arrays.asList(x).toArray() returns Object[] Create PKCS12 Keystores by Default Disable SHA-1 Certificates Enable GTK 3 on Linux Encapsulate Most Internal APIs HarfBuzz Font-Layout Engine Indify String Concatenation Make G1 the Default Garbage Collector Marlin Graphics Renderer Modular Run-Time Images New Version-String Scheme Unified GC Logging Unified JVM Logging Use CLDR Locale Data by Default UTF-8 Property Files Removed Remove apple script engine code in jdk repository Remove GC Combinations Deprecated in JDK 8 Remove HTTP Proxy implementation from RMI Remove Launch-Time JRE Version Selection Remove java-rmi.exe and java-rmi.cgi Remove the JVM TI hprof Agent Remove the jhat Tool Removed API references to java.awt.peer and java.awt.dnd.peer packages Removed Packer/Unpacker addPropertyChangeListener and removePropertyChangeListener methods Removed LogManager addPropertyChangeListener and removePropertyChangeListener methods Removed com.sun.security.auth.callback.DialogCallbackHandler
    [Show full text]
  • Javafx in Action by Simon Morris
    Covers JavaFX v1.2 IN ACTION Simon Morris SAMPLE CHAPTER MANNING JavaFX in Action by Simon Morris Chapter 1 Copyright 2010 Manning Publications brief contents 1 ■ Welcome to the future: introducing JavaFX 1 2 ■ JavaFX Script data and variables 15 3 ■ JavaFX Scriptcode and structure 46 4 ■ Swing by numbers 79 5 ■ Behind the scene graph 106 6 ■ Moving pictures 132 7 ■ Controls,charts, and storage 165 8 ■ Web services with style 202 9 ■ From app to applet 230 10 ■ Clever graphics and smart phones 270 11 ■ Best of both worlds: using JavaFX from Java 300 appendix A ■ Getting started 315 appendix B ■ JavaFX Script: a quick reference 323 appendix C ■ Not familiar with Java? 343 appendix D ■ JavaFX and the Java platform 350 vii Welcome to the future: introducing JavaFX This chapter covers ■ Reviewing the history of the internet-based application ■ Asking what promise DSLs hold for UIs ■ Looking at JavaFX Script examples ■ Comparing JavaFX to its main rivals “If the only tool you have is a hammer, you tend to see every problem as a nail,” American psychologist Abraham Maslow once observed. Language advocacy is a popular pastime with many programmers, but what many fail to realize is that programming languages are like tools: each is good at some things and next to useless at others. Java, inspired as it was by prior art like C and Smalltalk, sports a solid general-purpose syntax that gets the job done with the minimum of fuss in the majority of cases. Unfortunately, there will always be those areas that, by their very nature, demand something a little more specialized.
    [Show full text]
  • BOF1932-JAX-RS-REST-Services-And-Angular.Js-Too
    JAX-RS and AngularJS Tools for even beer experience Mar0n Mares So4ware developer Oracle September 30, 2014 Copyright © 2014, Oracle and/or its affiliates. All rights reserved. Safe Harbor Statement The following is intended to outline our general product direc0on. It is intended for informaon purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or func0onality, and should not be relied upon in making purchasing decisions. The development, release, and 0ming of any features or func0onality described for Oracle’s products remains at the sole discre0on of Oracle. Copyright © 2014, Oracle and/or its affiliates. All rights reserved. 4 Program Agenda 1 Decide if this BoF is for You 2 JAX-RS and AngularJS 3 Day by day TOI (documentaon) 4 Do not change your API (DTO support) 5 Few more notes Copyright © 2014, Oracle and/or its affiliates. All rights reserved. 5 About this presentaon Primary audience, presentaon style and content • So4ware development team leader – Developer who is responsible for project development phase and final design dessign – Not project manager • We will browse the code – Sources, console, browser – (I have a lot of slides, too) • Series of introduc0on level descrip0on of various tools – Star0ng with JAX-RS and AgularJS – why it well fits together – Demonstraon of other tools – JAVA TOOLS Copyright © 2014, Oracle and/or its affiliates. All rights reserved. 6 About this presentaon Mo@va@on – few lines of philosophy • Java and JavaScript – Same name and so different styles • Stac - dynamic type language • Refactor every day – never refactor – Must cooperate: Accept differences and define gray zone • Java and JavaScript developers – Do you have 2in1 in your team? Good for you but it is probably not true – Find same paerns in gray zone – Leverage from unique style Copyright © 2014, Oracle and/or its affiliates.
    [Show full text]
  • Design of a Jmldoclet for Jmldoc in Openjml
    University of Central Florida STARS Electronic Theses and Dissertations, 2004-2019 2016 Design of a JMLdoclet for JMLdoc in OpenJML Arjun Mitra Reddy Donthala University of Central Florida Part of the Computer Sciences Commons Find similar works at: https://stars.library.ucf.edu/etd University of Central Florida Libraries http://library.ucf.edu This Masters Thesis (Open Access) is brought to you for free and open access by STARS. It has been accepted for inclusion in Electronic Theses and Dissertations, 2004-2019 by an authorized administrator of STARS. For more information, please contact [email protected]. STARS Citation Donthala, Arjun Mitra Reddy, "Design of a JMLdoclet for JMLdoc in OpenJML" (2016). Electronic Theses and Dissertations, 2004-2019. 5132. https://stars.library.ucf.edu/etd/5132 DESIGN OF A JMLDOCLET FOR JMLDOC IN OPENJML by ARJUN MITRA REDDY DONTHALA B.S. GITAM University, 2014 A thesis submitted in partial fulfillment of the requirements for the degree of Master of Science in the Department of Computer Science in the College of Engineering and Computer Science at the University of Central Florida Orlando, Florida Summer Term 2016 © 2016 ARJUN MITRA REDDY DONTHALA ii ABSTRACT The Java Modeling Language (JML) is a behavioral interface specification language designed for specifying Java classes and interfaces. OpenJML is a tool for processing JML specifications of Java programs. To facilitate viewing of these specifications in a user-friendly manner, a tool JMLdoc was created. The JMLdoc tool adds JML specifications to the usual Javadoc documentation. JMLdoc is an enhancement of Javadoc that adds to the Javadoc documentation the JML specifications that are present in the source code.
    [Show full text]
  • Integrations
    Integrations Version 2.9 October 2014 This document applies to Ehcache Version 2.9 and to all subsequent releases. Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions. Copyright © 2014 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. The name Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG and/or Software AG USA Inc. and/or its subsidiaries and/or its affiliates and/or their licensors. Other company and product names mentioned herein may be trademarks of their respective owners. Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located at hp://documentation.softwareag.com/legal/. Use of this software is subject to adherence to Software AG's licensing conditions and terms. These terms are part of the product documentation, located at hp://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s). This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to "License Texts, Copyright Notices and Disclaimers of Third Party Products”. This document is part of the product documentation, located at hp://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s). Document ID: EHC-INT-29-20141015 M Table of Contents Table of Contents Using Ehcache with Hibernate.......................................................................................................5 About Using Ehcache with Hibernate.........................................................................................6 Downloading and Installing Ehcache for Hibernate..................................................................
    [Show full text]
  • Javadoc Tool What For?
    JavaDoc Tool Vishnu Kotrajaras Extraction from Java Documentation What for? • Making HTML documentation – allows you to generate documentation for source files whose code is incomplete or erroneous. – So we can generate documentation before all debugging and troubleshooting is done. – classes you create must either be loaded as an extension or in the Javadoc tool's class path. 1 Default page creation • Basic Content Pages – One class or interface page (classname.html) for each class or interface it is documenting. – One package page (package-summary.html) for each package it is documenting. The Javadoc tool will include any HTML text provided in a file named package.html in the package directory of the source tree. – One overview page (overview-summary.html) for the entire set of packages. This is the front page of the generated document. The Javadoc tool will include any HTML text provided in a file specified with the - overview option. Note that this file is created only if you pass into javadoc two or more package names. • Cross-Reference Pages – One class hierarchy page for the entire set of packages (overview-tree.html). To view this, click on "Overview" in the navigation bar, then click on "Tree". – One class hierarchy page for each package (package- tree.html) To view this, go to a particular package, class or interface page; click "Tree" to display the hierarchy for that package. – One "use" page for each package (package-use.html) and a separate one for each class and interface (class- use/classname.html). Given a class or interface A, its "use" page includes • subclasses of A • fields declared as A • methods that return A • and methods and constructors with parameters of type A.
    [Show full text]
  • IDE Users Guide
    IDE Users Guide Common IDE Tasks BEA Workshop for WebLogic Platform (Workshop for WebLogic) is a full-featured IDE for enterprise application development (SOA, J2EE, web applications). Workshop for WebLogic is based on the Eclipse framework. Topics Included in This Current Release Information: Section ● What's New Tutorial: Getting Started with BEA ● Upgrading to 10.0 Workshop for WebLogic Platform Introductory tutorial that takes you Useful Links: through the basics of the IDE: navigation, features, help, as well as the process of ● Tutorials creating and testing a "Hello, world!" application. ● Tips and Tricks Applications and Projects Other Resources: Description of how to assemble enterprise ● Online Docs applications from projects/modules. ● Dev2Dev Managing Project Dependencies ● Discussion Forums Description of how to set up dependencies between EAR projects and their web and ● Development Blogs EJB/utility projects. Understanding the Build Process Discussion of how to build your files before deployment. Before you Begin: Setting Up the Server Description of how to set up a server for development and testing. Managing Servers Description of how to manage development/testing servers. Deploying, Running, and Debugging Applications Explanation of how to deploy, run and debug enterprise applications. Setting up Logging Discussion of WebLogic Server message logging. file:///F|/depot/dev/src/workshop/product/plugins/com.bea....shop.product.wl.doc/html/ideuserguide/navIDEUserGuide.html (1 of 2)1/26/2007 2:42:51 PM IDE Users Guide Working with Source Control Description of how to check workspaces and projects into source control. Exporting Archives Description of how to export projects as EARs, WARs, or JARs.
    [Show full text]