Class QWidgetMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.dashboard.QWidgetMetaData

All Implemented Interfaces:

QWidgetMetaDataInterface, MetaDataProducerOutput, MetaDataWithName, MetaDataWithPermissionRules, QMetaDataObject, TopLevelMetaDataInterface, Serializable

Direct Known Subclasses:

ParentWidgetMetaData, QNoCodeWidgetMetaData, QuickSightChartMetaData

public class QWidgetMetaData
extends Object
implements QWidgetMetaDataInterface

Base metadata for frontend dashboard widgets

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected QCodeReference	codeReference
protected Map<String,Serializable>	defaultValues
protected String	footerHTML
protected Integer	gridColumns
protected Map<String,List<QHelpContent>>	helpContent
protected String	icon
protected Map<String,QIcon>	icons
protected boolean	isCard
protected String	label
protected String	minHeight
protected String	name
protected String	tooltip
protected String	type
protected QInstanceValidatorPluginInterface<QWidgetMetaDataInterface>	validatorPlugin

Fields inherited from interface com.kingsrook.qqq.backend.core.model.metadata.dashboard.QWidgetMetaDataInterface

LOG

Constructor Summary

Constructors

Constructor	Description
QWidgetMetaData()

Method Summary

Modifier and Type	Method	Description
QCodeReference	getCodeReference()	Getter for codeReference
Map<String,Serializable>	getDefaultValues()	Getter for defaultValues
List<WidgetDropdownData>	getDropdowns()	Getter for dropdowns
String	getFooterHTML()	Getter for footerHTML
Integer	getGridColumns()	Getter for gridColumns
Map<String,List<QHelpContent>>	getHelpContent()	Getter for helpContent
String	getIcon()	Getter for icon
Map<String,QIcon>	getIcons()	Getter for icons
boolean	getIsCard()	Getter for isCard
String	getLabel()	Getter for label
String	getMinHeight()	Getter for minHeight
String	getName()	Getter for name
QPermissionRules	getPermissionRules()	Getter for permissionRules
boolean	getShowExportButton()	Getter for showExportButton
boolean	getShowReloadButton()	Getter for showReloadButton
boolean	getStoreDropdownSelections()	Getter for storeDropdownSelections
String	getTooltip()	Getter for tooltip
String	getType()	Getter for type
QInstanceValidatorPluginInterface<QWidgetMetaDataInterface>	getValidatorPlugin()	Getter for validatorPlugin
void	removeHelpContent(String slot, Set<HelpRole> roles)	remove a helpContent for a slot based on its set of roles
void	setCodeReference(QCodeReference codeReference)	Setter for codeReference
void	setDefaultValues(Map<String,Serializable> defaultValues)	Setter for defaultValues
void	setDropdowns(List<WidgetDropdownData> dropdowns)	Setter for dropdowns
void	setFooterHTML(String footerHTML)	Setter for footerHTML
void	setGridColumns(Integer gridColumns)	Setter for gridColumns
void	setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
void	setIcon(String icon)	Setter for icon
void	setIcons(Map<String,QIcon> icons)	Setter for icons
void	setIsCard(boolean isCard)	Setter for isCard
void	setLabel(String label)	Setter for label
void	setMinHeight(String minHeight)	Setter for minHeight
void	setName(String name)	Setter for name
void	setPermissionRules(QPermissionRules permissionRules)	Setter for permissionRules
void	setShowExportButton(boolean showExportButton)	Setter for showExportButton
void	setShowReloadButton(boolean showReloadButton)	Setter for showReloadButton
void	setStoreDropdownSelections(boolean storeDropdownSelections)	Setter for storeDropdownSelections
void	setTooltip(String tooltip)	Setter for tooltip
void	setType(String type)	Setter for type
void	setValidatorPlugin(QInstanceValidatorPluginInterface<QWidgetMetaDataInterface> validatorPlugin)	Setter for validatorPlugin
QWidgetMetaData	withCodeReference(QCodeReference codeReference)	Fluent setter for codeReference
QWidgetMetaData	withDefaultValue(String key, Serializable value)	Fluent setter for a single defaultValue
QWidgetMetaData	withDefaultValues(Map<String,Serializable> defaultValues)	Fluent setter for defaultValues
QWidgetMetaData	withDropdown(WidgetDropdownData dropdown)	Fluent setter for dropdowns
QWidgetMetaData	withDropdowns(List<WidgetDropdownData> dropdowns)	Fluent setter for dropdowns
QWidgetMetaData	withFooterHTML(String footerHTML)	Fluent setter for footerHTML
QWidgetMetaData	withGridColumns(Integer gridColumns)	Fluent setter for gridColumns
QWidgetMetaData	withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)
QWidgetMetaData	withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent
QWidgetMetaData	withIcon(String icon)	Fluent setter for icon
QWidgetMetaData	withIcon(String role, QIcon icon)	Fluent setter for icons
QWidgetMetaData	withIcons(Map<String,QIcon> icons)	Fluent setter for icons
QWidgetMetaData	withIsCard(boolean isCard)	Fluent setter for isCard
QWidgetMetaData	withLabel(String label)	Fluent setter for label
QWidgetMetaData	withMinHeight(String minHeight)	Fluent setter for minHeight
QWidgetMetaData	withName(String name)	Fluent setter for name
QWidgetMetaData	withPermissionRules(QPermissionRules permissionRules)	Fluent setter for permissionRules
QWidgetMetaData	withShowExportButton(boolean showExportButton)	Fluent setter for showExportButton
QWidgetMetaData	withShowReloadButton(boolean showReloadButton)	Fluent setter for showReloadButton
QWidgetMetaData	withStoreDropdownSelections(boolean storeDropdownSelections)	Fluent setter for storeDropdownSelections
QWidgetMetaData	withTooltip(String tooltip)	Fluent setter for tooltip
QWidgetMetaData	withType(String type)	Fluent setter for type
QWidgetMetaData	withValidatorPlugin(QInstanceValidatorPluginInterface<QWidgetMetaDataInterface> validatorPlugin)	Fluent setter for validatorPlugin

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.model.metadata.dashboard.QWidgetMetaDataInterface

addSelfToInstance

Field Details

name

protected String name

icon

protected String icon

label

protected String label

tooltip

protected String tooltip

type

protected String type

minHeight

protected String minHeight

footerHTML

protected String footerHTML

isCard

protected boolean isCard

gridColumns

protected Integer gridColumns

codeReference

protected QCodeReference codeReference

icons

protected Map<String,QIcon> icons

helpContent

protected Map<String,List<QHelpContent>> helpContent

defaultValues

protected Map<String,Serializable> defaultValues

validatorPlugin

protected QInstanceValidatorPluginInterface<QWidgetMetaDataInterface> validatorPlugin

Constructor Details

QWidgetMetaData

public QWidgetMetaData()

Method Details

getName

public String getName()

Getter for name

Specified by:

getName in interface MetaDataWithName

Specified by:

getName in interface QWidgetMetaDataInterface

Specified by:

getName in interface TopLevelMetaDataInterface

setName

public void setName(String name)

Setter for name

Specified by:

setName in interface MetaDataWithName

Specified by:

setName in interface QWidgetMetaDataInterface

withName

public QWidgetMetaData withName(String name)

Fluent setter for name

Specified by:

withName in interface QWidgetMetaDataInterface

getIcon

public String getIcon()

Getter for icon

Specified by:

getIcon in interface QWidgetMetaDataInterface

setIcon

public void setIcon(String icon)

Setter for icon

Specified by:

setIcon in interface QWidgetMetaDataInterface

withIcon

public QWidgetMetaData withIcon(String icon)

Fluent setter for icon

getLabel

public String getLabel()

Getter for label

Specified by:

getLabel in interface MetaDataWithName

Specified by:

getLabel in interface QWidgetMetaDataInterface

setLabel

public void setLabel(String label)

Setter for label

Specified by:

setLabel in interface MetaDataWithName

Specified by:

setLabel in interface QWidgetMetaDataInterface

withLabel

public QWidgetMetaData withLabel(String label)

Fluent setter for label

Specified by:

withLabel in interface QWidgetMetaDataInterface

getCodeReference

public QCodeReference getCodeReference()

Getter for codeReference

Specified by:

getCodeReference in interface QWidgetMetaDataInterface

setCodeReference

public void setCodeReference(QCodeReference codeReference)

Setter for codeReference

Specified by:

setCodeReference in interface QWidgetMetaDataInterface

withCodeReference

public QWidgetMetaData withCodeReference(QCodeReference codeReference)

Fluent setter for codeReference

Specified by:

withCodeReference in interface QWidgetMetaDataInterface

getType

public String getType()

Getter for type

Specified by:

getType in interface QWidgetMetaDataInterface

setType

public void setType(String type)

Setter for type

Specified by:

setType in interface QWidgetMetaDataInterface

withType

public QWidgetMetaData withType(String type)

Fluent setter for type

Specified by:

withType in interface QWidgetMetaDataInterface

getGridColumns

public Integer getGridColumns()

Getter for gridColumns

Specified by:

getGridColumns in interface QWidgetMetaDataInterface

setGridColumns

public void setGridColumns(Integer gridColumns)

Setter for gridColumns

Specified by:

setGridColumns in interface QWidgetMetaDataInterface

withGridColumns

public QWidgetMetaData withGridColumns(Integer gridColumns)

Fluent setter for gridColumns

Specified by:

withGridColumns in interface QWidgetMetaDataInterface

getDefaultValues

public Map<String,Serializable> getDefaultValues()

Getter for defaultValues

Specified by:

getDefaultValues in interface QWidgetMetaDataInterface

setDefaultValues

public void setDefaultValues(Map<String,Serializable> defaultValues)

Setter for defaultValues

Specified by:

setDefaultValues in interface QWidgetMetaDataInterface

withDefaultValues

public QWidgetMetaData withDefaultValues(Map<String,Serializable> defaultValues)

Fluent setter for defaultValues

Specified by:

withDefaultValues in interface QWidgetMetaDataInterface

withDefaultValue

public QWidgetMetaData withDefaultValue(String key,
 Serializable value)

Fluent setter for a single defaultValue

Specified by:

withDefaultValue in interface QWidgetMetaDataInterface

getDropdowns

public List<WidgetDropdownData> getDropdowns()

Getter for dropdowns

Specified by:

getDropdowns in interface QWidgetMetaDataInterface

setDropdowns

public void setDropdowns(List<WidgetDropdownData> dropdowns)

Setter for dropdowns

Specified by:

setDropdowns in interface QWidgetMetaDataInterface

withDropdowns

public QWidgetMetaData withDropdowns(List<WidgetDropdownData> dropdowns)

Fluent setter for dropdowns

Specified by:

withDropdowns in interface QWidgetMetaDataInterface

getStoreDropdownSelections

public boolean getStoreDropdownSelections()

Getter for storeDropdownSelections

Specified by:

getStoreDropdownSelections in interface QWidgetMetaDataInterface

setStoreDropdownSelections

public void setStoreDropdownSelections(boolean storeDropdownSelections)

Setter for storeDropdownSelections

Specified by:

setStoreDropdownSelections in interface QWidgetMetaDataInterface

withStoreDropdownSelections

public QWidgetMetaData withStoreDropdownSelections(boolean storeDropdownSelections)

Fluent setter for storeDropdownSelections

withDropdown

public QWidgetMetaData withDropdown(WidgetDropdownData dropdown)

Fluent setter for dropdowns

Specified by:

withDropdown in interface QWidgetMetaDataInterface

getIsCard

public boolean getIsCard()

Getter for isCard

Specified by:

getIsCard in interface QWidgetMetaDataInterface

setIsCard

public void setIsCard(boolean isCard)

Setter for isCard

Specified by:

setIsCard in interface QWidgetMetaDataInterface

withIsCard

public QWidgetMetaData withIsCard(boolean isCard)

Fluent setter for isCard

getMinHeight

public String getMinHeight()

Getter for minHeight

Specified by:

getMinHeight in interface QWidgetMetaDataInterface

setMinHeight

public void setMinHeight(String minHeight)

Setter for minHeight

Specified by:

setMinHeight in interface QWidgetMetaDataInterface

withMinHeight

public QWidgetMetaData withMinHeight(String minHeight)

Fluent setter for minHeight

getPermissionRules

public QPermissionRules getPermissionRules()

Getter for permissionRules

Specified by:

getPermissionRules in interface MetaDataWithPermissionRules

Specified by:

getPermissionRules in interface QWidgetMetaDataInterface

setPermissionRules

public void setPermissionRules(QPermissionRules permissionRules)

Setter for permissionRules

Specified by:

setPermissionRules in interface MetaDataWithPermissionRules

Specified by:

setPermissionRules in interface QWidgetMetaDataInterface

withPermissionRules

public QWidgetMetaData withPermissionRules(QPermissionRules permissionRules)

Fluent setter for permissionRules

getFooterHTML

public String getFooterHTML()

Getter for footerHTML

Specified by:

getFooterHTML in interface QWidgetMetaDataInterface

setFooterHTML

public void setFooterHTML(String footerHTML)

Setter for footerHTML

Specified by:

setFooterHTML in interface QWidgetMetaDataInterface

withFooterHTML

public QWidgetMetaData withFooterHTML(String footerHTML)

Fluent setter for footerHTML

getShowReloadButton

public boolean getShowReloadButton()

Getter for showReloadButton

setShowReloadButton

public void setShowReloadButton(boolean showReloadButton)

Setter for showReloadButton

withShowReloadButton

public QWidgetMetaData withShowReloadButton(boolean showReloadButton)

Fluent setter for showReloadButton

getShowExportButton

public boolean getShowExportButton()

Getter for showExportButton

setShowExportButton

public void setShowExportButton(boolean showExportButton)

Setter for showExportButton

withShowExportButton

public QWidgetMetaData withShowExportButton(boolean showExportButton)

Fluent setter for showExportButton

getIcons

public Map<String,QIcon> getIcons()

Getter for icons

setIcons

public void setIcons(Map<String,QIcon> icons)

Setter for icons

withIcon

public QWidgetMetaData withIcon(String role,
 QIcon icon)

Fluent setter for icons

withIcons

public QWidgetMetaData withIcons(Map<String,QIcon> icons)

Fluent setter for icons

getTooltip

public String getTooltip()

Getter for tooltip

Specified by:

getTooltip in interface QWidgetMetaDataInterface

setTooltip

public void setTooltip(String tooltip)

Setter for tooltip

withTooltip

public QWidgetMetaData withTooltip(String tooltip)

Fluent setter for tooltip

getHelpContent

public Map<String,List<QHelpContent>> getHelpContent()

Getter for helpContent

Specified by:

getHelpContent in interface QWidgetMetaDataInterface

setHelpContent

public void setHelpContent(Map<String,List<QHelpContent>> helpContent)

Setter for helpContent

Specified by:

setHelpContent in interface QWidgetMetaDataInterface

withHelpContent

public QWidgetMetaData withHelpContent(Map<String,List<QHelpContent>> helpContent)

Fluent setter for helpContent

withHelpContent

public QWidgetMetaData withHelpContent(String slot,
 QHelpContent helpContent)

Fluent setter for adding 1 helpContent (for a slot)

Specified by:

withHelpContent in interface QWidgetMetaDataInterface

removeHelpContent

public void removeHelpContent(String slot,
 Set<HelpRole> roles)

remove a helpContent for a slot based on its set of roles

Specified by:

removeHelpContent in interface QWidgetMetaDataInterface

getValidatorPlugin

public QInstanceValidatorPluginInterface<QWidgetMetaDataInterface> getValidatorPlugin()

Getter for validatorPlugin

Specified by:

getValidatorPlugin in interface QWidgetMetaDataInterface

setValidatorPlugin

public void setValidatorPlugin(QInstanceValidatorPluginInterface<QWidgetMetaDataInterface> validatorPlugin)

Setter for validatorPlugin

withValidatorPlugin

public QWidgetMetaData withValidatorPlugin(QInstanceValidatorPluginInterface<QWidgetMetaDataInterface> validatorPlugin)

Fluent setter for validatorPlugin