public abstract class AbstractWidget extends java.lang.Object implements Widget
| Constructor and Description |
|---|
AbstractWidget(java.lang.String id,
Dashboard dashboard) |
| 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() |
public AbstractWidget(java.lang.String id,
Dashboard dashboard)
public Dashboard getDashboard()
getDashboard in interface WidgetDashboard, which this Widget is a member of.public java.lang.String getId()
Widgetpublic boolean isLocked()
Widgetpublic void setLocked(boolean locked)
public UpdateConditions getUpdateConditions()
getUpdateConditions in interface Widgetpublic void setUpdateConditions(UpdateConditions updateConditions)
public abstract java.lang.String getOnInit()
public abstract java.util.Map<java.lang.String,java.lang.Object> getOnInitOptions()
WidgetgetOnInitOptions in interface Widgetpublic java.lang.String getHtml()
public WidgetBounds getBounds()
public void setBounds(WidgetBounds bounds)
public void setTitle(java.lang.String title)
public java.lang.String getTitle()
public java.lang.String getTemplate()
getTemplate in interface Widgetpublic void setTemplate(java.lang.String template)
public java.lang.String getColorTheme()
getColorTheme in interface Widgetpublic void setColorTheme(java.lang.String theme)
public void setSelfAdjustingHeight(AdjustHeight selfAdjustingHeight)
public AdjustHeight getHeightSelfAdjusting()
WidgetgetHeightSelfAdjusting in interface Widgetpublic void setToolbar(Toolbar toolbar)
public Toolbar getToolbar()
getToolbar in interface Widgetpublic boolean showActionTooltip()
showActionTooltip in interface Widgetpublic void setShowActionTooltip(boolean showActionTooltip)
public java.lang.String getPostRenderer()
WidgetgetPostRenderer in interface Widgetpublic void setPostRenderer(java.lang.String postRenderer)
public java.util.Collection<Action> getHeaderActions()
getHeaderActions in interface Widgetpublic void setHeaderActions(java.util.Collection<Action> headerActions)
public boolean isHidden()
public void setHidden(boolean hidden)
public void setSidepanel(Sidepanel sidepanel)
public Sidepanel getSidepanel()
getSidepanel in interface Widgetpublic java.lang.String getIdHash()
getIdHash in interface Customizablepublic void setIdHash(java.lang.String idHash)
public boolean isCustomizable()
isCustomizable in interface Customizablepublic void setCustomizable(boolean customizable)
public boolean isContentCustomizable()
isContentCustomizable in interface Widgetpublic void setContentCustomizable(boolean contentCustomizable)
public java.lang.String getCustomization()
getCustomization in interface Customizablepublic void setCustomization(java.lang.String customization)
public boolean isBadgeVisible()
isBadgeVisible in interface Widgetpublic void setBadgeVisible(boolean badgeVisible)
protected java.util.Map<java.lang.String,java.lang.Object> getDefaultOnInitOptions()
public java.lang.String getResource()
getResource in interface Widgetpublic void setResource(java.lang.String resource)