Package org.exoplatform.webui.application

Class WebuiApplication

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.web.application.Application

org.exoplatform.webui.application.WebuiApplication

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

PortalApplication, PortletApplication

public abstract class WebuiApplication
extends org.exoplatform.web.application.Application

Created by The eXo Platform SAS May 7, 2006 This abstract class defines several methods to abstract the differnt type of web application the eXo web framework can provide such as portal or portlet.

Field Summary

Fields inherited from class org.exoplatform.web.application.Application

EXO_GADGET_TYPE, EXO_PORTAL_TYPE, EXO_PORTLET_TYPE, JSR168_APPLICATION_TYPE, WSRP_TYPE

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor	Description
WebuiApplication()

Method Summary

Modifier and Type	Method	Description
<T> void	broadcast(Event<T> event)
<T extends UIComponent> T	createUIComponent(Class<T> type, String configId, String id, WebuiRequestContext context)
abstract String	getApplicationInitParam(String name)
ConfigurationManager	getConfigurationManager()
Set<UIComponent>	getDefaultUIComponentToUpdateByAjax(WebuiRequestContext context)
StateManager	getStateManager()
void	onInit()	This initialisation goals is to first extract and parse the webui configuration XML file defined inside the web.xml of the web application.
void	setStateManager(StateManager sm)

Methods inherited from class org.exoplatform.web.application.Application

getApplicationGroup, getApplicationId, getApplicationLifecycle, getApplicationName, getApplicationServiceContainer, getApplicationType, getAttribute, getOwnerResourceBundle, getResourceBundle, getResourceResolver, onDestroy, setApplicationLifecycle, setAttribute, setResourceResolver

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Details

WebuiApplication

public WebuiApplication()

Method Details

onInit

public void onInit()
            throws Exception

This initialisation goals is to first extract and parse the webui configuration XML file defined inside the web.xml of the web application. The ConfigurationManager class is responsible of the parsing and then wrap all the information about the UI configuration. One of the information is the real implementation of the StateManager object. That object is extracted from the configuration and stored as a field in that class. Lifecycle phases are also extracted from the XML file, referenced in this WebuiApplication class and initialized at the same time.

Overrides:

onInit in class org.exoplatform.web.application.Application

Throws:

Exception

getConfigurationManager

public ConfigurationManager getConfigurationManager()

getStateManager

public StateManager getStateManager()

setStateManager

public void setStateManager(StateManager sm)

getApplicationInitParam

public abstract String getApplicationInitParam(String name)

broadcast

public <T> void broadcast(Event<T> event)
                   throws Exception

Throws:

Exception

createUIComponent

public <T extends UIComponent> T createUIComponent(Class<T> type,
 String configId,
 String id,
 WebuiRequestContext context)
                                            throws Exception

Throws:

Exception

getDefaultUIComponentToUpdateByAjax

public Set<UIComponent> getDefaultUIComponentToUpdateByAjax(WebuiRequestContext context)