FireWebApplication

java.lang.Object
- org.fireweb.Element
- - org.fireweb.FireWebApplication

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EventOptionsTest, SerializedApp
```
public class FireWebApplication
extends Element
```
Element represent FireWeb application.
This is main objects container (root).

Version:

4.0

Author:

Piotr Ptak

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

FireWebApplication()

Constructors
Constructor and Description
`FireWebApplication()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FireWebApplication`	`addHeadElement(HeadElement element)` Adds element to <head> if not exists on the list.
`FireWebApplication`	`assignApplicationTitle(java.lang.String title)` Sets application title without calling script.
`java.lang.String`	`getApplicationTitle()`
`java.lang.String[]`	`getBundleNames()` Bundle names annotated at application.
`java.lang.String`	`getCharset()` Charset from servlet definition
`java.lang.String`	`getContextPath()`
`long`	`getCreationTime()` Instance creation time.
`java.util.List<HeadElement>`	`getHeadElements()` List elements of <head>.
`long`	`getLastAccessedTime()` Session last accessed time.
`java.util.Locale`	`getLocale()` Gets current application locale.
`long`	`getMaxInactiveInterval()` Session inactive live time in seconds.
`java.lang.String`	`getOnBeforeAfterEvent()`
`java.lang.String`	`getOnSessionClosed()`
`java.lang.String`	`getResource(java.lang.String key)` Find resource string in bundles defined by `Constants.APPLICATION_RESOURCE_BUNDLE` context parameter.
`java.lang.Object`	`getResourceObject(java.lang.String key)` Find resource object in bundles defined by `Constants.APPLICATION_RESOURCE_BUNDLE` context parameter.
`java.lang.String`	`getSessionId()`
`javax.websocket.Session`	`getWebSocketSession()` Current application's instance of WebSocket.
`FireWebApplication`	`insertHeadElement(HeadElement element, int index)` Insert element to <head> at given index if not exists on the list.
`boolean`	`isDebug()` If application is in debug mode.
`boolean`	`isSessionExpired()` Checks if session expired.
`FireWebApplication`	`quit()` Removes application from server session and closes websocket.
`FireWebApplication`	`refreshView()` Refresh application view.
`FireWebApplication`	`removeHeadElement(HeadElement element)` Removes element from <head>.
`FireWebApplication`	`setApplicationTitle(java.lang.String title)` Sets browser window title and sends JavaScript "document.title=..."
`FireWebApplication`	`setBookmark(java.lang.String bookmark)` Add bookmark to browser (client) history by calling FW.bookmarks.set script.
`FireWebApplication`	`setLocale(java.util.Locale locale)` Sets current application locale and fire event `OnLocaleChanged` on view.
`FireWebApplication`	`setOnBeforeAfterEvent(java.lang.String onBeforeAfterEvent)` Java Script function name or function definition which is calling by FW JS engine on browser before event processing in order to eg prevent click on any active element by displaying translucent element all over whole document.
`FireWebApplication`	`setOnSessionClosed(java.lang.String onSessionClosed)` Java Script function name or function definition which is calling by FW JS engine on browser when server session closed.

Methods inherited from class org.fireweb.Element
add, addAllDropTargets, addDropTarget, addStyleClass, alert, assignText, callBack, callScript, clearDropTargets, clearElements, clearElements, confirm, findElement, findEventOptions, findParent, findViewElements, fireEvent, fireEvent, fireEventOnView, fireEventOnView, firePropertyChange, focus, getApplication, getContenteditableValue, getDir, getDropTargets, getElements, getElements, getEventListeners, getId, getLang, getParent, getStyle, getStyle, getStyleClass, getStyles, getTabIndex, getText, getTitle, getTypeEvents, insert, isChildrenSetChanged, isContenteditable, isDraggable, isDrawn, isListening, listenerOff, listenerOn, print, prompt, remove, remove, removeDropTarget, removeEventOptions, removeParent, removeStyle, removeStyleClass, removeStyles, replace, replaceStyleClass, setChangeChildrenSet, setContenteditable, setDir, setDrawn, setEventOptions, setLang, setParent, setStyle, setStyleClass, setStyles, setTabIndex, setText, setTitle

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

- Constructor Detail
  - FireWebApplication
```
public FireWebApplication()
```
- Method Detail
  - getHeadElements
```
public final java.util.List<HeadElement> getHeadElements()
```
    List elements of <head>.
    
    Returns:
    
    Head elements list
  - quit
```
public final FireWebApplication quit()
```
    Removes application from server session and closes websocket.
    
    Returns:
    
    this
  - getSessionId
```
public final java.lang.String getSessionId()
```
    Returns:
    
    the sessionId
  - getContextPath
```
public final java.lang.String getContextPath()
```
    Returns:
    
    the contextPath
  - refreshView
```
public FireWebApplication refreshView()
```
    Refresh application view.
    
    Returns:
    
    this
  - getWebSocketSession
```
public javax.websocket.Session getWebSocketSession()
```
    Current application's instance of WebSocket.
    
    Returns:
    
    WebSocket instance.
  - getBundleNames
```
public java.lang.String[] getBundleNames()
```
    Bundle names annotated at application.
    
    Returns:
    
    Names array
  - getCharset
```
public java.lang.String getCharset()
```
    Charset from servlet definition
    
    Returns:
    
    charset name
  - isDebug
```
public boolean isDebug()
```
    If application is in debug mode. Comes from servlet definition.
    
    Returns:
    
    true/false
  - getCreationTime
```
public long getCreationTime()
```
    Instance creation time.
    
    Returns:
    
    the creationTime
  - getLastAccessedTime
```
public long getLastAccessedTime()
```
    Session last accessed time.
    
    Returns:
    
    the lastAccessedTime
  - getMaxInactiveInterval
```
public long getMaxInactiveInterval()
```
    Session inactive live time in seconds. Comes from servlet definition.
    
    Returns:
    
    the maxInactiveInterval
  - isSessionExpired
```
public boolean isSessionExpired()
```
    Checks if session expired. Is alive if maxInactiveInterval <= 0 or currentTime - lastAccessedTime <= maxInactiveInterval
    
    Returns:
    
    true/false
  - addHeadElement
```
public FireWebApplication addHeadElement(HeadElement element)
```
    Adds element to <head> if not exists on the list.
    
    Parameters:
    
    element - StyleTag element represents the style
    
    Returns:
    
    this
  - insertHeadElement
```
public FireWebApplication insertHeadElement(HeadElement element,
                                            int index)
```
    Insert element to <head> at given index if not exists on the list.
    
    Parameters:
    
    element - StyleTag element represents the style
    
    index - At which list element to insert
    
    Returns:
    
    this
  - removeHeadElement
```
public FireWebApplication removeHeadElement(HeadElement element)
```
    Removes element from <head>.
    
    Parameters:
    
    element - to remove.
    
    Returns:
    
    this
  - setBookmark
```
public FireWebApplication setBookmark(java.lang.String bookmark)
```
    Add bookmark to browser (client) history by calling FW.bookmarks.set script.
    
    Parameters:
    
    bookmark - value will be sent to browser
    
    Returns:
    
    this
  - getApplicationTitle
```
public java.lang.String getApplicationTitle()
```
    Returns:
    
    Window browser title.
  - assignApplicationTitle
```
public FireWebApplication assignApplicationTitle(java.lang.String title)
```
    Sets application title without calling script.
    
    Parameters:
    
    title - String with application title
    
    Returns:
    
    this
  - setApplicationTitle
```
public FireWebApplication setApplicationTitle(java.lang.String title)
```
    Sets browser window title and sends JavaScript "document.title=..."
    
    Parameters:
    
    title - the application title to set
    
    Returns:
    
    this
  - getLocale
```
public java.util.Locale getLocale()
```
    Gets current application locale. Coming from request.
    
    Returns:
    
    the locale
  - setLocale
```
public FireWebApplication setLocale(java.util.Locale locale)
```
    Sets current application locale and fire event OnLocaleChanged on view. Event contains previous locale.
    
    Parameters:
    
    locale - the locale to set
    
    Returns:
    
    this
  - setOnSessionClosed
```
public FireWebApplication setOnSessionClosed(java.lang.String onSessionClosed)
```
    Java Script function name or function definition which is calling by FW JS engine on browser when server session closed. If is null or empty the FW.utils.defautlSessionClosed will be calling.
    
    Parameters:
    
    onSessionClosed - String JS script
    
    Returns:
    
    this
  - getOnSessionClosed
```
public java.lang.String getOnSessionClosed()
```
    Returns:
    
    the Java Script function name or function definition which is calling by FW JS engine on browser when server session closed.
  - setOnBeforeAfterEvent
```
public FireWebApplication setOnBeforeAfterEvent(java.lang.String onBeforeAfterEvent)
```
    Java Script function name or function definition which is calling by FW JS engine on browser before event processing in order to eg prevent click on any active element by displaying translucent element all over whole document. If is null or empty the FW.utils.defaultBeforeAfterEvent will be calling.
    
    Parameters:
    
    onBeforeAfterEvent - String JS script
    
    Returns:
    
    this
  - getOnBeforeAfterEvent
```
public java.lang.String getOnBeforeAfterEvent()
```
    Returns:
    
    the Java Script function name or function definition which is calling by FW JS engine on browser before event processing in order to eg prevent click on any active element by displaying translucent element all over whole document.
  - getResource
```
public java.lang.String getResource(java.lang.String key)
```
    Find resource string in bundles defined by Constants.APPLICATION_RESOURCE_BUNDLE context parameter.
    
    Parameters:
    
    key - resource bundle string to find
    
    Returns:
    
    found resource string
    
    Throws:
    
    java.util.MissingResourceException - if not found resource by the key
  - getResourceObject
```
public java.lang.Object getResourceObject(java.lang.String key)
```
    Find resource object in bundles defined by Constants.APPLICATION_RESOURCE_BUNDLE context parameter.
    
    Parameters:
    
    key - resource bundle string to find
    
    Returns:
    
    found resource object
    
    Throws:
    
    java.util.MissingResourceException - if not found resource by the key

Class FireWebApplication

Constructor Summary

Method Summary

Methods inherited from class org.fireweb.Element

Methods inherited from class java.lang.Object

Constructor Detail

FireWebApplication

Method Detail

getHeadElements

quit

getSessionId

getContextPath

refreshView

getWebSocketSession

getBundleNames

getCharset

isDebug

getCreationTime

getLastAccessedTime

getMaxInactiveInterval

isSessionExpired

addHeadElement

insertHeadElement

removeHeadElement

setBookmark

getApplicationTitle

assignApplicationTitle

setApplicationTitle

getLocale

setLocale

setOnSessionClosed

getOnSessionClosed

setOnBeforeAfterEvent

getOnBeforeAfterEvent

getResource

getResourceObject