Package org.exoplatform.webui.core

Class UIComponent

java.lang.Object

org.exoplatform.webui.core.UIComponent

Direct Known Subclasses:

UIAbstractManagerComponent, UIBreadcumbs, UIComponentDecorator, UIContainer, UIDropDownControl, UIGrid, UIItemSelector, UIPageIterator, UIRepeater, UIRightClickPopupMenu, UIToolbar, UITree

public abstract class UIComponent
extends Object

Created by The eXo Platform SAS May 7, 2006

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AJAX_ASYNC
protected Component	config
static final String	OBJECTID
static final String	UICOMPONENT
protected UIComponent	uiparent
static final boolean	USE_WEBUI_RESOURCES

Constructor Summary

Constructors

Constructor	Description
UIComponent()

Method Summary

Modifier and Type	Method	Description
<T> void	broadcast(Event<T> event, Event.Phase phase)
org.exoplatform.portal.config.model.ModelObject	buildModelObject()
Event<UIComponent>	createEvent(String name, Event.Phase phase, WebuiRequestContext context)
<T extends UIComponent> T	createUIComponent(Class<T> type, String configId, String componentId)
<T extends UIComponent> T	createUIComponent(Class<T> type, String configId, String componentId, UIComponent parent)
<T extends UIComponent> T	createUIComponent(WebuiRequestContext context, Class<T> type, String configId, String componentId)
String	doAsync(String name, String beanId, org.exoplatform.web.application.Parameter[] params)
String	event(String name)
String	event(String name, String beanId)
String	event(String name, String beanId, org.exoplatform.web.application.Parameter[] params)	Render an event ajax URL for a given bean.
<T extends UIComponent> T	findComponentById(String lookupId)
<T> void	findComponentOfType(List<T> list, Class<T> type)
<T extends UIComponent> T	findFirstComponentOfType(Class<T> type)
<T extends UIComponent> T	getAncestorOfType(Class<T> classType)
<T> T	getApplicationComponent(Class<T> type)
Component	getComponentConfig()
String	getId()
String	getName()
<T extends UIComponent> T	getParent()
String	getTemplate()
org.exoplatform.resolver.ResourceResolver	getTemplateResourceResolver(WebuiRequestContext context, String template)
String	getUIComponentName()
boolean	isRendered()
protected String	loadConfirmMesssage(Event event, WebuiRequestContext context, String beanId)
void	processAction(WebuiRequestContext context)
void	processDecode(WebuiRequestContext context)
void	processRender(WebuiRequestContext context)
String	renderEventURL(boolean ajax, String name, String beanId, org.exoplatform.web.application.Parameter[] params)	Render an event URL of a given bean.
void	setComponentConfig(Class<?> clazz, String id)
void	setComponentConfig(String componentId, Component config)
UIComponent	setId(String id)
void	setParent(UIComponent uicomponent)
<T extends UIComponent> T	setRendered(boolean b)
<T extends UIComponent> void	setRenderSibling(Class<T> type)
String	url(String name)
String	url(String name, String beanId)
String	url(String name, String beanId, org.exoplatform.web.application.Parameter[] params)	Render an event URL for a given bean.

Methods inherited from class java.lang.Object

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

Field Details

USE_WEBUI_RESOURCES

public static final boolean USE_WEBUI_RESOURCES

OBJECTID

public static final String OBJECTID

See Also:

• Constant Field Values

UICOMPONENT

public static final String UICOMPONENT

See Also:

• Constant Field Values

AJAX_ASYNC

public static final String AJAX_ASYNC

See Also:

• Constant Field Values

uiparent

protected UIComponent uiparent

config

protected Component config

Constructor Details

UIComponent

public UIComponent()

Method Details

getId

public String getId()

setId

public UIComponent setId(String id)

getName

public String getName()

getParent

public <T extends UIComponent> T getParent()

setParent

public void setParent(UIComponent uicomponent)

isRendered

public boolean isRendered()

setRendered

public <T extends UIComponent> T setRendered(boolean b)

processDecode

public void processDecode(WebuiRequestContext context)
                   throws Exception

Throws:

Exception

processAction

public void processAction(WebuiRequestContext context)
                   throws Exception

Throws:

Exception

processRender

public void processRender(WebuiRequestContext context)
                   throws Exception

Throws:

Exception

getComponentConfig

public Component getComponentConfig()

setComponentConfig

public void setComponentConfig(String componentId,
 Component config)

setComponentConfig

public void setComponentConfig(Class<?> clazz,
 String id)

getTemplate

public String getTemplate()

getTemplateResourceResolver

public org.exoplatform.resolver.ResourceResolver getTemplateResourceResolver(WebuiRequestContext context,
 String template)

getAncestorOfType

public <T extends UIComponent> T getAncestorOfType(Class<T> classType)

loadConfirmMesssage

protected String loadConfirmMesssage(Event event,
 WebuiRequestContext context,
 String beanId)

event

public String event(String name)
             throws Exception

Throws:

Exception

event

public String event(String name,
 String beanId)
             throws Exception

Throws:

Exception

event

public String event(String name,
 String beanId,
 org.exoplatform.web.application.Parameter[] params)
             throws Exception

Render an event ajax URL for a given bean.

Parameters:

name - the event name

beanId - the optional bean id

params - the optional event parameters

Returns:

the rendered URL

Throws:

Exception - any exception

url

public String url(String name)
           throws Exception

Throws:

Exception

url

public String url(String name,
 String beanId)
           throws Exception

Throws:

Exception

url

public String url(String name,
 String beanId,
 org.exoplatform.web.application.Parameter[] params)
           throws Exception

Render an event URL for a given bean.

Parameters:

name - the event name

beanId - the optional bean id

params - the optional event parameters

Returns:

the rendered URL

Throws:

Exception - any exception

renderEventURL

public String renderEventURL(boolean ajax,
 String name,
 String beanId,
 org.exoplatform.web.application.Parameter[] params)
                      throws Exception

Render an event URL of a given bean.

Parameters:

ajax - the url type, true for ajax, false otherwise

name - the event name

beanId - the optional bean id

params - the optional event parameters

Returns:

the rendered URL

Throws:

Exception - any exception

doAsync

public String doAsync(String name,
 String beanId,
 org.exoplatform.web.application.Parameter[] params)
               throws Exception

Throws:

Exception

broadcast

public <T> void broadcast(Event<T> event,
 Event.Phase phase)
                   throws Exception

Throws:

Exception

createUIComponent

public <T extends UIComponent> T createUIComponent(Class<T> type,
 String configId,
 String componentId,
 UIComponent parent)
                                            throws Exception

Throws:

Exception

createUIComponent

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

Throws:

Exception

createUIComponent

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

Throws:

Exception

findComponentById

public <T extends UIComponent> T findComponentById(String lookupId)

findFirstComponentOfType

public <T extends UIComponent> T findFirstComponentOfType(Class<T> type)

findComponentOfType

public <T> void findComponentOfType(List<T> list,
 Class<T> type)

setRenderSibling

public <T extends UIComponent> void setRenderSibling(Class<T> type)

getUIComponentName

public String getUIComponentName()

getApplicationComponent

public <T> T getApplicationComponent(Class<T> type)

buildModelObject

public org.exoplatform.portal.config.model.ModelObject buildModelObject()

createEvent

public Event<UIComponent> createEvent(String name,
 Event.Phase phase,
 WebuiRequestContext context)
                               throws Exception

Throws:

Exception