com.technia.helium.core.ui.dashboard

Interface Dashboard

All Superinterfaces:

Component, Customizable, PageComponent

All Known Implementing Classes:

DefaultDashboard

public interface Dashboard
extends Component, PageComponent, Customizable

Represents a dashboard, which is a grid holding various widgets.

Since:

2015.1.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigObjectId() Stores config business object id .
com.technia.tvc.core.table.TableBean<? extends com.technia.tvc.core.table.TableData>	getDashboardData() Returns a table bean loaded at dashboard level.
com.technia.tvc.core.db.aef.env.Environment	getEnv()
long	getId()
java.lang.String	getOriginalResource() originalResource options to store the resource name read from XML.
java.lang.String	getResizableHandles() Resizable options
java.lang.String	getResource()
java.util.Collection<Widget>	getWidgets() Widgets included in the dashboard grid.
boolean	isDisableCustomization() Whether the customization at dashboard level is disabled or not.
boolean	isDraftConfig() Stores whether the config is in draft state .
boolean	isFloating() Should widgets in this dashboard be allowed to float freely? Default is false, which means widgets will float to top.
boolean	isLocked() Whether the dashboard is locked for modification or not.
void	setDisableCustomization(boolean disableCustomization)
void	setFloating(boolean floating)
void	setId(long id)

Methods inherited from interface com.technia.helium.core.ui.Component

getTemplates

Methods inherited from interface com.technia.helium.customization.Customizable

getCustomization, getIdHash, isCustomizable

Method Detail

getEnv

com.technia.tvc.core.db.aef.env.Environment getEnv()

isFloating

boolean isFloating()

Should widgets in this dashboard be allowed to float freely? Default is false, which means widgets will float to top.

Since:

2015.2.0

setFloating

void setFloating(boolean floating)

isLocked

boolean isLocked()

Whether the dashboard is locked for modification or not. If locked, user cannot move, resize, remove or add widgets.

Returns:

Since:

2015.1.0

isDisableCustomization

boolean isDisableCustomization()

Whether the customization at dashboard level is disabled or not. If disabled, then dashboard customization will be off for particular dashboard.

Returns:

Since:

2021.3.0

getWidgets

java.util.Collection<Widget> getWidgets()

Widgets included in the dashboard grid.

Returns:

Since:

2015.1.0

getId

long getId()

Returns:

Id

Since:

2015.2.0

setId

void setId(long id)

Parameters:

id - Id

Since:

2015.2.0

setDisableCustomization

void setDisableCustomization(boolean disableCustomization)

Parameters:

disableCustomization - The boolean value to set.

Since:

2021.3.0

getResource

java.lang.String getResource()

Returns:

Since:

2016.2.0

getResizableHandles

java.lang.String getResizableHandles()

Resizable options

Returns:

Since:

2018.3.0

getOriginalResource

java.lang.String getOriginalResource()

originalResource options to store the resource name read from XML.

Returns:

Since:

2020.5.0

getConfigObjectId

java.lang.String getConfigObjectId()

Stores config business object id .

Returns:

Since:

2021.4.0

isDraftConfig

boolean isDraftConfig()

Stores whether the config is in draft state .

Returns:

Since:

2021.5.0

getDashboardData

com.technia.tvc.core.table.TableBean<? extends com.technia.tvc.core.table.TableData> getDashboardData()

Returns a table bean loaded at dashboard level. This data is loaded using the dataset provided at dashboard level.

Returns:

Since:

2021.2.0