Interface QWidgetMetaDataInterface

All Superinterfaces:

MetaDataProducerOutput, MetaDataWithName, MetaDataWithPermissionRules, QMetaDataObject, Serializable, TopLevelMetaDataInterface

All Known Implementing Classes:

ParentWidgetMetaData, QNoCodeWidgetMetaData, QuickSightChartMetaData, QWidgetMetaData

public interface QWidgetMetaDataInterface
extends MetaDataWithPermissionRules, TopLevelMetaDataInterface

Interface for qqq widget meta data

Field Summary

Fields

Modifier and Type	Field	Description
static final QLogger	LOG

Method Summary

Modifier and Type	Method	Description
default void	addSelfToInstance(QInstance qInstance)	call the appropriate methods on a QInstance to add ourselves to it.
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
default Map<String,List<QHelpContent>>	getHelpContent()
String	getIcon()	Getter for icon
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	getStoreDropdownSelections()	Getter for storeDropdownSelections
default String	getTooltip()	Getter for tooltip
String	getType()	Getter for type
default QInstanceValidatorPluginInterface<QWidgetMetaDataInterface>	getValidatorPlugin()	let the widget include an instance validator plugin
default 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 label)	Setter for footerHTML
void	setGridColumns(Integer gridColumns)	Setter for gridColumns
default void	setHelpContent(Map<String,List<QHelpContent>> helpContent)
void	setIcon(String type)	Setter for icon
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	setStoreDropdownSelections(boolean storeDropdownSelections)	Setter for storeDropdownSelections
void	setType(String type)	Setter for type
QWidgetMetaDataInterface	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
QWidgetMetaDataInterface	withGridColumns(Integer gridColumns)	Fluent setter for gridColumns
default QWidgetMetaDataInterface	withHelpContent(String slot, QHelpContent helpContent)
QWidgetMetaDataInterface	withLabel(String label)	Fluent setter for label
QWidgetMetaDataInterface	withName(String name)	Fluent setter for name
QWidgetMetaDataInterface	withType(String type)	Fluent setter for type

Field Details

LOG

static final QLogger LOG

Method Details

getName

String getName()

Getter for name

Specified by:

getName in interface MetaDataWithName

Specified by:

getName in interface TopLevelMetaDataInterface

setName

void setName(String name)

Setter for name

Specified by:

setName in interface MetaDataWithName

withName

QWidgetMetaDataInterface withName(String name)

Fluent setter for name

getFooterHTML

String getFooterHTML()

Getter for footerHTML

setFooterHTML

void setFooterHTML(String label)

Setter for footerHTML

getLabel

String getLabel()

Getter for label

Specified by:

getLabel in interface MetaDataWithName

setLabel

void setLabel(String label)

Setter for label

Specified by:

setLabel in interface MetaDataWithName

withLabel

QWidgetMetaDataInterface withLabel(String label)

Fluent setter for label

getType

String getType()

Getter for type

setType

void setType(String type)

Setter for type

withType

QWidgetMetaDataInterface withType(String type)

Fluent setter for type

getGridColumns

Integer getGridColumns()

Getter for gridColumns

setGridColumns

void setGridColumns(Integer gridColumns)

Setter for gridColumns

withGridColumns

QWidgetMetaDataInterface withGridColumns(Integer gridColumns)

Fluent setter for gridColumns

getCodeReference

QCodeReference getCodeReference()

Getter for codeReference

setCodeReference

void setCodeReference(QCodeReference codeReference)

Setter for codeReference

withCodeReference

QWidgetMetaDataInterface withCodeReference(QCodeReference codeReference)

Fluent setter for codeReference

getIcon

String getIcon()

Getter for icon

setIcon

void setIcon(String type)

Setter for icon

getIsCard

boolean getIsCard()

Getter for isCard

setIsCard

void setIsCard(boolean isCard)

Setter for isCard

getMinHeight

String getMinHeight()

Getter for minHeight

setMinHeight

void setMinHeight(String minHeight)

Setter for minHeight

getStoreDropdownSelections

boolean getStoreDropdownSelections()

Getter for storeDropdownSelections

setStoreDropdownSelections

void setStoreDropdownSelections(boolean storeDropdownSelections)

Setter for storeDropdownSelections

getDefaultValues

Map<String,Serializable> getDefaultValues()

Getter for defaultValues

setDefaultValues

void setDefaultValues(Map<String,Serializable> defaultValues)

Setter for defaultValues

withDefaultValues

QWidgetMetaData withDefaultValues(Map<String,Serializable> defaultValues)

Fluent setter for defaultValues

withDefaultValue

QWidgetMetaData withDefaultValue(String key,
 Serializable value)

Fluent setter for a single defaultValue

getPermissionRules

QPermissionRules getPermissionRules()

Getter for permissionRules

Specified by:

getPermissionRules in interface MetaDataWithPermissionRules

setPermissionRules

void setPermissionRules(QPermissionRules permissionRules)

Setter for permissionRules

Specified by:

setPermissionRules in interface MetaDataWithPermissionRules

getDropdowns

List<WidgetDropdownData> getDropdowns()

Getter for dropdowns

setDropdowns

void setDropdowns(List<WidgetDropdownData> dropdowns)

Setter for dropdowns

withDropdowns

QWidgetMetaData withDropdowns(List<WidgetDropdownData> dropdowns)

Fluent setter for dropdowns

withDropdown

QWidgetMetaData withDropdown(WidgetDropdownData dropdown)

Fluent setter for dropdowns

getTooltip

default String getTooltip()

Getter for tooltip

getHelpContent

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

setHelpContent

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

withHelpContent

default QWidgetMetaDataInterface withHelpContent(String slot,
 QHelpContent helpContent)

removeHelpContent

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

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

addSelfToInstance

default void addSelfToInstance(QInstance qInstance)

Description copied from interface: MetaDataProducerOutput

call the appropriate methods on a QInstance to add ourselves to it.

Specified by:

addSelfToInstance in interface MetaDataProducerOutput

Specified by:

addSelfToInstance in interface TopLevelMetaDataInterface

getValidatorPlugin

default QInstanceValidatorPluginInterface<QWidgetMetaDataInterface> getValidatorPlugin()

let the widget include an instance validator plugin