Package org.exoplatform.webui.core

Class UIPortletApplication

java.lang.Object

org.exoplatform.webui.core.UIComponent

org.exoplatform.webui.core.UIContainer

org.exoplatform.webui.core.UIApplication

org.exoplatform.webui.core.UIPortletApplication

All Implemented Interfaces:

Serializable

public abstract class UIPortletApplication
extends UIApplication

Root UI component of portlets written using GateIn WebUI framework should extends this class
There are 3 WebUI lifecycle methods, that are called during JSR 286 portlet lifecycle :
- processDecode - decode and bind parameters from the request to WebUI component
- processAction - triggered when there is a request for portlet ActionURL, or a WebUI event
- processRender - mapped to JSR 286 render method
- serveResource - mapped to JSR 286 serveResource method
Portlet request go through this class and then be delegated to child WebUI components with the help of UIApplicationLifecycle. Use ComponentConfig annotation to config lifecycle class for WebUI component.
This class also provides machanism to show a WebUI popup message

See Also:

• UIApplicationLifecycle
• PortletApplicationController
• PortletApplication
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.exoplatform.webui.core.UIContainer

UIContainer.SelectTabActionListener

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_MODE
static String	EDIT_MODE
static String	HELP_MODE
static String	VIEW_MODE

Fields inherited from class org.exoplatform.webui.core.UIApplication

log

Fields inherited from class org.exoplatform.webui.core.UIComponent

AJAX_ASYNC, config, OBJECTID, UICOMPONENT, uiparent, USE_WEBUI_RESOURCES

Constructor Summary

Constructors

Constructor	Description
UIPortletApplication()

Method Summary

Modifier and Type	Method	Description
int	getMinHeight()	Deprecated.
int	getMinWidth()	Deprecated.
UIPopupMessages	getUIPopupMessages()	Return the common UIPopupMessages
void	processRender(WebuiApplication app, WebuiRequestContext context)	The default processRender for an UIPortletApplication does nothing if the current WindowState in the render request is MINIMIZED.
void	renderChildren()
void	serveResource(WebuiRequestContext context)	Root uicomponent of a portlet should override this method to leverage serveResource that JSR286 offers
void	setMinHeight(int minHeight)	Deprecated.
void	setMinWidth(int minWidth)	Deprecated.

Methods inherited from class org.exoplatform.webui.core.UIApplication

addMessage, addMessage, clearMessages, findComponentById, getLastAccessApplication, getUIComponentName, processAction, renderBlockToUpdate, setLastAccessApplication

Methods inherited from class org.exoplatform.webui.core.UIContainer

addChild, addChild, findComponentOfType, findFirstComponentOfType, getChild, getChild, getChildById, getChildren, hasChildren, removeChild, removeChildById, renderChild, renderChild, renderChild, renderChild, renderChildren, renderUIComponent, replaceChild, replaceChild, setChildren, setRenderedChild, setRenderedChild, setRenderedChildrenOfTypes

Methods inherited from class org.exoplatform.webui.core.UIComponent

broadcast, buildModelObject, createEvent, createUIComponent, createUIComponent, createUIComponent, doAsync, event, event, event, getAncestorOfType, getApplicationComponent, getComponentConfig, getId, getName, getParent, getTemplate, getTemplateResourceResolver, isRendered, loadConfirmMesssage, processDecode, processRender, renderEventURL, setComponentConfig, setComponentConfig, setId, setParent, setRendered, setRenderSibling, url, url, url

Methods inherited from class java.lang.Object

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

Field Details

VIEW_MODE

public static String VIEW_MODE

EDIT_MODE

public static String EDIT_MODE

HELP_MODE

public static String HELP_MODE

CONFIG_MODE

public static String CONFIG_MODE

Constructor Details

UIPortletApplication

public UIPortletApplication()
                     throws Exception

Throws:

Exception

Method Details

getUIPopupMessages

public UIPopupMessages getUIPopupMessages()

Description copied from class: UIApplication

Return the common UIPopupMessages

Overrides:

getUIPopupMessages in class UIApplication

Returns:

UIPopupMessages

getMinWidth

@Deprecated
public int getMinWidth()

Deprecated.

setMinWidth

@Deprecated
public void setMinWidth(int minWidth)

Deprecated.

getMinHeight

@Deprecated
public int getMinHeight()

Deprecated.

setMinHeight

@Deprecated
public void setMinHeight(int minHeight)

Deprecated.

renderChildren

public void renderChildren()
                    throws Exception

Overrides:

renderChildren in class UIApplication

Throws:

Exception

processRender

public void processRender(WebuiApplication app,
 WebuiRequestContext context)
                   throws Exception

The default processRender for an UIPortletApplication does nothing if the current WindowState in the render request is MINIMIZED. Otherwise, it handles two cases: A. Ajax is used --------------- If Ajax is used and that the entire portal should not be re rendered, then an AJAX fragment is generated with information such as the portlet id, the portlet title, the portlet modes, the window states as well as the HTML for the block to render B. A full render is made ------------------------ a simple call to the method super.processRender(context) which will delegate the call to all the Lifecycle components

Throws:

Exception

serveResource

public void serveResource(WebuiRequestContext context)
                   throws Exception

Root uicomponent of a portlet should override this method to leverage serveResource that JSR286 offers

Parameters:

context - - WebUI context

Throws:

Exception