Crear Ventanas de Ayuda con JavaHelp

Necesitas crear ventanas de Ayuda para tus Aplicaciones en Java? Conoce la Forma mas Sencilla y Completa de hacerlo, conozcamos JavaHelp. JavaHelp es una expansion de Java para facilitar el diseño e implementacion de Ventanas de Ayuda para aplicaciones en este Lenguaje de Programacion, esto se hace a traves de Archivos XML y HTML que son los que se mostraran al Usuario. JavaHelp lanzara la Ventana de Ayuda al pulsar el boton que especifiquemos o al presionar F1. Vamos entonces a ver como crear ventanas de Ayuda con JavaHelp…

Requerimientos

JavaHelp
Algo de HTML (No Mucho 😉 )

Escenario

Antes de Comenzar a Configurar #JavaHelp vamos a ver nuestro escenario. Tenemos una Aplicacion que importa la libreria JavaHelp ( descargada del link anterior ) y compuesta por 2 clases con la siguiente estructura

Tambien tenemos creada una carpeta llamada «javahelp» y dentro otra llamada «html» todo esto en nuestra raiz de nuestro proyecto

esto nos servira para organizarnos un poquito mejor 😉

Agregando JavaHelp

Ahora que conocemos la estructura de nuestro proyecto de ejemplo y hemos creado las carpetas necesarias vamos a el codigo 😀 En nuestra clase Main unicamente llamamos a nuestra clase ventana, que es un JFrame que sera obviamente nuestra ventana grafica, ahora dentro de esta clase ventana tenemos solo lo basico para mostrar una ventana veamos como esta hasta ahora


public class Ventana extends JFrame{    
    JMenuBar barra;
    JMenu menu;
    JMenuItem ayuda;
    
    public Ventana(){
        setTitle("Crear Ventanas de Ayuda con JavaHelp");
        setLocation(400, 200);
        setDefaultCloseOperation(EXIT_ON_CLOSE);
        setSize(600,400);
        setResizable(true);
        setVisible(true);    
        
        initMenus();
    }
	
	private void initMenus(){
        barra = new JMenuBar();
        menu = new JMenu("Menu");
        ayuda = new JMenuItem("Ayuda");
        
        menu.add(ayuda);
        barra.add(menu);
        setJMenuBar(barra);
    }
}

Si, es todo 😀 puedes ejecutar tu proyecto para ver lo simple que es 😉

Ahora crearemos un metodo llamado «init();» que llamaremos en el contructor de nuestra ventana despues de el metodo «initMenus();»


private void init() {
	File archivo = new File("javahelp/help_set.hs");
	URL hsURL;
	try {
		hsURL = archivo.toURI().toURL();
		//Leemos el HelpSet de COnfiguracion
		HelpSet helpset = new HelpSet(getClass().getClassLoader(),hsURL);
		HelpBroker helpbroker = helpset.createHelpBroker();
		
		//añadimos la ayuda a los botones
		//Al pulsar sobre el boton del menu ayuda se muestra la ayuda
		helpbroker.enableHelpOnButton(ayuda, "aplicacion", helpset);
		//Al presionar F1 sobre la ventana se muestra la ayuda
		helpbroker.enableHelpKey(getContentPane(), "ventana_principal", helpset);
		
	} catch (Exception ex) {
		Logger.getLogger(Ventana.class.getName()).log(Level.SEVERE, null, ex);
	}
}

Como puedes ver necesitamos un archivo help_set.hs dentro de nuestra carpeta javahelp 😯 vamos a ver como crearlo, este archivo es un simple archivo xml que se guarda con extension hs (help set) tendra el siguiente contenido:

Nota: He tenido un problema al agregar el codigo faltante, estoy trabajando en agregarlo de nuevo, una disculpa.