PDF de programación - Tutorial para escribir un pequeño plugin para jEdit

Tutorial para escribir un pequeño

plugin para jEdit

Jairo Martínez

Tutorial para escribir un pequeño plugin para jEdit
por Jairo Martínez

Este documento se cede al dominio público.

Historial de revisiones
Revisión 1.0 1 Junio 2002 Revised by: jm

Revisión 1.1 10 de Junio Revised by: jid

Revisión 1.2 12 de Junio Revised by: jm

Tabla de contenidos

1. Aspectos básicos de Jedit.......................................................................................................................1
1.1. ¿Qué es Jedit?..............................................................................................................................1
1.2. Requisitos mínimos.....................................................................................................................1
1.3. Licencia.......................................................................................................................................2
1.4. Descargar el programa desde Internet y obtener información adicional.....................................2
1.5. Explicación de la arquitectura de jEdit .......................................................................................2
2. Creación de un plugin básico ................................................................................................................4
2.1. ¿Qué es un plugin?......................................................................................................................4
2.2. Plugin Hello World!....................................................................................................................4
2.2.1. Escribiendo la clase principal del plugin........................................................................5
2.2.2. Escribiendo la clase HelloWorld..................................................................................6
2.2.3. Recursos requeridos por el plugin ..................................................................................7
2.2.4. Compilando el plugin .....................................................................................................8
2.2.5. Empaquetar en un archivo JAR ......................................................................................8
2.2.6. Ubicar el archivo JAR.....................................................................................................9
2.2.7. Resultado final ................................................................................................................9
3. Agregando funcionalidad al plugin ....................................................................................................11
3.1. Modificar la clase HelloWorld ...............................................................................................11
3.2. Creación de la clase WizardManager......................................................................................12
3.3. Creación de la clase HelloWorldPanel1 ...............................................................................13
3.4. Creación de la clase HelloWorldPanel2 ...............................................................................13
3.5. Creación de la clase HelloWorldPanel3 ...............................................................................15
A. ..............................................................................................................................................................16
A.1. Listado de archivos del plugin Hello World .............................................................................16
A.1.1. Archivo HelloWorldPlugin.java..........................................................................16
A.1.2. Archivo HelloWorld.java.......................................................................................16
A.1.3. Archivo actions.xml................................................................................................17
A.1.4. Archivo HelloWorld.props.....................................................................................17
A.2. Listado de archivos del plugin Hello World modificado para agregarle mayor funcionalidad 18
A.2.1. Archivo HelloWorld.java.......................................................................................18
A.2.2. Archivo WizardManager.java ................................................................................18
A.2.3. Archivo HelloWorldPanel1.java..........................................................................19
A.2.4. Archivo HelloWorldPane2.java ............................................................................21
A.2.5. Archivo HelloWorldPane3.java ............................................................................24

i

Capítulo 1. Aspectos básicos de Jedit

1.1. ¿Qué es Jedit?

jEdit es un editor de texto orientado hacia programadores y escrito en Java. Fue desarrollado por Slava
Pestov y otros.
Sus características principales son :

•

•

•

Fácil de usar, extremadamente configurable y posee un amplio conjunto de opciones, dentro de las que
se encuentra el coloreado de sintaxis para 70 lenguajes, tabulación automática, ilimitado
deshacer/rehacer, entre muchas otras.

Utiliza BeanShell, como lenguaje de scripting que permite el desarrollo de macros para jEdit. Pocos
macros son incluidos con jEdit; sin embargo se pueden encontrar muchos más en la dirección de
Internet http://community.jedit.org (http://community.jedit.org)

Soporta plugins. Mas de 50 plugins estan actualmente disponibles para automatizar un amplio rango
de tareas. Los plugins pueden ser descargados de Internet y instalados mediante el "plugin manager",
el cual viene incluido con jEdit. Para encontrar más información sobre los plugins de jEdit puede
consultar en esta dirección de internet http://plugins.jedit.org (http://plugins.jedit.org)

Las siguientes son algunas vistas de pantalla de jEdit corriendo sobre diferentes plataformas:

Windows

jEdit corriendo sobre Windows
Linux

jEdit corriendo sobre Linux

1

1.2. Requisitos mínimos

Capítulo 1. Aspectos básicos de Jedit

jEdit requiere Java 2 (o Java 1.1 con Swing 1.1). La versión de Java recomendada para utilizar jEdit es
Java 2 versión 1.3.

1.3. Licencia

jEdit es software libre, por lo que se da la libertad de distribuirlo bajo los términos de la Licencia Publica
General GNU (la versión 2 o superiores).

Con respecto a los plugins disponibles para jEdit, a menos que esté especificado de manera diferente en
la documentación, estos se encuentran licenciados para uso y distribución bajo los términos de la
Licencia Publica General GNU (versión 2 o superiores).

1.4. Descargar el programa desde Internet y obtener
información adicional

Para descargar el programa desde internet y encontrar información detallada sobre los diferentes
aspectos del programa (incluyendo su código fuente) puede dirigirse a la siguiente dirección de internet:
http://www.jedit.org (http://www.jedit.org).

1.5. Explicación de la arquitectura de jEdit

jEdit es una aplicación monousuario que trabaja de manera local. Sin embargo, cuenta con algunos
servicios para ser utilizados sobre una conexión de red como lo son el descargar plugins y realizar
transferencias de archivos mediante un plugin para manejar FTP.

Para desarrollar macros o plugins para jEdit es necesario conocer al API (aplication programmer
interface) que se incluye con la aplicación. Esta está conformada por:

•

•

Comandos de BeanShell

Clases generales de jEdit

2

•

Clases de EditBus

Capítulo 1. Aspectos básicos de Jedit

Los comandos de BeanShell sólo pueden ser usados por las macros. Las clases generales de jEdit son
usadas tanto para el desarrollo de macros como para el de plugins. Las clases de EditBus cubren el
manejo del sistema de mensajes EditBus, el cual es utilizado principalmente por los plugins.

Para consultar información detallada sobre el API de jEdit puede consultar los documentos de ayuda de
jEdit, a los cuales puede acceder mediante el menú de ayuda de jEdit

3

Capítulo 2. Creación de un plugin básico

2.1. ¿Qué es un plugin?

Un plugin es un programa adicional que puede ser añadido a una aplicación para aumentar la
funcionalidad de esta. Este programa adicional es cargado y corrido por la aplicación principal.

Al igual que jEdit, sus plugin son escritos primordialmente en Java. Para escribir en plugin aunque se
requiere cierto conocimiento del lenguaje, no se necesita ser un experto en Java. Si usted puede escribir
una aplicación útil en Java, usted puede escribir un plugin.

A continuación, desarrollaremos un pequeño plugin con el objetivo de ilustrar las aspectos básicos que
debe tener un plugin desarrollado para jEdit.
Para escribir su primer plugin, usted necesitará:

•

•

Java 2, Standard Edition. (se recomienda la versión 1.3)

jEdit (ultima versión estable en la fecha de escritura de este documento : 4.0). Se puede descargar del
sitio: http://www..jedit.org (http://www.jedit.org)

Tambien es recomendable utilizar alguna herramienta que permita desarrollar aplicaciones para Java de
manera rápida y eficiente, como por ejemplo JBuilder. Sin embargo, esto no es un requisito. Se pueden
desarrollar los diferentes archivos mediante el uso de un editor de texto como emacs, notepad, editplus o
el mismo jEdit.

2.2. Plugin Hello World!

Desarrollaremos un plugin bastante sencillo, en donde se muestran las características mínimas que debe
tener un plugin para jEdit. Este plugin tendrá como única función mostrar en un cuadro de dialogo la
frase "Hello World !"

Los pasos que se seguiran para desarrollar el plugin son los siguientes:

1.

4

Escribir la clase principal del plugin, la cual llevará el nombre de HelloWorldPlugin

Capítulo 2. Creación de un plugin básico

2.

3.

4.

5.

6.

Escribir la clase encargada de la visualización del plugin, a la que llamaremos HelloWorld

Desarrollar los archivos donde se encuentran los recursos a utilizar por el plugin

Compilar los archivos que contienen el cód