public class UIDashboardContainer
extends org.exoplatform.webui.core.UIContainer
| Modifier and Type | Class and Description |
|---|---|
static class |
UIDashboardContainer.AddNewGadgetActionListener |
static class |
UIDashboardContainer.DeleteGadgetActionListener |
static class |
UIDashboardContainer.MoveGadgetActionListener |
| 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 |
| Constructor and Description |
|---|
UIDashboardContainer(org.exoplatform.webui.config.InitParams initParams)
Constructs new UIDashboardContainer which belongs to a UIDashboardPortlet
|
| 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) |
addChild, addChild, findComponentById, findComponentOfType, findFirstComponentOfType, getChild, getChild, getChildById, getChildren, hasChildren, removeChild, removeChildById, renderChild, renderChild, renderChild, renderChild, renderChildren, renderChildren, renderUIComponent, replaceChild, replaceChild, setChildren, setRenderedChild, setRenderedChild, setRenderedChildrenOfTypesbroadcast, 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, urlpublic static final int MAX_COLUMN
public static final String COLUMN_CONTAINER
public static final String ROW_CONTAINER
public static final String ROOT_CONTAINER
public static final String COLINDEX
public static final String ROWINDEX
public static String SAVE_FAIL
public UIDashboardContainer(org.exoplatform.webui.config.InitParams initParams)
throws Exception
initParams - initial parametersException - if can't create UIDashboardContainerDashboardParent,
InitParamspublic void processRender(org.exoplatform.webui.application.WebuiRequestContext context)
throws Exception
processRender in class org.exoplatform.webui.core.UIComponentExceptionpublic void addUIGadget(UIGadget gadget, int col, int row)
gadget - UIGadget to add in UIDashboardContainercol - index of column to addrow - index of row to addUIGadgetpublic UIGadget getUIGadget(int col, int row)
col - index of columnrow - index of rownull if specified position doesn't exist UIGadget otherwiseUIGadgetpublic UIGadget getUIGadget(String gadgetId)
gadgetId - applicationInstanceUniqueId_ of UIGadgetUIGadgetpublic UIGadget removeUIGadget(String gadgetId)
gadgetId - applicationInstanceUniqueId_ of UIGadgetUIGadget which deletednull otherwiseUIGadgetpublic UIGadget removeUIGadget(int col, int row)
col - index of the columnrow - index of the rowUIGadget which deletednull otherwiseUIGadgetpublic void moveUIGadget(String gadgetId, int col, int row)
gadgetId - applicationInstanceUniqueId_ of UIGadgetcol - index of destination columnrow - index of destination rowUIGadgetpublic UIContainer getColumn(int col)
col - index of columnUIContainer if the column existnull otherwiseUIContainerpublic boolean hasUIGadget()
false if and only if this UIDashboardContainer has no UIGadgettrue otherwisepublic UIDashboardContainer setColumns(int num) throws Exception
num - total of columnsnull if totals of columns is less than 1 or greater than MAX_COLUMN this
UIDashboardContainer otherwiseException - if this UIDashboardContainer can not create new UIComponentpublic List<UIContainer> getColumns()
List of UIContainerList,
UIContainerpublic org.exoplatform.portal.config.model.Container createContainer(String type, String id) throws Exception
type - type of Container, that is ROW_CONTAINER or COLUMN_CONTAINERid - id of ContainerContainer if UIDashboardContainer has specified type null otherwiseException - if toContainer(String) method throws an ExceptionContainer,
toContainer(String)public String getWindowId()
UIPortletUIPortletpublic void setContainerTemplate(String template)
public String getContainerTemplate()
Copyright © 2017 JBoss by Red Hat. All Rights Reserved.