com.cathive.fx.guice.fxml

Class FXMLLoadingScope

java.lang.Object

com.cathive.fx.guice.fxml.FXMLLoadingScope

All Implemented Interfaces:

com.google.inject.Scope

public final class FXMLLoadingScope
extends Object
implements com.google.inject.Scope

Handles construction of objects annotated with FXMLController.

Author:

Andy Till

Constructor Summary

Constructors

Constructor and Description
FXMLLoadingScope()

Method Summary

Modifier and Type	Method and Description
void	enter(GuiceFXMLLoader fxmlLoader) Enter the scope.
void	exit() End the scope.
Collection<IdentifiableController>	getIdentifiables()
<T> T	getInstance(String controllerId)
boolean	isActive() Checks whether the FXML Loading Scope is currently being used.
<T> com.google.inject.Provider<T>	scope(com.google.inject.Key<T> key, com.google.inject.Provider<T> unscoped)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.inject.Scope

toString

Constructor Detail

FXMLLoadingScope

public FXMLLoadingScope()

Method Detail

enter

public void enter(GuiceFXMLLoader fxmlLoader)

Enter the scope. From here on in, controllers implementing IdentifiableController and annotated wih FXMLController will be retrievable from any ControllerLookup instance that is injected.

Parameters:

fxmlLoader - The FXML Loader to be used within this scope.

exit

public void exit()

End the scope.

scope

public <T> com.google.inject.Provider<T> scope(com.google.inject.Key<T> key,
                                               com.google.inject.Provider<T> unscoped)

Specified by:

scope in interface com.google.inject.Scope

getInstance

public <T> T getInstance(String controllerId)

getIdentifiables

public Collection<IdentifiableController> getIdentifiables()

isActive

public boolean isActive()

Checks whether the FXML Loading Scope is currently being used.

Returns:

true if this scope is currently active, false otherwise.