Application (ontimize-core 5.6.0 API)

All Superinterfaces:

Internationalization

All Known Implementing Classes:

MainApplication
```
public interface Application
extends Internationalization
```
Defines the methods that an application must implement. Those methods allows to interchange references among the application elements as well to perform the main operations the application must perform.

Field Summary
- Fields inherited from interface com.ontimize.gui.i18n.Internationalization
  DEBUG_LANGUAGE

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`endSession()` Ends the user session.
`void`	`exit()` Closes the application.
`IFormManager`	`getFormManager(String formManagerName)` Provides a reference to a FormManager.
`Frame`	`getFrame()` Returns the frame in which the application is placed.
`Locale`	`getLocale()` Returns the current application locale.
`JMenuBar`	`getMenu()` Provides a reference to the application menu bar.
`MenuListener`	`getMenuListener()` Provides a reference to the class that listens the menu events.
`String`	`getName()` Returns the application name.
`ApplicationPreferences`	`getPreferences()` Returns the application preferences.
`EntityReferenceLocator`	`getReferenceLocator()` Provides a reference to the ReferenceLocator configured to this application.
`ResourceBundle`	`getResourceBundle()` Returns the current application resource bundle.
`JToolBar`	`getToolBar()` Provides a reference to the application tool bar.
`ToolBarListener`	`getToolBarListener()` Returns the application tool bar listener
`void`	`lock()` Deprecated.
`boolean`	`login()` Performs the login operation
`void`	`registerFormManager(String formManagerName, IFormManager formManager)` Adds a FormManager to the application.
`void`	`registerStatusComponent(StatusComponent statusComponent)` Register a `StatusComponent` to be managed by this application.
`void`	`setMenu(JMenuBar menuBar)` Sets a menu bar to the application.
`void`	`setMenuListener(MenuListener menuListener)` Sets the application menu listener
`void`	`setReferencesLocator(EntityReferenceLocator locator)` Sets the EntityReferenceLocator for this application.
`void`	`setStatusBarText(String text)` Sets a text in the application bar.
`void`	`setToolBar(JToolBar toolBar)` Sets a tool bar to the application.
`void`	`setToolBarListener(ToolBarListener toolbarListener)` Sets a toolbarListener
`void`	`show()` Shows the application.
`void`	`showFormManagerContainer(String formManagerName)` Shows a form manager.
`void`	`unregisterStatusComponent(StatusComponent statusComponent)` Unregister a `StatusComponent` from the list of the be application managed components.

Methods inherited from interface com.ontimize.gui.i18n.Internationalization
getTextsToTranslate, setComponentLocale, setResourceBundle

- Method Detail
  - setMenu
```
void setMenu(JMenuBar menuBar)
```
    Sets a menu bar to the application.
    
    Parameters:
    menuBar - the menu bar
    See Also:
    ApplicationMenuBar
  - setToolBar
```
void setToolBar(JToolBar toolBar)
```
    Sets a tool bar to the application.
    
    Parameters:
    toolBar - the tool bar
    See Also:
    ApplicationToolBar
  - getReferenceLocator
```
EntityReferenceLocator getReferenceLocator()
```
    Provides a reference to the ReferenceLocator configured to this application. The locator is set by the application constructor, and is mandatory to perform the login process.
    
    Returns:
    a reference to the ReferencesLocator, null in case no locator set yet
  - setReferencesLocator
```
void setReferencesLocator(EntityReferenceLocator locator)
```
    Sets the EntityReferenceLocator for this application. The references locator is necessary to provide references to the Entity objects. The locator set will be unique for the whole application.
    
    Parameters:
    locator -
  - showFormManagerContainer
```
void showFormManagerContainer(String formManagerName)
```
    Shows a form manager.
    
    Parameters:
    formManagerName - the name of the FormManager to show.
  - getFormManager
```
IFormManager getFormManager(String formManagerName)
```
    Provides a reference to a FormManager.
    
    Parameters:
    formManagerName - the name of the FormManager
    
    Returns:
    the FormManager or null in case that FormManager does not exist.
  - registerFormManager
```
void registerFormManager(String formManagerName,
                       IFormManager formManager)
```
    Adds a FormManager to the application.
    
    Parameters:
    formManagerName - the FormManager class
    formManager - the name that will be use to register and reference the FormManager
  - show
```
void show()
```
    Shows the application. This is the last method that is called before showing the application to the user. If some operations must be done before the application is loaded, this is the method that must be overwritten/implemented. For example, if the application must be sent to the tool bar just before to be showed, this is the method in which do that.
  - getFrame
```
Frame getFrame()
```
    Returns the frame in which the application is placed.
  - login
```
boolean login()
```
    Performs the login operation
  - exit
```
void exit()
```
    Closes the application.
  - lock
```
@Deprecated
void lock()
```
    Deprecated.
    
    Locks the application without closing it.
  - endSession
```
void endSession()
```
    Ends the user session.
  - getLocale
```
Locale getLocale()
```
    Returns the current application locale.
    
    Returns:
    the current application locale
  - getResourceBundle
```
ResourceBundle getResourceBundle()
```
    Returns the current application resource bundle.
    
    Returns:
    the current application resource bundle
  - getMenu
```
JMenuBar getMenu()
```
    Provides a reference to the application menu bar.
    
    Returns:
    the application menu bar
  - getMenuListener
```
MenuListener getMenuListener()
```
    Provides a reference to the class that listens the menu events.
    
    Returns:
    the application menu listener
  - setMenuListener
```
void setMenuListener(MenuListener menuListener)
```
    Sets the application menu listener
    
    Parameters:
    menuListener - the application menu listener
  - getToolBar
```
JToolBar getToolBar()
```
    Provides a reference to the application tool bar.
    
    Returns:
    the application tool bar
  - getToolBarListener
```
ToolBarListener getToolBarListener()
```
    Returns the application tool bar listener
    
    Returns:
    the application tool bar listener
  - setToolBarListener
```
void setToolBarListener(ToolBarListener toolbarListener)
```
    Sets a toolbarListener
    
    Parameters:
    toolbarListener - the new ToolBarListener
  - getPreferences
```
ApplicationPreferences getPreferences()
```
    Returns the application preferences.
    
    Returns:
    the preferences for the application
  - setStatusBarText
```
void setStatusBarText(String text)
```
    Sets a text in the application bar.
    
    Parameters:
    text -
  - registerStatusComponent
```
void registerStatusComponent(StatusComponent statusComponent)
```
    Register a StatusComponent to be managed by this application.
    
    Parameters:
    statusComponent - the StatusComponent
  - unregisterStatusComponent
```
void unregisterStatusComponent(StatusComponent statusComponent)
```
    Unregister a StatusComponent from the list of the be application managed components.
    
    Parameters:
    statusComponent - the StatusComponent
  - getName
```
String getName()
```
    Returns the application name.
    
    Returns:
    the application name.

Interface Application

Field Summary

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

Method Summary

Methods inherited from interface com.ontimize.gui.i18n.Internationalization

Method Detail

setMenu

setToolBar

getReferenceLocator

setReferencesLocator

showFormManagerContainer

getFormManager

registerFormManager

show

getFrame

login

exit

lock

endSession

getLocale

getResourceBundle

getMenu

getMenuListener

setMenuListener

getToolBar

getToolBarListener

setToolBarListener

getPreferences

setStatusBarText

registerStatusComponent

unregisterStatusComponent

getName