Class QHelpContent

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.help.QHelpContent
All Implemented Interfaces:
QMetaDataObject, Serializable, Cloneable
public class QHelpContent extends Object implements QMetaDataObject, Cloneable
meta-data definition of "Help Content" to show to a user - for use in a specific "role" (e.g., insert screens but not view screens), and in a particular "format" (e.g., plain text, html, markdown). Meant to be assigned to several different pieces of QQQ meta data (fields, tables, processes, etc), and used as-needed by various frontends. May evolve something like a "Presentation" attribute in the future - e.g., to say "present this one as a tooltip" vs. "present this one as inline text" May be dynamically added to meta-data via (non-meta-) data - see HelpContentMetaDataProvider and QInstanceHelpContentManager
See Also:

  • Field Details

  • Constructor Details

    • QHelpContent

      public QHelpContent()
      Constructor

    • QHelpContent

      public QHelpContent(String content)
      Constructor

  • Method Details

    • getContentAsHtml

      public String getContentAsHtml()
      Return the content as html string, based on its format. Only MARKDOWN actually gets processed (via commonmark) - but TEXT and HTML come out as-is.

    • getContent

      public String getContent()
      Getter for content

    • setContent

      public void setContent(String content)
      Setter for content

    • withContent

      public QHelpContent withContent(String content)
      Fluent setter for content

    • withContentAsHTML

      public QHelpContent withContentAsHTML(String content)
      Fluent setter for content that also sets format as HTML

    • withContentAsText

      public QHelpContent withContentAsText(String content)
      Fluent setter for content that also sets format as TEXT

    • withContentAsMarkdown

      public QHelpContent withContentAsMarkdown(String content)
      Fluent setter for content that also sets format as Markdown

    • getFormat

      public HelpFormat getFormat()
      Getter for format

    • setFormat

      public void setFormat(HelpFormat format)
      Setter for format

    • withFormat

      public QHelpContent withFormat(HelpFormat format)
      Fluent setter for format

    • getRoles

      public Set<HelpRole> getRoles()
      Getter for roles

    • setRoles

      public void setRoles(Set<HelpRole> roles)
      Setter for roles

    • withRoles

      public QHelpContent withRoles(Set<HelpRole> roles)
      Fluent setter for roles

    • withRole

      public QHelpContent withRole(HelpRole role)
      Fluent method to add a role

    • withRoles

      public QHelpContent withRoles(HelpRole... roles)
      Fluent method to add a role

    • clone

      public QHelpContent clone()
      Overrides:
      clone in class Object

    • getSummary

      public String getSummary()
      Getter for summary

    • setSummary

      public void setSummary(String summary)
      Setter for summary

    • withSummary

      public QHelpContent withSummary(String summary)
      Fluent setter for summary

    • getPermissionName

      public String getPermissionName()
      Getter for permissionName

    • setPermissionName

      public void setPermissionName(String permissionName)
      Setter for permissionName

    • withPermissionName

      public QHelpContent withPermissionName(String permissionName)
      Fluent setter for permissionName

    • getClientChannel

      public String getClientChannel()
      Getter for clientChannel

    • setClientChannel

      public void setClientChannel(String clientChannel)
      Setter for clientChannel

    • withClientChannel

      public QHelpContent withClientChannel(String clientChannel)
      Fluent setter for clientChannel

    • getFromData

      public boolean getFromData()
      Getter for fromData

    • setFromData

      public void setFromData(boolean fromData)
      Setter for fromData

    • withFromData

      public QHelpContent withFromData(boolean fromData)
      Fluent setter for fromData

    • getCodeContent

      public QHelpContent getCodeContent()
      Getter for codeContent

    • setCodeContent

      public void setCodeContent(QHelpContent codeContent)
      Setter for codeContent

    • withCodeContent

      public QHelpContent withCodeContent(QHelpContent codeContent)
      Fluent setter for codeContent

    • getPlainText

      public String getPlainText()
      Plain text for search and derived summaries; never includes markup.

    • getSummaryOrDerived

      public String getSummaryOrDerived()
      Explicit summary, or the first plain-text sentence capped at 200 characters.