Package com.storedobject.ui

Class Application

java.lang.Object

com.storedobject.vaadin.Application

com.storedobject.ui.Application

All Implemented Interfaces:

Device, ErrorLogger, RequiresApproval, RunningLogic

public class Application
extends Application
implements Device, RunningLogic, RequiresApproval

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Application.BusyIndicator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLOR_ERROR
static final String	COLOR_INFO
static final String	COLOR_NORMAL
static final String	COLOR_SUCCESS

Constructor Summary

Constructors

Constructor	Description
Application()
Application(ApplicationLayout applicationLayout)
Application(ApplicationLayout applicationLayout, boolean singleLogicMode)
Application(ApplicationLayout applicationLayout, boolean singleLogicMode, boolean abortOnLogicSwitch)

Method Summary

Modifier and Type	Method	Description
void	addContent(long fileId, AbstractContentGenerator content)
void	addMultiContent(long fileId, AbstractContentGenerator content)
void	alert(LoginMessage message)
void	alert(String alert)
void	alert(String caption, String alert)
void	alert(String caption, String alert, String icon)
void	alertCountChanged(Object owner)	This method is invoked whenever alter count changes for a particular owner.
void	attached()	Invoked whenever this application is attached to a UI.
protected boolean	canCreateMenu(Logic logic)
protected boolean	canCreateMenu(LogicGroup logicGroup)
void	checkDayEnd()
void	close()	Close the application by closing all registered "resources".
void	close(int reason)
void	close(String exitSite)
void	close(String exitSite, int reason)
void	closeAllViews(boolean forShutdown)	Close all current views by invoking View.abort() on each of them.
void	closeMenu()
void	closeWaitMessage()
protected ApplicationEnvironment	createEnvironment()	An "application environment" may be created to specify certain behaviours of the application.
static Object	createInstance(String propertyName, boolean showError, boolean raiseError)
protected final ApplicationLayout	createLayout()	This method is invoked only once to determine the layout of the application.
protected Runnable	createLogin()
protected PostLogin	createPostLogin()
void	detached()	Invoked whenever this application is detached from its UI (it may get attached again to another UI if the user just refreshed the browser).
void	disableBiometric()	For internal use only.
void	download(ContentProducer producer, Consumer<Long> informMe)
void	execute(Logic logic)
void	exit(String message, String exitSite)	Exit the application after showing a message.
final void	forgotPassword(IdentityCheck identityCheck)
final boolean	forgotPassword(Login login)
static Application	get()
StyledBuilder	getAlert()
StyledBuilder	getAlert(Id reference)
StyledBuilder	getAlert(Object alertHandler)
StyledBuilder	getAlert(Object alertHandler, Id reference)
com.vaadin.flow.component.Component	getAlertButton()
Id	getBiometricDeviceId()
Application.BusyIndicator	getBusyIndicator()
int	getCloseReason()	The reason for closing the application.
String	getCountry()	Get ISO 2-character the country-code of the user in capital letters.
static String	getDefaultCountry()
static Currency	getDefaultCurrency()
BrowserDeviceLayout	getDeviceLayout()
String	getDeviceType()
final String	getDisplayVersion()
String	getDriverIdentifier()
static MediaFile	getHomeImage()
static String	getLogicCaption(String defaultCaption)	Get the caption of the currently running logic from the current Application.
String	getLogicTitle(String defaultTitle)	Get the title of the currently running logic.
Login	getLogin()	This return the Login instance associated with application.
QuickSender	getMailSender()
final MessageViewer	getMessageViewer()
final String	getName()
Application.BusyIndicator	getProgressBar(boolean indeterminate)
Logic	getRunningLogic()
ApplicationServer	getServer()
QuickSender	getSMSSender()
TransactionManager	getTransactionManager()
protected Consumer<com.vaadin.flow.component.UI>	getUIConfigurator()	Get UI configurator if any so that UI will be passed to it for handling any special configuration.
static FilterProvider	getUserVisibility(String action)
void	information(StyledBuilder appDetails)
protected void	init(com.vaadin.flow.server.VaadinRequest request)	This method is invoked by ApplicationView class.
protected boolean	init(String link)	This method is invoked when the application comes up.
boolean	isBiometricAvailable()
boolean	isBiometricRegistered()
boolean	isCompactTheme()	Is the application theme currently in compact mode?
boolean	isMenuOpened()
void	loadStyles(String textContentName)
void	log(Object anything)	Log something (goes to the System error stream).
void	log(Object anything, Throwable error)	Log something along with an exception (goes to the System error stream).
final boolean	loggedIn(Login login)
final void	login()	This method can be overridden to accept login credentials and Application.loggedin() must be called if successfully logged in.
void	logout()
void	openMenu()
void	parse(Logic logic)
void	removeToolbarButtons()	Remove the alert and speaker buttons from the toolbar.
void	setAbortOnLogicSwitch(boolean abortOnLogicSwitch)
void	setCompactTheme(boolean compactMode)	Set the application theme in compact mode.
void	setDate(Date date)
void	setDeviceLayout(DeviceLayout layout)
void	setRunningLogic(Logic logic)
void	setServer(ApplicationServer server)
void	setSingleLogicMode(boolean singleLogicMode)
boolean	supportsCloseableView()	Whether this application supports CloseableView or not.
void	view(Id objectId)
void	view(Id objectId, String actionName, Consumer<StoredObject> action)
void	view(MediaFile mediaFile)
void	view(MediaFile mediaFile, boolean windowMode)
void	view(StoredObject object)
void	view(StoredObject object, String actionName, Consumer<StoredObject> action)
void	view(String caption, ContentProducer producer, Consumer<Long> timeTracker, boolean windowMode)
void	view(String caption, ContentProducer producer, Consumer<Long> timeTracker, boolean windowMode, com.vaadin.flow.component.Component... extraHeaderButtons)
void	view(String caption, Id objectId)
void	view(String caption, Id objectId, String actionName, Consumer<StoredObject> action)
void	view(String caption, MediaFile mediaFile)
void	view(String caption, MediaFile mediaFile, boolean windowMode)
void	view(String caption, StoredObject object)
void	view(String caption, StoredObject object, String actionName, Consumer<StoredObject> action)
protected void	viewDetached(View view)	This method is invoked whenever a running View is detached.

Methods inherited from class com.storedobject.vaadin.Application

access, addBrowserResizedListener, addContentResizedListener, clearAlert, clearAlerts, clearAlerts, createMenuItem, createMenuItem, createMenuItemGroup, error, error, execute, execute, get, getActiveView, getActiveViewCount, getActiveViews, getAlertCount, getAlerts, getCaption, getCommonAlert, getContentHeight, getContentWidth, getData, getDeviceHeight, getDeviceWidth, getEnvironment, getIdentifier, getIPAddress, getLinkName, getLocale, getMajorVersion, getMinorVersion, getPage, getQueryParameter, getUI, getURL, getViewFor, getWebBrowser, isFullScreenMode, isSpeakerOn, isSpeaking, loggedin, message, message, registerAlert, registerResource, removeData, removeData, removeQueryParameter, removeQueryParameters, setCaption, setData, setData, setLocale, setPollInterval, setPollInterval, setPostFocus, showAlerts, showAlerts, showNotification, showNotification, showNotification, showNotification, speak, startPolling, stopPolling, tray, tray, warning, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.Device

download, download, download, getDateFormat, getDefaultEntity, getDeviceHeight, getDeviceWidth, getIdentifier, getIPAddress, getLocale, getMajorVersion, getMinorVersion, setLocale, showNotification, showNotification, showNotification, showNotification, view, view, view, view, view, view, view, view, view, view, view, view, view, view, view

Field Details

COLOR_ERROR

public static final String COLOR_ERROR

See Also:

• Constant Field Values

COLOR_SUCCESS

public static final String COLOR_SUCCESS

See Also:

• Constant Field Values

COLOR_INFO

public static final String COLOR_INFO

See Also:

• Constant Field Values

COLOR_NORMAL

public static final String COLOR_NORMAL

See Also:

• Constant Field Values

Constructor Details

Application

public Application()

Application

public Application(ApplicationLayout applicationLayout)

Application

public Application(ApplicationLayout applicationLayout,
 boolean singleLogicMode)

Application

public Application(ApplicationLayout applicationLayout,
 boolean singleLogicMode,
 boolean abortOnLogicSwitch)

Method Details

init

protected void init(com.vaadin.flow.server.VaadinRequest request)

Description copied from class: Application

This method is invoked by ApplicationView class. If you want to override this method, make sure that super is called.

Overrides:

init in class Application

Parameters:

request - Vaadin Request

init

protected boolean init(String link)

Description copied from class: Application

This method is invoked when the application comes up.

Overrides:

init in class Application

Parameters:

link - The context path of the application.

Returns:

True if application can go ahead. Otherwise, an "Initialization failed" message is displayed. Default return value is true.

getUIConfigurator

protected Consumer<com.vaadin.flow.component.UI> getUIConfigurator()

Description copied from class: Application

Get UI configurator if any so that UI will be passed to it for handling any special configuration. This will be invoked before Application.setUI(UI) is called.

Overrides:

getUIConfigurator in class Application

Returns:

Default implementation returns null.

getLogin

public Login getLogin()

This return the Login instance associated with application. It will be available only till logged in.

Returns:

Login instance when not logged in, otherwise null.

setCompactTheme

public void setCompactTheme(boolean compactMode)

Set the application theme in compact mode.

Parameters:

compactMode - Whether to show compact mode or not.

isCompactTheme

public boolean isCompactTheme()

Is the application theme currently in compact mode?

Returns:

True/false.

supportsCloseableView

public boolean supportsCloseableView()

Whether this application supports CloseableView or not. Applications may override the standard menu system and the overridden menu system may not have support for displaying appropriate "close" icon for closing the view. In such cases, this method should return false.

Returns:

True/false. Default is true.

attached

public void attached()

Description copied from class: Application

Invoked whenever this application is attached to a UI. Default implementation does nothing.

Overrides:

attached in class Application

loadStyles

public void loadStyles(String textContentName)

createLayout

protected final ApplicationLayout createLayout()

Description copied from class: Application

This method is invoked only once to determine the layout of the application.

Specified by:

createLayout in class Application

Returns:

Application layout.

getName

public final String getName()

createEnvironment

protected ApplicationEnvironment createEnvironment()

Description copied from class: Application

An "application environment" may be created to specify certain behaviours of the application. If this method returns null, a default "environment" will be created.

Overrides:

createEnvironment in class Application

Returns:

Returns null by default.

setSingleLogicMode

public void setSingleLogicMode(boolean singleLogicMode)

setAbortOnLogicSwitch

public void setAbortOnLogicSwitch(boolean abortOnLogicSwitch)

execute

public void execute(Logic logic)

logout

public void logout()

detached

public void detached()

Description copied from class: Application

Invoked whenever this application is detached from its UI (it may get attached again to another UI if the user just refreshed the browser). The default implementation closes the application (Application.close()) after 20 seconds.

Overrides:

detached in class Application

getCloseReason

public int getCloseReason()

The reason for closing the application. A negative number is returned if a redirection had happened while closing.

0: Not closed 1, -1: Logged out by the user. 2, -2: Closed after showing a message. 3, -3: Application server session expired. 4, -4: Login failed and closed. 5, -5: Cancelled from the login screen. 6, -6: Cancelled while selecting the entity. 7, -7: Timed out during interactive session dialog. 8, -8: Closed by the user in the interactive session dialog. 9, -9: Closed while switching to another server/DB. 10, -10: MFA not verified. 100, -100: Programmatic close from unknown code. 101, -101: Programmatic redirection for authentication.

Returns:

Reason code.

close

public void close()

Description copied from class: Application

Close the application by closing all registered "resources". If the associated session is not closed and no other Application instance exists, it will also be closed.

Specified by:

close in interface Device

Overrides:

close in class Application

close

public void close(String exitSite)

Specified by:

close in interface Device

close

public void close(int reason)

close

public void close(String exitSite,
 int reason)

exit

public void exit(String message,
 String exitSite)

Exit the application after showing a message.

Parameters:

message - Message to show.

exitSite - Exit to this site (If null is passed, it will exit to the configured site).

closeAllViews

public void closeAllViews(boolean forShutdown)

Close all current views by invoking View.abort() on each of them.

Parameters:

forShutdown - True should be passed if this is for a shutdown so that all internal timers will be removed.

get

public static Application get()

getDefaultCurrency

public static Currency getDefaultCurrency()

getDefaultCountry

public static String getDefaultCountry()

isBiometricAvailable

public boolean isBiometricAvailable()

isBiometricRegistered

public boolean isBiometricRegistered()

getBiometricDeviceId

public Id getBiometricDeviceId()

disableBiometric

public void disableBiometric()

For internal use only.

getTransactionManager

public TransactionManager getTransactionManager()

log

public void log(Object anything)

Description copied from class: Application

Log something (goes to the System error stream).

Specified by:

log in interface Device

Specified by:

log in interface ErrorLogger

Overrides:

log in class Application

Parameters:

anything - Message to log, it could be a Throwable

log

public void log(Object anything,
 Throwable error)

Description copied from class: Application

Log something along with an exception (goes to the System error stream).

Specified by:

log in interface Device

Specified by:

log in interface ErrorLogger

Overrides:

log in class Application

Parameters:

anything - Message to log, it could be a Throwable

error - Error to be printed

setRunningLogic

public void setRunningLogic(Logic logic)

Specified by:

setRunningLogic in interface RunningLogic

getRunningLogic

public Logic getRunningLogic()

Specified by:

getRunningLogic in interface RunningLogic

getLogicTitle

public String getLogicTitle(String defaultTitle)

Get the title of the currently running logic. Note: A call to this method will reset it, and you can not call it again to get it!

Parameters:

defaultTitle - Default title to be returned if there is no current logic.

Returns:

Title of the logic or default title.

getLogicCaption

public static String getLogicCaption(String defaultCaption)

Get the caption of the currently running logic from the current Application. Note: A call to this method will reset it, and you can not call it again to get it!

Parameters:

defaultCaption - Default caption to be returned if there is no current logic or application instance in the current context.

Returns:

Title of the logic or default caption.

setServer

public void setServer(ApplicationServer server)

Specified by:

setServer in interface Device

getServer

public ApplicationServer getServer()

Specified by:

getServer in interface Device

setDate

public void setDate(Date date)

Specified by:

setDate in interface Device

parse

public void parse(Logic logic)
           throws SOException

Specified by:

parse in interface Device

Throws:

SOException

getMessageViewer

public final MessageViewer getMessageViewer()

Specified by:

getMessageViewer in interface Device

getDeviceType

public String getDeviceType()

Specified by:

getDeviceType in interface Device

getDisplayVersion

public final String getDisplayVersion()

getDriverIdentifier

public String getDriverIdentifier()

Specified by:

getDriverIdentifier in interface Device

getDeviceLayout

public BrowserDeviceLayout getDeviceLayout()

Specified by:

getDeviceLayout in interface Device

setDeviceLayout

public void setDeviceLayout(DeviceLayout layout)

Specified by:

setDeviceLayout in interface Device

view

public void view(MediaFile mediaFile)

view

public void view(String caption,
 MediaFile mediaFile)

view

public void view(MediaFile mediaFile,
 boolean windowMode)

view

public void view(String caption,
 MediaFile mediaFile,
 boolean windowMode)

view

public void view(String caption,
 Id objectId)

view

public void view(Id objectId)

view

public void view(StoredObject object)

view

public void view(String caption,
 StoredObject object)

view

public void view(String caption,
 Id objectId,
 String actionName,
 Consumer<StoredObject> action)

view

public void view(Id objectId,
 String actionName,
 Consumer<StoredObject> action)

view

public void view(StoredObject object,
 String actionName,
 Consumer<StoredObject> action)

view

public void view(String caption,
 StoredObject object,
 String actionName,
 Consumer<StoredObject> action)

view

public void view(String caption,
 ContentProducer producer,
 Consumer<Long> timeTracker,
 boolean windowMode)

Specified by:

view in interface Device

view

public void view(String caption,
 ContentProducer producer,
 Consumer<Long> timeTracker,
 boolean windowMode,
 com.vaadin.flow.component.Component... extraHeaderButtons)

closeWaitMessage

public void closeWaitMessage()

download

public void download(ContentProducer producer,
 Consumer<Long> informMe)

Specified by:

download in interface Device

removeToolbarButtons

public void removeToolbarButtons()

Remove the alert and speaker buttons from the toolbar.

getAlertButton

public com.vaadin.flow.component.Component getAlertButton()

alert

public void alert(LoginMessage message)

Specified by:

alert in interface Device

alert

public void alert(String alert)

Specified by:

alert in interface Device

alert

public void alert(String caption,
 String alert)

Specified by:

alert in interface Device

alert

public void alert(String caption,
 String alert,
 String icon)

getAlert

public StyledBuilder getAlert()

getAlert

public StyledBuilder getAlert(Object alertHandler)

getAlert

public StyledBuilder getAlert(Object alertHandler,
 Id reference)

getAlert

public StyledBuilder getAlert(Id reference)

alertCountChanged

public void alertCountChanged(Object owner)

Description copied from class: Application

This method is invoked whenever alter count changes for a particular owner.

Overrides:

alertCountChanged in class Application

Parameters:

owner - Alert owner

openMenu

public void openMenu()

closeMenu

public void closeMenu()

isMenuOpened

public boolean isMenuOpened()

getHomeImage

public static MediaFile getHomeImage()

login

public final void login()

Description copied from class: Application

This method can be overridden to accept login credentials and Application.loggedin() must be called if successfully logged in.

Overrides:

login in class Application

createLogin

protected Runnable createLogin()

createPostLogin

protected PostLogin createPostLogin()

viewDetached

protected void viewDetached(View view)

Description copied from class: Application

This method is invoked whenever a running View is detached. (Sometimes, the application wants to take some action when a view is detached).

Overrides:

viewDetached in class Application

Parameters:

view - View that is detached now.

loggedIn

public final boolean loggedIn(Login login)

Specified by:

loggedIn in interface Device

forgotPassword

public final boolean forgotPassword(Login login)

Specified by:

forgotPassword in interface Device

forgotPassword

public final void forgotPassword(IdentityCheck identityCheck)

getUserVisibility

public static FilterProvider getUserVisibility(String action)

getProgressBar

public Application.BusyIndicator getProgressBar(boolean indeterminate)

getBusyIndicator

public Application.BusyIndicator getBusyIndicator()

information

public void information(StyledBuilder appDetails)

canCreateMenu

protected boolean canCreateMenu(Logic logic)

canCreateMenu

protected boolean canCreateMenu(LogicGroup logicGroup)

getCountry

public String getCountry()

Description copied from class: Application

Get ISO 2-character the country-code of the user in capital letters. (Examples: "US" for US, "IN" for India). This information is used for formatting the numbers in NumericField.

Overrides:

getCountry in class Application

Returns:

ISO country code. (Default is "US").

checkDayEnd

public void checkDayEnd()

addContent

public void addContent(long fileId,
 AbstractContentGenerator content)

addMultiContent

public void addMultiContent(long fileId,
 AbstractContentGenerator content)

getSMSSender

public QuickSender getSMSSender()

getMailSender

public QuickSender getMailSender()

createInstance

public static Object createInstance(String propertyName,
 boolean showError,
 boolean raiseError)