Interface JavaFxSupport

rust/src/jfx.rs:27–52

Provides JavaFx support.

/// Provides JavaFx support.
pub trait JavaFxSupport {
    /// Triggers the start of a JavaFX application.
    /// When the JavaFX application starts, the `InstanceReceiver` channel will receive an Instance of `javafx.stage.Stage`.
    ///
    /// The UI may start being built using the provided `Stage`
    fn start_javafx_app(&self) -> errors::Result<InstanceReceiver>;
    /// Deploys the required dependencies to run a JavaFX application in order to be able to be used by j4rs.
    fn deploy_javafx_dependencies(&self) -> errors::Result<()>;
    /// Creates an instance receiver that will be receiving `Instance`s of events.
    /// The fx_event_type argument is the type of the event that we want to handle and receive Instances for.
    ///
    /// For example, to create an `InstanceReceiver` for a 'javafx.scene.control.Button',
    /// you need to call the method by using the button as the _instance_ argument
    /// `FxEventType::ActionEvent_Action` as the fx_event_type argument
    fn get_javafx_event_receiver(
        &self,
        instance: &Instance,
        fx_event_type: FxEventType,
    ) -> errors::Result<InstanceReceiver>;
    /// Creates an instance receiver that will be receiving `Instance`s of events for onclose requests of a `Stage`.
    ///
    /// The instance passed as argument needs to be of class `javafx.stage.Stage`.
    fn on_close_event_receiver(&self, stage: &Instance) -> errors::Result<InstanceReceiver>;
    /// Loads a FXML and returns a Result of a FxController for it.
    fn load_fxml(&self, path: &PathBuf, stage: &Instance) -> errors::Result<FxController>;
}

impl JavaFxSupport for Jvm {
    /// Triggers the start of a JavaFX application.