com.technia.helium.core.ui.dashboard.impl

Class AbstractWidget

java.lang.Object

com.technia.helium.core.ui.dashboard.impl.AbstractWidget

All Implemented Interfaces:

Widget, Customizable

Direct Known Subclasses:

ChartWidget, ClipboardWidget, CollectionWidget, CountWidget, DataTableWidget, DefaultWidget, FormWidget, HistoryWidget, IframeWidget, LifecycleWidget, RecentObjectWidget, TileWidget

public abstract class AbstractWidget
extends java.lang.Object
implements Widget

Base class for widget implementations

Since:

2015.2.0

Constructor Summary

Constructors

Constructor and Description
AbstractWidget(java.lang.String id, Dashboard dashboard)

Method Summary

Modifier and Type	Method and Description
WidgetBounds	getBounds()
java.lang.String	getColorTheme()
java.lang.String	getCustomization()
Dashboard	getDashboard()
protected java.util.Map<java.lang.String,java.lang.Object>	getDefaultOnInitOptions()
java.util.Collection<Action>	getHeaderActions()
AdjustHeight	getHeightSelfAdjusting() Stretches height of widget to its content in order to not display scrollbars.
java.lang.String	getHtml()
java.lang.String	getId() Get id for widget.
java.lang.String	getIdHash()
abstract java.lang.String	getOnInit()
abstract java.util.Map<java.lang.String,java.lang.Object>	getOnInitOptions() Options to send as onInit method along with system options (widget, dashboard, context etc).
java.lang.String	getPostRenderer() Callback function that will be executed after the widget has finished rendering
java.lang.String	getResource()
Sidepanel	getSidepanel()
java.lang.String	getTemplate()
java.lang.String	getTitle()
Toolbar	getToolbar()
UpdateConditions	getUpdateConditions()
boolean	isBadgeVisible()
boolean	isContentCustomizable()
boolean	isCustomizable()
boolean	isHidden()
boolean	isLocked() Whether the widget is locked in its dashboard context.
void	setBadgeVisible(boolean badgeVisible)
void	setBounds(WidgetBounds bounds)
void	setColorTheme(java.lang.String theme)
void	setContentCustomizable(boolean contentCustomizable)
void	setCustomizable(boolean customizable)
void	setCustomization(java.lang.String customization)
void	setHeaderActions(java.util.Collection<Action> headerActions)
void	setHidden(boolean hidden)
void	setIdHash(java.lang.String idHash)
void	setLocked(boolean locked)
void	setPostRenderer(java.lang.String postRenderer)
void	setResource(java.lang.String resource)
void	setSelfAdjustingHeight(AdjustHeight selfAdjustingHeight)
void	setShowActionTooltip(boolean showActionTooltip)
void	setSidepanel(Sidepanel sidepanel)
void	setTemplate(java.lang.String template)
void	setTitle(java.lang.String title)
void	setToolbar(Toolbar toolbar)
void	setUpdateConditions(UpdateConditions updateConditions)
boolean	showActionTooltip()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.technia.helium.core.ui.dashboard.Widget

getType

Constructor Detail

AbstractWidget

public AbstractWidget(java.lang.String id,
                      Dashboard dashboard)

Method Detail

getDashboard

public Dashboard getDashboard()

Specified by:

getDashboard in interface Widget

Returns:

The Dashboard, which this Widget is a member of.

getId

public java.lang.String getId()

Description copied from interface: Widget

Get id for widget. Note that a widget only can exist once in a dashboard.

Specified by:

getId in interface Widget

Returns:

The id

isLocked

public boolean isLocked()

Description copied from interface: Widget

Whether the widget is locked in its dashboard context.

Specified by:

isLocked in interface Widget

Returns:

Locked or not - boolean

setLocked

public void setLocked(boolean locked)

getUpdateConditions

public UpdateConditions getUpdateConditions()

Specified by:

getUpdateConditions in interface Widget

Returns:

The Widgets update settings

setUpdateConditions

public void setUpdateConditions(UpdateConditions updateConditions)

getOnInit

public abstract java.lang.String getOnInit()

Specified by:

getOnInit in interface Widget

Returns:

The initialization code that is invoked after the widget has been added.

getOnInitOptions

public abstract java.util.Map<java.lang.String,java.lang.Object> getOnInitOptions()

Description copied from interface: Widget

Options to send as onInit method along with system options (widget, dashboard, context etc).

Specified by:

getOnInitOptions in interface Widget

Returns:

The options

getHtml

public java.lang.String getHtml()

Specified by:

getHtml in interface Widget

Returns:

Some HTML markup used for the widget. Note that you should generally not produce large amount of HTML on the server side, instead, the returned HTML should just simplify the initialization of the widget via your scripts.

getBounds

public WidgetBounds getBounds()

Specified by:

getBounds in interface Widget

Returns:

The bounds for this widget

setBounds

public void setBounds(WidgetBounds bounds)

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface Widget

Returns:

The title for this widget.

getTemplate

public java.lang.String getTemplate()

Specified by:

getTemplate in interface Widget

Returns:

The title of the rendering template used by the widget

setTemplate

public void setTemplate(java.lang.String template)

getColorTheme

public java.lang.String getColorTheme()

Specified by:

getColorTheme in interface Widget

Returns:

The title of the color theme used by the widget

setColorTheme

public void setColorTheme(java.lang.String theme)

setSelfAdjustingHeight

public void setSelfAdjustingHeight(AdjustHeight selfAdjustingHeight)

getHeightSelfAdjusting

public AdjustHeight getHeightSelfAdjusting()

Description copied from interface: Widget

Stretches height of widget to its content in order to not display scrollbars.

Specified by:

getHeightSelfAdjusting in interface Widget

Returns:

If the height of widget should be adjusted

setToolbar

public void setToolbar(Toolbar toolbar)

getToolbar

public Toolbar getToolbar()

Specified by:

getToolbar in interface Widget

Returns:

The toolbar configured for the widget

showActionTooltip

public boolean showActionTooltip()

Specified by:

showActionTooltip in interface Widget

Returns:

Should show tooltip on header actions

setShowActionTooltip

public void setShowActionTooltip(boolean showActionTooltip)

getPostRenderer

public java.lang.String getPostRenderer()

Description copied from interface: Widget

Callback function that will be executed after the widget has finished rendering

Specified by:

getPostRenderer in interface Widget

Returns:

The callback function

setPostRenderer

public void setPostRenderer(java.lang.String postRenderer)

getHeaderActions

public java.util.Collection<Action> getHeaderActions()

Specified by:

getHeaderActions in interface Widget

Returns:

Header actions configured for this widget

setHeaderActions

public void setHeaderActions(java.util.Collection<Action> headerActions)

isHidden

public boolean isHidden()

Specified by:

isHidden in interface Widget

Returns:

If the widget is hidden or not

setHidden

public void setHidden(boolean hidden)

setSidepanel

public void setSidepanel(Sidepanel sidepanel)

getSidepanel

public Sidepanel getSidepanel()

Specified by:

getSidepanel in interface Widget

Returns:

Sidepanel for this widget

getIdHash

public java.lang.String getIdHash()

Specified by:

getIdHash in interface Customizable

setIdHash

public void setIdHash(java.lang.String idHash)

isCustomizable

public boolean isCustomizable()

Specified by:

isCustomizable in interface Customizable

setCustomizable

public void setCustomizable(boolean customizable)

isContentCustomizable

public boolean isContentCustomizable()

Specified by:

isContentCustomizable in interface Widget

Returns:

true if widget content (datatable, chart etc.) is customizable

setContentCustomizable

public void setContentCustomizable(boolean contentCustomizable)

getCustomization

public java.lang.String getCustomization()

Specified by:

getCustomization in interface Customizable

setCustomization

public void setCustomization(java.lang.String customization)

isBadgeVisible

public boolean isBadgeVisible()

Specified by:

isBadgeVisible in interface Widget

Returns:

Should show badge on widget

setBadgeVisible

public void setBadgeVisible(boolean badgeVisible)

getDefaultOnInitOptions

protected java.util.Map<java.lang.String,java.lang.Object> getDefaultOnInitOptions()

getResource

public java.lang.String getResource()

Specified by:

getResource in interface Widget

Returns:

setResource

public void setResource(java.lang.String resource)