JavaFX

Como librería de usuario en Eclipse

Una vez descargado el SDK de JavaFX debemos integrarlo en Eclipse como una librería de usuario. Para ello, en Eclipse, debemos crear una nueva librería de usuario. Elegimos la opción Window|Preferences||Java|Build Path|User Libraries y elegimos la opción New y le damos un nombre apropiado.

Cuando ya hemos creado la librería, elegimos la opción Add External JARs... y añadimos todos los ficheros .jar situados en la localización donde hemos descargado el SDK bajo la carpeta lib.

Hecho esto creamos un nuevo proyecto java y a éste le añadimos la librería de usuario que hemos creado anteriormente para lo que utilizaremos la opción Build Path|Add Libraries... del menú contextual que nos aparece a nivel de proyecto. Elegimos User Library y la librería anteriormente creada.

Damos contenido al proyecto a modo de primer ejemplo, para lo que puedes descargar y añadir los siguientes ficheros: Main.java, panelPrincial.fxml y Controlador.java.

Si intentamos ejecutar el fichero Main.java desde Eclipse como Java Application obtendremos este error en el IDE.

Esto es debido a que la VM de Java comprueba que la clase a la que pertenece el método main que se está ejecutando no extienda de Application. Para solucionarlo tenemos dos opciones:

1. Añadir los módulos necesarios como  argumentos de la VM de Java (--module-path ${project_classpath} --add-modules javafx.controls,javafx.fxml):
   
2. Crear una clase lanzadora que no extienda de Application (LanzadoraMain.java):
   

Llegados a este punto debemos ser capaces de ejecutar la clase principal, o la clase lanzadora, dependiendo de la opción elegida y veremos una salida parecida a la mostrada.

Esta opción tiene el inconveniente que no es portable ya que la librería la hemos añadido al IDE pero está localizada localmente. Pero es un buen comienzo para poder empezar a practicar.

Utilizando el plugin e(fx)clipse

Otra opción es utilizar el plugin de Eclipse para trabajar con Java FX: e(fx)clipse.

Este plugin lo podemos instalar accediendo al mercado de eclipse mediante la opción Help|Eclipse Marketplace...  buscamos e(fx)clipse y lo instalamos normalmente como cualquier otro plugin.

Una vez hecho esto debemos configurar correctamente el camino al SDK y así que este plugin sea capaz de localizarlo y añadirlo automáticamente a los proyectos que creemos usándolo. Para ello debemos acceder a la opción Window|Preferences|JavaFX e indicar la localización donde hemos descargado el SDK de JavaFX (tiene una primera opción que por ahora obviaremos y de la que hablaremos más adelante) en la segunda opción etiquetada como JavaFX 11+ SDK.

Ahora crearemos un proyecto utilizando el plugin recién instalado.

Nos creará un esqueleto de proyecto (en el que simplemente he cambiado que el lenguaje utilizado sea FXML) tal el como muestra su estructura y cuya ejecución sería la mostrada.

La única ventaja que tiene utilizar este plugin es que añade automáticamente el SDK de Java FX y también los argumentos adecuados a la VM para poder ejecutarlo. Al igual que en la opción anterior nos encontramos con una opción, que por si sola, no es portable

Utilizando gradle como gestor de dependencias

Por último podemos utilizar gradle para gestionar las dependencias y ayudarnos en el empaquetado.

Para ello creamos un nuevo proyecto gradle.

Sustituimos el fichero build.gradle por el que muestro a continuación. En él indicamos que queremos utilizar el plugin de gradle para JavaFX y los módulos a cargar. También se indica quién será la clase principal a la hora de ejecutarlo y cómo se empaquetará el fichero jar y qué clase se indicará en el fichero de manifiestro como clase principal.

plugins {
    id 'application'
    id 'org.openjfx.javafxplugin' version '0.0.13'
}

repositories {
    mavenCentral()
}

dependencies {
    // Depenedencias del proyecto
}

javafx {
    version = "17"
    modules = [ 'javafx.controls', 'javafx.fxml' ]
}

mainClassName = 'pruebajavafxgradle.Main'

jar {
	manifest {
		attributes 'Main-Class': 'pruebajavafxgradle.LanzadoraMain'
	}
	from {
		configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
	}
}

Creamos la estructura que se muestra con los siguientes ficheros (es muy parecido al ejemplo utilizando la primera solución): Main.java, LanzadoraMain.java, Controlador.java y panelPrincipal.fxml. Refrescamos el proyecto gradle para que se descargue las librerías.

Ahora podremos ejecutar la clase LanzadoraMain desde el IDE o bien podremos utilizar gradle para ello.

Si te das cuenta, en este ejemplo hemos colocado el fichero .fxml en otro directorio aunque bajo el mismo paquete. Esta es lo forma correcta de trabajar con recursos para que luego funcione todo correctamente. A veces es recomendable estructurar los recursos en diferentes paquetes: imagenes, vistas (con los ficheros .fxml), estilo (con los ficheros .css), etc. En este caso lo mejor sería utilizar una interfaz marcadora a la altura del paquete con los demás subpaquetes y utilizar ésta para acceder a ese paquete ya que con el método getResource no podemos utilizar el .. ni el . para navegar por los paquetes.

De esta forma podríamos localizar un recurso fácilmente desde cualquier otro paquete y que nos funcionase tanto en el IDE como en el fichero empaquetado jar. Por ejemplo:

	...
	FXMLLoader cargadorVentanaPrincipal = new FXMLLoader(LocalizadorRecursos.class.getResource("vistas/VentanaPrincipal.fxml"));
	...
	escena.getStylesheets().add(LocalizadorRecursos.class.getResource("estilos/estilos.css").toExternalForm());

Lo explicado aquí se hizo con una versión del plugin de gradle para Eclipse anterior y con JavaFX 11. Aunque todo es correcto, ahora la versión adecuada a utilizar es la 17 (última LTS a día de hoy), por eso ya he actualizado el build.gradle en el código anterior, aunque no he actualizado los pantallazos.

Ahora el plugin de gradle para elicpse genera una estructura algo diferente y es más tedioso acomodarlo a como lo hemos explicado, por lo que he creado un repositorio en github con el esqueleto y con las instrucciones para adecuarlo a tus necesidades.

Repositorio GitHub con el esqueto de proyecto gradle y las dependencias de JavaFX