moe.tristan.easyfxml.model.fxml

Class BaseEasyFxml

java.lang.Object

moe.tristan.easyfxml.model.fxml.BaseEasyFxml

All Implemented Interfaces:

EasyFxml

@Component
public class BaseEasyFxml
extends Object
implements EasyFxml

This is the standard implementation of EasyFxml.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEasyFxml(org.springframework.context.ApplicationContext context, org.springframework.core.env.Environment environment, ControllerManager controllerManager)

Method Summary

Modifier and Type	Method and Description
io.vavr.control.Try<javafx.scene.layout.Pane>	loadNode(FxmlNode node) Loads a FxmlNode as a Pane (this is the safest base class for all sorts of hierarchies) since most of the base containers are subclasses of it.
<T extends javafx.scene.Node> io.vavr.control.Try<T>	loadNode(FxmlNode nodeInfo, Class<T> nodeClass) Same as EasyFxml.loadNode(FxmlNode) except you can choose the return type wished for instead of just Pane.
<T extends javafx.scene.Node> io.vavr.control.Try<T>	loadNode(FxmlNode nodeInfo, Class<T> nodeClass, Object selector) This is to EasyFxml.loadNode(FxmlNode, Class) just what EasyFxml.loadNode(FxmlNode, Object) is to EasyFxml.loadNode(FxmlNode).
io.vavr.control.Try<javafx.scene.layout.Pane>	loadNode(FxmlNode node, Object selector) Same as EasyFxml.loadNode(FxmlNode) but offers a selector parameter for multistage usage of ControllerManager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseEasyFxml

@Autowired
protected BaseEasyFxml(org.springframework.context.ApplicationContext context,
                                  org.springframework.core.env.Environment environment,
                                  ControllerManager controllerManager)

Method Detail

loadNode

public io.vavr.control.Try<javafx.scene.layout.Pane> loadNode(FxmlNode node)

Description copied from interface: EasyFxml

Loads a FxmlNode as a Pane (this is the safest base class for all sorts of hierarchies) since most of the base containers are subclasses of it.

It also registers its controller in the ControllerManager for later usage.

It returns a Try which is a monadic structure which allows us to do clean exception-handling.

Specified by:

loadNode in interface EasyFxml

Parameters:

node - The element's FxmlNode counterpart.

Returns:

A Try containing either the JavaFX Pane inside a Try.Success or the exception that was raised during the chain of calls needed to load it, inside a Try.Failure. See Value.getOrElse(Object), Try.onFailure(Consumer), Try.recover(Function) and related methods for how to handle Try.Failure.

loadNode

public io.vavr.control.Try<javafx.scene.layout.Pane> loadNode(FxmlNode node,
                                                              Object selector)

Description copied from interface: EasyFxml

Same as EasyFxml.loadNode(FxmlNode) but offers a selector parameter for multistage usage of ControllerManager.

Specified by:

loadNode in interface EasyFxml

Parameters:

node - The element's FxmlNode counterpart.

selector - The selector for deduplication of Panes sharing the same FxmlNode.

Returns:

A Try of the Pane to be loaded. See EasyFxml.loadNode(FxmlNode) for more information on Try.

loadNode

public <T extends javafx.scene.Node> io.vavr.control.Try<T> loadNode(FxmlNode nodeInfo,
                                                                     Class<T> nodeClass)

Description copied from interface: EasyFxml

Same as EasyFxml.loadNode(FxmlNode) except you can choose the return type wished for instead of just Pane.

It's a bad idea but it can sometimes be actually useful on the rare case where the element is really nothing like a Pane. Be it a very complex button or a custom textfield with non-rectangular shape.

Specified by:

loadNode in interface EasyFxml

Type Parameters:

T - The type of the node. Mostly for type safety.

Parameters:

nodeInfo - The element's FxmlNode counterpart.

nodeClass - The class of the JavaFX Node represented by this FxmlNode.

Returns:

A Try of the Node to be loaded. See EasyFxml.loadNode(FxmlNode) for more information on Try.

loadNode

public <T extends javafx.scene.Node> io.vavr.control.Try<T> loadNode(FxmlNode nodeInfo,
                                                                     Class<T> nodeClass,
                                                                     Object selector)

Description copied from interface: EasyFxml

This is to EasyFxml.loadNode(FxmlNode, Class) just what EasyFxml.loadNode(FxmlNode, Object) is to EasyFxml.loadNode(FxmlNode).

Specified by:

loadNode in interface EasyFxml

Type Parameters:

T - The type of the node. Mostly for type safety.

Parameters:

nodeInfo - The element's FxmlNode counterpart.

nodeClass - The class of the JavaFX Node represented by this FxmlNode.

selector - The selector for deduplication of Panes sharing the same FxmlNode.

Returns:

A Try of the Node to be loaded. See EasyFxml.loadNode(FxmlNode) for more information on Try.