Easy to Learn Java: Programming Articles, Examples and Tips

Start with Java in a few days with Java Lessons or Lectures

Home

Code Examples

Java Tools

More Java Tools!

Java Forum

All Java Tips

Books

Submit News
Search the site here...
Search...
 

Swing Chapter 25. (Special topics) JavaHelp. Easy for reading, Click here!

Custom Search
Swing Chapter 25. (Special topics) JavaHelp. Easy for reading, Click here!

[ Return to Swing (Book) ]

Page: 4/6 



Previous Page Previous Page (3/6) - Next Page (5/6) Next Page
Subpages: 1. JavaHelp introduction
2. JavaHelp API overview
3. Basic JavaHelp example
4. Adding dialog-style help
5. Customizing the JHelp viewer
5. Creating a custom help view

25.4  Adding dialog-style help

Dialogs in modern applications quite often contain a "Help" button to invoke content-sensitive help for a particular component in that dialog (usually using an altered question mark cursor). In this section we'll show how to add such a feature provided by JavaHelp to the FTP client example we constructed in chapter 13.

Figure 25.2 FTP Client application with help buttons for default and context-sensitive help.

<<file figure25-2.gif>>

Figure 25.3 JavaHelp viewer displaying custom help for our FTP client application.

<<file figure25-3.gif>>

HelpSet file: FTP.hs

see \Chapter25\2\help

<?xml version='1.0' encoding='ISO-8859-1' ?>

<helpset>

   <title>FTP Client Example - Help</title>

   <maps>

     <homeID>top</homeID>

     <mapref location="FTP.jhm"/>

   </maps>

   <view>

     <name>TOC</name>

     <label>Table Of Contents</label>

     <type>javax.help.TOCView</type>

     <data>FTPTOC.xml</data>

   </view>

   <view>

     <name>Index</name>

     <label>Help Index</label>

     <type>javax.help.IndexView</type>

     <data>FTPIndex.xml</data>

   </view>

   <view>

     <name>Search</name>

     <label>Search</label>

     <type>javax.help.SearchView</type>

     <data>JavaHelpSearch</data>

   </view>

</helpset>

Map file: FTP.jhm

see \Chapter25\2\help

<?xml version='1.0' encoding='ISO-8859-1' ?>

<map version="1.0">

  <mapID target="top" url="FTPClient.html" />

  <mapID target="UserName" url="FTPClient.html#UserName" />

  <mapID target="Password" url="FTPClient.html#Password" />

  <mapID target="URL" url="FTPClient.html#URL" />

  <mapID target="File" url="FTPClient.html#File" />

  <mapID target="PutButton" url="FTPClient.html#PutButton" />

  <mapID target="GetButton" url="FTPClient.html#GetButton" />

  <mapID target="FileButton" url="FTPClient.html#FileButton" />

  <mapID target="CloseButton" url="FTPClient.html#CloseButton" />

</map>

TOC file: FTPTOC.xml

see \Chapter25\2\help

<?xml version='1.0' encoding='ISO-8859-1' ?>

<toc version="1.0">

  <tocitem target=top>FTP Client Example - TOC

    <tocitem text="User Name" target="UserName"/>

    <tocitem text="Password" target="Password"/>

    <tocitem text="URL" target="URL"/>

    <tocitem text="File" target="File"/>

    <tocitem text="Put button" target="PutButton"/>

    <tocitem text="Get button" target="GetButton"/>

    <tocitem text="File button" target="FileButton"/>

    <tocitem text="Close button" target="CloseButton"/>

  </tocitem>

</toc>

Index file: FTPIndex.xml

see \Chapter25\2\help

<?xml version='1.0' encoding='ISO-8859-1'  ?>

<index version="1.0">

  <indexitem text="Index">

    <indexitem text="C">

      <indexitem target="CloseButton" text="Close button"/>

    </indexitem>

    <indexitem text="F">

      <indexitem target="File" text="File"/>

      <indexitem target="FileButton" text="File button"/>

    </indexitem>

    <indexitem text="G">

      <indexitem target="GetButton" text="Get button"/>

    </indexitem>

    <indexitem text="P">

      <indexitem target="Password" text="Password"/>

      <indexitem target="PutButton" text="Put button"/>

    </indexitem>

    <indexitem text="U">

      <indexitem target="UserName" text="User Name"/>

      <indexitem target="URL" text="URL"/>

    </indexitem>

  </indexitem>

</index>

The Code: FTPApp.java

see \Chapter25\2

// Unchanged imports from section 13.5

import javax.help.*;

public class FTPApp extends JFrame

{

  // Unchanged code from section 13.5

  protected HelpSet m_hs;

  protected HelpBroker m_hb;

  static final String HELPSETNAME = "Help/FTP.hs";

  public FTPApp() {

    super("FTP Client [Help]");

    createHelp();

    JPanel p = new JPanel();

    p.setLayout(new DialogLayout2(5, 5));

    p.setBorder(new EmptyBorder(5, 5, 5, 5));

    // Unchanged code from section 13.5

    JButton btHelp = new JButton("Help");

    btHelp.setToolTipText("Show help");

    m_hb.enableHelpOnButton(btHelp, "top", null);

    p.add(btHelp);

    btHelp = new JButton(new ImageIcon("onItem.gif"));

    btHelp.setToolTipText("Component help");

    btHelp.addActionListener(

      new CSH.DisplayHelpAfterTracking(m_hb));

    p.add(btHelp);

    CSH.setHelpIDString(m_txtUser,"UserName");

    CSH.setHelpIDString(m_txtPassword,"Password");

    CSH.setHelpIDString(m_txtURL,"URL");

    CSH.setHelpIDString(m_txtFile,"File");

    CSH.setHelpIDString(m_btPut,"PutButton");

    CSH.setHelpIDString(m_btGet,"GetButton");

    CSH.setHelpIDString(m_btFile,"FileButton");

    CSH.setHelpIDString(m_btClose,"CloseButton");

    setSize(520,340);

    setResizable(false);

    setVisible(true);

  }

  protected void createHelp() {

    ClassLoader loader = this.getClass().getClassLoader();

    URL url;

    try {

      url = HelpSet.findHelpSet(loader, HELPSETNAME);

      m_hs = new HelpSet(loader, url);

      m_hb = m_hs.createHelpBroker();

      m_hb.enableHelpKey(getRootPane(), "top", m_hs);

    }

    catch (Exception ex) { ex.printStackTrace(); }

  }

  // Unchanged code from section 13.5

}

Understanding the Code

Class FTPApp

The mechanism of adding help to this application is very similar to that of the previous example. We add IDs to each button and text field component using CSH's setHelpIDString() method, and enable help invocation on the frame's JRootPane using an identical createHelp() method (see previous example).

Two new buttons are added to the button row. The first one is titled "Help". Method enableHelpOnButton() is called on the HelpBroker instance to invoke the display of the default help topic when this button is pressed. The second button receives a predefined ActionListener retrieved with the CSH.DisplayHelpAfterTracking() method. This listener displays a custom question mark cursor and displays the appropriate help topic corresponding to the clicked component. (Note that once a component is clicked and help is shown, the cursor reverts back to normal.)

Running the Code

Figure 25.2 shows our FTP client example with two new buttons to manage help. Press the "Help" button to display the default help topic (which calso can be shown using the F1 key). Try using the content-sensitive help button to bring up a help topic for a particular component, and note the use of a custom cursor.



[ Return to Swing (Book) ]


Top 10 read Java Articles
 Get free "1000 Java Tips eBook"

 Java Calendar and Date: good to know facts and code examples

 Array vs ArrayList vs LinkedList vs Vector: an excellent overview and examples

 How can I convert any Java Object into byte array? And byte array to file object

 The Java Lesson 1: What is Java?

 How do I compare two dates and times, date between dates, time between times and

 Maven vs Ant or Ant vs Maven?

 How to open, read, write, close file(s) in Java? Examples on move, rename and de

 Java Array

 Java: JLabel font and color


[ More in News Section ]
Java Lessons

The Java Lesson 1:
What is Java?
The Java Lesson 2:
Anatomy of a simple Java program
The Java Lesson 3:
Identifiers and primitive data types
The Java Lesson 4:
Variables, constants, and literals
The Java Lesson 5:
Arithmetic operations, conversions, and casts
The Java Lesson 6:
Boolean expressions and operations
The Java Lesson 7:
Bitwise operations
The Java Lesson 8:
Flow control with if and else
The Java Lesson 9:
switch statements
The Java Lesson 10:
for, while, and do-while statements
The Java Lesson 11:
Using break and continue
The Java Lesson 12:
Class methods and how they are called
The Java Lesson 13:
Using the Math class
The Java Lesson 14:
Creating and calling custom class methods
The Java Lesson 15:
Overloading class methods
The Java Lesson 16:
An introduction to objects and object references
The Java Lesson 17:
The String class
The Java Lesson 18:
The StringBuffer class
The Java Lesson 19:
Initializing and processing arrays of primitives
The Java Lesson 20:
Initializing and processing arrays of objects
The Java Lesson 23:
Inheritance and overriding inherited methods
The Java Lesson 24:
abstract classes and polymorphism
The Java Lesson 25:
Interfaces, instanceof, and object conversion and casting
The Java Lesson 26:
Introduction to graphical programming and the java.awt packa
The Java Lesson 27:
The Component class
The Java Lesson 28:
Containers and simple layout managers
The Java Lesson 29:
The Color and Font classes
The Java Lesson 30:
Drawing geometric shapes
The Java Lesson 31:
Choice, List, and Checkbox controls
The Java Lesson 32:
Using the Scrollbar graphical control
The Java Lesson 33:
Menus and submenus
The Java Lesson 34:
An introduction to applets and the Applet class
The Java Lesson 35:
Essential HTML to launch an applet and pass it parameters
The Java Lesson 36:
Mouse event processing
Java Lesson 37:
Menus and submenus
Java Lesson 38:
The WindowListener interface and the WindowAdapter class
Java Lesson 39:
An introduction to GridBagLayout
Java Lesson 40:
An introduction to the Java Collections API
Java Lesson 41:
Exception handling with try, catch, and finally blocks
Java Lesson 42:
Claiming and throwing exceptions
Java Lesson 43:
Multithreading, the Thread class, and the Runnable interface
Java Lesson 44:
An introduction to I/O and the File and FileDialog classes
Java Lesson 45:
Low-level and high-level stream classes
Java Lesson 46:
Using the RandomAccessFile class
Java Lessons by
Joh Huhtala: Update

Latest articles
 Java Profiler JProbe to Resolve Performance Problems Faster

 SSL with GlassFish v2, page 5

 SSL with GlassFish v2, page 4

 SSL with GlassFish v2, page 3

 SSL with GlassFish v2, page 2

 The Java Lesson 2: Anatomy of a simple Java program, page 2

 New site about Java for robots and robotics: both software and hardware.

 Exceptions -III: What's an exception and why do I care?

 Exceptions -II: What's an exception and why do I care?

 Exceptions: What's an exception and why do I care?

 Double your Java code quality in 10 minutes, here is receipt

 Murach's Java Servlets and JSP

 How to get ascii code from a char in Java?

 Can we just try without catch? Yes!

 Make Tomcat page load faster

 Make your Tomcat More secure - limit network address for certain IP addresses

 New Java book online starts now here...

 Implementing RESTful Web Services in Java

 Firefox trimming from 1 GB to 40 Mb with many tabs opened

 SSL with GlassFish v2

 My request to replublish Tech Tips

 Search JavaFAQ.nu site here

 New Advanced Installer for Java 6.0 brings XML updates and imports 3rd party MSI

 EJB programming restrictions

 Maven vs Ant or Ant vs Maven?

 Why Java does not use default value which it should?

 How to unsign signed bytes in Java - your guide is here

 The Java Lesson 3: Identifiers and primitive data types. Page 2

 The Java Lesson 7: Bitwise operations with good examples, click here! Page 4

 The Java Lesson 7: Bitwise operations with good examples, click here! Page 3


[ More in News Section ]


Home Code Examples Java Forum All Java Tips Books Submit News, Code... Search... Offshore Software Tech Doodling

RSS feed Java FAQ RSS feed Java FAQ News     

    RSS feed Java Forums RSS feed Java Forums

All logos and trademarks in this site are property of their respective owner. The comments are property of their posters, all the rest 1999-2006 by Java FAQs Daily Tips.

Interactive software released under GNU GPL, Code Credits, Privacy Policy