Package org.exoplatform.webui.core

Class UIGrid

java.lang.Object

org.exoplatform.webui.core.UIComponent

org.exoplatform.webui.core.UIGrid

Direct Known Subclasses:

UIFormGrid

public class UIGrid
extends UIComponent

Created by The eXo Platform SARL Author : Tuan Nguyen tuan08@users.sourceforge.net May 7, 2006
A grid element (represented by an HTML table) that can be paginated with a UIPageIterator

See Also:

• UIPageIterator

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	action_	An array of String representing the actions on each bean
protected String[]	beanField_	An array of String representing the fields in each bean
protected String	beanIdField_	The bean field that holds the id of this bean
protected int	displayedChars_
protected String	label_
protected UIPageIterator	uiIterator_	The page iterator
protected boolean	useAjax

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

AJAX_ASYNC, config, OBJECTID, UICOMPONENT, uiparent, USE_WEBUI_RESOURCES

Constructor Summary

Constructors

Constructor	Description
UIGrid()

Method Summary

Modifier and Type	Method	Description
UIGrid	configure(String beanIdField, String[] beanField, String[] action)
UIComponent	findComponentById(String lookupId)
String[]	getBeanActions()
String[]	getBeanFields()
String	getBeanIdField()
String	getBeanIdFor(Object bean)
List<?>	getBeans()
int	getDisplayedChars()
Object	getFieldValue(Object bean, String field)
String	getLabel()
UIPageIterator	getUIPageIterator()
boolean	isUseAjax()
void	setDisplayedChars(int displayedChars)
void	setLabel(String label)
void	setUseAjax(boolean value)

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

broadcast, buildModelObject, createEvent, createUIComponent, createUIComponent, createUIComponent, doAsync, event, event, event, findComponentOfType, findFirstComponentOfType, getAncestorOfType, getApplicationComponent, getComponentConfig, getId, getName, getParent, getTemplate, getTemplateResourceResolver, getUIComponentName, isRendered, loadConfirmMesssage, processAction, 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

uiIterator_

protected UIPageIterator uiIterator_

The page iterator

beanIdField_

protected String beanIdField_

The bean field that holds the id of this bean

beanField_

protected String[] beanField_

An array of String representing the fields in each bean

action_

protected String[] action_

An array of String representing the actions on each bean

label_

protected String label_

useAjax

protected boolean useAjax

displayedChars_

protected int displayedChars_

Constructor Details

UIGrid

public UIGrid()
       throws Exception

Throws:

Exception

Method Details

getUIPageIterator

public UIPageIterator getUIPageIterator()

configure

public UIGrid configure(String beanIdField,
 String[] beanField,
 String[] action)

getBeanIdField

public String getBeanIdField()

getBeanFields

public String[] getBeanFields()

getBeanActions

public String[] getBeanActions()

getBeans

public List<?> getBeans()
                 throws Exception

Throws:

Exception

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getFieldValue

public Object getFieldValue(Object bean,
 String field)
                     throws Exception

Throws:

Exception

getBeanIdFor

public String getBeanIdFor(Object bean)
                    throws Exception

Throws:

Exception

findComponentById

public UIComponent findComponentById(String lookupId)

Overrides:

findComponentById in class UIComponent

isUseAjax

public boolean isUseAjax()

setUseAjax

public void setUseAjax(boolean value)

getDisplayedChars

public int getDisplayedChars()

setDisplayedChars

public void setDisplayedChars(int displayedChars)