Uses of Class
com.kingsrook.qqq.backend.core.model.metadata.help.QHelpContent

Packages that use QHelpContent

Package	Description
com.kingsrook.qqq.backend.core.actions.ai.tools
com.kingsrook.qqq.backend.core.actions.help
com.kingsrook.qqq.backend.core.instances
com.kingsrook.qqq.backend.core.model.actions.metadata
com.kingsrook.qqq.backend.core.model.metadata
com.kingsrook.qqq.backend.core.model.metadata.dashboard
com.kingsrook.qqq.backend.core.model.metadata.fields
com.kingsrook.qqq.backend.core.model.metadata.frontend
com.kingsrook.qqq.backend.core.model.metadata.help
com.kingsrook.qqq.backend.core.model.metadata.layout
com.kingsrook.qqq.backend.core.model.metadata.possiblevalues
com.kingsrook.qqq.backend.core.model.metadata.processes
com.kingsrook.qqq.backend.core.model.metadata.reporting
com.kingsrook.qqq.backend.core.model.metadata.tables
com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components

Uses of QHelpContent in com.kingsrook.qqq.backend.core.actions.ai.tools

Method parameters in com.kingsrook.qqq.backend.core.actions.ai.tools with type arguments of type QHelpContent

Modifier and Type	Method	Description
static String	AiHelpText.plain(Collection<QHelpContent> helpContents)	Plain text of a list of help contents (null if there is none).
static String	AiHelpText.plain(Map<String,List<QHelpContent>> helpContentMap)	Plain text of a map of help slots to contents (slots in sorted order).

Uses of QHelpContent in com.kingsrook.qqq.backend.core.actions.help

Methods in com.kingsrook.qqq.backend.core.actions.help that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
List<QHelpContent>	HelpTarget.contents()	Returns the value of the contents record component.

Constructor parameters in com.kingsrook.qqq.backend.core.actions.help with type arguments of type QHelpContent

Modifier	Constructor	Description
	HelpTarget(String kind, String key, String name, String table, String process, String label, String parentKey, boolean hidden, List<QHelpContent> contents, Object owner)	Creates an instance of a HelpTarget record class.

Uses of QHelpContent in com.kingsrook.qqq.backend.core.instances

Methods in com.kingsrook.qqq.backend.core.instances that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
static Map<String,List<QHelpContent>>	QInstanceHelpContentManager.cloneHelpContent(Map<String,List<QHelpContent>> contents)	Deep copy help slots when metadata is cloned.

Methods in com.kingsrook.qqq.backend.core.instances with parameters of type QHelpContent

Modifier and Type	Method	Description
void	QHelpContentPlugin.acceptHelpContent(QInstance qInstance, QHelpContent helpContent, Map<String,String> nameValuePairs)	accept a single helpContent record, and apply its data to some data in the qInstance
static void	QInstanceHelpContentManager.putHelpContentInList(QHelpContent helpContent, List<QHelpContent> helpContents)	add a help content object to a list - replacing an entry in the list with the same roles if one is found.

Method parameters in com.kingsrook.qqq.backend.core.instances with type arguments of type QHelpContent

Modifier and Type	Method	Description
static Map<String,List<QHelpContent>>	QInstanceHelpContentManager.cloneHelpContent(Map<String,List<QHelpContent>> contents)	Deep copy help slots when metadata is cloned.
static void	QInstanceHelpContentManager.putHelpContentInList(QHelpContent helpContent, List<QHelpContent> helpContents)	add a help content object to a list - replacing an entry in the list with the same roles if one is found.
static void	QInstanceHelpContentManager.removeHelpContentByRoleSetFromList(Set<HelpRole> roles, List<QHelpContent> helpContents)	Remove any helpContent entries in a list if they have a set of roles that matches the input set.

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.actions.metadata

Methods in com.kingsrook.qqq.backend.core.model.actions.metadata that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	MetaDataOutput.getHelpContents()	Getter for helpContents

Method parameters in com.kingsrook.qqq.backend.core.model.actions.metadata with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	MetaDataOutput.setHelpContents(Map<String,List<QHelpContent>> helpContents)	Setter for helpContents

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata

Fields in com.kingsrook.qqq.backend.core.model.metadata with type parameters of type QHelpContent

Modifier and Type	Field	Description
protected Map<String,List<QHelpContent>>	QInstance.helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	QInstance.getHelpContent()	Getter for helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata with parameters of type QHelpContent

Modifier and Type	Method	Description
QInstance	QInstance.withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	QInstance.setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
QInstance	QInstance.withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.dashboard

Fields in com.kingsrook.qqq.backend.core.model.metadata.dashboard with type parameters of type QHelpContent

Modifier and Type	Field	Description
protected Map<String,List<QHelpContent>>	QWidgetMetaData.helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata.dashboard that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	QWidgetMetaData.getHelpContent()	Getter for helpContent
default Map<String,List<QHelpContent>>	QWidgetMetaDataInterface.getHelpContent()

Methods in com.kingsrook.qqq.backend.core.model.metadata.dashboard with parameters of type QHelpContent

Modifier and Type	Method	Description
QWidgetMetaData	QWidgetMetaData.withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)
default QWidgetMetaDataInterface	QWidgetMetaDataInterface.withHelpContent(String slot, QHelpContent helpContent)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata.dashboard with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	QWidgetMetaData.setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
default void	QWidgetMetaDataInterface.setHelpContent(Map<String,List<QHelpContent>> helpContent)
QWidgetMetaData	QWidgetMetaData.withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.fields

Methods in com.kingsrook.qqq.backend.core.model.metadata.fields that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
List<QHelpContent>	QFieldMetaData.getHelpContents()	Getter for helpContents

Methods in com.kingsrook.qqq.backend.core.model.metadata.fields with parameters of type QHelpContent

Modifier and Type	Method	Description
QFieldMetaData	QFieldMetaData.withHelpContent(QHelpContent helpContent)	Fluent setter for adding 1 helpContent
QVirtualFieldMetaData	QVirtualFieldMetaData.withHelpContent(QHelpContent helpContent)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata.fields with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	QFieldMetaData.setHelpContents(List<QHelpContent> helpContents)	Setter for helpContents
QFieldMetaData	QFieldMetaData.withHelpContents(List<QHelpContent> helpContents)	Fluent setter for helpContents
QVirtualFieldMetaData	QVirtualFieldMetaData.withHelpContents(List<QHelpContent> helpContents)

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.frontend

Fields in com.kingsrook.qqq.backend.core.model.metadata.frontend with type parameters of type QHelpContent

Modifier and Type	Field	Description
protected Map<String,List<QHelpContent>>	QFrontendWidgetMetaData.helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata.frontend that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	QFrontendWidgetMetaData.getHelpContent()	Getter for helpContent
Map<String,List<QHelpContent>>	QFrontendAppMetaData.getHelpContents()	Getter for helpContents
List<QHelpContent>	QFrontendFieldMetaData.getHelpContents()	Getter for helpContents
Map<String,List<QHelpContent>>	QFrontendProcessMetaData.getHelpContents()	Getter for helpContents
Map<String,List<QHelpContent>>	QFrontendReportMetaData.getHelpContents()	Getter for helpContents
Map<String,List<QHelpContent>>	QFrontendTableMetaData.getHelpContents()	Getter for helpContents

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.help

Methods in com.kingsrook.qqq.backend.core.model.metadata.help that return QHelpContent

Modifier and Type	Method	Description
QHelpContent	QHelpContent.clone()
QHelpContent	QHelpContent.getCodeContent()	Getter for codeContent
QHelpContent	QHelpContent.withClientChannel(String clientChannel)	Fluent setter for clientChannel
QHelpContent	QHelpContent.withCodeContent(QHelpContent codeContent)	Fluent setter for codeContent
QHelpContent	QHelpContent.withContent(String content)	Fluent setter for content
QHelpContent	QHelpContent.withContentAsHTML(String content)	Fluent setter for content that also sets format as HTML
QHelpContent	QHelpContent.withContentAsMarkdown(String content)	Fluent setter for content that also sets format as Markdown
QHelpContent	QHelpContent.withContentAsText(String content)	Fluent setter for content that also sets format as TEXT
QHelpContent	QHelpContent.withFormat(HelpFormat format)	Fluent setter for format
QHelpContent	QHelpContent.withFromData(boolean fromData)	Fluent setter for fromData
QHelpContent	QHelpContent.withPermissionName(String permissionName)	Fluent setter for permissionName
QHelpContent	QHelpContent.withRole(HelpRole role)	Fluent method to add a role
QHelpContent	QHelpContent.withRoles(HelpRole... roles)	Fluent method to add a role
QHelpContent	QHelpContent.withRoles(Set<HelpRole> roles)	Fluent setter for roles
QHelpContent	QHelpContent.withSummary(String summary)	Fluent setter for summary

Methods in com.kingsrook.qqq.backend.core.model.metadata.help that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
static List<QHelpContent>	HelpContentVisibility.filter(List<QHelpContent> contents)	Filter a list without changing shared metadata or exposing targeting fields.
static Map<String,List<QHelpContent>>	HelpContentVisibility.filter(Map<String,List<QHelpContent>> contents)	Filter each slot, retaining the existing null/empty shape.

Methods in com.kingsrook.qqq.backend.core.model.metadata.help with parameters of type QHelpContent

Modifier and Type	Method	Description
void	QHelpContent.setCodeContent(QHelpContent codeContent)	Setter for codeContent
QHelpContent	QHelpContent.withCodeContent(QHelpContent codeContent)	Fluent setter for codeContent

Method parameters in com.kingsrook.qqq.backend.core.model.metadata.help with type arguments of type QHelpContent

Modifier and Type	Method	Description
static List<QHelpContent>	HelpContentVisibility.filter(List<QHelpContent> contents)	Filter a list without changing shared metadata or exposing targeting fields.
static Map<String,List<QHelpContent>>	HelpContentVisibility.filter(Map<String,List<QHelpContent>> contents)	Filter each slot, retaining the existing null/empty shape.

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.layout

Fields in com.kingsrook.qqq.backend.core.model.metadata.layout with type parameters of type QHelpContent

Modifier and Type	Field	Description
protected Map<String,List<QHelpContent>>	QAppMetaData.helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata.layout that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	QAppMetaData.getHelpContent()	Getter for helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata.layout with parameters of type QHelpContent

Modifier and Type	Method	Description
QAppMetaData	QAppMetaData.withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata.layout with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	QAppMetaData.setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
QAppMetaData	QAppMetaData.withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.possiblevalues

Methods in com.kingsrook.qqq.backend.core.model.metadata.possiblevalues that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	QPossibleValueSource.getHelpContent()	Getter for helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata.possiblevalues with parameters of type QHelpContent

Modifier and Type	Method	Description
QPossibleValueSource	QPossibleValueSource.withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata.possiblevalues with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	QPossibleValueSource.setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
QPossibleValueSource	QPossibleValueSource.withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.processes

Methods in com.kingsrook.qqq.backend.core.model.metadata.processes that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	QProcessMetaData.getHelpContent()	Getter for helpContent
List<QHelpContent>	QFrontendStepMetaData.getHelpContents()	Getter for helpContents

Methods in com.kingsrook.qqq.backend.core.model.metadata.processes with parameters of type QHelpContent

Modifier and Type	Method	Description
QFrontendStepMetaData	QFrontendStepMetaData.withHelpContent(QHelpContent helpContent)	Fluent setter for adding 1 helpContent
QProcessMetaData	QProcessMetaData.withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata.processes with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	QProcessMetaData.setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
void	QFrontendStepMetaData.setHelpContents(List<QHelpContent> helpContents)	Setter for helpContents
QProcessMetaData	QProcessMetaData.withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent
QFrontendStepMetaData	QFrontendStepMetaData.withHelpContents(List<QHelpContent> helpContents)	Fluent setter for helpContents

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.reporting

Methods in com.kingsrook.qqq.backend.core.model.metadata.reporting that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	QReportMetaData.getHelpContent()	Getter for helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata.reporting with parameters of type QHelpContent

Modifier and Type	Method	Description
QReportMetaData	QReportMetaData.withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata.reporting with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	QReportMetaData.setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
QReportMetaData	QReportMetaData.withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent

Uses of QHelpContent in com.kingsrook.qqq.backend.core.model.metadata.tables

Fields in com.kingsrook.qqq.backend.core.model.metadata.tables with type parameters of type QHelpContent

Modifier and Type	Field	Description
protected Map<String,List<QHelpContent>>	QTableMetaData.helpContent

Methods in com.kingsrook.qqq.backend.core.model.metadata.tables that return types with arguments of type QHelpContent

Modifier and Type	Method	Description
Map<String,List<QHelpContent>>	QTableMetaData.getHelpContent()	Getter for helpContent
List<QHelpContent>	QFieldSection.getHelpContents()	Getter for helpContents

Methods in com.kingsrook.qqq.backend.core.model.metadata.tables with parameters of type QHelpContent

Modifier and Type	Method	Description
QFieldSection	QFieldSection.withHelpContent(QHelpContent helpContent)	Fluent setter for adding 1 helpContent
QTableMetaData	QTableMetaData.withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)

Method parameters in com.kingsrook.qqq.backend.core.model.metadata.tables with type arguments of type QHelpContent

Modifier and Type	Method	Description
void	QTableMetaData.setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
void	QFieldSection.setHelpContents(List<QHelpContent> helpContents)	Setter for helpContents
QTableMetaData	QTableMetaData.withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent
QFieldSection	QFieldSection.withHelpContents(List<QHelpContent> helpContents)	Fluent setter for helpContents

Uses of QHelpContent in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components

Method parameters in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components with type arguments of type QHelpContent

Modifier and Type	Method	Description
static List<HelpContentV1>	HelpContentV1.of(List<QHelpContent> contents)	Wrap a list, applying targeting also for endpoints wrapping full metadata.
static Map<String,List<HelpContentV1>>	HelpContentV1.of(Map<String,List<QHelpContent>> contents)	Wrap a slot map while preserving property names and null shapes.

Constructors in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components with parameters of type QHelpContent

Modifier	Constructor	Description
	HelpContentV1(QHelpContent wrapped)	Wrap visible help.