org.exoplatform.dashboard.webui.component

Class UIDashboardContainer

java.lang.Object

org.exoplatform.webui.core.UIComponent

org.exoplatform.webui.core.UIContainer

org.exoplatform.dashboard.webui.component.UIDashboardContainer

public class UIDashboardContainer
extends org.exoplatform.webui.core.UIContainer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIDashboardContainer.AddNewGadgetActionListener
static class	UIDashboardContainer.DeleteGadgetActionListener
static class	UIDashboardContainer.MoveGadgetActionListener

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

org.exoplatform.webui.core.UIContainer.SelectTabActionListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLINDEX
static String	COLUMN_CONTAINER Column Type of Container
static int	MAX_COLUMN Specify max number of columns in dashboard container Default value is 4
static String	ROOT_CONTAINER Root Type of Container
static String	ROW_CONTAINER Row Type of Container
static String	ROWINDEX
static String	SAVE_FAIL

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

AJAX_ASYNC, config, OBJECTID, UICOMPONENT, uiparent

Constructor Summary

Constructors

Constructor and Description
UIDashboardContainer(org.exoplatform.webui.config.InitParams initParams) Constructs new UIDashboardContainer which belongs to a UIDashboardPortlet

Method Summary

Modifier and Type	Method and Description
void	addUIGadget(UIGadget gadget, int col, int row) Adds an UIGadget into UIDashboardContainer in specified position
org.exoplatform.portal.config.model.Container	createContainer(String type, String id) Creates a Container that representation of row or column in this UIDashboardContainer
UIContainer	getColumn(int col) Gets an UIContainer representation of a column at specified index
List<UIContainer>	getColumns() Returns a List of the UIContainers of this UIDashboardContainer which representation of list of columns.
String	getContainerTemplate()
UIGadget	getUIGadget(int col, int row) Gets an UIGadget at specified position
UIGadget	getUIGadget(String gadgetId) Gets an UIGadget which has applicationInstanceUniqueId_ according to specified Id
String	getWindowId() Get windowId of UIPortlet
boolean	hasUIGadget() Tests if this UIDashboardContainer has UIGadget
void	moveUIGadget(String gadgetId, int col, int row) Moves an UIGadget which has specified applicationInstanceUniqueId_ to specified position
void	processRender(org.exoplatform.webui.application.WebuiRequestContext context)
UIGadget	removeUIGadget(int col, int row) Removes an UIGadget at specified position
UIGadget	removeUIGadget(String gadgetId) Removes an UIGadget belongs to this which has specified applicationInstanceUniqueId_
void	save() Saves all UIComponent of this UIDashboardContainer to database
UIDashboardContainer	setColumns(int num) Sets total of columns of this UIDashboardContainer, total of columns is between 1 and MAX_COLUMN
void	setContainerTemplate(String template)

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

addChild, addChild, findComponentById, findComponentOfType, findFirstComponentOfType, getChild, getChild, getChildById, getChildren, hasChildren, removeChild, removeChildById, renderChild, renderChild, renderChild, renderChild, renderChildren, 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, getUIComponentName, isRendered, loadConfirmMesssage, processAction, processDecode, 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 Detail

MAX_COLUMN

public static final int MAX_COLUMN

Specify max number of columns in dashboard container Default value is 4

See Also:

Constant Field Values

COLUMN_CONTAINER

public static final String COLUMN_CONTAINER

Column Type of Container

See Also:

Constant Field Values

ROW_CONTAINER

public static final String ROW_CONTAINER

Row Type of Container

See Also:

Constant Field Values

ROOT_CONTAINER

public static final String ROOT_CONTAINER

Root Type of Container

See Also:

Constant Field Values

COLINDEX

public static final String COLINDEX

See Also:

Constant Field Values

ROWINDEX

public static final String ROWINDEX

See Also:

Constant Field Values

SAVE_FAIL

public static String SAVE_FAIL

Constructor Detail

UIDashboardContainer

public UIDashboardContainer(org.exoplatform.webui.config.InitParams initParams)
                     throws Exception

Constructs new UIDashboardContainer which belongs to a UIDashboardPortlet

Parameters:

initParams - initial parameters

Throws:

Exception - if can't create UIDashboardContainer

See Also:

DashboardParent, InitParams

Method Detail

processRender

public void processRender(org.exoplatform.webui.application.WebuiRequestContext context)
                   throws Exception

Overrides:

processRender in class org.exoplatform.webui.core.UIComponent

Throws:

Exception

addUIGadget

public void addUIGadget(UIGadget gadget,
                        int col,
                        int row)

Adds an UIGadget into UIDashboardContainer in specified position

Parameters:

gadget - UIGadget to add in UIDashboardContainer

col - index of column to add

row - index of row to add

See Also:

UIGadget

getUIGadget

public UIGadget getUIGadget(int col,
                            int row)

Gets an UIGadget at specified position

Parameters:

col - index of column

row - index of row

Returns:

null if specified position doesn't exist UIGadget otherwise

See Also:

UIGadget

getUIGadget

public UIGadget getUIGadget(String gadgetId)

Gets an UIGadget which has applicationInstanceUniqueId_ according to specified Id

Parameters:

gadgetId - applicationInstanceUniqueId_ of UIGadget

Returns:

null if UIGadget doesn't exist
UIGadget otherwise

See Also:

UIGadget

removeUIGadget

public UIGadget removeUIGadget(String gadgetId)

Removes an UIGadget belongs to this which has specified applicationInstanceUniqueId_

Parameters:

gadgetId - applicationInstanceUniqueId_ of UIGadget

Returns:

UIGadget which deleted
null otherwise

See Also:

UIGadget

removeUIGadget

public UIGadget removeUIGadget(int col,
                               int row)

Removes an UIGadget at specified position

Parameters:

col - index of the column

row - index of the row

Returns:

UIGadget which deleted
null otherwise

See Also:

UIGadget

moveUIGadget

public void moveUIGadget(String gadgetId,
                         int col,
                         int row)

Moves an UIGadget which has specified applicationInstanceUniqueId_ to specified position

Parameters:

gadgetId - applicationInstanceUniqueId_ of UIGadget

col - index of destination column

row - index of destination row

See Also:

UIGadget

getColumn

public UIContainer getColumn(int col)

Gets an UIContainer representation of a column at specified index

Parameters:

col - index of column

Returns:

UIContainer if the column exist
null otherwise

See Also:

UIContainer

hasUIGadget

public boolean hasUIGadget()

Tests if this UIDashboardContainer has UIGadget

Returns:

false if and only if this UIDashboardContainer has no UIGadget
true otherwise

setColumns

public UIDashboardContainer setColumns(int num)
                                throws Exception

Sets total of columns of this UIDashboardContainer, total of columns is between 1 and MAX_COLUMN

Parameters:

num - total of columns

Returns:

null if totals of columns is less than 1 or greater than MAX_COLUMN this UIDashboardContainer otherwise

Throws:

Exception - if this UIDashboardContainer can not create new UIComponent

getColumns

public List<UIContainer> getColumns()

Returns a List of the UIContainers of this UIDashboardContainer which representation of list of columns.

Returns:

List of UIContainer

See Also:

List, UIContainer

createContainer

public org.exoplatform.portal.config.model.Container createContainer(String type,
                                                                     String id)
                                                              throws Exception

Creates a Container that representation of row or column in this UIDashboardContainer

Parameters:

type - type of Container, that is ROW_CONTAINER or COLUMN_CONTAINER

id - id of Container

Returns:

Container if UIDashboardContainer has specified type
null otherwise

Throws:

Exception - if toContainer(String) method throws an Exception

See Also:

Container, toContainer(String)

getWindowId

public String getWindowId()

Get windowId of UIPortlet

Returns:

a String represents windowId of portlet

See Also:

UIPortlet

setContainerTemplate

public void setContainerTemplate(String template)

getContainerTemplate

public String getContainerTemplate()

save

public void save()
          throws Exception

Saves all UIComponent of this UIDashboardContainer to database

Throws:

Exception