java

位置:IT落伍者 >> java >> 浏览文章

理解JavaHelp结构的好处


发布日期:2018年02月06日
 
理解JavaHelp结构的好处
Sun微系统的JavaHelp系统是一种应用程序帮助技术它可以在所有支持Java的平台和浏览器中运行??只要它是一个纯粹的Java产品通过applet和Java应用程序在其他环境下比如在互联网或企业内部互联网中它是理想的使用对象在本文中我将回顾JavaHelp的主要作用并阐明它的简单使用方法

优点

JavaHelp通过使用Java基础类(JFC)软件组件来实现这使得开发户自定义界面和功能变得灵活轻松您可以轻而易举地将应用程序的帮助信息嵌入到应用程序之中或者嵌入到另一个独立的窗口里JFC还具有通过自定义导航控件拓展帮助功能的能力

JavaHelp使动态更新帮助数据或将其存储在一个便利的位置变得简单易行不管是在客户端还是服务器端内容窗口使用HTML格式显示话题使内容设计变得简单标准导航提供内容表单(TOC)索引和全文搜索(TOC和索引都遵循WC标准

JavaHelpDataSheet提供以下信息TOC提供层叠式和扩展式话题展示无限量等级层次和多重TOC的合并TOC与内容阅读器同步显示也就是说显示的话题在TOC中被突出索引支持多重索引的合并全文搜索被设计得很灵活并且可以配置搜索引擎也可置于用户或服务器中的任一方

帮助内容和搜索引擎被压缩成一个使用标准JAR格式的单个文件尽管为了使存储和访问更具灵活性推荐将所有文件压缩成一个单独的文件但是您仍然可以将所有文件以扩展的格式保存在目录中您可以在自定义编写的导航器搜索引擎标准JavaHelp阅读器或在任何HTML显示中包括标准Web浏览器中查看和导航内容

JavaHelpAPI提供一个上下文敏感帮助和ID映射的机制您可以将多重组件的帮助信息用JavaHelpAPI合并这样用户就看到一个单独的完整文档合并机制可以应用于TOC索引和搜索数据库

特性

JavaHelp有两个主要版本最早支持JavaHelp的Java版本是JSE因此您无需担心自己的代码是否支持JavaHelpJavaHelp系统由一个特性完整的可扩展的规范API以及一个参考执行组成

标准JavaHelp系统的主窗口有三个显示窗口在您退出窗口时并未被关闭依然可配置在默认情况下一个主要窗口有以下三个窗格工具栏导航窗口和内容窗口见图表

用户可以应用多种方式通过内部应用程序调用在线帮助例如当一个用户从帮助菜单中选择一项或在应用程序GUI中点击帮助按钮JavaHelp系统提供一个简便的界面通过这个界面应用程序要求话题的ID得以显示然后JavaHelp系统将话题ID与相应的URL相连接并将其显示出来

ID被映射到一个被称作映射文件的JavaHelp系统元数据文件中的URL上例如当为文件选择对话框编码时开发人员要求话题IDfc_help在当对话框底部的帮助按钮被点击时显示在映射文件中IDfc_help被定义为名为l的文件使用以下XML句法

<mapIDtarget=fc_helpurl=html/help/l/>

将文件名(或URL)的规范从程序代码分离为内容的作者提供了控制与话题ID相关的信息的自由

工具提示是一个显示给用户的简短信息当光标停留在一个按钮上的时间间隔长于阈值时它就会出现您还可以将工具提示信息纳入JavaHelp系统数据

JavaHelp系统数据具有调用在线帮助的能力能够在应用程序GUI中描述图形组件用户操纵激活语境敏感帮助然后将组件以问题形式特定化与组件相联系的ID被显示您可以从TOC索引导航或主要窗口的内容窗格中显示帮助话题

轻型组件

轻型组件能够向帮助话题添加功能这些组件与Java的applet相似但它们的加载和执行更为迅速一个帮助的创作者能够使用已经在JavaHelp中执行的轻型组件这个组件执行弹出窗口和次级窗口在HTML话题文件中使用轻型组件您可以使用HTML<object>标记正如列表A中的例子所显示的

在例子中弹出的对象包括文件/topicB/l用户点击的对象(viewerActivator)是个链接窗口类型属于弹出型窗口大小为x用户在链接中看到的内容是Clickhere(点击这里)

Java开发商还可以创造新的轻型组件例如这样的组件可能为帮助话题添加动画和多媒体功能

要求抽象查看的轻型组件必须执行javaxjavahelpimplViewAwareComponen这些组件执行setViewData()方法这个组件能够根据抽象查看中的信息决定它所执行的环境(注意要访问抽象查看您应该使用JavaHelpAPI)在列表B中文档对象下面的编码片断来自于抽象查看

需要更多关于创造Java轻型组件的信息请参阅相关文件

JavaHelp编写工具

有很多通过商业途径可以得到的编写工具能够为您的应用程序编写和维护一个完美的帮助系统最有名的三个是SoftwareGmbh的HelenSolutionsoft的HelpBreeze和Pivotonic的JawaHelpAuthor所有这些第三方产品都支持Java和Java标准需要更多关于编写工具的信息请参阅Sun的帮助编写工具页面

试试看吧

如果JavaHelp听起来像是一个您认为您的用户和伙伴开发商都喜欢的系统的话那么从SunMicrosystem公司的网站上立刻下载吧这个地址提供了安装过程所需要的所有信息

上一篇:Java中数组的返回

下一篇:JSF ( JavaServer Faces ) 介绍