MobileApplication (charm 0.0.2 API)

java.lang.Object
- javafx.application.Application
- - com.gluonhq.charm.glisten.application.MobileApplication

```
public class MobileApplication
extends javafx.application.Application
```
For Glisten-based applications, the MobileApplication class should be considered as the base class, in a similar fashion to the Application class is to JavaFX applications. In fact, MobileApplication extends from Application, so the importance of this class should be clear.
Unlike Application, MobileApplication does not require any specific methods to be implemented. There are requirements on the developer, however. In particular, the developer of a mobile application has to specify the views and layers in their application, and provide these to the MobileApplication instance as factories that can be called on-demand. The most important view factory is the one that specifies the 'home view', which is shown when the application first starts. For example, here is the code to create a view factory for the home view:
```
 
 addViewFactory(MobileApplication.HOME_VIEW, () -> {
     // normal JavaFX code to create a scenegraph of nodes
     Node homeViewContent = ...;
   
     return new View(MobileApplication.HOME_VIEW, homeViewContent);
 });
```
Note in the code above that we call the addViewFactory(String, Supplier) method of the MobileApplication class, and we provide two arguments:
1. The name of the view. In this case, we are using the HOME_VIEW public static field, but this can be any String, as long as it is unique to your application (i.e. don't add multiple view factories with the same name!).
2. We provide a Supplier implementation that, when called by Glisten, should return a new instance of this particular View. Note that the returned object is a View instance.
With this view defined (along with other views relevant to your application), switching between views is simply a matter of calling MobileApplication.getInstance().switchView("view-name"), which "view-name" is replaced by the name of the view you wish to go to (or, if you wish to return home, simply HOME_VIEW).

Similar functionality exists for layers, which make use of the GlassPane to appear above the rest of your application user interface.
See Also:

GlassPane, View, Layer

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.StringProperty`	`title` The title of the application.
`javafx.beans.property.ReadOnlyObjectProperty<View>`	`view` The currently showing view within this application.

Nested Class Summary
- Nested classes/interfaces inherited from class javafx.application.Application
  javafx.application.Application.Parameters

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String HOME_VIEW
All Glisten-based applications should define one View with its name specified as HOME_VIEW.
- Fields inherited from class javafx.application.Application
  STYLESHEET_CASPIAN, STYLESHEET_MODENA

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`HOME_VIEW` All Glisten-based applications should define one `View` with its name specified as `HOME_VIEW`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected MobileApplication()
Creates a new instance of MobileApplication.

Constructors
Modifier	Constructor and Description
`protected`	`MobileApplication()` Creates a new instance of MobileApplication.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLayerFactory(java.lang.String layerName, java.util.function.Supplier<Layer> supplier)` Adds a new layer factory to this application, if the given layer name is unique (otherwise an IllegalArgumentException is thrown).
`void`	`addViewFactory(java.lang.String viewName, java.util.function.Supplier<View> supplier)` Adds a new view factory to this application, if the given view name is unique (otherwise an IllegalArgumentException is thrown).
`GlassPane`	`getGlassPane()` Returns the `GlassPane` instance that is part of this application.
`static MobileApplication`	`getInstance()` Returns the single instance of the MobileApplication.
`double`	`getScreenHeight()` Returns the height of the screen that this application is running on.
`double`	`getScreenWidth()` Returns the width of the screen that this application is running on.
`java.lang.String`	`getTitle()` Gets the value of the property title.
`View`	`getView()` Gets the value of the property view.
`void`	`hideLayer(java.lang.String layerName)` Attempts to hide a layer with the given name.
`void`	`postInit(javafx.scene.Scene scene)` Intended for adding aditional initilization code
`java.util.Optional<View>`	`retrieveView(java.lang.String viewname)` Attempts to retrieve the view represented by the given view name.
`void`	`setTitle(java.lang.String title)` Sets the value of the property title.
`void`	`showLayer(java.lang.String layerName)` Attempts to show a layer with the given name.
`void`	`showMessage(java.lang.String text)`
`void`	`start(javafx.stage.Stage primaryStage)`
`void`	`switchToPreviousView()` Attempts to switch to a previously used view if one exists
`void`	`switchView(java.lang.String viewName)` Attempts to switch the view from the current view to a view represented by the given view name.
`javafx.beans.property.StringProperty`	`titleProperty()` The title of the application.
`javafx.beans.property.ReadOnlyObjectProperty<View>`	`viewProperty()` The currently showing view within this application.

Methods inherited from class javafx.application.Application
getHostServices, getParameters, getUserAgentStylesheet, init, launch, launch, notifyPreloader, setUserAgentStylesheet, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - title
```
public final javafx.beans.property.StringProperty titleProperty
```
    The title of the application. If this software is run on a desktop machine, this title will appear in the standard title area for applications. On other platforms, it is likely that this title will not be visible.
    
    See Also:
    
    getTitle(), setTitle(String)
  - view
```
public final javafx.beans.property.ReadOnlyObjectProperty<View> viewProperty
```
    The currently showing view within this application.
    
    See Also:
    
    getView()
- Field Detail
  - HOME_VIEW
```
public static final java.lang.String HOME_VIEW
```
    All Glisten-based applications should define one View with its name specified as HOME_VIEW. This View will then become the default view of the user interface.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MobileApplication
```
protected MobileApplication()
```
    Creates a new instance of MobileApplication.
- Method Detail
  - getInstance
```
public static MobileApplication getInstance()
```
    Returns the single instance of the MobileApplication.
  - start
```
public final void start(javafx.stage.Stage primaryStage)
                 throws java.lang.Exception
```
    Specified by:
    
    start in class javafx.application.Application
    
    Throws:
    
    java.lang.Exception
  - titleProperty
```
public final javafx.beans.property.StringProperty titleProperty()
```
    The title of the application. If this software is run on a desktop machine, this title will appear in the standard title area for applications. On other platforms, it is likely that this title will not be visible.
    
    See Also:
    
    getTitle(), setTitle(String)
  - setTitle
```
public final void setTitle(java.lang.String title)
```
    Sets the value of the property title.
  - getTitle
```
public final java.lang.String getTitle()
```
    Gets the value of the property title.
  - viewProperty
```
public final javafx.beans.property.ReadOnlyObjectProperty<View> viewProperty()
```
    The currently showing view within this application.
    
    See Also:
    
    getView()
  - getView
```
public final View getView()
```
    Gets the value of the property view.
  - getGlassPane
```
public final GlassPane getGlassPane()
```
    Returns the GlassPane instance that is part of this application.
  - postInit
```
public void postInit(javafx.scene.Scene scene)
```
    Intended for adding aditional initilization code
    
    Parameters:
    
    scene - application scene
  - switchView
```
public final void switchView(java.lang.String viewName)
```
    Attempts to switch the view from the current view to a view represented by the given view name. If the view name does not exist, then the current view remains visible to users. If the view name does exist, then the view will be switched to the new view represented by this name.
  - switchToPreviousView
```
public final void switchToPreviousView()
```
    Attempts to switch to a previously used view if one exists
  - retrieveView
```
public final java.util.Optional<View> retrieveView(java.lang.String viewname)
```
    Attempts to retrieve the view represented by the given view name. The result is wrapped in an Optional, to prevent null pointer exceptions.
  - addViewFactory
```
public final void addViewFactory(java.lang.String viewName,
                                 java.util.function.Supplier<View> supplier)
```
    Adds a new view factory to this application, if the given view name is unique (otherwise an IllegalArgumentException is thrown).
    
    Parameters:
    
    viewName - The name of the view - this will be used at other points in the application lifecycle to reference this view, and to switch to it.
    
    supplier - A Supplier instance that, when called, should return the view. This view is cached inside the mobile application, and as such is reused throughout the life of the application instance.
  - addLayerFactory
```
public final void addLayerFactory(java.lang.String layerName,
                                  java.util.function.Supplier<Layer> supplier)
```
    Adds a new layer factory to this application, if the given layer name is unique (otherwise an IllegalArgumentException is thrown).
    
    Parameters:
    
    layerName - The name of the layer - this will be used at other points in the application lifecycle to reference this layer, and to show it.
    
    supplier - A Supplier instance that, when called, should return the Layer. This layer is cached inside the mobile application, and as such is reused throughout the life of the application instance.
  - showLayer
```
public final void showLayer(java.lang.String layerName)
```
    Attempts to show a layer with the given name. Is equivalent to calling Layer.show().
  - hideLayer
```
public final void hideLayer(java.lang.String layerName)
```
    Attempts to hide a layer with the given name. Is equivalent to calling Layer.hide().
  - getScreenHeight
```
public final double getScreenHeight()
```
    Returns the height of the screen that this application is running on.
  - getScreenWidth
```
public final double getScreenWidth()
```
    Returns the width of the screen that this application is running on.
  - showMessage
```
public void showMessage(java.lang.String text)
```

Class MobileApplication

Property Summary

Nested Class Summary

Nested classes/interfaces inherited from class javafx.application.Application

Field Summary

Fields inherited from class javafx.application.Application

Constructor Summary

Method Summary

Methods inherited from class javafx.application.Application

Methods inherited from class java.lang.Object

Property Detail

title

view

Field Detail

HOME_VIEW

Constructor Detail

MobileApplication

Method Detail

getInstance

start

titleProperty

setTitle

getTitle

viewProperty

getView

getGlassPane

postInit

switchView

switchToPreviousView

retrieveView

addViewFactory

addLayerFactory

showLayer

hideLayer

getScreenHeight

getScreenWidth

showMessage