FireWebApplication

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

```
@Type(tagName="body")
public class FireWebApplication
extends Element
```
Element represent FireWeb application.
This is main objects container (root).

Version:

3.2

Author:

Piotr Ptak

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.
`protected void`	`clearScript()` Clears Java Script buffer
`void`	`drawAttributes()` Draws onLoad event code of HTML document which is container of application view.
`java.lang.String`	`getApplicationTitle()`
`java.util.List<HeadElement>`	`getHeadElements()` List elements of <head>.
`java.util.Locale`	`getLocale()` Gets current application locale.
`java.lang.String`	`getOnBeforeAfterEvent()`
`java.lang.String`	`getOnFeedbackTimeout()`
`java.lang.String`	`getOnSessionClosed()`
`protected java.lang.StringBuffer`	`getScript()`
`FireWebApplication`	`insertHeadElement(HeadElement element, int index)` Insert element to <head> at given index if not exists on the list.
`FireWebApplication`	`quit()` Removes application from server session.
`FireWebApplication`	`refreshView()` Reloads 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.
`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`	`setOnFeedbackTimeout(java.lang.String onFeedbackTimeout)` Java Script function name or function definition which is calling by FW JS engine on browser when event processing takes more then 1 second.
`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, addListener, addStyleClass, alert, assignText, callBack, callBack, callScript, clearDropTargets, clearElements, clearElements, confirm, confirm, drawAttribute, findElement, findParent, findViewElements, fireEvent, fireEvent, fireEventOnView, fireEventOnView, firePropertyChange, focus, getApplication, getBundle, getBundleObject, getCustomDragMove, getDir, getDragDropEventsOptions, getDropTargets, getElements, getElements, getEventListeners, getId, getLang, getParent, getStyle, getStyleClass, getTabIndex, getText, getTitle, insert, isChildrenSetChanged, isContenteditable, isDraggable, isDrawn, isEscapeText, isListening, isListening, isListening, print, prompt, prompt, remove, remove, removeAttribute, removeDropTarget, removeListener, removeListener, removeParent, removeStyleClass, replace, replaceStyleClass, retrieveListeners, retrieveListeners, setChangeChildrenSet, setContenteditable, setCustomDragMove, setDir, setDragDropEventsOptions, setDraggable, setDrawn, setEscapeText, setLang, setParent, setStyle, setStyleClass, setTabIndex, setText, setTitle, transformTagName

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

- Constructor Detail
  - FireWebApplication
```
public FireWebApplication()
```
- Method Detail
  - getScript
```
protected java.lang.StringBuffer getScript()
```
    Returns:
    
    the script
  - clearScript
```
protected void clearScript()
```
    Clears Java Script buffer
  - drawAttributes
```
@InitializeAttributes
public void drawAttributes()
```
    Draws onLoad event code of HTML document which is container of application view.
  - getHeadElements
```
public java.util.List<HeadElement> getHeadElements()
```
    List elements of <head>.
    
    Returns:
    
    Head elements list
  - 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
  - refreshView
```
public FireWebApplication refreshView()
```
    Reloads application view.
    
    Returns:
    
    this
  - quit
```
public FireWebApplication quit()
```
    Removes application from server session.
    
    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.
    
    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.
  - setOnFeedbackTimeout
```
public FireWebApplication setOnFeedbackTimeout(java.lang.String onFeedbackTimeout)
```
    Java Script function name or function definition which is calling by FW JS engine on browser when event processing takes more then 1 second. If is null or empty the FW.utils.defaultFeedbackTimeout will be calling.
    
    Parameters:
    
    onFeedbackTimeout - String JS script
    
    Returns:
    
    this
  - getOnFeedbackTimeout
```
public java.lang.String getOnFeedbackTimeout()
```
    Returns:
    
    the Java Script function name or function definition which is calling by FW JS engine on browser when event processing takes more then 1 second.
  - 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.

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

getScript

clearScript

drawAttributes

getHeadElements

addHeadElement

insertHeadElement

removeHeadElement

refreshView

quit

setBookmark

getApplicationTitle

assignApplicationTitle

setApplicationTitle

getLocale

setLocale

setOnSessionClosed

getOnSessionClosed

setOnFeedbackTimeout

getOnFeedbackTimeout

setOnBeforeAfterEvent

getOnBeforeAfterEvent