Pasando parámetros JavaFX FXML

Resuelto Alvaro asked hace 11 años • 10 respuestas

¿Cómo puedo pasar parámetros a una ventana secundaria en javafx? ¿Existe alguna forma de comunicarse con el controlador correspondiente?

Por ejemplo: el usuario elige un cliente de TableViewy se abre una nueva ventana que muestra la información del cliente.

Stage newStage = new Stage();
try 
{
    AnchorPane page = (AnchorPane) FXMLLoader.load(HectorGestion.class.getResource(fxmlResource));
    Scene scene = new Scene(page);
    newStage.setScene(scene);
    newStage.setTitle(windowTitle);
    newStage.setResizable(isResizable);
    if(showRightAway) 
    {
        newStage.show();
    }
}

newStagesería la nueva ventana. El problema es que no puedo encontrar una manera de decirle al controlador dónde buscar la información del cliente (pasando la identificación como parámetro).

¿Algunas ideas?

Alvaro avatar Jan 07 '13 06:01 Alvaro
Aceptado

Usando MVC

La mayor parte de esta respuesta se centra en una llamada directa para pasar un parámetro de una clase que llama al controlador.

Si, en cambio, desea desacoplar la persona que llama y el controlador y utilizar una arquitectura más general que incluya una clase de modelo con propiedades configurables y escuchables para lograr la comunicación entre controladores, consulte la siguiente descripción general básica:

  • Aplicando MVC con JavaFx

Enfoque recomendado

Esta respuesta enumera diferentes mecanismos para pasar parámetros a los controladores FXML.

Para aplicaciones pequeñas, recomiendo pasar parámetros directamente desde la persona que llama al controlador; es simple, directo y no requiere marcos adicionales.

Para aplicaciones más grandes y complicadas, valdría la pena investigar si desea utilizar mecanismos de inyección de dependencia o bus de eventos dentro de su aplicación.

Pasar parámetros directamente desde el llamante al controlador

Pase datos personalizados a un controlador FXML recuperando el controlador de la instancia del cargador FXML y llamando a un método en el controlador para inicializarlo con los valores de datos requeridos.

Algo como el siguiente código:

public Stage showCustomerDialog(Customer customer) {
  FXMLLoader loader = new FXMLLoader(
    getClass().getResource(
      "customerDialog.fxml"
    )
  );

  Stage stage = new Stage(StageStyle.DECORATED);
  stage.setScene(
    new Scene(loader.load())
  );

  CustomerDialogController controller = loader.getController();
  controller.initData(customer);

  stage.show();

  return stage;
}

...

class CustomerDialogController {
  @FXML private Label customerName;
  void initialize() {}
  void initData(Customer customer) {
    customerName.setText(customer.getName());
  }
}

Se construye un nuevo FXMLLoader como se muestra en el código de muestra, es decir new FXMLLoader(location). La ubicación es una URL y puede generar dicha URL a partir de un recurso FXML de la siguiente manera:

new FXMLLoader(getClass().getResource("sample.fxml"));

Tenga cuidado de NO utilizar una función de carga estática en FXMLLoader, o no podrá obtener su controlador desde su instancia de cargador.

Las propias instancias de FXMLLoader nunca saben nada sobre los objetos de dominio. No pasa directamente objetos de dominio específicos de la aplicación al constructor FXMLLoader, sino que:

  1. Construya un FXMLLoader basado en el marcado fxml en una ubicación específica
  2. Obtenga un controlador de la instancia de FXMLLoader.
  3. Invoca métodos en el controlador recuperado para proporcionarle referencias a los objetos del dominio.

Este blog (de otro escritor) proporciona un ejemplo alternativo, pero similar .

Configuración de un controlador en FXMLLoader

CustomerDialogController dialogController = 
    new CustomerDialogController(param1, param2);

FXMLLoader loader = new FXMLLoader(
    getClass().getResource(
        "customerDialog.fxml"
    )
);
loader.setController(dialogController);

Pane mainPane = loader.load();

Puede construir un nuevo controlador en código, pasando cualquier parámetro que desee de la persona que llama al constructor del controlador. Una vez que haya construido un controlador, puede configurarlo en una instancia de FXMLLoader antes de invocar el método load() de instancia .

Para configurar un controlador en un cargador (en JavaFX 2.x), NO PUEDE definir un fx:controlleratributo en su archivo fxml.

Debido a la limitación de la fx:controllerdefinición en FXML, personalmente prefiero obtener el controlador del FXMLLoader en lugar de configurar el controlador en el FXMLLoader.

Hacer que el controlador recupere parámetros de un método estático externo

Este método se ejemplifica en la respuesta de Sergey a Javafx 2.0 How-to Application.getParameters() en un archivo Controller.java .

Usar inyección de dependencia

FXMLLoader admite sistemas de inyección de dependencia como Guice, Spring o Java EE CDI al permitirle configurar una fábrica de controladores personalizada en FXMLLoader. Esto proporciona una devolución de llamada que puede utilizar para crear la instancia del controlador con valores dependientes inyectados por el sistema de inyección de dependencia respectivo.

En la respuesta a:

  • Agregar inyección de dependencia de Spring en JavaFX (repositorio JPA, servicio)

Un enfoque de inyección de dependencia realmente agradable y limpio se ejemplifica en el marco afterburner.fx con una aplicación de muestra de air-hacks que lo utiliza. afterburner.fx se basa en JEE6 javax.inject para realizar la inyección de dependencia.

Utilice un bus de eventos

Greg Brown, el creador e implementador de la especificación FXML original, a menudo sugiere considerar el uso de un bus de eventos, como Guava EventBus , para la comunicación entre controladores instanciados FXML y otra lógica de aplicación.

EventBus es una API de publicación/suscripción simple pero potente con anotaciones que permite a los POJO comunicarse entre sí en cualquier lugar de una JVM sin tener que consultarse entre sí.

Preguntas y respuestas de seguimiento

En el primer método, ¿por qué devuelves Stage? El método también puede ser nulo porque ya estás dando el comando show(); justo antes de la etapa de regreso;. ¿Cómo se planifica el uso al devolver el escenario?

Es una solución funcional a un problema. La función devuelve una etapa showCustomerDialogpara que una clase externa pueda almacenar una referencia a ella y desee hacer algo, como ocultar la etapa al hacer clic en un botón en la ventana principal, en un momento posterior. Una solución alternativa orientada a objetos podría encapsular la funcionalidad y la referencia de etapa dentro de un objeto CustomerDialog o tener una etapa extendida CustomerDialog. Un ejemplo completo de una interfaz orientada a objetos para un cuadro de diálogo personalizado que encapsula datos FXML, controlador y modelo está más allá del alcance de esta respuesta, pero puede ser una publicación de blog valiosa para cualquiera que esté dispuesto a crear una.


Información adicional proporcionada por el usuario de StackOverflow llamado @dzim

Ejemplo de inyección de dependencia de Spring Boot

La pregunta de cómo hacerlo "The Spring Boot Way", hubo una discusión sobre JavaFX 2, que respondí en el enlace permanente adjunto. El enfoque aún es válido y se probó en marzo de 2016, en Spring Boot v1.3.3.RELEASE: https://stackoverflow.com/a/36310391/1281217


A veces, es posible que desees devolver los resultados a la persona que llama, en cuyo caso puedes consultar la respuesta a la pregunta relacionada:

  • Parámetro JavaFX FXML que pasa del controlador A al B y viceversa
jewelsea avatar Jan 07 '2013 05:01 jewelsea

Me doy cuenta de que esta es una publicación muy antigua y que ya tiene algunas respuestas excelentes, pero quería hacer un MCVE simple para demostrar uno de esos enfoques y permitir a los nuevos programadores ver rápidamente el concepto en acción.

En este ejemplo, usaremos 5 archivos:

  1. Main.java : simplemente se usa para iniciar la aplicación y llamar al primer controlador.
  2. Controller1.java : el controlador para el primer diseño FXML.
  3. Controller2.java : el controlador para el segundo diseño FXML.
  4. Layout1.fxml : el diseño FXML para la primera escena.
  5. Layout2.fxml : el diseño FXML para la segunda escena.

Todos los archivos se enumeran en su totalidad al final de esta publicación.

El objetivo: demostrar valores de paso de Controller1a Controller2y viceversa.

El flujo del programa:

  • La primera escena contiene a TextField, a Buttony a Label. Cuando se Buttonhace clic en , se carga y muestra la segunda ventana, incluido el texto ingresado en el archivo TextField.
  • Dentro de la segunda escena, también hay a TextField, a Buttony a Label. Mostrará Labelel texto ingresado en TextFieldla primera escena.
  • Al ingresar texto en la segunda escena TextFieldy hacer clic en él Button, la primera escena Labelse actualiza para mostrar el texto ingresado.

Esta es una demostración muy simple y seguramente podría representar alguna mejora, pero debería dejar el concepto muy claro.

El código en sí también está comentado con algunos detalles de qué está pasando y cómo.

EL CÓDIGO

Principal.java:

import javafx.application.Application;
import javafx.stage.Stage;

public class Main extends Application {

    public static void main(String[] args) {
        launch(args);
    }

    @Override
    public void start(Stage primaryStage) {

        // Create the first controller, which loads Layout1.fxml within its own constructor
        Controller1 controller1 = new Controller1();

        // Show the new stage
        controller1.showStage();

    }
}

Controlador1.java:

import javafx.fxml.FXML;
import javafx.fxml.FXMLLoader;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.control.TextField;
import javafx.stage.Stage;

import java.io.IOException;

public class Controller1 {

    // Holds this controller's Stage
    private final Stage thisStage;

    // Define the nodes from the Layout1.fxml file. This allows them to be referenced within the controller
    @FXML
    private TextField txtToSecondController;
    @FXML
    private Button btnOpenLayout2;
    @FXML
    private Label lblFromController2;

    public Controller1() {

        // Create the new stage
        thisStage = new Stage();

        // Load the FXML file
        try {
            FXMLLoader loader = new FXMLLoader(getClass().getResource("Layout1.fxml"));

            // Set this class as the controller
            loader.setController(this);

            // Load the scene
            thisStage.setScene(new Scene(loader.load()));

            // Setup the window/stage
            thisStage.setTitle("Passing Controllers Example - Layout1");

        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * Show the stage that was loaded in the constructor
     */
    public void showStage() {
        thisStage.showAndWait();
    }

    /**
     * The initialize() method allows you set setup your scene, adding actions, configuring nodes, etc.
     */
    @FXML
    private void initialize() {

        // Add an action for the "Open Layout2" button
        btnOpenLayout2.setOnAction(event -> openLayout2());
    }

    /**
     * Performs the action of loading and showing Layout2
     */
    private void openLayout2() {

        // Create the second controller, which loads its own FXML file. We pass a reference to this controller
        // using the keyword [this]; that allows the second controller to access the methods contained in here.
        Controller2 controller2 = new Controller2(this);

        // Show the new stage/window
        controller2.showStage();

    }

    /**
     * Returns the text entered into txtToSecondController. This allows other controllers/classes to view that data.
     */
    public String getEnteredText() {
        return txtToSecondController.getText();
    }

    /**
     * Allows other controllers to set the text of this layout's Label
     */
    public void setTextFromController2(String text) {
        lblFromController2.setText(text);
    }
}

Controlador2.java:

import javafx.fxml.FXML;
import javafx.fxml.FXMLLoader;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.control.TextField;
import javafx.stage.Stage;

import java.io.IOException;

public class Controller2 {

    // Holds this controller's Stage
    private Stage thisStage;

    // Will hold a reference to the first controller, allowing us to access the methods found there.
    private final Controller1 controller1;

    // Add references to the controls in Layout2.fxml
    @FXML
    private Label lblFromController1;
    @FXML
    private TextField txtToFirstController;
    @FXML
    private Button btnSetLayout1Text;

    public Controller2(Controller1 controller1) {
        // We received the first controller, now let's make it usable throughout this controller.
        this.controller1 = controller1;

        // Create the new stage
        thisStage = new Stage();

        // Load the FXML file
        try {
            FXMLLoader loader = new FXMLLoader(getClass().getResource("Layout2.fxml"));

            // Set this class as the controller
            loader.setController(this);

            // Load the scene
            thisStage.setScene(new Scene(loader.load()));

            // Setup the window/stage
            thisStage.setTitle("Passing Controllers Example - Layout2");

        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * Show the stage that was loaded in the constructor
     */
    public void showStage() {
        thisStage.showAndWait();
    }

    @FXML
    private void initialize() {

        // Set the label to whatever the text entered on Layout1 is
        lblFromController1.setText(controller1.getEnteredText());

        // Set the action for the button
        btnSetLayout1Text.setOnAction(event -> setTextOnLayout1());
    }

    /**
     * Calls the "setTextFromController2()" method on the first controller to update its Label
     */
    private void setTextOnLayout1() {
        controller1.setTextFromController2(txtToFirstController.getText());
    }

}

Diseño1.fxml:

<?xml version="1.0" encoding="UTF-8"?>
<?import javafx.geometry.Insets?>
<?import javafx.scene.control.*?>
<?import javafx.scene.layout.AnchorPane?>
<?import javafx.scene.layout.HBox?>
<?import javafx.scene.layout.VBox?>
<AnchorPane xmlns="http://javafx.com/javafx/9.0.1" xmlns:fx="http://javafx.com/fxml/1">
    <VBox alignment="CENTER" spacing="10.0">
        <padding>
            <Insets bottom="10.0" left="10.0" right="10.0" top="10.0"/>
        </padding>
        <Label style="-fx-font-weight: bold;" text="This is Layout1!"/>
        <HBox alignment="CENTER_LEFT" spacing="10.0">
            <Label text="Enter Text:"/>
            <TextField fx:id="txtToSecondController"/>
            <Button fx:id="btnOpenLayout2" mnemonicParsing="false" text="Open Layout2"/>
        </HBox>
        <VBox alignment="CENTER">
            <Label text="Text From Controller2:"/>
            <Label fx:id="lblFromController2" text="Nothing Yet!"/>
        </VBox>
    </VBox>
</AnchorPane>

Diseño2.fxml:

<?xml version="1.0" encoding="UTF-8"?>
<?import javafx.geometry.Insets?>
<?import javafx.scene.control.*?>
<?import javafx.scene.layout.AnchorPane?>
<?import javafx.scene.layout.HBox?>
<?import javafx.scene.layout.VBox?>
<AnchorPane xmlns="http://javafx.com/javafx/9.0.1" xmlns:fx="http://javafx.com/fxml/1">
    <VBox alignment="CENTER" spacing="10.0">
        <padding>
            <Insets bottom="10.0" left="10.0" right="10.0" top="10.0"/>
        </padding>
        <Label style="-fx-font-weight: bold;" text="Welcome to Layout 2!"/>
        <VBox alignment="CENTER">
            <Label text="Text From Controller1:"/>
            <Label fx:id="lblFromController1" text="Nothing Yet!"/>
        </VBox>
        <HBox alignment="CENTER_LEFT" spacing="10.0">
            <Label text="Enter Text:"/>
            <TextField fx:id="txtToFirstController"/>
            <Button fx:id="btnSetLayout1Text" mnemonicParsing="false" text="Set Text on Layout1"/>
        </HBox>
    </VBox>
</AnchorPane>
Zephyr avatar Jun 26 '2018 20:06 Zephyr

A continuación se muestra un ejemplo para pasar parámetros a un documento fxml a través del espacio de nombres.

<?xml version="1.0" encoding="UTF-8"?>
<?import javafx.scene.control.Label?>
<?import javafx.scene.layout.BorderPane?>
<?import javafx.scene.layout.VBox?>
<VBox xmlns="http://javafx.com/javafx/null" xmlns:fx="http://javafx.com/fxml/1">
    <BorderPane>
        <center>
            <Label text="$labelText"/>
        </center>
    </BorderPane>
</VBox>

Definir valor External Textpara la variable de espacio de nombres labelText:

import javafx.application.Application;
import javafx.fxml.FXMLLoader;
import javafx.scene.Parent;
import javafx.scene.Scene;
import javafx.stage.Stage;

import java.io.IOException;

public class NamespaceParameterExampleApplication extends Application {

    public static void main(String[] args) {
        launch(args);
    }

    @Override
    public void start(Stage primaryStage) throws IOException {
        final FXMLLoader fxmlLoader = new FXMLLoader(getClass().getResource("namespace-parameter-example.fxml"));

        fxmlLoader.getNamespace()
                  .put("labelText", "External Text");

        final Parent root = fxmlLoader.load();

        primaryStage.setTitle("Namespace Parameter Example");
        primaryStage.setScene(new Scene(root, 400, 400));
        primaryStage.show();
    }
}
user1503636 avatar Jan 12 '2016 04:01 user1503636

La clase javafx.scene.Node tiene un par de métodos setUserData(Object) y Object getUserData()

Que podrías usar para agregar tu información al Node.

Entonces, puedes llamar a page.setUserData(info);

Y el controlador puede verificar si la información está configurada. Además, puede utilizar ObjectProperty para la transferencia de datos hacia atrás, si es necesario.

Observe una documentación aquí: http://docs.oracle.com/javafx/2/api/javafx/fxml/doc-files/introduction_to_fxml.html Antes de la frase "En la primera versión, handleButtonAction() está etiquetado con @FXML para permitir que el marcado definido en el documento del controlador lo invoque. En el segundo ejemplo, el campo del botón está anotado para permitir que el cargador establezca su valor. El método inicializar() está anotado de manera similar."

Por lo tanto, debe asociar un controlador con un nodo y establecer datos de usuario para el nodo.

Alexander Kirov avatar Jan 07 '2013 00:01 Alexander Kirov

Esto funciona ..

Recuerde que la primera vez que imprima el valor de paso obtendrá un valor nulo. Puede usarlo después de cargar Windows, lo mismo para todo lo que desee codificar para cualquier otro componente.

Primer controlador

try {
    Stage st = new Stage();
    FXMLLoader loader = new FXMLLoader(getClass().getResource("/com/inty360/free/form/MainOnline.fxml"));

    Parent sceneMain = loader.load();

    MainOnlineController controller = loader.<MainOnlineController>getController();
    controller.initVariable(99L);

    Scene scene = new Scene(sceneMain);
    st.setScene(scene);
    st.setMaximized(true);
    st.setTitle("My App");
    st.show();
} catch (IOException ex) {
    Logger.getLogger(LoginController.class.getName()).log(Level.SEVERE, null, ex);
}

Otro controlador

public void initVariable(Long id_usuario){
    this.id_usuario = id_usuario;
    label_usuario_nombre.setText(id_usuario.toString());
}
diego matos - keke avatar Apr 28 '2016 22:04 diego matos - keke