La ayuda en Java

Estos días estoy intentando terminar la aplicación Ferraplan, y me ha parecido muy interesante añadir una ayuda, con la idea de mejorar la funcionalidad de la aplicación y hacerla mas accesible al usuario. Con esta idea, estuve buceando en internet a ver cual era el sistema más sencillo, y en estas me encontré con JavaHelp. Con JavaHelp se pueden crear las ventanas típicas de ayuda de las aplicaciones informáticas, en las que sale en el lado izquierdo un panel con varias pestañas: índice de contenidos, búsqueda, temas favoritos, índice alfabético, etc. En el lado derecho sale el texto de la ayuda.

Las ventanas de ayuda pueden lanzarse directamente con la pulsación de botones en la aplicación, o bien por medio de la pulsación de la tecla F1, mostrando la ayuda correspondiente a la ventana sobre la que estamos trabajando.

Las ventanas de ayuda de JavaHelp se configuran por medio de varios ficheros en formato XML. Los textos de ayuda que se quieran mostrar se escribirán en ficheros con formato HTML.

JavaHelp no se incluye en la JDK, ni en la JRE, sino que debe conseguirse como un paquete externo.

Con JavaHelp, desarrollas por completo la ayuda, y solo hay que preparar las hojas html de cada uno de los items de ayuda e incorporarlos y esta aplicación se encarga de realizar el resto. Para incorporarlo a la ayuda, simplemente hay que introducir el siguiente testo:

[java]

try {
ClassLoader objClassLoader = Ferraplan.class.getClassLoader();
String strHelpFileName = «Ferraplan.hs»;
URL hsURL = HelpSet.findHelpSet(objClassLoader, strHelpFileName);
HelpSet helpset = new HelpSet(getClass().getClassLoader(), hsURL);
HelpBroker hb = helpset.createHelpBroker();
hb.enableHelpOnButton(this.jMenuItemAyuda, «top», helpset);
hb.enableHelpKey(this,»top», helpset);
}catch (HelpSetException ex) {
ErrorDialog.manejaError(ex);
}

[/java]

1 comentario en “La ayuda en Java

  1. NA
    Nacho P. hace 14 años

    ¡Felicidades por el tutorial!

    Yo también estoy intentando crear una ayuda para mi programa (una aplicación de revisión de traducciones) y me encuentro con el problema de que aunque he instalado javahelp con:

    sudo apt-get install javahelp2

    A la hora de incluir la línea en el programa para utilizar la ayuda:

    import javax.help.*;

    Me aparece un error avisándome de que el paquete no existe, ¿sabes dónde podría estar el problema y cómo solucionarlo?

    ¡Muchas gracias!

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *