Content modeling annotations - Documentation

An important step of content modeling is defining data interactions—how users and databases interact with the model. This section lists the annotations you can use to implement data interactions. In addition to the annotations in this section, your model can use annotations defined in the Dari @Recordable interface. Those annotations provide a wide variety of data validation, data processing, and string manipulation functionalities. For details, see <a href="/dari-guide/latest/data-modeling-annotations" data-cms-id="0000017d-726b-d029-adff-77fb698c0000" data-cms-href="/dari-guide/latest/data-modeling-annotations" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815097656,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815097656,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-726b-d029-adff-77fb698c0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"_id":"0000017d-90fd-dc6e-a17f-91fd81db0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" Data modeling annotations ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-90fd-dc6e-a17f-91fd81cc0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> Data modeling annotations . See also: Annotations Basics @ClearOnPlaceholderChange Clears the placeholder text when an editor starts keying in the annotated field. Requires <a href="/developer-guide/latest/content-modeling-annotations#placeholder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="placeholder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815132199,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815132199,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"placeholder","_id":"0000017d-90fe-d657-a7fd-bbff1d9c0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @Placeholder ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-90fe-d657-a7fd-bbff1d8d0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @Placeholder , <a href="/developer-guide/latest/content-modeling-annotations#editableplaceholder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="editableplaceholder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815165131,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815165131,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"editableplaceholder","_id":"0000017d-90fe-dc6e-a17f-91fe711f0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @EditablePlaceholder ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-90fe-dc6e-a17f-91fe71100000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @EditablePlaceholder . The following table lists the elements available with this annotation. Element Description Valid Value value If true or absent, the placeholder text is cleared. If false, the placeholder text remains. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ClearOnPlaceholderChange","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.ClearOnPlaceholderChange;\nimport com.psddev.cms.ui.form.EditablePlaceholder;\nimport com.psddev.cms.ui.form.Placeholder;\n\npublic class Article extends Content {\n\n @Placeholder(\"Today's headline: \")\n @ClearOnPlaceholderChange(false) \n @EditablePlaceholder(true)\n private String headline;\n\n}","annotations":[{"lineNumber":"9","codeSnippet":" @ClearOnPlaceholderChange(false) ","annotation":"When an editor starts typing in the field Headline , ensures the placeholder text is not cleared.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c60-dd18-a17d-ff61904c0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c60-dc6e-a17f-6df440650000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c60-dc6e-a17f-6df440600000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c60-d029-adff-6ff140300000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @Content.Searchable Applies to: Class Excludes or includes instances of this content type from indexing by Solr. Instances excluded from indexing do not appear as search results in the search panel. (If you want to include instances of this content type in Solr indexing but exclude them from the search panel, combine this annotation with <a href="/developer-guide/latest/content-modeling-annotations#toolui-excludefromglobalsearch" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-excludefromglobalsearch" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815193671,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815193671,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-excludefromglobalsearch","_id":"0000017d-90ff-dc6e-a17f-91ff147b0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ToolUi.ExcludeFromGlobalSearch ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-90ff-dc6e-a17f-91ff146d0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ToolUi.ExcludeFromGlobalSearch .) The following table lists the elements available with this annotation. Element Description Valid Value value If true or absent, Brightspot’s search results include items of this content type. If false, Brightspot’s search results exclude items of this content type. true (default), false By default, models extending from Content are searchable, and models extending from Record are not searchable. This annotation is inherited, so models extending from an annotated model have the same setting for @Content.Searchable. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Content.Searchable 1","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\n\n@Content.Searchable(false) \npublic class Article extends Content {\n\n}","annotations":[{"lineNumber":"3","codeSnippet":"@Content.Searchable(false) ","annotation":"Excludes all matching instances of Article from search results.","originalLineNumber":3,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c62-d657-a7fd-7ffff3c20000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c62-d029-adff-6ff39c820000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c62-d029-adff-6ff39c7d0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c62-d657-a7fd-7fff9c440000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Content.Searchable 2","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport content.article\n\n@Content.Searchable \npublic class Recipe extends Article { \n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@Content.Searchable ","annotation":"Sets @Content.Searchable to true, reversing the effect of the inherited annotation. As a result, recipes are included in the search results.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c63-d029-adff-6ff385cb0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"5","codeSnippet":"public class Recipe extends Article { ","annotation":"Specifies that Recipe extends from Article, which implies that Recipe objects are also excluded from search results as indicated in the previous snippet.","originalLineNumber":5,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c63-dd18-a17d-ff63af870000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c63-d029-adff-6ff33b290000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c63-d029-adff-6ff33b240000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c63-d657-a7fd-7fff3aec0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <h2 data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1693514751519,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1693514751519,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000018a-4d58-d1f2-ad8f-eddd572b0000","_type":"45fe84ac-6709-39c0-bdaa-04029f434665"}">@DateTimeRangeGroups Applies to: Field, Method Specifies the date ranges in available from a date filter in the search panel. Requires @ToolUi.Filterable . The following table lists the elements available with this annotation. Element Description Valid Value value String of group names that are applicable to the date field in the search panel. Array of strings. The following string constants are available: DateTimeRange.FUTURE_RANGE —Lists future date ranges, such as Any Due Date , Due Date: Today , Due Date: Next 7 Days , Due Date: Next 30 Days , Due Date: Tomorrow , and Due Date: Custom . DateTimeRange.PAST_RANGE —Lists past date ranges, such as Any Due Date , Due Date: Yesterday , Due Date: Past 7 Days , Due Date: Past 30 Days , and Due Date: Custom . ASSIGNMENT_RANGE —Lists Any Due Date and Due Date: Past Due . If value is empty, or if this annotation is absent, the date ranges are Any Due Date , Due Date: Today , Due Date: Yesterday , Due Date: Past 7 Days , Due Date: Past 30 Days , and Due Date: Custom . The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.hideLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollable":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollableLinesVisible":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._preset":null,"title":"Configuring date range labels in a search panel's date field","code":{"codeType":"JAVA","code":"@Indexed\n@ToolUi.Filterable\n@ToolUi.CssClass(\"is-minimal\")\n@DateTimeRangeGroups({DateTimeRange.FUTURE_RANGE})\nprivate Date dueDate;","annotations":[{"lineNumber":"4","codeSnippet":"@DateTimeRangeGroups({DateTimeRange.FUTURE_RANGE})","annotation":"Lists date ranges in the future.","originalLineNumber":4,"_id":"0000018a-5101-d25c-abea-51a3b97d0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"_id":"0000018a-5100-d1f2-ad8f-fdd5e0bd0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"_id":"0000018a-5100-d1f2-ad8f-fdd5e0ad0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"_id":"0000018a-5100-d1f2-ad8f-fdd5de900000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}" data-rte-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1693576244715,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1693576244715,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"codeBlock":{"codeBlock":{"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.hideLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollable":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollableLinesVisible":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._preset":null,"title":"Configuring date range labels in a search panel's date field","code":{"codeType":"JAVA","code":"@Indexed\n@ToolUi.Filterable\n@ToolUi.CssClass(\"is-minimal\")\n@DateTimeRangeGroups({DateTimeRange.FUTURE_RANGE})\nprivate Date dueDate;","annotations":[{"lineNumber":"4","codeSnippet":"@DateTimeRangeGroups({DateTimeRange.FUTURE_RANGE})","annotation":"Lists date ranges in the future.","originalLineNumber":4,"_id":"0000018a-5101-d25c-abea-51a3b97d0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"_id":"0000018a-5100-d1f2-ad8f-fdd5e0bd0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"_id":"0000018a-5100-d1f2-ad8f-fdd5e0ad0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"_id":"0000018a-5100-d1f2-ad8f-fdd5de900000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000018a-5100-d1f2-ad8f-fdd5de5c0000","_type":"bc197941-6969-3a80-8658-e03060c646aa"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1693576266530,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1693576266530,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018a-4d92-d1f2-ad8f-edd785610001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000018a-5102-d1f2-ad8f-fdd7e4130001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000018a-5102-d1f2-ad8f-fdd7e4130000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">Date Time Range Groups - Future @DynamicFieldClass Applies to: Field, Method Specifies the class defining a field’s or method’s dynamic behavior in the content edit form. The following table lists the elements available with this annotation. Element Description Valid Value value Class used to dynamically render or modify a member in the content edit form. Any class that implements DynamicField. The following snippets include examples of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Defining dynamic field behavior","code":{"codeType":"JAVA","code":"import brightspot.core.person.AuthorableData;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.cms.ui.form.DynamicField;\nimport com.psddev.dari.db.ObjectField;\nimport com.psddev.dari.db.Recordable;\n\npublic class ArticleBodyDynamicField implements DynamicField {\n\n @Override\n public void update(Recordable record, ObjectField field) { \n field.as(ToolUi.class).setReadOnly(record.as(Article.class).getAuthors().isEmpty()); \n }\n}","annotations":[{"lineNumber":"10","codeSnippet":" public void update(Recordable record, ObjectField field) { ","annotation":"Callback that runs when the content edit form is loaded, with every save, and with every work-in-process save.","originalLineNumber":10,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c64-dc6e-a17f-6df4c6890000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"11","codeSnippet":" field.as(ToolUi.class).setReadOnly(record.as(Article.class).getAuthors().isEmpty()); ","annotation":"Checks if the passed record has any authors. If not, the field annotated with this class is rendered as read-only. This line uses the method getAuthors declared in the snippet that follows this one.","originalLineNumber":11,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c65-d029-adff-6ff505cd0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c64-dd18-a17d-ff657ae40000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c64-dd18-a17d-ff657ade0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c64-d657-a7fd-7ffd7a980000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Applying a dynamic field annotation","code":{"codeType":"JAVA","code":"import brightspot.core.person.Author;\nimport com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.DynamicFieldClass;\n\npublic class Article extends Content {\n\n private String headline;\n\n @DynamicFieldClass(ArticleBodyDynamicField.class) \n private Body body;\n\n private List authors;\n\n public List getAuthors() { \n return authors;\n }\n}","annotations":[{"lineNumber":"9","codeSnippet":" @DynamicFieldClass(ArticleBodyDynamicField.class) ","annotation":"Applies the annotation from the snippet before this one.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c66-dc6e-a17f-6df6410d0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"14","codeSnippet":" public List getAuthors() { ","annotation":"Provides a list of authors.","originalLineNumber":14,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c66-dd18-a17d-ff6787d70000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c65-dd18-a17d-ff65d1d80000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c65-dd18-a17d-ff65d1d30000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c65-dc6e-a17f-6df5d18e0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @DynamicNoteClass Applies to: Class, Field, Method Specifies the class providing a dynamic note in the content edit form. You can display a note for a field or for the entire form. You can apply more than one of these annotations to the same item. The following table lists the elements available with this annotation. Element Description Valid Value value Class used to construct a note associated with the annotated item. Any class that implements DynamicNote. The following snippets include examples of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Returning dynamic note at the class level","code":{"codeType":"JAVA","code":"import com.psddev.cms.ui.form.DynamicNote;\nimport com.psddev.dari.db.ObjectField;\nimport com.psddev.dari.db.Recordable;\n\npublic class ArticleDynamicNote implements DynamicNote {\n\n @Override\n public Object get(Recordable record, ObjectField field) { \n Integer numStories = methodReturningNumberStoriesByTag(\"asteroids\");\n return \"We already have \" + numStories.toString() + \" articles about asteroids. Please focus on a different topic.\";\n\n }\n}","annotations":[{"lineNumber":"8","codeSnippet":" public Object get(Recordable record, ObjectField field) { ","annotation":"Callback that runs when the content edit form is loaded.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c67-d029-adff-6ff7d7320000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c67-dc6e-a17f-6df78c6e0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c67-dc6e-a17f-6df78c690000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c67-d657-a7fd-7fff8c110000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Returning dynamic note at the field level","code":{"codeType":"JAVA","code":"import com.psddev.cms.ui.form.DynamicNote;\nimport com.psddev.dari.db.ObjectField;\nimport com.psddev.dari.db.Recordable;\n\npublic class ArticleHeadlineDynamicNote implements DynamicNote {\n @Override\n public Object get(Recordable record, ObjectField field) { \n Date today = new Date();\n SimpleDateFormat DATE_FORMAT = new SimpleDateFormat(\"MMMM dd, yyyy\");\n String date = DATE_FORMAT.format(today);\n return (\"Ensure your facts are correct as of \" + date.toString() + \".\");\n }\n}","annotations":[{"lineNumber":"7","codeSnippet":" public Object get(Recordable record, ObjectField field) { ","annotation":"Callback that runs when the content edit form is loaded.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c68-d029-adff-6ff972600000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c68-dd18-a17d-ff6938180000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c68-dd18-a17d-ff6938130000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c68-d657-a7fd-7ffd37c80000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Applying dynamic note annotations","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.DynamicNoteClass;\n\n@DynamicNoteClass(ArticleDynamicNote.class) \npublic class Article extends Content {\n\n @DynamicNoteClass(ArticleHeadlineDynamicNote.class) \n private String headline;\n\n}","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c68-dc6e-a17f-6dfcc1a40000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c68-dc6e-a17f-6dfcc19f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c68-d657-a7fd-7ffdc1620000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638201442368,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638201442368,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6c69-dd18-a17d-ff69e4d80000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6c69-d029-adff-6ff9daaa0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c69-d029-adff-6ff9daa90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">DynamicNoteClass.png See also: <a href="/developer-guide/latest/content-modeling-annotations#dynamicnotemethod" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicnotemethod" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815305613,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815305613,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnotemethod","_id":"0000017d-9100-d657-a7fd-bbbddbcb0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicNoteMethod ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9100-d657-a7fd-bbbddbbc0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicNoteMethod <a href="/developer-guide/latest/content-modeling-annotations#note" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="note" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815319941,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815319941,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"note","_id":"0000017d-9101-d657-a7fd-bbbd13f30000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @Note ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9101-d657-a7fd-bbbd13e50000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @Note <a href="/developer-guide/latest/content-modeling-annotations#htmlnote" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="htmlnote" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815335746,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815335746,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"htmlnote","_id":"0000017d-9101-dc6e-a17f-91954eae0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @HtmlNote ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9101-dc6e-a17f-91954e9f0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @HtmlNote @DynamicNoteMethod Applies to: Class, Field, Method Specifies a method that displays a dynamic note. You can display a note for a field or for the entire content edit form. You can apply more than one of these annotations to the same item. The following table lists the elements available with this annotation. Element Description Valid Value value Name of method used to construct a note associated with the annotated item. Any valid method name. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"DynamicNoteMethod","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.DynamicNoteMethod;\n\n@DynamicNoteMethod(\"classNote\") \npublic class Article extends Content {\n\n @DynamicNoteMethod(\"headlineNote\") \n private String headline;\n\n private String classNote() { \n Integer numStories = methodReturningNumberStoriesByTag(\"asteroids\");\n return \"We already have \" + numStories.toString() + \" articles about asteroids. Please focus on a different topic.\";\n }\n\n private String headlineNote() { \n Date today = new Date();\n SimpleDateFormat DATE_FORMAT = new SimpleDateFormat(\"MMMM dd, yyyy\");\n String date = DATE_FORMAT.format(today);\n return (\"Ensure your facts are correct as of \" + date.toString() + \".\");\n\n }\n}","annotations":[{"lineNumber":"4","codeSnippet":"@DynamicNoteMethod(\"classNote\") ","annotation":"Annotation specifying the classNote method for displaying a note at the top of the content edit form.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6b-dd18-a17d-ff6bd8550000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"7","codeSnippet":" @DynamicNoteMethod(\"headlineNote\") ","annotation":"Annotation specifying the headlineNote method for displaying a note for the Headline field.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6c-d657-a7fd-7ffd1a900000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"10","codeSnippet":" private String classNote() { ","annotation":"Method that returns a dynamic string.","originalLineNumber":10,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6c-dc6e-a17f-6dfc45ed0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"15","codeSnippet":" private String headlineNote() { ","annotation":"Method that returns a dynamic string.","originalLineNumber":15,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6c-d029-adff-6ffd76480000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6b-d657-a7fd-7fff87680000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c6b-d657-a7fd-7fff87630000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6b-dd18-a17d-ff6b87310000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638201670302,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638201670302,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6c6d-dd18-a17d-ff6d42c10001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6c6d-dc6e-a17f-6dfd33be0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c6d-dc6e-a17f-6dfd33bd0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">DynamicNoteMethod.png See also: <a href="/developer-guide/latest/content-modeling-annotations#dynamicplaceholderclass" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicplaceholderclass" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815359457,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815359457,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicplaceholderclass","_id":"0000017d-9101-d657-a7fd-bbbdb6170000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicPlaceholderClass ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9101-d657-a7fd-bbbdb6080000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicPlaceholderClass <a href="/developer-guide/latest/content-modeling-annotations#note" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="note" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815377220,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815377220,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"note","_id":"0000017d-9101-dc6e-a17f-9195e7d70001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @Note ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9101-dc6e-a17f-9195e7c90000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @Note <a href="/developer-guide/latest/content-modeling-annotations#htmlnote" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="htmlnote" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815389313,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815389313,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"htmlnote","_id":"0000017d-9102-d657-a7fd-bbbf2bdb0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @HtmlNote ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9102-d657-a7fd-bbbf2bcc0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @HtmlNote @DynamicPlaceholderClass Applies to: Field, Method Specifies the class providing a field’s or method’s dynamic placeholder text in the content edit form. The following table lists the elements available with this annotation. Element Description Valid Value value Class used to construct the placeholder text in the annotated field. Any class that implements DynamicPlaceholder. The following snippets include examples of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Returning dynamic placeholder text","code":{"codeType":"JAVA","code":"import com.psddev.cms.ui.form.DynamicPlaceholder;\nimport com.psddev.dari.db.ObjectField;\nimport com.psddev.dari.db.Recordable;\n\npublic class ArticleHeadlineDynamicPlaceholder implements DynamicPlaceholder {\n\n @Override\n public String get(Recordable record, ObjectField field) { \n DateFormat dateFormat = new SimpleDateFormat(\"yyyy/MM/dd\");\n Date date = new Date();\n return \"Hockey scores as of \" + dateFormat.format(date);\n }\n}","annotations":[{"lineNumber":"8","codeSnippet":" public String get(Recordable record, ObjectField field) { ","annotation":"Callback that runs when the content edit form is loaded. This method returns a string.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6f-dd18-a17d-ff6f5f4f0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6e-d657-a7fd-7ffff9420000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c6e-d657-a7fd-7ffff93d0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6e-d029-adff-6ffff9010000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Applying a dynamic placeholder annotation","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.DynamicPlaceholderClass;\n\npublic class Article extends Content {\n\n @DynamicPlaceholderClass(ArticleHeadlineDynamicPlaceholder.class) \n private String headline;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @DynamicPlaceholderClass(ArticleHeadlineDynamicPlaceholder.class) ","annotation":"Applies the annotation from the snippet above.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c70-d029-adff-6ff118910000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6f-dc6e-a17f-6dffd4890000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c6f-dc6e-a17f-6dffd4830000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c6f-d657-a7fd-7fffd3d10000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638201873910,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638201873910,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6c70-d657-a7fd-7ffd931f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6c70-dc6e-a17f-6df47fd00001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c70-dc6e-a17f-6df47fd00000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">DynamicPlaceholderClass.png See also: <a href="/developer-guide/latest/content-modeling-annotations#dynamicplaceholdermethod" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicplaceholdermethod" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815454629,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815454629,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicplaceholdermethod","_id":"0000017d-9103-d657-a7fd-bbbf15bd0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicPlaceholderMethod ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9103-d657-a7fd-bbbf15ae0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicPlaceholderMethod <a href="/developer-guide/latest/content-modeling-annotations#placeholder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="placeholder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815470352,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815470352,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"placeholder","_id":"0000017d-9103-dc6e-a17f-91975a340000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @Placeholder ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9103-dc6e-a17f-91975a250000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @Placeholder @DynamicPlaceholderMethod Applies to: Field, Method Specifies a method that displays dynamic placeholder text in a field. You can apply more than one of these annotations to achieve multiple effects. The following table lists the elements available with this annotation. Element Description Valid Value value Name of method that returns a string appearing in the annotated field. Any valid method name. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"DynamicPlaceholderMethod","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.DynamicPlaceholderMethod;\n\npublic class Article extends Content {\n\n @DynamicPlaceholderMethod(\"currentDate\") \n private String headline;\n\n private String currentDate() { \n DateFormat dateFormat = new SimpleDateFormat(\"yyyy/MM/dd\");\n Date date = new Date();\n return \"Hockey scores as of \" + dateFormat.format(date);\n }\n}","annotations":[{"lineNumber":"6","codeSnippet":" @DynamicPlaceholderMethod(\"currentDate\") ","annotation":"Annotation specifying the currentDate method for populating the placeholder text.","rekognitionVideo.timeFrameMetadata":[],"originalLineNumber":6,"_id":"0000017d-6c88-dd18-a17d-ffa9953f0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":" private String currentDate() { ","annotation":"Method that returns a dynamic string.","rekognitionVideo.timeFrameMetadata":[],"originalLineNumber":9,"_id":"0000017d-6c88-d657-a7fd-7fbdd4d10000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c88-dd18-a17d-ffa95a850000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c88-dd18-a17d-ffa95a800000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c88-dc6e-a17f-6d9c5a380000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638203503375,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638203503375,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6c89-d657-a7fd-7fbd6f410001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6c89-dd18-a17d-ffa9611e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c89-dd18-a17d-ffa9611e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">DynamicPlaceholderMethod.png See also: <a href="/developer-guide/latest/content-modeling-annotations#dynamicplaceholderclass" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicplaceholderclass" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815492979,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815492979,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicplaceholderclass","_id":"0000017d-9103-d657-a7fd-bbbfc49e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicPlaceholderClass ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9103-d657-a7fd-bbbfc48f0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicPlaceholderClass <a href="/developer-guide/latest/content-modeling-annotations#placeholder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="placeholder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815513191,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815513191,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"placeholder","_id":"0000017d-9103-d657-a7fd-bbbff8ee0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @Placeholder ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9103-d657-a7fd-bbbff8e00000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @Placeholder @DynamicTypeClass Applies to: Class Specifies the class defining a class’s behavior in the content edit form. You can apply more than one of these annotations to achieve multiple effects. The following table lists the elements available with this annotation. Element Description Valid Value value Class used to dynamically render or modify a class in the content edit form. Any class that implements DynamicType. The following snippets include examples of applying this annotation. <bsp-callout data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1722007439763,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1722007439763,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"callout":{"callout":{"type":"NOTE","calloutText":"There is a known issue related to having more than one @DynamicTypeClass annotation in a single record that may cause problems with ObjectFields . In these cases, <bsp-snippet data-snippet-state=\"{&quot;cms.site.owner&quot;:{&quot;_ref&quot;:&quot;0000017a-e99b-d9c6-a5fa-eddf364e0000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30006&quot;},&quot;cms.content.publishDate&quot;:1721932620001,&quot;cms.content.publishUser&quot;:{&quot;_ref&quot;:&quot;00000171-7e3f-db90-a57b-7ebfd55a0000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30018&quot;},&quot;cms.content.updateDate&quot;:1721932620001,&quot;cms.content.updateUser&quot;:{&quot;_ref&quot;:&quot;00000171-7e3f-db90-a57b-7ebfd55a0000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30018&quot;},&quot;snippet&quot;:{&quot;_ref&quot;:&quot;0000017b-64ac-d86b-a77f-6dad65240000&quot;,&quot;_type&quot;:&quot;d2a205aa-dd4d-3a6e-acf9-d4f7609d4d35&quot;},&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment&quot;:null,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset&quot;:null,&quot;_id&quot;:&quot;00000190-eb2e-dd74-a1ba-fbbf8e030000&quot;,&quot;_type&quot;:&quot;968481a3-3236-3bd5-82c4-ba78207b9d17&quot;}\"> recommends adding the following line at the end of the update implementation: type.setFields(type.getFields()); ","_id":"00000190-eb2c-dd74-a1ba-fbbf8dab0000","_type":"a64a25ea-0f4e-3e27-8136-0e63bec56e72"},"_id":"00000190-eb2c-dd74-a1ba-fbbf8c550000","_type":"96fa12a0-b117-3f56-8123-eefe760f046e"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"00000190-eb2c-dd74-a1ba-fbbf8c160000","_type":"98cde75f-32a8-3181-9416-3bf9f401af77"}"> Defining dynamic class behavior <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Defining dynamic class behavio","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.TabDisplayMode;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.cms.ui.form.DynamicType;\nimport com.psddev.dari.db.ObjectType;\nimport com.psddev.dari.db.Recordable;\n\npublic class ArticleDynamicType implements DynamicType {\n\n @Override\n public void update(ObjectType type, Recordable record) { \n if (record.as(Article.class).getAuthors().isEmpty()) { \n type.as(ToolUi.class).setTabDisplayMode(TabDisplayMode.TABS);\n } else {\n type.as(ToolUi.class).setTabDisplayMode(TabDisplayMode.MENU);\n }\n }\n}","annotations":[{"lineNumber":"10","codeSnippet":" public void update(ObjectType type, Recordable record) { ","annotation":"Callback that runs when the content edit form is loaded and with every save.","originalLineNumber":10,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8b-d029-adff-6f9b48350000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"11","codeSnippet":" if (record.as(Article.class).getAuthors().isEmpty()) { ","annotation":"Checks if the passed record has any authors. If there are no authors, the content edit form has a hotdog menu with a list of tabs. If there are any authors, the content edit form explicitly displays the tabs. This line uses the method getAuthors declared in the snippet below (Applying a dynamic class annotation ) .","originalLineNumber":11,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8b-dc6e-a17f-6d9f75a00000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8a-d657-a7fd-7fbfc2960000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c8a-d657-a7fd-7fbfc2900000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8a-dd18-a17d-ffabc23a0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Applying a dynamic class annotation <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Applying a dynamic class annotation","code":{"codeType":"JAVA","code":"import brightspot.core.person.Author;\nimport com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.DynamicTypeClass;\n\n@DynamicTypeClass(ArticleDynamicType.class) \npublic class Article extends Content {\n\n private List authors;\n\n public List getAuthors() { \n return authors;\n }\n}","annotations":[{"lineNumber":"5","codeSnippet":"@DynamicTypeClass(ArticleDynamicType.class) ","annotation":"Applies the annotation from the snippet above.","originalLineNumber":5,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8c-d657-a7fd-7fbd192b0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" private List authors;","annotation":"Provides a list of authors.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8c-d657-a7fd-7fbd5c880000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8b-d657-a7fd-7fbfc9d50000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c8b-d657-a7fd-7fbfc9d00000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8b-dc6e-a17f-6d9fc9930000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-video data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638203741169,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638203741169,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"video":{"_ref":"0000017d-6c8c-d029-adff-6f9dfe370001","_type":"0000015d-56b9-d2db-a5dd-f6fd6edb000c"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c8c-d029-adff-6f9df2960000","_type":"0000015d-56b9-d2db-a5dd-f6fd6edc0004"}">dynamic_type_class.mp4 In the previous video, the tabs display explicitly or under a hotdog menu depending on the existence of any authors. @EditablePlaceholder Places the cursor after a field’s placeholder text. This annotation reduces the number of keystrokes necessary to prepend a standard phrase before a string in a field. Requires <a href="/developer-guide/latest/content-modeling-annotations#placeholder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="placeholder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815700823,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815700823,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"placeholder","_id":"0000017d-9106-d029-adff-979761e20000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @Placeholder ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9106-d029-adff-979761d30000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @Placeholder . Overrides <a href="/developer-guide/latest/content-modeling-annotations#clearonplaceholderchange" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="clearonplaceholderchange" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815716947,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815716947,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"clearonplaceholderchange","_id":"0000017d-9107-dc6e-a17f-91972bc30000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ClearOnPlaceholderChange ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9107-dc6e-a17f-91972bb40000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ClearOnPlaceholderChange . The following table lists the elements available with this annotation. Element Description Valid Value value If true or absent, on field focus the cursor is positioned after the placeholder text. If false, on field focus the cursor is positioned before the placeholder text. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"EditablePlaceholder","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.EditablePlaceholder;\nimport com.psddev.cms.ui.form.Placeholder;\n\npublic class Article extends Content {\n\n @Placeholder(\"Today's headline: \")\n @EditablePlaceholder \n private String headline;\n\n}","annotations":[{"lineNumber":"8","codeSnippet":" @EditablePlaceholder ","annotation":"When an editor applies focus to the field Headline , the cursor is positioned after the placeholder text.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8e-dc6e-a17f-6d9e72830000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8e-dc6e-a17f-6d9e271d0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c8e-dc6e-a17f-6d9e27150000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8e-dd18-a17d-ffaf26d10000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-video data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638203867200,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638203867200,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"video":{"_ref":"0000017d-6c8e-d029-adff-6f9ff1680001","_type":"0000015d-56b9-d2db-a5dd-f6fd6edb000c"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c8e-dc6e-a17f-6d9ee56d0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6edc0004"}">editable-placeholder.mp4 In the previous video, the editor clicks in the field Headline, and the cursor is positioned after the placeholder text. @HtmlNote Applies to: Class, Field, Method Specifies a static note containing HTML markup appearing adjacent to the annotated item. (To render a plain-text note, see <a href="/developer-guide/latest/content-modeling-annotations#note" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="note" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815736071,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815736071,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"note","_id":"0000017d-9107-dc6e-a17f-9197799d0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @Note ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9107-dc6e-a17f-9197798f0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @Note .) The following table lists the elements available with this annotation. Element Description Valid Value value Explanatory text appearing adjacent to the annotated class or field. Any valid HTML string. The following snippet includes an example of applying this annotation. Contact abraun@brightspot.com for technical support. \") \npublic class Article extends Content {\n\n @HtmlNote(\" Hint Drag files here.\") \n @ToolUi.BulkUpload\n private StorageItem image;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":"@HtmlNote(\" Contact abraun@brightspot.com for technical support. \") ","annotation":"Displays a note at the top of the content edit form.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c90-d657-a7fd-7fbd05b90000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":" @HtmlNote(\" Hint Drag files here.\") ","annotation":"Displays a note adjacent to the Image field.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c90-dd18-a17d-ffb15ba40000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8f-dc6e-a17f-6d9fc9620000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c8f-dc6e-a17f-6d9fc95d0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c8f-d029-adff-6f9fc92f0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638204002299,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638204002299,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6c90-dd18-a17d-ffb1f84e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6c91-d029-adff-6f91453a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c91-d029-adff-6f9145390000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">HtmlNote.png See also: <a href="/developer-guide/latest/content-modeling-annotations#dynamicnoteclass" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicnoteclass" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815751412,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815751412,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnoteclass","_id":"0000017d-9107-d657-a7fd-bbbfb2ed0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicNoteClass ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9107-d657-a7fd-bbbfb2de0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicNoteClass <a href="/developer-guide/latest/content-modeling-annotations#dynamicnotemethod" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicnotemethod" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815763541,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815763541,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnotemethod","_id":"0000017d-9107-dd18-a17d-9f27e3010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicNoteMethod ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9107-dd18-a17d-9f27e2f20000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicNoteMethod @Note Applies to: Class, Field, Method Specifies a static plain-text note appearing adjacent to the annotated item. (To render a note containing HTML, see <a href="/developer-guide/latest/content-modeling-annotations#htmlnote" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="htmlnote" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815778241,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815778241,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"htmlnote","_id":"0000017d-9108-d029-adff-979924730000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @HtmlNote ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9108-d029-adff-979924640000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @HtmlNote .) The following table lists the elements available with this annotation. Element Description Valid Value value Explanatory text appearing adjacent to the annotated class or field. Any string. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Note","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.cms.ui.form.Note;\nimport com.psddev.dari.util.StorageItem;\n\n@Note(\"Please, no more articles about asteroid impacts...\") \npublic class Article extends Content {\n\n @Note(\"Drag files here\") \n @ToolUi.BulkUpload\n private StorageItem image;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":"@Note(\"Please, no more articles about asteroid impacts...\") ","annotation":"Displays a note at the top of the content edit form.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c92-d029-adff-6f9362f40000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":" @Note(\"Drag files here\") ","annotation":"Displays a note adjacent to the Image field.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c92-d657-a7fd-7fbf8f4b0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c92-dc6e-a17f-6d962db80000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c92-dc6e-a17f-6d962db30000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c92-d657-a7fd-7fbf2d6f0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638204140110,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638204140110,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6c93-d657-a7fd-7fbf1bc90001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6c93-d657-a7fd-7fbf0e090001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c93-d657-a7fd-7fbf0e090000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">Note.png See also: <a href="/developer-guide/latest/content-modeling-annotations#dynamicnoteclass" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicnoteclass" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815792434,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815792434,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnoteclass","_id":"0000017d-9108-d029-adff-9799552e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicNoteClass ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9108-d029-adff-9799551f0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicNoteClass <a href="/developer-guide/latest/content-modeling-annotations#dynamicnotemethod" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicnotemethod" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815861265,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815861265,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnotemethod","_id":"0000017d-9109-dd18-a17d-9f2956ee0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicNoteMethod ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9109-dd18-a17d-9f2956df0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicNoteMethod @Placeholder Applies to: Field, Method Specifies static placeholder text appearing in a field. (To render dynamic placeholder text, see <a href="/developer-guide/latest/content-modeling-annotations#dynamicplaceholderclass" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicplaceholderclass" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815892925,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815892925,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicplaceholderclass","_id":"0000017d-9109-d029-adff-9799e3130000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicPlaceholderClass ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9109-d029-adff-9799e3040000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicPlaceholderClass , <a href="/developer-guide/latest/content-modeling-annotations#dynamicplaceholdermethod" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="dynamicplaceholdermethod" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638815911760,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638815911760,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicplaceholdermethod","_id":"0000017d-910a-d029-adff-979b27100000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @DynamicPlaceholderMethod ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-910a-d029-adff-979b27000000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @DynamicPlaceholderMethod .) The following table lists the elements available with this annotation. Element Description Valid Value value Placeholder text appearing in the annotated class or field. Any string. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Placeholder","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.ui.form.Placeholder;\n\npublic class TestArticle extends Content {\n\n @Placeholder(\"Write your headline here.\") \n private String headline;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @Placeholder(\"Write your headline here.\") ","annotation":"Displays placeholder text in the Headline field.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c94-d657-a7fd-7fbd5cd60000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c94-dd18-a17d-ffb51b620000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c94-dd18-a17d-ffb51b5d0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c94-dc6e-a17f-6d941b280000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638204263669,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638204263669,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6c95-d029-adff-6f9509040001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6c94-d657-a7fd-7fbdff810001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6c94-d657-a7fd-7fbdff810000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">Placeholder.png See also: <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#clearonplaceholderchange" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="clearonplaceholderchange" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638975869438,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638975869438,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"clearonplaceholderchange","_id":"0000017d-9a92-dc6e-a17f-9b96c0660000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ClearOnPlaceholderChange ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9a92-dc6e-a17f-9b96c0550000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ClearOnPlaceholderChange <a href="/developer-guide/latest/content-modeling-annotations#editableplaceholder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="editableplaceholder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816023684,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816023684,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"editableplaceholder","_id":"0000017d-910b-dd18-a17d-9f2bd83d0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @EditablePlaceholder ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-910b-dd18-a17d-9f2bd82e0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @EditablePlaceholder @RichTextElement.Exclusive Applies to: Class. Ensures rich-text elements do not have nested markup. When editors concatenate one rich-text element after another, Brightspot stores those elements as nested. \n Massive Rogue Asteroid\n \n on Course to Destroy\n \n All Life in Van Nuys, CA\n ","annotations":[{"lineNumber":"3","codeSnippet":" ","annotation":"Child element &lt;div class=\"h2\"&gt;on Course to Destroy&lt;/div&gt; is nested within a parent element &lt;div class=\"h1\"&gt;Massive Rogue Asteroid All Life in Van Nuys, CA&lt;/div&gt; ","originalLineNumber":3,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c96-dd18-a17d-ffb730de0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c95-dd18-a17d-ffb5e7c80000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c95-dd18-a17d-ffb5e7c20000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c95-d029-adff-6f95e7800000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Depending on the editors’ preferences and the CSS definitions, nesting may not provide predictable or desirable rendering. You can use the annotation @RichTextElement.Exclusive to prevent nesting. Implementing this annotation requires the following steps. Step 1: Annotate a marker interface <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Annotate a marker interface","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.RichTextElement;\nimport com.psddev.dari.db.Recordable;\n\n@RichTextElement.Exclusive \npublic interface ElementsWithoutNesting extends Recordable { \n}","annotations":[{"lineNumber":"4","codeSnippet":"@RichTextElement.Exclusive ","annotation":"Applies the annotation @RichTextElement.Exclusive to the interface.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c97-dc6e-a17f-6d97024e0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"5","codeSnippet":"public interface ElementsWithoutNesting extends Recordable { ","annotation":"Declares a marker interface.","originalLineNumber":5,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c97-dd18-a17d-ffb732900000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c96-dd18-a17d-ffb7c1530000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c96-dd18-a17d-ffb7c14e0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c96-dc6e-a17f-6d96c1150000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Step 2: Implement interface in rich text element <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Implement interface in rich-text element","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.RichTextElement;\nimport com.psddev.dari.db.Recordable;\n\n@Recordable.DisplayName(\"Heading 1\")\n@RichTextElement.Tag(\n value = \"h1\",\n preview = true,\n block = false)\npublic class HeadingOneRichTextElement extends RichTextElement implements ElementsWithoutNesting { \n\n @Required\n private String heading1;\n\n public String getHeading1() {\n return heading1;\n }\n\n public void setHeading1(String heading1) {\n this.heading1 = heading1;\n }\n}","annotations":[{"lineNumber":"9","codeSnippet":"public class HeadingOneRichTextElement extends RichTextElement implements ElementsWithoutNesting { ","annotation":"Specifies the marker interface you created in Step 1. When editors concatenate an implementing rich-text element after another implementing rich-text element, Brightspot closes the original element and opens the new element. See the following snippet.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c97-dd18-a17d-ffb7f86e0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c97-dd18-a17d-ffb7acd90000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c97-dd18-a17d-ffb7acd40000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c97-d657-a7fd-7fbfac920000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> The following snippet is the result. \n Massive Rogue Asteroid on Course\n \n \n to Destroy All Life in Van Nuys, CA\n ","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c98-dc6e-a17f-6d9c76880000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c98-dc6e-a17f-6d9c76830000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c98-dd18-a17d-ffb976460000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @RichTextElement.Tag Applies to: Class Configures the appearance and behavior of a rich-text element in a rich-text editor. The following table lists the elements available with this annotation. Element Description Valid Value value Custom tag surrounding the rich-text element in published HTML. For example, for value="quote", the rich-text element appears inside tags. Any string valid for an HTML tag. Required. No default. htmlBody Treats the RichTextElement’s body text as HTML or plain text. The element's value affects the implementation of the RichTextElement’s fromBody method. true, false (default). initialBody Initial content for the rich-text element. Any string. If blank (default), there is no initial content for rich-text element. block Places the rich-text element in its own line in the rich-text editor. true, false (default). When true, inline in the @ToolUi.RichText annotation must be false. See <a href="/developer-guide/latest/content-modeling-annotations#toolui-richtext" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-richtext" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816071803,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816071803,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-richtext","_id":"0000017d-910c-d657-a7fd-bbbd83880000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ToolUi.RichText ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-910c-d657-a7fd-bbbd837a0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ToolUi.RichText . preview Displays a preview of the rich-text element inside the rich-text editor. The preview is generated by overriding RichTextElement#writePreviewHtml. true, false (default) readOnly Prevents modification of an existing rich-text element. true, false (default) root Indicates rich-text element can contain child elements. true, false (default) children List of class instances that can be embedded in instances of this rich-text element. Array of classes. menu Toolbar item under which this rich-text element appears. If absent, rich-text element appears directly on the toolbar. Any string. Default is string of length zero, in which case rich-text element appears on toolbar. tooltip Displays a tool tip when the mouse hovers over the rich-text element’s menu item. Any string. If blank (default), no tool tip appears. keymaps Shortcut keys associated with the rich-text item. The shortcut keys are active while the cursor is inside the edit area. Array of strings representing keyboard shortcuts, such as {"Ctrl-I","Cmd-I"}. Any string that complies with CodeMirror’s <a href="https://codemirror.net/5/doc/manual.html#keymaps" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1655131947078,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1655131947078,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"target":"NEW","attributes":[],"url":"https://codemirror.net/5/doc/manual.html#keymaps","_id":"00000181-5d8d-ddac-a59f-7fdf0a610001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"Key Maps","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"_id":"00000181-5d8d-ddac-a59f-7fdf0a610000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">Key Maps is valid. Default is no keyboard shortcut. position Sort order in which menu items appear compared to other menu items in same level on the toolbar. The sort order is as follows: Sort those rich-text elements without this element in alphabetical order based on the value in the @Recordable.DisplayName annotation. Sort those rich-text elements with this element based on its numerical value. Break ties by sorting alphabetically based on the value in the annotation @Recordable.DisplayName. Double. Default is 0. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"RTE.Tag","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.RichTextElement;\nimport com.psddev.dari.db.Recordable;\n\n@Recordable.DisplayName(\"Pull Quote\") \n@RichTextElement.Tag(value = \"quote\", \n block = true, \n initialBody = \"Meaningful quote here\", \n menu = \"Tools\", \n preview = true,\n readOnly = true,\n root = true,\n keymaps = {\"Ctrl-I\"}, \n tooltip = \"Add pull quote (Ctrl-I)\" \n)\npublic class PullQuoteRichTextElement extends RichTextElement {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@Recordable.DisplayName(\"Pull Quote\") ","annotation":"Specifies the label of the rich-text element’s menu item.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9b-dc6e-a17f-6d9f5ccb0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"5","codeSnippet":"@RichTextElement.Tag(value = \"quote\", ","annotation":"Generates tags around the rich-text element at run time.","originalLineNumber":5,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9b-d657-a7fd-7fbfa0260000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"6","codeSnippet":" block = true, ","annotation":"Sets the rich-text element in its own line.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9b-d657-a7fd-7fbff0d30000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"7","codeSnippet":" initialBody = \"Meaningful quote here\", ","annotation":"Specifies the initial text in the rich-text element’s widget.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9c-d029-adff-6f9d23f20000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" menu = \"Tools\", ","annotation":"Places menu item under the top-level Tools menu.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9c-dd18-a17d-ffbd578a0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"12","codeSnippet":" keymaps = {\"Ctrl-I\"}, ","annotation":"Maps the keyboard shortcut Ctrl-I to opening the rich-text element’s widget.","originalLineNumber":12,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9c-dd18-a17d-ffbd9aae0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"13","codeSnippet":" tooltip = \"Add pull quote (Ctrl-I)\" ","annotation":"Displays a tool tip.","originalLineNumber":13,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9c-dd18-a17d-ffbdc9cf0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9b-d657-a7fd-7fbf15700000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6c9b-d657-a7fd-7fbf156b0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6c9b-d029-adff-6f9b14f20000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @RichTextElement.Tags Applies to: Field Displays the rich-text editor with a standard toolbar and additional custom rich-text elements. Requires <a href="/developer-guide/latest/content-modeling-annotations#toolui-richtext" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-richtext" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816071803,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816071803,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-richtext","_id":"0000017d-910c-d657-a7fd-bbbd83880000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ToolUi.RichText ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-910c-d657-a7fd-bbbd837a0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ToolUi.RichText . The following table lists the elements available with this annotation. Element Description Valid Value value RichTextElement classes appearing along with standard rich-text toolbar. Array of classes. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"RTE.Tags","code":{"codeType":"JAVA","code":"import brightspot.core.tool.SmallRichTextToolbar;\nimport com.psddev.cms.db.Content;\nimport com.psddev.cms.db.RichTextElement;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.RichText(inline = false, toolbar = SmallRichTextToolbar.class) \n @RichTextElement.Tags({KlingonRichTextElement.class}) \n public String body;\n\n}","annotations":[{"lineNumber":"8","codeSnippet":" @ToolUi.RichText(inline = false, toolbar = SmallRichTextToolbar.class) ","annotation":"Renders the text field as a rich-text editor with a standard toolbar. The element inline = false is mandatory.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cd8-d029-adff-6fd9a5450000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":" @RichTextElement.Tags({KlingonRichTextElement.class}) ","annotation":"Adds a custom rich-text element to the toolbar.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cd8-dd18-a17d-fff9da5d0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cd8-dc6e-a17f-6ddc5cce0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6cd8-dc6e-a17f-6ddc5cc90000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cd8-dd18-a17d-fff95c6e0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-callout data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638208732794,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638208732794,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"callout":{"callout":{"type":"NOTE","calloutText":"This annotation may add duplicate buttons to the rich-text toolbar. In such cases, consider using a customized rich-text toolbar. ","rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cd9-d029-adff-6fd95cf20000","_type":"a64a25ea-0f4e-3e27-8136-0e63bec56e72"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cd9-d657-a7fd-7ffd5ca90000","_type":"96fa12a0-b117-3f56-8123-eefe760f046e"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6cd9-d657-a7fd-7ffd5c9e0000","_type":"98cde75f-32a8-3181-9416-3bf9f401af77"}"> @Seo.DescriptionFields Applies to: Class Specifies the fields used to populate the Description field under SEO in the content edit form. Requires the clause implements Seo. The following table lists the elements available with this annotation. Element Description Valid Value value Array of fields whose values are included in the Description field. Brightspot uses only the first element in the array to construct the description. Array of strings. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"SEO.DescriptionFields","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.Seo;\n\n@Seo.DescriptionFields({\"headline\"}) \npublic class Article extends Content implements Seo {\n\n private String headline;\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@Seo.DescriptionFields({\"headline\"}) ","annotation":"Specifies using the value of the model’s headline field as the value for the SEO tab’s Description field.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cda-d657-a7fd-7fffa4530000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cda-dd18-a17d-fffb40ba0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6cda-dd18-a17d-fffb40b50000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cda-d657-a7fd-7fff407c0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> If editors manually change the value in the Description field, Brightspot disables the automatic copying between the two fields. You can access the value of the field referred to in the annotation by calling the findDescription() method. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"SEO.DescriptionFields2","code":{"codeType":"JAVA","code":"String seoDescription = \nmodel.as(Seo.ObjectModification.class).findDescription();","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cdb-dc6e-a17f-6ddf0d740000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6cdb-dc6e-a17f-6ddf0d6f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cdb-d029-adff-6fdb0d1e0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Front-end developers can use seoDescription to populate the tag at runtime, as in the following example. ","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cdb-d029-adff-6fdbcb8e0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6cdb-d029-adff-6fdbcb880000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cdb-d657-a7fd-7fffcb4c0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @Seo.KeywordsFields Applies to: Class Specifies from which fields to collect keywords. Requires the clause implements Seo. The following table lists the elements available with this annotation. Element Description Valid Value value Array of fields whose values are included in the keywords. Array of strings. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Seo.KeywordsFields","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.Seo;\n\n@Seo.KeywordsFields({\"headline\"}) \npublic class Article extends Content {\n\n private String headline;\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@Seo.KeywordsFields({\"headline\"}) ","annotation":"Includes the value of the model’s headline field as a source for keywords.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cde-dc6e-a17f-6ddea6800000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cde-dc6e-a17f-6dde687f0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6cde-dc6e-a17f-6dde687a0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cde-d029-adff-6fdf683d0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> You can access the value of the field referred to in the annotation, along with any other keywords the editor enters under SEO in the Keywords field, by calling the findKeywords() method. seoKeywords = \nmodel.as(Seo.ObjectModification.class).findKeywords();","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cdf-dc6e-a17f-6ddf27ed0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6cdf-dc6e-a17f-6ddf27e80000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cdf-d657-a7fd-7fff27a60000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Front-end developers can use seoKeywords to populate the tag at runtime, as in the following example. \n","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cdf-d657-a7fd-7fff8e430000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6cdf-d657-a7fd-7fff8e3d0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cdf-d029-adff-6fdf8df90000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @Seo.OpenGraphType Applies to: Class Specifies the type of object in the item’s Open Graph tag. Requires the clause implements Seo. This annotation typically requires additional logic to populate the tag’s content attribute. The following table lists the elements available with this annotation. Element Description Valid Value value String specifying the value of the Open Graph property attribute. String. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"SEO.OpenGraphType","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.Seo;\n\n@Seo.OpenGraphType(\"title\") \npublic class Article extends Content {\n\n private String headline;\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@Seo.OpenGraphType(\"title\") ","annotation":"Specifies the Open Graph type is title.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce5-dd18-a17d-ffe524890000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce4-dc6e-a17f-6df4c82e0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6ce4-dc6e-a17f-6df4c8290000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce4-dd18-a17d-ffe5c7e00000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> You can access the value of the field referred to in the annotation by calling the getOpen GraphType() method. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Seo.OpenGraphType2","code":{"codeType":"JAVA","code":"String seoOpenGraphType = model.getState().getType().as(Seo.TypeModification.class).getOpenGraphType();","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce5-d657-a7fd-7ffd9eed0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6ce5-d657-a7fd-7ffd9ee80000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce5-dd18-a17d-ffe59eae0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Front-end developers can use seoOpenGraphType to populate the tag at runtime, as in the following example. ","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce6-dc6e-a17f-6df637750000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6ce6-dc6e-a17f-6df637700000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce6-d657-a7fd-7fff37270000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @Seo.TitleFields Applies to: Class Specifies the fields used to populate the Title field under SEO . Requires the clause implements Seo. If this annotation is absent, Brightspot places into the "> tag the item's ID. The following table lists the elements available with this annotation. Element Description Valid Value value Array of fields included in the "> tag. Brightspot uses only the first element in the array to construct the title. Array of strings. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"SeoTitleTags","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.Seo;\n\n@Seo.TitleFields({\"headline\"}) \npublic class Article extends Content {\n\n private String headline;\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@Seo.TitleFields({\"headline\"}) ","annotation":"Specifies using the value of the model’s &lt;headline&gt; field as the value for the SEO tab’s Title field.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-9111-dd18-a17d-9f317d4f0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-9111-dd18-a17d-9f3139400000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-9111-dd18-a17d-9f31393b0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-9111-d029-adff-979138f10000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> If editors manually change the value in the Title field, Brightspot disables the automatic copying between the two fields. You can access the value of the field referred to in the annotation by calling the findTitle() method. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"TitleFields2","code":{"codeType":"JAVA","code":"String titleString = model.as(Seo.ObjectModification.class).findTitle();","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-9112-dd18-a17d-9f33b8aa0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-9112-dd18-a17d-9f33b8a50000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-9112-d657-a7fd-bbbfb8410000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Front-end developers can use seoTitle to populate the "> tag at runtime, as in the following example. ","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-9113-dd18-a17d-9f335a240000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-9113-dd18-a17d-9f335a1f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-9113-dc6e-a17f-919759d40000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.AddToTop Applies to: Field Places new entries at the top of a list’s selection field; without this annotation, new entries appear at the bottom of the selection field. (Applies only to fields of type List; does not apply to fields of type Set.) The following table lists the elements available with this annotation. Element Description Valid Value value Indicates new elements appear at top of selection field. true (default), false The following snippet includes an example of applying this annotation. relatedArticles; \n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.AddToTop ","annotation":"Opens entries in the selection field on top of the existing entries.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce9-dd18-a17d-ffe9b11d0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"7","codeSnippet":" private List relatedArticles; ","annotation":"Renders a selection field for selecting items of type Article.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce9-dc6e-a17f-6dfdda120000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce9-dd18-a17d-ffe927ea0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6ce9-dd18-a17d-ffe927e50000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ce9-d029-adff-6ff927ae0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638209878361,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638209878361,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6cea-d657-a7fd-7fffa19c0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6cea-d657-a7fd-7fff94080001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6cea-d657-a7fd-7fff94080000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.AddToTop.png @ToolUi.BulkUpload Applies to: Field Indicates the field is available for bulk uploading so that users can drag and drop files from their desktops onto the field. Applies to StorageItem and derived fields in a child model, and requires annotating the child model with <a href="/dari-guide/latest/data-modeling-annotations#recordable-previewfield" data-cms-id="0000017d-726b-d029-adff-77fb698c0000" data-cms-href="/dari-guide/latest/data-modeling-annotations" anchor="recordable-previewfield" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816684586,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816684586,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-726b-d029-adff-77fb698c0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"recordable-previewfield","_id":"0000017d-9115-d657-a7fd-bbbdcce90001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@Recordable.PreviewField","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9115-d657-a7fd-bbbdcce90000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@Recordable.PreviewField . The following table lists the elements available with this annotation. Element Description Valid Value value Indicates field is available for bulk uploads. true (default), false Implementing bulk upload requires two models: the child model containing the bulk-upload field, and the parent model containing the child model. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Bulk upload—child model","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.dari.db.Recordable;\nimport com.psddev.dari.util.StorageItem;\n\n@Recordable.PreviewField(\"image\") \npublic class Image extends Content { \n\n private String caption;\n\n @ToolUi.BulkUpload \n private StorageItem image;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":"@Recordable.PreviewField(\"image\") ","annotation":"Indicates which of the model’s fields is the preview field. This annotation is required for bulk uploading.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ceb-dc6e-a17f-6dffce930000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"11","codeSnippet":" @ToolUi.BulkUpload ","annotation":"Indicates users can drag and drop files from their desktops onto the field Image in the content edit form.","originalLineNumber":11,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cec-dc6e-a17f-6dfc18740000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ceb-dc6e-a17f-6dff8c2a0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6ceb-dc6e-a17f-6dff8c240000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ceb-dd18-a17d-ffeb8bcd0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> In a production environment, you should limit the types of files users can upload, either globally or at the field level. For details, see <a href="/developer-guide/latest/security#limiting-uploads-by-file-type" data-cms-id="0000017d-6c96-d029-adff-6f97b3dc0000" data-cms-href="/developer-guide/latest/security" anchor="limiting-uploads-by-file-type" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816756217,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816756217,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c96-d029-adff-6f97b3dc0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"limiting-uploads-by-file-type","_id":"0000017d-9116-dd18-a17d-9f3779da0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" Limiting uploads by file type ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9116-dd18-a17d-9f3779ca0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> Limiting uploads by file type and <a href="/dari-guide/latest/data-modeling-annotations#recordable-mimetypes" data-cms-id="0000017d-726b-d029-adff-77fb698c0000" data-cms-href="/dari-guide/latest/data-modeling-annotations" anchor="recordable-mimetypes" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816704937,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816704937,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-726b-d029-adff-77fb698c0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"recordable-mimetypes","_id":"0000017d-9116-dd18-a17d-9f372c6d0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @Recordable.MimeTypes ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9116-dd18-a17d-9f372c5d0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @Recordable.MimeTypes . image; \n\n}","annotations":[{"lineNumber":"8","codeSnippet":" private List image; ","annotation":"Establishes the field image as a list of Images—the same field annotated with @ToolUi.BulkUpload above.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6ced-dc6e-a17f-6dfd05120000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cec-d029-adff-6ffdb80c0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6cec-d029-adff-6ffdb8060000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cec-d657-a7fd-7ffdb7c20000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> At run time, Brightspot indicates the field Image is available for bulk upload by displaying the following labels: Upload Files —indicating users can drag and drop multiple files from the desktop. <bsp-snippet data-snippet-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638210061084,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638210061084,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"snippet":{"_ref":"0000017b-6408-d86b-a77f-6d8dfc7b0001","_type":"d2a205aa-dd4d-3a6e-acf9-d4f7609d4d35"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6ced-d657-a7fd-7ffdb1d00000","_type":"968481a3-3236-3bd5-82c4-ba78207b9d17"}"> —indicating users can select a file existing in Brightspot. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638210087511,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638210087511,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6ced-d029-adff-6ffde3e80000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6ced-d657-a7fd-7ffdd5910001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6ced-d657-a7fd-7ffdd5910000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.BulkUpload.png <bsp-callout data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816809487,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816809487,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"callout":{"callout":{"type":"TIP","calloutText":"Use the <a href=\"/developer-guide/latest/content-modeling-annotations#toolui-note\" data-cms-id=\"0000017d-6c50-d657-a7fd-7ffdefc00000\" data-cms-href=\"/developer-guide/latest/content-modeling-annotations\" anchor=\"toolui-note\" link-data=\"{&quot;cms.site.owner&quot;:{&quot;_ref&quot;:&quot;0000017a-a154-d39c-a7ff-aff6dcf90000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30006&quot;},&quot;cms.content.publishDate&quot;:1638816808059,&quot;cms.content.publishUser&quot;:{&quot;_ref&quot;:&quot;00000171-7e3f-db90-a57b-7ebfd55a0000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30018&quot;},&quot;cms.content.updateDate&quot;:1638816808059,&quot;cms.content.updateUser&quot;:{&quot;_ref&quot;:&quot;00000171-7e3f-db90-a57b-7ebfd55a0000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30018&quot;},&quot;rekognitionVideo.timeFrameMetadata&quot;:[],&quot;link&quot;:{&quot;rekognitionVideo.timeFrameMetadata&quot;:[],&quot;attributes&quot;:[],&quot;item&quot;:{&quot;_ref&quot;:&quot;0000017d-6c50-d657-a7fd-7ffdefc00000&quot;,&quot;_type&quot;:&quot;75918a10-b479-3fb1-bb84-6a57df4b0241&quot;},&quot;anchor&quot;:&quot;toolui-note&quot;,&quot;_id&quot;:&quot;0000017d-9117-dd18-a17d-9f37cc3e0000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ed10000&quot;},&quot;linkText&quot;:&quot;&lt;u class=\\&quot;rte2-style-underline\\&quot;&gt;@ToolUi.Note&lt;/u&gt;&quot;,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle&quot;:null,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template&quot;:null,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment&quot;:null,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template&quot;:null,&quot;_id&quot;:&quot;0000017d-9117-dd18-a17d-9f37cc2e0000&quot;,&quot;_type&quot;:&quot;00000162-ab56-d787-af72-fb57299f0000&quot;}\"> @ToolUi.Note annotation in the parent model to provide a hint to users that a field accepts drag-and-drop. ","rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cee-d657-a7fd-7fff4c330000","_type":"a64a25ea-0f4e-3e27-8136-0e63bec56e72"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6cee-dc6e-a17f-6dfe4be90000","_type":"96fa12a0-b117-3f56-8123-eefe760f046e"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6cee-dc6e-a17f-6dfe4bdd0000","_type":"98cde75f-32a8-3181-9416-3bf9f401af77"}"> After users drag and drop the files onto the field, Brightspot displays a preview of the dragged images along with the content edit form corresponding to the child model. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638210198185,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638210198185,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6cef-d657-a7fd-7fff65a10001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6cef-d657-a7fd-7fff5a6b0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6cef-d657-a7fd-7fff5a6a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.BulkUpload content edit form.png In the previous image— The bulk-uploaded images are part of the Image model. As a result, Brightspot displays a preview of the dragged image using the field image. Brightspot also displays the content edit form for the model Image. @ToolUi.Cluster Applies to: Field Groups fields under an accordion for presentation on the content edit form. You can use this annotation to provide explanatory information or as a label for closely related fields. Fields without a cluster label appear first in the content edit form before fields with a cluster label. Cluster labels are sorted in order of appearance; you can override this order using the annotation <a href="/developer-guide/latest/content-modeling-annotations#toolui-clusterdisplayorder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-clusterdisplayorder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638859155718,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638859155718,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-clusterdisplayorder","_id":"0000017d-9118-dd18-a17d-9f3924b90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.ClusterDisplayOrder","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9118-dd18-a17d-9f3924aa0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.ClusterDisplayOrder . The following table lists the elements available with this annotation. Element Description Valid Value value Cluster label under which this field appears in the content edit form. Any string. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUi.Cluster","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.Cluster(\"Summary text\") \n private String headline;\n\n @ToolUi.Cluster(\"Summary text\")\n private String headlineShort;\n\n @ToolUi.Cluster(\"Summary text\")\n private String leadIn;\n\n private Author author; \n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.Cluster(\"Summary text\") ","annotation":"Specifies a cluster heading Summary text as an accordion for the fields headline, headlineShort, and leadIn.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d01-dc6e-a17f-6d957a730000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"15","codeSnippet":" private Author author; ","annotation":"Because the field author has no cluster heading, it appears first in the content edit form.","originalLineNumber":15,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d01-d029-adff-6f91b1040000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d01-dd18-a17d-ff21352e0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d01-dd18-a17d-ff2135290000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d01-d657-a7fd-7fbd34e50000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638211418911,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638211418911,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d02-dd18-a17d-ff2326fc0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d02-d029-adff-6f9318110001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d02-d029-adff-6f9318110000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.Cluster.png @ToolUi.ClusterDisplayOrder Applies to: Class Specifies the order in which clusters appear in the content edit form. By default, Brightspot displays clusters (the accordions you declare with <a href="/developer-guide/latest/content-modeling-annotations#toolui-cluster" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-cluster" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816874899,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816874899,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-cluster","_id":"0000017d-9118-dc6e-a17f-919caa750000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ToolUi.Cluster ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9118-dc6e-a17f-919caa660000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ToolUi.Cluster ) in the order in which they first appear in the model. Using this annotation, you can specify which cluster appears first, which cluster appears last, and if the clusters are sorted alphabetically. Regardless of this annotation, Brightspot always places fields without any cluster at the top of the content edit form. The following table lists the elements available with this annotation. Element Description Valid Value tab Tab to which this cluster order applies. Main or any string appearing as a parameter to the annotation <a href="/developer-guide/latest/content-modeling-annotations#toolui-tab" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-tab" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816898079,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816898079,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-tab","_id":"0000017d-9119-dd18-a17d-9f3915d60000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ToolUi.Tab ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9119-dd18-a17d-9f3915bd0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ToolUi.Tab . Required. alphabetize If true, clusters are sorted alphabetically. If false or absent, clusters are sorted in order of first appearance in the model. true, false (default) start Topmost clusters in the content edit form (after fields not associated with any cluster). Brightspot displays the clusters in the order as they appear in the array, so start={"Soda Pop","Mineral Water"} displays the cluster Soda Pop above the cluster Mineral Water. Array of strings, the elements of which are parameters to the annotation <a href="/developer-guide/latest/content-modeling-annotations#toolui-cluster" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-cluster" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816874899,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816874899,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-cluster","_id":"0000017d-9118-dc6e-a17f-919caa750000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ToolUi.Cluster ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9118-dc6e-a17f-919caa660000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ToolUi.Cluster . end Bottommost clusters in the content edit form. Brightspot displays the clusters in the order as they appear in the array, so start={"Soda Pop","Mineral Water"} displays the cluster Soda Pop above the cluster Mineral Water. Overrides alphabetize = true. If the same cluster is passed to start and end, the layout specified by end has higher priority. Array of strings, the elements of which are parameters to the annotation <a href="/developer-guide/latest/content-modeling-annotations#toolui-cluster" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-cluster" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816874899,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816874899,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-cluster","_id":"0000017d-9118-dc6e-a17f-919caa750000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ToolUi.Cluster ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9118-dc6e-a17f-919caa660000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ToolUi.Cluster . The following snippet includes an example of implementing this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUi.ClusterDisplayOrder","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.ClusterDisplayOrder(tab=\"Main\",alphabetize=true) \npublic class Article extends Content {\n\n private String headline; \n private String body;\n private String author;\n\n @ToolUi.Cluster(\"Markets\") \n private String state;\n\n @ToolUi.Cluster(\"Markets\")\n private String county;\n\n @ToolUi.Cluster(\"Markets\")\n private String city;\n\n @ToolUi.Cluster(\"Demographics\") \n private String gender;\n\n @ToolUi.Cluster(\"Demographics\")\n private String age;\n\n @ToolUi.Cluster(\"Demographics\")\n private String occupation;\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.ClusterDisplayOrder(tab=\"Main\",alphabetize=true) ","annotation":"Specifies that the clusters are sorted alphabetically such that Demographics appears first, overriding the default that Markets be the topmost cluster.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d04-dc6e-a17f-6d9419d10000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"7","codeSnippet":" private String headline; ","annotation":"Defines three fields without a @ToolUi.Cluster annotation; these fields appear first in the content edit form.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d04-d029-adff-6f9558bc0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"11","codeSnippet":" @ToolUi.Cluster(\"Markets\") ","annotation":"Defines three fields appearing under the cluster Markets. By default, Markets is the topmost cluster because it is appears first in the model.","originalLineNumber":11,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d04-dd18-a17d-ff25a0f30000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"20","codeSnippet":" @ToolUi.Cluster(\"Demographics\") ","annotation":"Defines three fields appearing under the cluster Demographics.","originalLineNumber":20,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d04-d657-a7fd-7fbdee4a0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d03-dc6e-a17f-6d97ca1c0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d03-dc6e-a17f-6d97ca130000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d03-d657-a7fd-7fbfc9d00000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638211646254,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638211646254,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d05-d657-a7fd-7fbda85e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d05-d029-adff-6f959db30001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d05-d029-adff-6f959db30000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.ClusterDisplayOrder.svg @ToolUi.ClusterDisplayOrders Containing annotation for <a href="/developer-guide/latest/content-modeling-annotations#toolui-clusterdisplayorder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-clusterdisplayorder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638816990059,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638816990059,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-clusterdisplayorder","_id":"0000017d-911a-dc6e-a17f-919e66d10000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" @ToolUi.ClusterDisplayOrder ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-911a-dc6e-a17f-919e66c10000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> @ToolUi.ClusterDisplayOrder annotations. You do not use this annotation explicitly; it implicitly allows for applying multiple @ToolUi.ClusterDisplayOrder annotations to the same model and avoiding a Duplicate annotation error. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUi.ClusterDisplayOrders","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.ClusterDisplayOrder(tab=\"Main\",alphabetize=true)\n@ToolUi.ClusterDisplayOrder(tab=\"Marketing\",alphabetize=true)\n@ToolUi.ClusterDisplayOrder(tab=\"Sales History\",start=\"First Contact Info\", end=\"Latest Contact Info\") \npublic class Article extends Content {\n\n /* Fields with annotations @ToolUi.Tab and @ToolUi.Cluster. */\n\n}","annotations":[{"lineNumber":"6","codeSnippet":"@ToolUi.ClusterDisplayOrder(tab=\"Sales History\",start=\"First Contact Info\", end=\"Latest Contact Info\") ","annotation":"Applies the annotation @ToolUi.ClusterDisplayOrder multiple times to the same model.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d08-d657-a7fd-7fbd16aa0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d07-d657-a7fd-7fbfd0220000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d07-d657-a7fd-7fbfd01c0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d07-d029-adff-6f97cfe30000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.CodeType Applies to: Field Applies syntax highlighting to the text inside a String field. The following table lists the elements available with this annotation. Element Description Valid Value value A code used to apply syntax highlighting. One of the CodeMirror language modes. Language modes for syntax highlighting Language Mode Example on CodeMirror text/clike <a href="https://codemirror.net/5/mode/clike/index.html" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1655132336156,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1655132336156,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"target":"NEW","attributes":[],"url":"https://codemirror.net/5/mode/clike/index.html","_id":"00000181-5d92-d85d-a9d3-dfbbf8ff0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"C-like mode","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"_id":"00000181-5d92-d85d-a9d3-dfbbf8ff0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">C-like mode text/xml <a href="https://codemirror.net/5/mode/xml/index.html" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1655132381970,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1655132381970,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"target":"NEW","attributes":[],"url":"https://codemirror.net/5/mode/xml/index.html","_id":"00000181-5d93-ddac-a59f-7fdba7100001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"XML mode","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"_id":"00000181-5d93-ddac-a59f-7fdba7100000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">XML mode text/javascript <a href="https://codemirror.net/5/mode/javascript/index.html" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1655132405842,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1655132405842,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"target":"NEW","attributes":[],"url":"https://codemirror.net/5/mode/javascript/index.html","_id":"00000181-5d94-ddac-a59f-7fde15a30001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"JavaScript mode","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"_id":"00000181-5d94-ddac-a59f-7fde15a30000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">JavaScript mode text/css <a href="https://codemirror.net/5/mode/css/index.html" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1655132531656,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1655132531656,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"target":"NEW","attributes":[],"url":"https://codemirror.net/5/mode/css/index.html","_id":"00000181-5d96-d85d-a9d3-dfbf101a0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"CSS mode","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"_id":"00000181-5d96-d85d-a9d3-dfbf101a0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">CSS mode text/html <a href="https://codemirror.net/5/mode/xml/index.html" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1655132550868,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1655132550868,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"target":"NEW","attributes":[],"url":"https://codemirror.net/5/mode/xml/index.html","_id":"00000181-5d96-ddac-a59f-7fde55f40000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"XML mode","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"_id":"00000181-5d96-ddac-a59f-7fde55f30000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">XML mode text/htmlembedded <a href="https://codemirror.net/5/mode/htmlembedded/index.html" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1655132575439,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1655132575439,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"target":"NEW","attributes":[],"url":"https://codemirror.net/5/mode/htmlembedded/index.html","_id":"00000181-5d96-d85d-a9d3-dfbfab7e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"Html Embedded Scripts mode","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"_id":"00000181-5d96-d85d-a9d3-dfbfab7e0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">Html Embedded Scripts mode The following snippet includes an example of implementing this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUi.CodeType","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.CodeType(\"text/xml\") \n private String xmlText;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.CodeType(\"text/xml\") ","annotation":"Applies XML syntax highlighting to text in the field xmlText.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0a-d657-a7fd-7fbf70210000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0a-d657-a7fd-7fbf03c10000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d0a-d657-a7fd-7fbf03bb0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0a-dc6e-a17f-6d9e033f0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638212012500,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638212012500,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d0b-d029-adff-6f9b2fda0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d0b-dc6e-a17f-6d9f25170000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d0b-dc6e-a17f-6d9f25160000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.CodeType.png @ToolUi.CollectionItemProgress Applies to: Field Displays a progress bar for each item in an embedded list. You can use the progress bar to indicate a particular state of each item in the list, such as the number of times the item was viewed as a percentage of a goal. Applies to a field of type double inside a child model. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates Brightspot renders annotated field with progress bar and label. true (default), false Implementing progress bars requires two models: the child model containing the field with the progress bar, and a parent model containing the embedded child model. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Item progress bars—child model","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class HeadlineProgress extends Content {\n\n private String headline;\n\n @ToolUi.CollectionItemProgress \n private double progressBar;\n\n public void setProgressBar(double progressBar) {\n this.progressBar = progressBar;\n }\n\n @Override \n protected void beforeSave() {\n setProgressBar(0.5d);\n }\n\n}","annotations":[{"lineNumber":"8","codeSnippet":" @ToolUi.CollectionItemProgress ","annotation":"Displays a progress bar in the content edit form for the current object.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0c-d657-a7fd-7fbdb6df0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"15","codeSnippet":" @Override ","annotation":"Updates the value of the progress bar at the beforeSave event. In a typical scenario, you write a function that provides a descriptive state of the object as a percentage, such as number of views as a percent of a goal.","originalLineNumber":15,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0c-d029-adff-6f9dfa960000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0c-d657-a7fd-7fbd6a510000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d0c-d657-a7fd-7fbd6a4c0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0c-dc6e-a17f-6d9c69fe0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> headlines; \n\n}","annotations":[{"lineNumber":"7","codeSnippet":" @Embedded ","annotation":"Embeds the child model. This annotation is required to display progress bars.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0f-dc6e-a17f-6d9f0e790000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" private List headlines; ","annotation":"Declares a List of the child model.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d10-dc6e-a17f-6d9455da0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0e-dd18-a17d-ff2fb6d80000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d0e-dd18-a17d-ff2fb6d30000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d0e-d029-adff-6f9fb6950000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> At run time, when an editor saves the parent model, the child model’s callback beforeSave updates the percentages, and Brightspot displays the progress bar accordingly. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638212437288,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638212437288,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d11-dd18-a17d-ff318a9d0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d11-d657-a7fd-7fbd80ac0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d11-d657-a7fd-7fbd80ab0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.CollectionItemProgress.png See also: <a href="/dari-guide/latest/persistence-apis" data-cms-id="0000017d-768b-dc6e-a17f-779fa1750000" data-cms-href="/dari-guide/latest/persistence-apis" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638817025635,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638817025635,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-768b-dc6e-a17f-779fa1750000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"_id":"0000017d-911b-d657-a7fd-bbbf1a920000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":" Persistence APIs ","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-911b-d657-a7fd-bbbf1a820000","_type":"00000162-ab56-d787-af72-fb57299f0000"}"> Persistence APIs @ToolUi.CollectionItemToggle Applies to: Field Displays a toggle for each item in an embedded list. Applies to a field of type boolean inside a child model. Requires <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-collectionitemweight" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-collectionitemweight" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638898903406,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638898903406,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-collectionitemweight","_id":"0000017d-911b-dd18-a17d-9f3b68c90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.CollectionItemWeight","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-911b-dd18-a17d-9f3b68ba0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.CollectionItemWeight . The following table lists the elements available with this annotation. Element Description Valid Value value Indicates toggle appears with annotated field. true (default), false When false , the field’s weight is allocated to the other fields based on their weights. The following table shows the effect of toggling off Headline B in a weighting. Headline Toggle On Toggle Off A 10 20 B 50 0 C 40 80 Referring to the previous table, Headlines A and C have relative weights of 20% (10 ÷ 50) and 80% (40 ÷ 50). When Headline B is toggled off, its weight of 50 is allocated 10 points (0.2 × 50) to Headline A and 40 points (0.8 × 50) to Headline C. Developers can access these weights for their own implementations. For example, if three headlines have weights 20%, 50%, and 30%, you can write code to inject the different headlines into parent models 20%, 50%, and 30% of the time. Implementing item toggles requires two models: the child model containing the toggled field, and a parent model containing the embedded child model. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Item toggles—child model","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.dari.util.StorageItem;\n\npublic class VideoWithToggles extends Content {\n\n private String title;\n\n private StorageItem video;\n\n @ToolUi.CollectionItemWeight(calculated = false) \n private double weight;\n\n @ToolUi.CollectionItemToggle(value = false) \n private boolean onff;\n\n}","annotations":[{"lineNumber":"11","codeSnippet":" @ToolUi.CollectionItemWeight(calculated = false) ","annotation":"Displays a weight in the item bar for the current object.","originalLineNumber":11,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d13-dd18-a17d-ff3383be0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"14","codeSnippet":" @ToolUi.CollectionItemToggle(value = false) ","annotation":"Displays a toggle for the current object. You can use these toggles to preview the impact on percentage weights when deleting an item.","originalLineNumber":14,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d13-d029-adff-6f93b2d90000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d13-dc6e-a17f-6d973f280000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d13-dc6e-a17f-6d973f220000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d13-dd18-a17d-ff333ee00000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> videos; \n\n}","annotations":[{"lineNumber":"7","codeSnippet":" @Embedded ","annotation":"Embeds the child model. This annotation is required to display toggles.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d14-dd18-a17d-ff3548470000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" private List videos; ","annotation":"Declares the field videos as a List of the child model.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d14-d029-adff-6f9582b90000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d14-dd18-a17d-ff351cda0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d14-dd18-a17d-ff351cd40000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d14-d657-a7fd-7fbd1c470000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> At run time, when an editor toggles an item in the list, Brightspot computes the remaining items’ percentages accordingly. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638212704043,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638212704043,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d15-d657-a7fd-7fbda9750001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d15-d657-a7fd-7fbd9d5f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d15-d657-a7fd-7fbd9d5f0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">CollectionItemToggleOn.png <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638212738006,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638212738006,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d16-d657-a7fd-7fbf37c70001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d16-d029-adff-6f9725370001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d16-d029-adff-6f9725370000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">CollectionItemToggleOff.png @ToolUi.CollectionItemWeight Displays an item bar containing one weight for each item in an embedded list. Optionally displays handles on the item bar to adjust the relative weights of each item. Applies to a double field inside a child model. The following table lists the elements available with this annotation. Element Description Valid Value value Activates this annotation true (default), false calculated If true , handles do not appear on the item bar. If false or absent, handles appear on the item bar. true , false (default) Implementing item weights requires two models: the child model containing the weighted field, and a parent model containing the embedded child model. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Item weights—child model","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.ToolUi;\nimport com.psddev.dari.db.Record;\n\npublic class Headline extends Record {\n\n private String headline;\n\n @ToolUi.CollectionItemWeight(calculated = false) \n private double weight;\n\n}","annotations":[{"lineNumber":"8","codeSnippet":" @ToolUi.CollectionItemWeight(calculated = false) ","annotation":"Displays an item bar with handles.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d17-d029-adff-6f97af6a0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d17-d029-adff-6f974c5c0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d17-d029-adff-6f974c570000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d17-d657-a7fd-7fbf4c1a0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> headlines; \n\n}","annotations":[{"lineNumber":"7","codeSnippet":" @Embedded ","annotation":"Embeds the child model. This annotation is required to display weights.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d18-d657-a7fd-7fbd38cd0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" private List headlines; ","annotation":"Declares the field headlines as a List of the child model.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d18-d657-a7fd-7fbd59a40000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d17-d029-adff-6f97f52e0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d17-d029-adff-6f97f5290000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d17-dd18-a17d-ff37f4e90000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638212921192,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638212921192,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d18-d657-a7fd-7fbdff230001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d18-d657-a7fd-7fbddd100001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d18-d657-a7fd-7fbddd100000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.CollectionItemWeight.png @ToolUi.CollectionItemWeightColor Applies to: Field Assigns a single color to all weights inside an item bar. Without this annotation, Brightspot assigns colors to weights that optimize contrast as illustrated in "Item weights with handles and colors." Requires <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-collectionitemweight" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-collectionitemweight" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638898745374,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638898745374,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-collectionitemweight","_id":"0000017d-95fa-d029-adff-97fb052f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.CollectionItemWeight","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95fa-d029-adff-97fb052f0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.CollectionItemWeight . Applies to a String field inside a model that extends from Record . The following table lists the elements available with this annotation. Element Description Valid Value value Color applied to fields annotated with @ToolUi.CollectionItemWeight . String representation of a hexadecimal triplet. The following snippet includes an example of implementing this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"CollectionItemWeightColor","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.ToolUi;\nimport com.psddev.dari.db.Record;\n\npublic class Headline extends Record {\n\n @ToolUi.CollectionItemWeight(calculated = true)\n private double weight;\n\n @ToolUi.CollectionItemWeightColor \n private String weightColor = \"#007D7D\";\n\n}","annotations":[{"lineNumber":"9","codeSnippet":" @ToolUi.CollectionItemWeightColor ","annotation":"Sets the color for all weights to #007D7D (close to teal).","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1a-d657-a7fd-7fbf4ff70000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1a-d029-adff-6f9b19e40000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d1a-d029-adff-6f9b19df0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1a-d657-a7fd-7fbf199a0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638213036430,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638213036430,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d1a-dd18-a17d-ff3bd9d40000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d1a-d029-adff-6f9bc84b0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d1a-d029-adff-6f9bc84b0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.CollectionItemWeightColor.png @ToolUi.CollectionItemWeightMarker Applies to: Field Displays markers at specified points along a weight in an item bar. You can use the markers to indicate when certain events occur, such as when the visitor sees a cue for companion content during a video playback. Requires <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-collectionitemweight" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-collectionitemweight" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638898600664,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638898600664,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-collectionitemweight","_id":"0000017d-95f7-dd18-a17d-9ff7c6ca0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.CollectionItemWeight","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95f7-dd18-a17d-9ff7c6bb0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.CollectionItemWeight . Applies to a ">List field inside a child model. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates Brightspot applies weight markers to annotated field. true (default), false Implementing weight markers requires two models: the child model containing the marked field, and a parent model containing the embedded child model. Item weight markers—child model <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Item weight markers—child model","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.dari.util.StorageItem;\n\npublic class VideoWithMarkers extends Content {\n\n private String title;\n\n private StorageItem video;\n\n @ToolUi.CollectionItemWeightMarker \n private List markers;\n\n @ToolUi.CollectionItemWeight(calculated = true) \n private double weight;\n\n public List getMarkers() { \n if (markers == null) {\n markers = new ArrayList<>();\n }\n return markers;\n }\n\n @Override \n protected void beforeSave() {\n getMarkers().addAll(Arrays.asList(0.25d, 0.50d, 0.75d));\n }\n}","annotations":[{"lineNumber":"11","codeSnippet":" @ToolUi.CollectionItemWeightMarker ","annotation":"Indicates the List of markers appears as dots inside the item bar. Each element inside the List represents a decimal percentage from 0.0 to 1.0.","originalLineNumber":11,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1c-d029-adff-6f9de76a0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"14","codeSnippet":" @ToolUi.CollectionItemWeight(calculated = true) ","annotation":"Displays the weight for the current item in the item bar.","originalLineNumber":14,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1d-dc6e-a17f-6d9d14050000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"17","codeSnippet":" public List getMarkers() { ","annotation":"Provides a non-null getter for the list of markers.","originalLineNumber":17,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1d-d029-adff-6f9d611a0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"24","codeSnippet":" @Override ","annotation":"Adds markers at 25%, 50%, and 75% of the width of the item’s weight at the beforeSave event.","originalLineNumber":24,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1d-dd18-a17d-ff3d8e730000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1c-dc6e-a17f-6d9c81240000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d1c-dc6e-a17f-6d9c811f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d1c-dd18-a17d-ff3d80f40000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Item weight markers—parent model videos; \n\n}","annotations":[{"lineNumber":"7","codeSnippet":" @Embedded ","annotation":"Embeds the child model. This annotation is required to display markers.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d27-d029-adff-6fb76e180000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" private List videos; ","annotation":"Declares the field videos as a List of the child model declared in Item weight markers—child model. ","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d27-d029-adff-6fb78ae90000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d21-dd18-a17d-ff2104e90000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d21-dd18-a17d-ff2104e40000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d21-dc6e-a17f-6db504980000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> At run time, when an editor saves the parent model, the child model’s callback beforeSave updates the markers, and Brightspot displays the markers accordingly. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638213924263,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638213924263,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d28-d029-adff-6fb964350001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d28-d657-a7fd-7fbd54cd0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d28-d657-a7fd-7fbd54cd0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.CollectionItemWeightMarker.png In the previous image, the markers appear at 25%, 50%, and 75% of the width of each item’s weight. @ToolUi.ColorPicker Applies to: Field Renders a String field as a color picker. When a user selects a color from the color picker, Brightspot inserts the corresponding hexadecimal value into the field. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates Brightspot renders the annotated field as a color picker. true (default), false The following snippet includes an example of implementing this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiColorPicker","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.ColorPicker \n private String hexColor;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.ColorPicker ","annotation":"Renders the field hexColor as a color picker.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d2a-dd18-a17d-ff2b234d0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d29-d029-adff-6fb9f0690000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d29-d029-adff-6fb9f0630008","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d29-dc6e-a17f-6dbdf02c0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638214076088,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638214076088,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d2a-d657-a7fd-7fbf8dc60001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d2a-d657-a7fd-7fbf836e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d2a-d657-a7fd-7fbf836e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.ColorPicker.png @ToolUi.CompatibleTypes Applies to: Class Lists the models into which the annotated model can be transformed. The following table lists the elements available with this annotation. Element Description Valid Value value Content types into which the annotated class can be transformed. Array of superclasses from which the annotated class is derived. The following snippet includes an example of implementing this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiCompatibleTypes","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.CompatibleTypes({LongArticle.class,ReallyLongArticle.class}) \npublic class Article extends Content {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.CompatibleTypes({LongArticle.class,ReallyLongArticle.class}) ","annotation":"Indicates that Article models can be transformed to LongArticle and ReallyLongArticle models.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d2f-dd18-a17d-ff2f0ed40000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d2e-dd18-a17d-ff2fd32b0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d2e-dd18-a17d-ff2fd3260000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d2e-d029-adff-6fbfd2e80000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.CssClass Applies to: Field, Class Renders objects on the content edit form using the provided CSS class. When applied to a field, Brightspot renders the field using the provided CSS class; when applied to a class, Brightspot renders the class’s entire content edit form using the provided CSS class. The following table lists the elements available with this annotation. Element Description Valid Value value CSS class with which annotated class or field is rendered. String representing a CSS class. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiCssClass","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.CssClass(\"text-green\") \n private String headline;\n\n private String subHeadline; \n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.CssClass(\"text-green\") ","annotation":"Renders the field headline in the content edit form using the CSS class text-green.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d37-dd18-a17d-ff37a78f0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":" private String subHeadline; ","annotation":"Renders the field subHeadline in the content edit form using the default styling.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d37-dc6e-a17f-6db7cb340000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d37-dd18-a17d-ff3735880000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d37-dd18-a17d-ff3735820000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d37-d657-a7fd-7fbf35580000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638214980990,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638214980990,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d38-d657-a7fd-7fbd76670001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d38-d029-adff-6fb96ba00001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d38-d029-adff-6fb96ba00000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.CssClass.png Other supported CSS Class Values: Is-minimal can be used to fit as many inputs into a single line as there is space available Is-half can be used to place two fields side by side in a row, with each occupying half of the width Is-third can be used to place three fields side by side in a row, with each occupying a third of the row’s width Is-quarter can be used to place four fields side by side in a row, with each occupying a quarter of the row’s width @ToolUi.DefaultSearchResult Applies to: Field Displays the field in search results when filtering on the current model. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates annotated field appears in search results. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"TooUiDefaultSearchResult","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.DefaultSearchResult \n private Author author;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.DefaultSearchResult ","annotation":"Ensures that when an editor filters search results by Article , the results include a column for author .","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d3a-dc6e-a17f-6dbe00540000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d39-dc6e-a17f-6dbd943a0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d39-dc6e-a17f-6dbd94350000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d39-dd18-a17d-ff3993720000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638215111008,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638215111008,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d3a-d657-a7fd-7fbf7d290001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d3a-dd18-a17d-ff3b713c0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d3a-dd18-a17d-ff3b713c0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.DefaultSearchResult.svg @ToolUi.DefaultSortField Applies to: Class Sets the field by which search results are initially sorted when filtering on the current model. Requires the field have the <a href="/brightspot-developer-documentation/latest/data-modeling-annotations#recordable-indexed" data-cms-id="0000017d-726b-d029-adff-77fb698c0000" data-cms-href="/brightspot-developer-documentation/latest/data-modeling-annotations" anchor="recordable-indexed" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638896095975,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638896095975,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-726b-d029-adff-77fb698c0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"recordable-indexed","_id":"0000017d-95d1-d657-a7fd-bffd8b260000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@Indexed","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95d1-d657-a7fd-bffd8b250000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@Indexed annotation. For example, when an editor filters search results by Article , you can set the initial sort field for the results to author . The following table lists the elements available with this annotation. Element Description Valid Value value Sort field by which search results are displayed. String representing one of the model’s fields. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUIDefaultSearchResult","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.DefaultSortField(\"author\") \npublic class Article extends Content {\n\n @Indexed \n private String author;\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.DefaultSortField(\"author\") ","annotation":"Indicates that when users filter on Articles in the search panel, the initial sort is by the author field.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d3c-dd18-a17d-ff3d2ff50000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"7","codeSnippet":" @Indexed ","annotation":"Indexes the author field. This annotation is required to sort the field.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d3c-d657-a7fd-7fbd55990000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d3b-d029-adff-6fbbd93d0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d3b-d029-adff-6fbbd9380000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d3b-d657-a7fd-7fbfd90e0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1709132132769,"cms.content.publishUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1709132132769,"cms.content.updateUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018d-cc17-d90b-abbf-ecffdd7e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d3e-dc6e-a17f-6dbe24b50000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017d-6d3e-dc6e-a17f-6dbe24b40000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUIDefaultSortField.png @ToolUi.DisplayAfter Applies to: Field By default, Brightspot displays fields in the content edit form in the order they appear in your model. This annotation overrides that sequence, and specifies the order of fields after which the annotated field appears. See also <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-fielddisplayorder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-fielddisplayorder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638895991266,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638895991266,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-fielddisplayorder","_id":"0000017d-95cf-dd18-a17d-9fefd4c40000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.FieldDisplayOrder","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95cf-dd18-a17d-9fefd4b50000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.FieldDisplayOrder . The following table lists the elements available with this annotation. Element Description Valid Value value Fields after which annotated field appears. Array of strings representing one or more of the model’s other fields. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiDisplayAfter","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n private String headline;\n private String body;\n\n @ToolUi.DisplayAfter({\"lastName\",\"body\"})\n private String firstName;\n\n private String lastName;\n private String middleName;\n\n}","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d41-dd18-a17d-ff6155da0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d41-dd18-a17d-ff6155d50000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d41-d029-adff-6fd1559b0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> In the previous snippet, the default order of fields in the content edit form is headline , body , firstName , lastName , and middleName . The annotation @ToolUi.DisplayAfter overrides that order, and places the fields lastName and body (in that order) after firstName . <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638215596093,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638215596093,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d41-d657-a7fd-7ffdd9ce0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d41-dc6e-a17f-6dd5cf410001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d41-dc6e-a17f-6dd5cf410000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.DisplayAfter.png @ToolUi.DisplayBefore Applies to: Field By default, Brightspot displays fields in the content edit form in the order they appear in your model. This annotation overrides that sequence, and specifies the order of fields before the annotated field. See also <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-fielddisplayorder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-fielddisplayorder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638895902942,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638895902942,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-fielddisplayorder","_id":"0000017d-95ce-dd18-a17d-9fef954f0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.FieldDisplayOrder","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95ce-dd18-a17d-9fef95400000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.FieldDisplayOrder . The following table lists the elements available with this annotation. Element Description Valid Value value Fields appearing before the annotated field. Array of strings representing one or more of the model’s other fields. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiDisplayBefore","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.dari.util.StorageItem;\n\npublic class Article extends Content {\n\n private String headline;\n private String body;\n\n @ToolUi.DisplayBefore({\"body\",\"lastName\"})\n private String firstName;\n\n private String lastName;\n private String middleName;\n\n private StorageItem image;\n\n}","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d4f-d657-a7fd-7fff54280000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d4f-d657-a7fd-7fff54230000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d4f-d029-adff-6fdf53e20000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> In the previous snippet, the default order of fields in the content edit form is headline , body , firstName , lastName , and middleName . The annotation @ToolUi.DisplayBefore overrides that order, and places firstName before the fields body and lastName (in that order). <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638216514482,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638216514482,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d4f-dd18-a17d-ff6fe12e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d4f-dd18-a17d-ff6fd5d90001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d4f-dd18-a17d-ff6fd5d90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.DisplayBefore.png @ToolUi.DisplayFirst Applies to: Field By default, Brightspot displays fields in the content edit form in the order they appear in your model. This annotation overrides that sequence, and specifies which field appears first. If more than one field has the @ToolUi.DisplayFirst annotation, Brightspot orders them by occurrence, placing the first annotated field at the top of the form, followed by the second annotated field, and so on. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates annotated field appears first in content edit form. true (default), false See also <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-fielddisplayorder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-fielddisplayorder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638895837773,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638895837773,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-fielddisplayorder","_id":"0000017d-95cd-d029-adff-97dd99730000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.FieldDisplayOrder","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95cd-d029-adff-97dd99640000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.FieldDisplayOrder . The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiDisplayFirst","internalName":"ToolUi","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n private String headline;\n\n private String body;\n\n @ToolUi.DisplayFirst\n private String author;\n\n}","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d51-dd18-a17d-ff71260f0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d51-dd18-a17d-ff7126090000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d51-d029-adff-6fd125c20000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> In the previous snippet, the default order of fields in the content edit form is headline , body , and author . The annotation @ToolUi.DisplayFirst overrides that order, and places the author field first. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638216640871,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638216640871,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d51-d029-adff-6fd1e1080001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d51-d657-a7fd-7ffdd6ef0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d51-d657-a7fd-7ffdd6ef0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.DisplayFirst.png @ToolUi.DisplayGlobalFilters Applies to: Class Provides filtering controls for other models with the <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-globalfilter" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-globalfilter" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638895690275,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638895690275,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-globalfilter","_id":"0000017d-95cb-dc6e-a17f-95df545a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.GlobalFilter","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95cb-dc6e-a17f-95df544a0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.GlobalFilter annotation when filtering on this model. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates filtering controls for other models appear when filtering on annotated class. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiDisplayGlobalFilters","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.DisplayGlobalFilters \npublic class Author extends Content {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.DisplayGlobalFilters ","annotation":"Specifies that when an editor filters on Authors , a control appears for filtering on any other model with the @ToolUi.GlobalFilter annotation.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d53-d657-a7fd-7fff962c0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d53-dc6e-a17f-6dd73efb0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d53-dc6e-a17f-6dd73ef50000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d53-dd18-a17d-ff733eb60000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> The following snippet illustrates this annotation’s effect when used with @ToolUi.GlobalFilter . <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiDisplayGlobalFilter","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.GlobalFilter \npublic class Article extends Content {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.GlobalFilter ","annotation":"Specifies that a control for filtering on Articles appears when editors filter on Authors (or on All Content Types ).","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d54-d029-adff-6fd52d080000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d53-dc6e-a17f-6dd7f2150000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d53-dc6e-a17f-6dd7f20f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d53-d657-a7fd-7ffff1c80000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638216859796,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638216859796,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d55-dd18-a17d-ff751c400001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d55-d029-adff-6fd514e00001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d55-d029-adff-6fd514e00000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.DisplayGlobalFilters.svg Clicking on the filter displays a list of items with the same type as in the filter. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638216899526,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638216899526,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d55-d657-a7fd-7ffdc6f90001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d55-d657-a7fd-7ffdaab00001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d55-d657-a7fd-7ffdaab00000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.DisplayGlobalFilters - Article.svg @ToolUi.DisplayGrid Applies to: Field Specifies that the field appears as a grid in the content edit form. Applies to Set and List fields. In the absence of this annotation, the field’s members appear vertically. If the field is a subclass of a model with a <a href="/brightspot-developer-documentation/latest/data-modeling-annotations#recordable-previewfield" data-cms-id="0000017d-726b-d029-adff-77fb698c0000" data-cms-href="/brightspot-developer-documentation/latest/data-modeling-annotations" anchor="recordable-previewfield" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638895598010,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638895598010,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-726b-d029-adff-77fb698c0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"recordable-previewfield","_id":"0000017d-95c9-dc6e-a17f-95dde69a0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@Recordable.PreviewField","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95c9-dc6e-a17f-95dde69a0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@Recordable.PreviewField annotation, the field specified in that class annotation also appears in the grid. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates annotated field appears as a grid. true (default), false The following snippet includes an example of applying this annotation. slides;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.DisplayGrid ","annotation":"Specifies that the files in a slides field are laid out as a grid in the content edit form.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d57-d029-adff-6fd72d9e0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d57-d029-adff-6fd701c40000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d57-d029-adff-6fd701bf0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d57-dc6e-a17f-6dd701830000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1709132379975,"cms.content.publishUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1709132379975,"cms.content.updateUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018d-f038-ddaa-adad-fdbf7f9f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d57-d657-a7fd-7fff9ba30001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017d-6d57-d657-a7fd-7fff9ba30000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUI.DisplayGrid.png @ToolUi.DisplayLast Applies to: Field By default, Brightspot displays fields in the content edit form in the order they appear in your model. This annotation overrides that sequence, and specifies which field appears last. If more than one field has the @ToolUi.DisplayLast annotation, Brightspot orders them by occurrence, placing the first annotated field at the end of the form, followed by the second annotated field, and so on. See also <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-fielddisplayorder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-fielddisplayorder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638895459925,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638895459925,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-fielddisplayorder","_id":"0000017d-95c7-d029-adff-97d7c22b0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.FieldDisplayOrder","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95c7-d029-adff-97d7c21c0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.FieldDisplayOrder . The following table lists the elements available with this annotation. Element Description Valid Value value Indicates annotated field appears last in content edit form. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiDisplayLast","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.DisplayLast\n private String author;\n\n private String headline;\n\n private String body;\n\n}","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d58-d029-adff-6fd9e4f10000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d58-d029-adff-6fd9e4ec0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d58-dc6e-a17f-6ddce4b40001","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> In the previous snippet, the default order of fields in the content edit form is author , headline , and body . The annotation @ToolUi.DisplayLast overrides that order, and places the author field last. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638217135553,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638217135553,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d59-d657-a7fd-7ffd76340001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d59-dd18-a17d-ff796ae20001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d59-dd18-a17d-ff796ae20000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">TooUi.DisplayLast.png @ToolUi.DropDown Applies to: Field Renders the field’s options as a drop-down list instead of a selection widget. If a model’s field is another referenced model, Brightspot renders the field similar to an HTML "> . When users open the control, by default Brightspot displays the available objects in a content picker. If this annotation is present, Brightspot instead displays the available objects as a traditional list of options. The following table lists the elements available with this annotation. Element Description Valid Value value If true , control rendered as traditional drop-down list. true (default), false sortField Field by which drop-down options are sorted. Any field name in the model. sortDescending If true , options sorted in descending order. true , false (default) The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"DropDown","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.DropDown(value=true,sortField=\"lastName\") \n private Author author;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.DropDown(value=true,sortField=\"lastName\") ","annotation":"Renders the Author field as a traditional drop-down list.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7be4-dd18-a17d-ffe51ca80000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7be3-d657-a7fd-7bffd3ac0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7be3-d657-a7fd-7bffd3a70000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7be3-d029-adff-7ff3d37c0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1709131865582,"cms.content.publishUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1709131865582,"cms.content.updateUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018d-a85d-d381-afff-ecfde4a90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000018d-a861-d40d-ad8f-bae3b75f0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000018d-a861-d40d-ad8f-bae3b75f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolsUI.Dropdown.png @ToolUi.EmbeddedContentCreatorClass Applies to: Field, Method Specifies the class to use for rendering a picker of style variations. The following table lists the elements available with this annotation. Element Description Valid Value value Class used to render a style picker. Any class that implements EmbeddedContentCreator . The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiEmbeddedContentCreatorClass","code":{"codeType":"JAVA","code":"import brightspot.core.lead.Lead;\nimport com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.theme.StyleEmbeddedContentCreator;\n\npublic class AnotherArticle extends Content {\n\n @ToolUi.EmbeddedContentCreatorClass(StyleEmbeddedContentCreator.class) \n private Lead lead;\n\n}","annotations":[{"lineNumber":"8","codeSnippet":" @ToolUi.EmbeddedContentCreatorClass(StyleEmbeddedContentCreator.class) ","annotation":"Renders a style picker for the field lead .","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5c-dc6e-a17f-6ddc6fc00000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5c-dc6e-a17f-6ddc0ee00000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d5c-dc6e-a17f-6ddc0eda0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5c-d657-a7fd-7ffd0e8b0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638217360665,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638217360665,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d5c-dc6e-a17f-6ddcd21b0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d5c-d657-a7fd-7ffdc6130000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d5c-d657-a7fd-7ffdc6120000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.EmbeddedContentCreatorClass.png @ToolUi.ExcludeFromGlobalSearch Applies to: Class Excludes or includes indexed instances of the annotated content type from results in the search panel. Used with the annotation <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#content-searchable" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="content-searchable" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638894902818,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638894902818,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"content-searchable","_id":"0000017d-95bf-dd18-a17d-9fbf63f90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@Content.Searchable","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95bf-dd18-a17d-9fbf63e90000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@Content.Searchable . The following table lists the elements available with this annotation. Element Description Valid Value value If true or absent, Brightspot excludes instances of this content type from search results. If false , Brightspot includes instances of this content type in search results. true (default), false This annotation is inherited, so models extending from an annotated model have the same setting for @ToolUi.ExcludeFromGlobalSearch . The following snippets include examples of applying this annotation. Class excluded from search panel <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiExcludeFromGlobalSearch","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.ToolUi;\n\n@Content.Searchable \n@ToolUi.ExcludeFromGlobalSearch \npublic class Article extends Content {\n\n}","annotations":[{"lineNumber":"3","codeSnippet":"@Content.Searchable ","annotation":"Ensures Solr indexes instances of Article .","originalLineNumber":3,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5e-dc6e-a17f-6ddeab790000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"4","codeSnippet":"@ToolUi.ExcludeFromGlobalSearch ","annotation":"Excludes instances of Article from the results in the search panel.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5e-d657-a7fd-7fffd22f0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5e-dd18-a17d-ff7f6bb10000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d5e-dd18-a17d-ff7f6bac0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5e-d029-adff-6fdf6b510000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiExcludeFromGlobalSearch2","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.ToolUi;\nimport content.article\n\n@Content.ExcludeFromGlobalSearch(false) \npublic class Recipe extends Article { \n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@Content.ExcludeFromGlobalSearch(false) ","annotation":"Sets @ToolUi.ExcludeFromGlobalSearch to false , reversing the effect of the inherited annotation and including instances of Recipe in the search results.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5f-d657-a7fd-7fff5eb40000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"5","codeSnippet":"public class Recipe extends Article { ","annotation":"Specifies that Recipe extends from Article (the class declared in the snippet Class excluded from search panel ). Therefore, Solr indexes instances of Recipe objects but excludes them from results in the search panel.","originalLineNumber":5,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5f-dd18-a17d-ff7f9c8e0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5f-d657-a7fd-7fff1cbd0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d5f-d657-a7fd-7fff1cb70000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d5f-d029-adff-6fdf1c6a0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.Expanded Applies to: Field Ensures the child form containing the annotated field is never collapsed in the parent content edit form. This annotation applies to fields with the following characteristics: Field is of type Collection . <a href="/brightspot-developer-documentation/latest/data-modeling-annotations#recordable-embedded" data-cms-id="0000017d-726b-d029-adff-77fb698c0000" data-cms-href="/brightspot-developer-documentation/latest/data-modeling-annotations" anchor="recordable-embedded" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638894690227,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638894690227,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-726b-d029-adff-77fb698c0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"recordable-embedded","_id":"0000017d-95bc-d029-adff-97bd14c90001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@Embedded","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95bc-d029-adff-97bd14c90000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@Embedded annotation is applied to one of the following: The annotated field The child model The following table lists the elements available with this annotation. Element Description Valid Value value Indicates annotated field is always visible in content edit form. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiExpanded","code":{"codeType":"JAVA","code":"package content.article;\n\nimport com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Author extends Content { \n\n private String lastName;\n\n private String firstName;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":"public class Author extends Content { ","annotation":"Declares a child model Author with two fields: lastName and firstName .","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d75-dc6e-a17f-6df570cd0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d75-d657-a7fd-7ffd28e20000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d75-d657-a7fd-7ffd28dc0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d75-dc6e-a17f-6df528830000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> The following snippet illustrates applying this annotation to the child model. authors; \n\n}","annotations":[{"lineNumber":"4","codeSnippet":"public class Article extends Content { ","annotation":"Declares a parent model Article that contains the child model Author .","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d76-d029-adff-6ff720780000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"6","codeSnippet":" @Embedded ","annotation":"Embeds the child model.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d76-d657-a7fd-7fff6eb30000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"7","codeSnippet":" @ToolUi.Expanded ","annotation":"Ensures the form for entering an author is always expanded.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d76-dc6e-a17f-6df68a730000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" private List authors; ","annotation":"Declares a field subclassed from Collection&lt;record&gt; .","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d76-dd18-a17d-ff77c1e80000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d75-dd18-a17d-ff75da900000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d75-dd18-a17d-ff75da8b0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d75-d657-a7fd-7ffdda4d0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638219091037,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638219091037,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d77-dc6e-a17f-6df7417f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d77-d029-adff-6ff7389e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d77-d029-adff-6ff7389d0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.Expanded.png In the previous image, the two forms containing the embedded field Author are always expanded in the content edit form. @ToolUi.ExternalItemSortClass Applies to: Class Specifies the enum to use for rendering sort options for items retrieved from federated searches in the search panel. The following table lists the elements available with this annotation. Element Description Valid Value value Enum used to render sort options. Any enum that implements ExternalItemSort . Implementing this annotation requires the following steps. Step 1: Identify native sort options Review the external source’s API documentation for the available sort options, and determine the corresponding labels you want to use in the search panel. For example, the following table lists the available sort options from Getty Images and recommended labels in Brightspot. Getty native Brightspot label best_match Best Match most_popular Most Popular newest Newest random Random Step 2: Declare enum with sort options Enum for sorting external items <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Enum for sorting external items","internalName":"Enum for sorting exter","code":{"codeType":"JAVA","code":"import com.psddev.cms.tool.ExternalItemSort;\nimport com.psddev.dari.db.Query;\nimport com.psddev.dari.util.StringUtils;\n\npublic enum ProviderSort implements ExternalItemSort {\n\n BEST_MATCH, \n MOST_POPULAR,\n NEWEST,\n RANDOM;\n\n @Override \n public String getOperator() {\n return name();\n }\n\n @Override \n public String toString() {\n return StringUtils.toLabel(name());\n }\n\n @Override \n public void sort(Query query) {\n /* Optional custom sort function. */\n }\n\n}","annotations":[{"lineNumber":"7","codeSnippet":" BEST_MATCH, ","annotation":"Declares sort options.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d78-d029-adff-6ff9d6f20000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"12","codeSnippet":" @Override ","annotation":"Implements the method getOperator . Brightspot places the result of this method in the data-value attribute of an element.","originalLineNumber":12,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d78-dc6e-a17f-6dfcfd4c0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"17","codeSnippet":" @Override ","annotation":"Overrides the Object.toString method. Brightspot places the result of this method as the value of a tag. This example uses Dari’s StringUtils#toLabel method; see <a href=\"https://artifactory.psdops.com/psddev-releases/com/psddev/dari-util/4.2.14428-xf228ff/dari-util-4.2.14428-xf228ff-javadoc.jar!/com/psddev/dari/util/StringUtils.html\" target=\"_blank\" link-data=\"{&quot;cms.site.owner&quot;:{&quot;_ref&quot;:&quot;0000017a-a154-d39c-a7ff-aff6dcf90000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30006&quot;},&quot;cms.content.publishDate&quot;:1638894590927,&quot;cms.content.publishUser&quot;:{&quot;_ref&quot;:&quot;00000165-6c20-dfe9-abef-edbd9fd90000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30018&quot;},&quot;cms.content.updateDate&quot;:1638894590927,&quot;cms.content.updateUser&quot;:{&quot;_ref&quot;:&quot;00000165-6c20-dfe9-abef-edbd9fd90000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ee30018&quot;},&quot;rekognitionVideo.timeFrameMetadata&quot;:[],&quot;link&quot;:{&quot;target&quot;:&quot;NEW&quot;,&quot;attributes&quot;:[],&quot;url&quot;:&quot;https://artifactory.psdops.com/psddev-releases/com/psddev/dari-util/4.2.14428-xf228ff/dari-util-4.2.14428-xf228ff-javadoc.jar!/com/psddev/dari/util/StringUtils.html&quot;,&quot;rekognitionVideo.timeFrameMetadata&quot;:[],&quot;_id&quot;:&quot;0000017d-95ba-dc6e-a17f-95bec35f0000&quot;,&quot;_type&quot;:&quot;0000015d-56b9-d2db-a5dd-f6fd6ed00010&quot;},&quot;linkText&quot;:&quot;StringUtils&quot;,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle&quot;:null,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template&quot;:null,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment&quot;:null,&quot;theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template&quot;:null,&quot;_id&quot;:&quot;0000017d-95ba-dc6e-a17f-95bec3500000&quot;,&quot;_type&quot;:&quot;00000162-ab56-d787-af72-fb57299f0000&quot;}\">StringUtils for other available string manipulation methods.","originalLineNumber":17,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d79-dc6e-a17f-6dfd2c6a0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"22","codeSnippet":" @Override ","annotation":"Optionally overrides the sorting of the sort options. The default sorting is by the results of the method getOperator.","originalLineNumber":22,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d79-dc6e-a17f-6dfdc83b0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d78-d029-adff-6ff986f30000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d78-d029-adff-6ff986ee0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d78-dc6e-a17f-6dfc86b50000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Step 3: Apply enum with annotation <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Apply enum with annotatiojn","code":{"codeType":"JAVA","code":"package article;\n\nimport com.psddev.cms.db.ExternalItem;\nimport com.psddev.cms.db.ToolUi;\nimport com.psddev.dari.db.Recordable;\nimport com.psddev.id.SomeDatabaseProvider;\n\n@Recordable.SourceDatabaseProviderClass(SomeDatabaseProvider.class) \n@ToolUi.ExternalItemSortClass(ProviderSort.class) \npublic class SomeImageProvider extends ExternalItem {\n\n}","annotations":[{"lineNumber":"8","codeSnippet":"@Recordable.SourceDatabaseProviderClass(SomeDatabaseProvider.class) ","annotation":"Specifies the class providing the connection to the external provider.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d7a-d657-a7fd-7fff669b0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":"@ToolUi.ExternalItemSortClass(ProviderSort.class) ","annotation":"Applies the sorted labels using the enum defined in the snippet \"Enum for sorting external items.\"","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d7a-dc6e-a17f-6dfe9ee60000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d7a-d657-a7fd-7fff2da00000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d7a-d657-a7fd-7fff2d9b0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d7a-dd18-a17d-ff7b2d560000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> The following image illustrates how Brightspot renders the sort labels. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638219386821,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638219386821,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d7b-d029-adff-6ffbad5e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d7b-dc6e-a17f-6dffa2ef0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d7b-dc6e-a17f-6dffa2ef0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.ExternalItemSortClass.png See also: <a href="/brightspot-developer-documentation/latest/external-types" data-cms-id="0000017d-722c-d657-a7fd-7bbd1d620000" data-cms-href="/brightspot-developer-documentation/latest/external-types" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638894644506,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638894644506,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-722c-d657-a7fd-7bbd1d620000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"_id":"0000017d-95bb-dd18-a17d-9fbb7b3e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"External types","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95bb-dd18-a17d-9fbb7b2e0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">External types @ToolUi.FieldDisplayOrder Applies to: Class Indicates the order in which fields appear in the content edit form. Overrides <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-displaylast" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-displaylast" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638894144472,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638894144472,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-displaylast","_id":"0000017d-95b3-d657-a7fd-bfbfb3f30000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.DisplayLast","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95b3-d657-a7fd-bfbfb3e40000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.DisplayLast . Fields not appearing in this annotation appear in the order as in the model or as otherwise annotated. The following table lists the elements available with this annotation. Element Description Valid Value value Order by which fields appear in the content edit form. Array of strings representing the model’s fields. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"Example","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.FieldDisplayOrder({\"author\", \"headline\", \"body\"}) \npublic class Article extends Content {\n\n private String headline;\n\n private String body;\n\n private String author;\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.FieldDisplayOrder({\"author\", \"headline\", \"body\"}) ","annotation":"Specifies that the first three fields in the content edit form are author , headline , and body (in that order).","rekognitionVideo.timeFrameMetadata":[],"originalLineNumber":4,"_id":"0000017d-76d2-d657-a7fd-7fffe4530000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-76d2-dd18-a17d-fff3824e0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-76d2-dd18-a17d-fff382490000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-76d2-d029-adff-77d3820b0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638376118119,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638376118119,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d7d-d657-a7fd-7ffdfdfc0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-76d3-dc6e-a17f-77d73c5a0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-76d3-dc6e-a17f-77d73c5a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.FieldDisplayOrder.png @ToolUi.FieldDisplayPreview Applies to: Class Indicates which fields appear in an asset's Quick View widget. The following table lists the elements available with this annotation. Element Description Valid Value value Fields appearing in an asset's Quick View widget. Array of strings representing the model’s fields. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.hideLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollable":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollableLinesVisible":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._preset":null,"title":"Example","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.FieldDisplayPreview({\"headline\"})\npublic class Article extends Content {\n\n private String headline;\n\n private String subHeadline;\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.FieldDisplayPreview({\"headline\"})","annotation":"Specifies that the field headline appears in the Quick View widget for objects of type Article .","originalLineNumber":4,"_id":"00000190-b6a1-da55-a3f2-bea5ed7b0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"_id":"0000017d-76d2-dd18-a17d-fff3824e0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"_id":"0000017d-76d2-dd18-a17d-fff382490000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"_id":"0000017d-76d2-d029-adff-77d3820b0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}" data-rte-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1721052155130,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1721052155130,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"codeBlock":{"codeBlock":{"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.hideLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollable":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollableLinesVisible":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._preset":null,"title":"Example","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.FieldDisplayPreview({\"headline\"})\npublic class Article extends Content {\n\n private String headline;\n\n private String subHeadline;\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.FieldDisplayPreview({\"headline\"})","annotation":"Specifies that the field headline appears in the Quick View widget for objects of type Article .","originalLineNumber":4,"_id":"00000190-b6a1-da55-a3f2-bea5ed7b0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"_id":"0000017d-76d2-dd18-a17d-fff3824e0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"_id":"0000017d-76d2-dd18-a17d-fff382490000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"_id":"0000017d-76d2-d029-adff-77d3820b0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"00000190-b6a1-da55-a3f2-bea59c800000","_type":"bc197941-6969-3a80-8658-e03060c646aa"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1721052046051,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1721052046051,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"00000190-b6af-da55-a3f2-beaff8260000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-76d3-dc6e-a17f-77d73c5a0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017d-76d3-dc6e-a17f-77d73c5a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.FieldDisplayPreview Referring to the previous illustration, the Quick View widget includes the article's headline field but not the subheadline field, as indicated in the annotation @ToolUi.FieldDisplayPreview . @ToolUi.FieldDisplayType Applies to: Field Overrides the field’s default rendering with that of another type. You can use this annotation to perform pre-processing on the field before committing it to the database. The following table lists the elements available with this annotation. Element Description Valid Value value Data type by which annotated field is rendered. One of the following strings: "boolean" "date" "file" "layout" "locale" "location" "map" "metric" "number" "password" "permissions" "record" "region" "text" "timeZone" "toolUserSavedSearches" "workflowActions" The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiFieldDisplayType","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Author extends Content {\n\n @ToolUi.FieldDisplayType(\"password\") \n private String yourPassword;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.FieldDisplayType(\"password\") ","annotation":"Renders the String field as a password changer.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d7f-dd18-a17d-ff7f52e10000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d7e-dd18-a17d-ff7ff0730000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d7e-dd18-a17d-ff7ff06e0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d7e-d657-a7fd-7ffff02e0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638219677551,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638219677551,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d80-dd18-a17d-ffa116100001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d80-dd18-a17d-ffa1720f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d80-dd18-a17d-ffa1720f0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.FieldDisplayType.png @ToolUi.FieldSorted Applies to: Field Freezes the order in which entries in a Set field appear. Without this annotation, Brightspot displays the entries in a random order. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates members of annotated field appear in a fixed sort order. true (default), false The following snippet includes an example of applying this annotation. authors;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.FieldSorted ","annotation":"Specifies that when displaying an Article in the content edit form, the order of listed authors does not change.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d81-d657-a7fd-7fbd2c850000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d80-d029-adff-6f91ec540000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d80-d029-adff-6f91ec4f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d80-dc6e-a17f-6d94ec0c0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638219785747,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638219785747,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d81-d657-a7fd-7fbde4ac0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d81-d657-a7fd-7fbdd50a0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d81-d657-a7fd-7fbdd50a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.FieldSorted.png The previous illustration indicates that when displaying authors, the order of appearance is Christie, Picoult, and Twain—even if the editor originally selected the authors in a different order. @ToolUi.Filterable Applies to: Field Displays in the search panel a filtering option for this field when filtering on the field’s model. Requires the <a href="/brightspot-developer-documentation/latest/data-modeling-annotations#recordable-indexed" data-cms-id="0000017d-726b-d029-adff-77fb698c0000" data-cms-href="/brightspot-developer-documentation/latest/data-modeling-annotations" anchor="recordable-indexed" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638893869985,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638893869985,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-726b-d029-adff-77fb698c0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"recordable-indexed","_id":"0000017d-95af-dc6e-a17f-95bf899d0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@Indexed","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95af-dc6e-a17f-95bf899d0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@Indexed annotation. Without this annotation, non-string fields with the @Indexed annotation appear as a filter in the search panel. You can show or hide the filter with this annotation. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates if filtering is available on this field. true (default), false Use true to show the filter for string fields with the @Indexed annotation. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiFilterable","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Author extends Content {\n\n @ToolUi.Filterable\n @Indexed\n private String headline;\n\n @Indexed\n private String body;\n\n @Indexed\n private Author author;\n\n @ToolUi.Filterable(false)\n @Indexed\n private Image image;\n\n}","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d83-d029-adff-6f9359590000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d83-d029-adff-6f9359540000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d83-d657-a7fd-7fbf59140000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> The following table describes the annotations in the previous snippet. <table class="informaltable frame-box rules-all" style="box-sizing: border-box; border-collapse: collapse; border-spacing: 0px; background-color: rgb(255, 255, 255); border: 1px solid rgb(204, 204, 204); color: rgb(85, 85, 85); font-family: "Noto Sans", sans-serif; font-size: 18px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial;"> Field Default Behavior Annotated Behavior headline Because headline is a string, Brightspot does not display a filter control in the search panel for this field when the primary filter is Article . With the annotation @ToolUi.Filterable , Brightspot overrides the default behavior and displays a filter control in the search panel for this field when the primary filter is Article . body Because body is a string, Brightspot does not display a filter control in the search panel for this field when the primary filter is Article . N/A author Because author is not a string and is annotated with @Indexed , Brightspot displays a filter control for this field in the search panel when the primary filter is Article . N/A image Because image is not a string and is annotated with @Indexed , Brightspot displays a filter control for this field in the search panel when the primary filter is Article . With the annotation @ToolUi.Filterable(false) , Brightspot overrides the default behavior and suppresses a filter control in the search panel for this field when the primary filter is Article . <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638219944964,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638219944964,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d84-d657-a7fd-7fbd39f50001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d84-dc6e-a17f-6d942b680001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d84-dc6e-a17f-6d942b680000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.Filterable.svg @ToolUi.GlobalFilter Applies to: Class Provides an additional control for filtering on the annotated model when filtering by All Content Types in the search panel. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates filtering control is available for annotated model when filtering by All Content Types. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiGlobalFilter","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.GlobalFilter \npublic class Article extends Content {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.GlobalFilter ","annotation":"Displays a control for filtering by Articles when an editor is filtering search results by All Content Types .","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d85-d029-adff-6f95f5470000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d85-dc6e-a17f-6d95661d0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d85-dc6e-a17f-6d9566180000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d85-d029-adff-6f9565cb0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638220074298,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638220074298,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d86-dc6e-a17f-6d9645030001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d86-dc6e-a17f-6d9638020001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d86-dc6e-a17f-6d9638020000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.GlobalFilter.svg You can also have the control appear when filtering on specific models; for details, see <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-displayglobalfilters" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-displayglobalfilters" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638893830788,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638893830788,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-displayglobalfilters","_id":"0000017d-95af-d029-adff-97bf07a70000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.DisplayGlobalFilters","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95af-d029-adff-97bf07980000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.DisplayGlobalFilters . @ToolUi.Heading Deprecated. Use <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#toolui-cluster" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="toolui-cluster" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638893744594,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638893744594,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-cluster","_id":"0000017d-95ad-dc6e-a17f-95bda32c0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.Cluster","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95ad-dc6e-a17f-95bda31e0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.Cluster . @ToolUi.Hidden Applies to: Field, Class Suppresses display of the annotated field or class. When applied to a field, Brightspot suppresses display of the field in the content edit form; when applied to a class, Brightspot suppresses display of the model in the Create drop-down list—preventing editors from creating a new instance of the current model. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates Brightspot suppresses display of annotated class or field. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiHidden","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n private String headline;\n\n @ToolUi.Hidden \n private String author;\n\n private String body;\n\n}","annotations":[{"lineNumber":"8","codeSnippet":" @ToolUi.Hidden ","annotation":"Suppresses display of the author field in the content edit form.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d9d-d029-adff-6f9d1c970000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d9c-d029-adff-6f9de4c90000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d9c-d029-adff-6f9de4c40000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d9c-d657-a7fd-7fbde48c0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638221601097,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638221601097,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d9d-dd18-a17d-ffbd93c70001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d9d-d657-a7fd-7fbd82520001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d9d-d657-a7fd-7fbd82520000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.Hidden.png @ToolUi.IconName Applies to: Class Specifies the icon associated with the annotated model in the Quick Start widget. The following table lists the elements available with this annotation. Element Description Valid Value value Name of the icon Brightspot displays in the Quick Start widget. Any identifier in the <a href="https://fonts.google.com/icons" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1690465570262,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1690465570262,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"link":{"target":"NEW","attributes":[],"url":"https://fonts.google.com/icons","_id":"0000017f-4632-dfd5-a9ff-66fb5fa60001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"Material Icons","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._preset":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017f-4632-dfd5-a9ff-66fb5fa60000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">Material Icons . Defaults to add_circle_outline (<bsp-snippet data-snippet-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638893640326,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638893640326,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"snippet":{"_ref":"0000017b-6408-d86b-a77f-6d8dfc7b0001","_type":"d2a205aa-dd4d-3a6e-acf9-d4f7609d4d35"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95ac-d029-adff-97bd31250000","_type":"968481a3-3236-3bd5-82c4-ba78207b9d17"}"> ). mode Rotates the icon. One of the following: rotate90 rotate180 rotate270 Defaults to no rotation. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiIconName","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.IconName(value=\"face\") \npublic class Author extends Content {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.IconName(value=\"face\") ","annotation":"Displays Material Design’s face icon for the content type Author in the Quick Start widget.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d9e-d657-a7fd-7fbfc58f0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d9e-d657-a7fd-7fbf81700000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6d9e-d657-a7fd-7fbf816a0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6d9e-dd18-a17d-ffbf811e0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638221708408,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638221708408,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-6d9f-dd18-a17d-ffbf39ad0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-6d9f-dd18-a17d-ffbf2bf90001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-6d9f-dd18-a17d-ffbf2bf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.IconName.png See also: <a href="https://fonts.google.com/icons" target="_blank" link-data="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1690465592983,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1690465592983,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"link":{"target":"NEW","attributes":[],"url":"https://fonts.google.com/icons","_id":"0000017f-4644-dfd5-a9ff-66ef76800000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00010"},"linkText":"Material Symbols","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._preset":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017f-4644-dfd5-a9ff-66ef767f0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">Material Symbols @ToolUi.InputProcessorPath Applies to: Field Specifies path to the processor used to render and update the target field. This annotation is typically used for customized field processing and rendering instead of using the default field renderer. The following table lists the elements available with this annotation. Element Description Valid Value value Path to servlet. The path starts from a root at the following locations: For the express project, brightspot/express/frontend/src/main/webapp/ . For other projects, src/main/webapp/ . String. application Component for constructing path to appropriate servlet. At run time, Brightspot typically prepends this value to the value for value to construct the entire path to the servlet. String. Default is a zero-length string ( "" ). The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiInputProcessorPath","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Video extends Content {\n\n @ToolUi.InputProcessorPath(\"/path/duration.jsp\") \n @ToolUi.ReadOnly\n private Long duration;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.InputProcessorPath(\"/path/duration.jsp\") ","annotation":"Specifies the path to the widget used to compute a video’s duration. Inside the Brightspot express project, the file’s path is brightspot/express/frontend/src/main/webapp/path/duration.jsp .","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da0-dd18-a17d-ffa1f8d00000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da0-d029-adff-6fb14d760000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6da0-d029-adff-6fb14d710000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da0-d657-a7fd-7fbd4d250000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> See also: <a href="/brightspot-developer-documentation/latest/creating-custom-fields" data-cms-id="0000017d-7133-d657-a7fd-7bbf96c80000" data-cms-href="/brightspot-developer-documentation/latest/creating-custom-fields" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638893571949,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638893571949,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-7133-d657-a7fd-7bbf96c80000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"_id":"0000017d-95ab-d029-adff-97bb0c3f0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"Creating custom fields","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-95ab-d029-adff-97bb0c300000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">Creating custom fields @ToolUi.InputSearcherPath Applies to: Field Specifies path to the widget that provides search results for the target field. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiInputSearcherPath","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.InputSearcherPath(\"/path/searchWidget.jsp\") \n private Author author;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.InputSearcherPath(\"/path/searchWidget.jsp\") ","annotation":"Specifies the path to the widget for retrieving matching authors.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da3-dc6e-a17f-6db7ff000000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da3-d657-a7fd-7fbfd08d0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6da3-d657-a7fd-7fbfd0870000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da3-dd18-a17d-ffa3d05a0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.LanguageTag Applies to: Field Sets the lang attribute of the div containing a String field. The following table lists the elements available with this annotation. Element Description Valid Value value Language-region pair applied to the annotated field. Any language-region par as listed in IANA Language Subtag Registry . The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiLanguageTag","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.LanguageTag(\"en-US\") \n private String body;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.LanguageTag(\"en-US\") ","annotation":"Sets the lang attribute of the div containing the body’s textarea element in the content edit form to en-US .","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da4-dd18-a17d-ffa5f0e70000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da4-d029-adff-6fb5c83a0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6da4-d029-adff-6fb5c8350000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da4-d657-a7fd-7fbdc7f40000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> \n \n \n \n \n \n \n ","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da5-d029-adff-6fb559170000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-6da5-d029-adff-6fb5590f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-6da5-dd18-a17d-ffa558cd0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.LayoutField Deprecated. No replacement. @ToolUi.LayoutPlaceholder Deprecated. No replacement. @ToolUi.LayoutPlaceholders Deprecated. No replacement. @ToolUi.Main Applies to: Class Places a model in the MAIN CONTENT TYPES group of the search panel’s Create drop-down list. By default, Brightspot places any model implementing Directory.Item in the MAIN CONTENT TYPES group of the Create drop-down list, and places models not implementing that interface in the MISC CONTENT TYPES group. This annotation places models not implementing Directory.Item in the MAIN CONTENT TYPES group. The following table lists the elements available with this annotation. Element Description Valid Value value Lists model in the MAIN CONTENT TYPES in the Create drop-down list. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiMain1","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.Directory;\n\npublic class Author extends Content implements Directory.Item { \n\n}","annotations":[{"lineNumber":"4","codeSnippet":"public class Author extends Content implements Directory.Item { ","annotation":"Indicates that Author appears in the MAIN CONTENT TYPES group of the Create drop-down list, because this model implements Directory.Item .","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-70ff-d657-a7fd-7bff6f0e0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-70ff-dd18-a17d-ffff277f0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-70ff-dd18-a17d-ffff277a0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-70ff-d029-adff-77ff272e0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiMain2","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.Main \npublic class Article extends Content {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.Main ","annotation":"Indicates that Article appears in the MAIN CONTENT TYPES group of the Create drop-down list, even though this model does not implement Directory.Item .","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-70ff-d029-adff-77fff7440000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-70ff-d657-a7fd-7bffb3fd0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-70ff-d657-a7fd-7bffb3f80000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-70ff-dd18-a17d-ffffb3b40000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiMain3","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\npublic class Gallery extends Content {\n\n}","annotations":[],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7100-d029-adff-7791349a0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7100-d029-adff-779134950000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7100-d657-a7fd-7bbd344e0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> In the previous snippet, the model Gallery does not implement Directory.Item and has no annotation, so it appears in the MISC CONTENT TYPES group of the Create drop-down list. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638278446186,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638278446186,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-7100-d657-a7fd-7bbdec3a0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7100-d029-adff-7791e0be0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-7100-d029-adff-7791e0be0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.Main.png @ToolUi.Note Deprecated. Use <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#note" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="note" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892724796,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892724796,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"note","_id":"0000017d-959e-d029-adff-979f2da50000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@Note","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-959e-d029-adff-979f2d960000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@Note . @ToolUi.NoteHtml Deprecated. Use <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#dynamicnoteclass" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="dynamicnoteclass" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892667819,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892667819,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnoteclass","_id":"0000017d-959d-dc6e-a17f-959d521b0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@DynamicNoteClass","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-959d-dc6e-a17f-959d520c0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@DynamicNoteClass , <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#dynamicnotemethod" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="dynamicnotemethod" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892686924,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892686924,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnotemethod","_id":"0000017d-959d-d657-a7fd-bfbd8fe10000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@DynamicNoteMethod","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-959d-d657-a7fd-bfbd8fd30000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@DynamicNoteMethod , or <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#htmlnote" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="htmlnote" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892703642,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892703642,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"htmlnote","_id":"0000017d-959d-dc6e-a17f-959dd7c30000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@HtmlNote","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-959d-dc6e-a17f-959dd7b50000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@HtmlNote . @ToolUi.NoteRendererClass Deprecated. Use <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#dynamicnoteclass" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="dynamicnoteclass" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892596790,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892596790,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnoteclass","_id":"0000017d-959c-d029-adff-979d3c5a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@DynamicNoteClass","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-959c-d029-adff-979d3c4b0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@DynamicNoteClass , <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#dynamicnotemethod" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="dynamicnotemethod" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892613562,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892613562,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicnotemethod","_id":"0000017d-959c-dc6e-a17f-959c7a500000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@DynamicNoteMethod","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-959c-dc6e-a17f-959c7a410000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@DynamicNoteMethod . @ToolUi.OnlyPathed Applies to: Field Displays in the search panel only those items with a permalink—guaranteeing that an editor references a live item and does not create a dead link. This annotation applies to fields satisfying the following conditions: Reference models that implement Directory.Item . Reference instances with a saved and published permalink. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates selections for annotated field must have a permalink. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiOnlyPathed","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.OnlyPathed \n private Author author;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.OnlyPathed ","annotation":"Displays in the search panel only those published authors with permalinks.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7103-dc6e-a17f-7197372b0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7102-d029-adff-7793dfcd0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7102-d029-adff-7793dfc70000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7102-dd18-a17d-ff23df820000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638278642183,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638278642183,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-7103-d657-a7fd-7bbffa210001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7103-d657-a7fd-7bbfe5780000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-7103-d657-a7fd-7bbfe5770000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.OnlyPathed.svg @ToolUi.Permissionable Applies to: Class Enables the annotated class to have permissions, and to appear in the Permissions accordion of the Tool Role or Tool User widget. The annotated class must extend from Record . The following table lists the elements available with this annotation. Element Description Valid Value value Indicates access to annotated class in the Brightspot UI is determined by permissions. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiPermissionable","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.ToolUi;\nimport com.psddev.dari.db.Record;\n\n@ToolUi.Permissionable \npublic class RichTextHat extends Record { \n /* Class definition */\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.Permissionable ","annotation":"Renders the annotated class in the Permissions accordion of the Tool Role or Tool User widget.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7105-d029-adff-7795371a0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"5","codeSnippet":"public class RichTextHat extends Record { ","annotation":"Declares a class RichTextHat that extends from Record . Brightspot renders such classes as Other Type in a permissions form. Brightspot renders a class extending from Content as Content Type in a permissions form.","originalLineNumber":5,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7105-dd18-a17d-ff2559c40000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7105-d657-a7fd-7bbd01310000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7105-d657-a7fd-7bbd012b0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7105-d029-adff-779500dc0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.Placeholder Deprecated. Use <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#placeholder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="placeholder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892364873,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892364873,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"placeholder","_id":"0000017d-9598-dd18-a17d-9fb986410000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@Placeholder","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9598-dd18-a17d-9fb986310000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@Placeholder , <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#dynamicplaceholderclass" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="dynamicplaceholderclass" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892381827,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892381827,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicplaceholderclass","_id":"0000017d-9598-d657-a7fd-bfbdf1c80000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@DynamicPlaceholderClass","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9598-d657-a7fd-bfbdf1b80000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@DynamicPlaceholderClass , <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#dynamicplaceholdermethod" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="dynamicplaceholdermethod" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892400786,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892400786,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"dynamicplaceholdermethod","_id":"0000017d-9599-dd18-a17d-9fb935930000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@DynamicPlaceholderMethod","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9599-dd18-a17d-9fb9357d0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@DynamicPlaceholderMethod , <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#clearonplaceholderchange" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="clearonplaceholderchange" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892418624,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892418624,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"clearonplaceholderchange","_id":"0000017d-9599-dc6e-a17f-959d7f790000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ClearOnPlaceholderChange","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9599-dc6e-a17f-959d7f6a0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ClearOnPlaceholderChange , or <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#editableplaceholder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="editableplaceholder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892439056,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892439056,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"editableplaceholder","_id":"0000017d-9599-dd18-a17d-9fb9c9020000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@EditablePlaceholder","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9599-dd18-a17d-9fb9c8f30000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@EditablePlaceholder . @ToolUi.Publishable Applies to: Class Indicates if the class is publishable. If this annotation is absent, the class is publishable. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates annotated class is publishable. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiPublishable","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.Publishable(false) \npublic class Article extends Content {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.Publishable(false) ","annotation":"Indicates that no articles are publishable. The text inside the editorial toolbar changes to Save .","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7106-dd18-a17d-ff27faa10000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7106-dc6e-a17f-7196c3c80000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7106-dc6e-a17f-7196c3c30000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7106-d029-adff-7797c3780000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638278874508,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638278874508,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-7107-dc6e-a17f-719778ef0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7107-dc6e-a17f-719766510001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-7107-dc6e-a17f-719766510000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.Publishable.png @ToolUi.PublishButtonText Applies to: Class Specifies the text appearing on the publish button in the model’s content edit form. If annotation is absent, Brightspot uses the default text Publish . The following table lists the elements available with this annotation. Element Description Valid Value value Label for Publish button. Any string. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiPublishButtonText","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.PublishButtonText(\"Print it!\") \npublic class Article extends Content {\n\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.PublishButtonText(\"Print it!\") ","annotation":"Specifies that Print It! appears on the publish button for articles.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-710c-d657-a7fd-7bbd031b0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-710b-d029-adff-779bcd810000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-710b-d029-adff-779bcd7c0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-710b-dd18-a17d-ff2bcd260000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638279247911,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638279247911,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-710c-dc6e-a17f-719c9c340001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-710c-d029-adff-779d91310000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-710c-d029-adff-779d91300000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.PublishButtonText.png @ToolUi.ReadOnly Applies to: Field, Class Specifies the annotated item is read-only. When applied to a field, the annotated field is read only. When applied to a class, the model is read only: editors cannot modify instances of the model, and cannot create new instances. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates annotated class or field is read-only on content edit form. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiReadOnly","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n private String headline;\n\n @ToolUi.ReadOnly \n private String author;\n\n}","annotations":[{"lineNumber":"8","codeSnippet":" @ToolUi.ReadOnly ","annotation":"Specifies that Author is read-only on the content edit form.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-710e-d657-a7fd-7bbfbbb30000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-710e-dc6e-a17f-719e6d140000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-710e-dc6e-a17f-719e6d0e0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-710e-dd18-a17d-ff2f6cc40000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638279380157,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638279380157,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-710f-d029-adff-779f31dc0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-710f-dc6e-a17f-719f1e3e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-710f-dc6e-a17f-719f1e3e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.ReadOnly.png @ToolUi.RichText Applies to: Field Renders a String field as a rich-text editor. The following table lists the elements available with this annotation. Element Description Valid Value value If true , field rendered as a rich-text editor. true (default), false inline If true , includes controls for inline markup, such as typeface and comments. If false , includes controls for inline markup and for paragraph formatting, such as alignment and tables. true (default), false . Must be false if block in the <a href="/brightspot-developer-documentation/latest/content-modeling-annotations#richtextelement-tag" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/brightspot-developer-documentation/latest/content-modeling-annotations" anchor="richtextelement-tag" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892014983,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892014983,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"richtextelement-tag","_id":"0000017d-9593-d657-a7fd-bfbf27290000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@RichTextElement.Tag","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9593-d657-a7fd-bfbf271a0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@RichTextElement.Tag annotation is true . toolbar Renders the rich-text editor’s toolbar using the specified class. Any class that implements RichTextToolbar . Defaults to DefaultRichTextToolbar.class . Brightspot provides the following implementing classes: LargeRichTextToolbar —Provides all buttons. MediumRichTextToolbar —provides buttons for text formatting, alignment, lists, enhancements, and HTML. SmallRichTextToolbar —provides buttons for text formatting, alignment, and lists. TinyRichTextToolbar —provides buttons for text formatting. For information about creating your own rich-text toolbars and elements, see <a href="/brightspot-developer-documentation/latest/field-types#rich-text" data-cms-id="0000017d-6c13-d029-adff-6f932c4e0000" data-cms-href="/brightspot-developer-documentation/latest/field-types" anchor="rich-text" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638892113077,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638892113077,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c13-d029-adff-6f932c4e0000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"rich-text","_id":"0000017d-9594-d657-a7fd-bfbdc7ed0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"Rich text","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-9594-d657-a7fd-bfbd9e2a0000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">Rich text . The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiRichText","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\nimport brightspot.core.tool.SmallRichTextToolbar;\n\npublic class Article extends Content {\n\n @ToolUi.RichText(toolbar = SmallRichTextToolbar.class) \n private String body;\n\n}","annotations":[{"lineNumber":"7","codeSnippet":" @ToolUi.RichText(toolbar = SmallRichTextToolbar.class) ","annotation":"Renders the field body as a rich-text editor using the small version of the default toolbar.","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7110-dd18-a17d-ff318a800000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7110-d657-a7fd-7bbd56240000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7110-d657-a7fd-7bbd561f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7110-d029-adff-779155d10000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638279489049,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638279489049,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-7110-d029-adff-7791ef380000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7110-d029-adff-7791e22e0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-7110-d029-adff-7791e22e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.RichText.png @ToolUi.Secret Applies to: Field Hides the annotated String field’s value; a Show Secret/Hide Secret control toggles the field’s value in cleartext. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates annotated field toggles between a password and cleartext display. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiSecret","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.Secret \n private String password;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.Secret ","annotation":"Hides the password field’s value.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7112-dd18-a17d-ff338fce0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7112-d029-adff-77931a6f0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7112-d029-adff-77931a6a0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7112-d657-a7fd-7bbf1a210000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> This annotation does not provide encryption when sending to or receiving from the server. To encrypt a field’s value, use @ToolUi.FieldDisplayType("password"). For details, see <a href="/developer-guide/latest/content-modeling-annotations#toolui-fielddisplaytype" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-fielddisplaytype" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638859890496,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638859890496,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-fielddisplaytype","_id":"0000017d-93a9-d657-a7fd-bbbd08280000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.FieldDisplayType","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-93a9-d657-a7fd-bbbd08170000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.FieldDisplayType . @ToolUi.Sortable Applies to: Field Indicates search results can be sorted by the annotated String field when filtering on the corresponding model. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates search results can be sorted by annotated field. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiSortable","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.Sortable \n private String headline;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.Sortable ","annotation":"Indicates users can sort search results by headline when filtering on Articles.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7113-d657-a7fd-7bbf75f50000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7113-dc6e-a17f-71974d130000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7113-dc6e-a17f-71974d0d0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7113-d029-adff-77934cba0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1709132782100,"cms.content.publishUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1709132782100,"cms.content.updateUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018d-adf7-dfbd-a1df-bff716a60001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7113-dd18-a17d-ff33d7300001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017d-7113-dd18-a17d-ff33d7300000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUI.Sortable.png @ToolUi.StoragePreviewProcessorPath Applies to: Field Specifies path to the servlet used to generate a StorageItem ’s preview in the content edit form. If absent, Brightspot uses the method FileField#processField . <bsp-callout data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638280057215,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638280057215,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"callout":{"callout":{"type":"NOTE","calloutText":"The recommended implementation for customizing an image’s preview is to implement the interface method FileContentType#writePreview .","rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7119-dc6e-a17f-719d6c9a0000","_type":"a64a25ea-0f4e-3e27-8136-0e63bec56e72"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7119-dd18-a17d-ff396c570000","_type":"96fa12a0-b117-3f56-8123-eefe760f046e"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-7119-dd18-a17d-ff396c4b0000","_type":"98cde75f-32a8-3181-9416-3bf9f401af77"}"> The following table lists the elements available with this annotation. Element Description Valid Value value Path to servlet. String. application Component for constructing path to appropriate servlet. At run time, Brightspot typically prepends this value to the value for value to construct the entire path to the servlet. String. Default is a zero-length string ( "" ). The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiStoragePreviewProcessorPath","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.StoragePreviewProcessorPath(\"/WEB-INF/_plugins/myCustomFilePreview.jsp\") \n private StorageItem leadImage;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.StoragePreviewProcessorPath(\"/WEB-INF/_plugins/myCustomFilePreview.jsp\") ","annotation":"Specifies the path to the JSP servlet that generates the leadImage ’s preview in the content edit form.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711b-d657-a7fd-7bbf19fe0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711a-dd18-a17d-ff3b56590000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-711a-dd18-a17d-ff3b56540000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711a-d029-adff-779b56300000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.StorageSetting Applies to: Field Specifies the storage location for uploadable files. This annotation is useful if you want to save specific StorageItems on a dedicated server. This annotation requires a string identifying the storage location. The following table lists the elements available with this annotation. Element Description Valid Value value Storage location for files uploaded through the annotated field. String representation of a storage location configured in context.xml . Some Brightspot deployments declare two locations for storing StorageItems. For example, the following snippet from a context.xml declares two storage locations: primary and secondary . \n \n\n \n \n \n\n \n \n ","annotations":[{"lineNumber":"2","codeSnippet":" ","annotation":"Specifies primary as the default storage location.","originalLineNumber":2,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711c-d657-a7fd-7bbd46470000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"4","codeSnippet":" ","annotation":"Defines the URL for storage location primary .","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711c-d657-a7fd-7bbd6b530000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" ","annotation":"Defines the URL for storage location secondary .","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711c-dc6e-a17f-719c9e260000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711b-dc6e-a17f-719ff96f0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-711b-dc6e-a17f-719ff96a0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711b-d657-a7fd-7bbff8dc0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Because primary is the default storage location, Brightspot never uses secondary unless overridden in a @ToolUi.StorageSetting annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiStorageSetting2","internalName":"ToolUi","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.StorageSetting(\"secondary\") \n private StorageItem image;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.StorageSetting(\"secondary\") ","annotation":"Specifies that all objects associated with the image field are stored in the secondary location specified in the project’s context.xml file.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711d-dc6e-a17f-719de80f0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711d-dd18-a17d-ff3daf3c0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-711d-dd18-a17d-ff3daf370000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711d-dc6e-a17f-719daeea0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> @ToolUi.SuggestedMaximum Applies to: Field Suggested maximal number of characters in a String field. Brightspot retains the entire string even if longer than the suggested maximum. The following table lists the elements available with this annotation. Element Description Valid Value value Suggested maximal number of characters in annotated field. Any double ≥ 0. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiSuggestedMaximum","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.SuggestedMaximum(30) \n private String headline;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.SuggestedMaximum(30) ","annotation":"Specifies a suggested maximal length of 30 characters in the headline. When a user types more than 30, Brightspot displays a warning message.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711f-dd18-a17d-ff3f0ab60000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711e-d029-adff-779fb8c80000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-711e-d029-adff-779fb8c30000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-711e-d657-a7fd-7bbfb85a0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1708024897563,"cms.content.publishUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1708024897563,"cms.content.updateUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018d-ae36-d90b-abbf-aefe677c0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-711f-dc6e-a17f-719f73740001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017d-711f-dc6e-a17f-719f73740000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUI.SuggestedMaximum.png @ToolUi.SuggestedMinimum Applies to: Field Suggested minimal number of characters in a String field. Brightspot retains the string even if shorter than the suggested minimum. The following table lists the elements available with this annotation. Element Description Valid Value value Suggested minimal number of characters in annotated field. Any double ≥ 0. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiSuggestedMinimum","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.SuggestedMinimum(10) \n private String headline;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.SuggestedMinimum(10) ","annotation":"Specifies a suggested minimal length of 10 characters for the headline. Brightspot displays a warning message in the field until the user types 10 characters.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7120-dd18-a17d-ff21c6490000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7120-dc6e-a17f-71b45a5f0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7120-dc6e-a17f-71b45a5a0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7120-d657-a7fd-7bbd59f70000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1708025286068,"cms.content.publishUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1708025286068,"cms.content.updateUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018d-ae3b-dfbd-a1df-be7fcb0f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7121-d657-a7fd-7bbd30380001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017d-7121-d657-a7fd-7bbd30380000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUI.SuggestedMinimum.png @ToolUi.Suggestions Applies to: Field Based on an object’s content, this annotation a) provides suggested selections for drop-down lists, and b) provides recommended results in the content picker. Applies to fields referencing other models. When an editor opens a drop-down list with this annotation, Brightspot sends the current state of the object to the search platform for analysis. The server responds with suggested selections based on the model’s content and active drop-down list. For example, an editor enters the headline Bravest Soldiers I've Known and opens the Section drop-down list. Brightspot provides a list of suggested sections in which to publish the article based on other articles already published in those sections. This annotation becomes active after your Brightspot project reaches a certain volume of content. The following table lists the elements available with this annotation. Element Description Valid Value value Indicates Brightspot provides suggestions for the annotated field based on existing published content. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiSuggestions","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.Suggestions \n private Section section;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.Suggestions ","annotation":"Provides suggested selections when the user opens the Section field.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7122-dd18-a17d-ff233dcf0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7122-dd18-a17d-ff2305140000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7122-dd18-a17d-ff23050e0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7122-dc6e-a17f-71b604840000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> In the following illustration, Brightspot displays suggested names of sections. The suggested names are influenced by the story’s content. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1709133040065,"cms.content.publishUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1709133040065,"cms.content.updateUser":{"_ref":"0000018b-8145-db35-adab-8f572d010000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018d-b33f-d90b-abbf-bfff4c510001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7122-dc6e-a17f-71b6a5100001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000017d-7122-dc6e-a17f-71b6a5100000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUI.Suggestions.png @ToolUi.Tab Applies to: Field Indicates under which custom tab the field appears in the content edit form. If the tab does not exist, Brightspot creates it. Fields without this annotation appear as follows: In an unlabeled widget if there are no other tabs. In the Main tab if there are other tabs. Tabs appear left-to-right in the order they first appear in the model; you can override this order using the annotation <a href="/developer-guide/latest/content-modeling-annotations#toolui-tabdisplayorder" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-tabdisplayorder" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638859680780,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638859680780,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-tabdisplayorder","_id":"0000017d-93a5-d029-adff-97b5b9150000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.TabDisplayOrder","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-93a5-d029-adff-97b5b9050000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.TabDisplayOrder . The following table lists the elements available with this annotation. Element Description Valid Value value Label for tab under which annotated field appears. Any string. The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiTab","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class Article extends Content {\n\n @ToolUi.Tab(\"Markets\") \n private String state;\n\n @ToolUi.Tab(\"Markets\")\n private String county;\n\n @ToolUi.Tab(\"Markets\")\n private String city;\n\n}","annotations":[{"lineNumber":"6","codeSnippet":" @ToolUi.Tab(\"Markets\") ","annotation":"Specifies that the fields state, county, and city appear under the Markets tab in the content edit form.","originalLineNumber":6,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7124-dd18-a17d-ff257ca70000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7123-dc6e-a17f-71b7a80d0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7123-dc6e-a17f-71b7a8080000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7123-d657-a7fd-7bbfa7bf0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638280805836,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638280805836,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-7124-dc6e-a17f-71b4fe070001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7124-d029-adff-77b5f26c0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-7124-d029-adff-77b5f26c0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.Tab.png @ToolUi.TabDisplayOrder Applies to: Class Specifies the order in which custom tabs appear in the content edit form. By default, Brightspot displays custom tabs (the tabs you declare with <a href="/developer-guide/latest/content-modeling-annotations#toolui-tab" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-tab" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638859522912,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638859522912,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-tab","_id":"0000017d-93a3-d029-adff-97b33a150000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.Tab","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-93a3-d029-adff-97b33a060000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.Tab ) in the order in which they appear in the model. Using this annotation, you can specify which tab appears first and which tab appears last. Regardless of these annotations, Brightspot always places the tab Main first, and displays other system-level tabs such as SEO last. The following table lists the elements available with this annotation. Element Description Valid Value start Leftmost tabs on the content edit form (after the Main tab). Brightspot displays the tabs in the order as they appear in the array, so start={"Soda Pop","Mineral Water"} displays the tab Soda Pop and then the tab Mineral Water. Array of strings, the elements of which are parameters to the annotation <a href="/developer-guide/latest/content-modeling-annotations#toolui-tab" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-tab" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638859522912,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638859522912,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-tab","_id":"0000017d-93a3-d029-adff-97b33a150000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.Tab","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-93a3-d029-adff-97b33a060000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.Tab . end Rightmost tabs on the content edit form. Brightspot displays the tabs in the order as they appear in the array, so end={"Soda Pop","Mineral Water"} displays the tab Soda Pop and then the tab Mineral Water. If the same tab is passed to start and end, the layout specified by end has higher priority. Array of strings, the elements of which are parameters to the annotation <a href="/developer-guide/latest/content-modeling-annotations#toolui-tab" data-cms-id="0000017d-6c50-d657-a7fd-7ffdefc00000" data-cms-href="/developer-guide/latest/content-modeling-annotations" anchor="toolui-tab" link-data="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638859522912,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638859522912,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"link":{"rekognitionVideo.timeFrameMetadata":[],"attributes":[],"item":{"_ref":"0000017d-6c50-d657-a7fd-7ffdefc00000","_type":"75918a10-b479-3fb1-bb84-6a57df4b0241"},"anchor":"toolui-tab","_id":"0000017d-93a3-d029-adff-97b33a150000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed10000"},"linkText":"@ToolUi.Tab","theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs.linkStyle":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:link:Link.hbs._template":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-93a3-d029-adff-97b33a060000","_type":"00000162-ab56-d787-af72-fb57299f0000"}">@ToolUi.Tab . The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolTabDisplayOrder","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\n@ToolUi.TabDisplayOrder(end = {\"Markets\"}) \npublic class Article extends Content{\n\n private String headline; \n private String body;\n private String author;\n\n @ToolUi.Tab(\"Markets\") \n private String state;\n\n @ToolUi.Tab(\"Markets\")\n private String county;\n\n @ToolUi.Tab(\"Markets\")\n private String city;\n\n @ToolUi.Tab(\"Demographics\") \n private String gender;\n\n @ToolUi.Tab(\"Demographics\")\n private String age;\n\n @ToolUi.Tab(\"Demographics\")\n private String occupation;\n}","annotations":[{"lineNumber":"4","codeSnippet":"@ToolUi.TabDisplayOrder(end = {\"Markets\"}) ","annotation":"Specifies that the rightmost custom tab is Markets , overriding the default that Demographics is the rightmost custom tab.","originalLineNumber":4,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7126-d029-adff-77b711a20000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"7","codeSnippet":" private String headline; ","annotation":"Defines three fields without a @ToolUi.tab annotation; these fields appear under the tab Main .","originalLineNumber":7,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7126-dd18-a17d-ff2746470000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"11","codeSnippet":" @ToolUi.Tab(\"Markets\") ","annotation":"Defines three fields appearing under the custom tab Markets . By default, Markets is the leftmost tab because it is appears first in the model.","originalLineNumber":11,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7126-dc6e-a17f-71b68c230000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"20","codeSnippet":" @ToolUi.Tab(\"Demographics\") ","annotation":"Defines three fields appearing under the custom tab Demographics .","originalLineNumber":20,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7126-dd18-a17d-ff27cfb70000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7125-dd18-a17d-ff25cf440000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-7125-dd18-a17d-ff25cf3f0000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7125-d657-a7fd-7bbdceee0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638280984355,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638280984355,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-7127-dd18-a17d-ff278e0c0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-7127-d657-a7fd-7bbf82490001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-7127-d657-a7fd-7bbf82490000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.TabDisplayOrder.svg @ToolUi.Unlabeled Applies to: Field, method For embedded classes with a single field, this annotation hides that field's label. The embedded class must not extend Content . The following table lists the elements available with this annotation. Element Description Valid Value value Suppresses annotated field’s label. true (default), false The following snippet includes an example of applying this annotation. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.hideLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollable":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollableLinesVisible":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._preset":null,"title":"ToolUiUnlabeled","code":{"codeType":"JAVA","code":"@Recordable.Embedded\npublic class ExampleChild extends Record {\n\n @ToolUi.Unlabeled\n private String myStringField;\n\n}\n\npublic class ExampleParent extends Content {\n\n private ExampleChild myEmbeddedField;\n\n}","annotations":[{"lineNumber":"2","codeSnippet":"public class ExampleChild extends Record {","annotation":"Declares an embedded class with a single text field.","originalLineNumber":2,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7128-dc6e-a17f-71bcace50000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"4","codeSnippet":" @ToolUi.Unlabeled","annotation":"Suppresses the label My String Field in the content edit form.","originalLineNumber":4,"_id":"0000018b-62a7-db35-adab-6eb76f670000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":"public class ExampleParent extends Content {","annotation":"Declares a parent class with a field of type ExampleChild .","originalLineNumber":9,"_id":"0000018b-62a8-db35-adab-6ebb302d0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"_id":"0000017d-7128-dd18-a17d-ff29693a0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"_id":"0000017d-7128-dd18-a17d-ff2969340000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"_id":"0000017d-7128-d029-adff-77b968d90000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}" data-rte-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1698178965315,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1698178965315,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"codeBlock":{"codeBlock":{"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.hideLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollable":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.verticallyScrollableLinesVisible":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._preset":null,"title":"ToolUiUnlabeled","code":{"codeType":"JAVA","code":"@Recordable.Embedded\npublic class ExampleChild extends Record {\n\n @ToolUi.Unlabeled\n private String myStringField;\n\n}\n\npublic class ExampleParent extends Content {\n\n private ExampleChild myEmbeddedField;\n\n}","annotations":[{"lineNumber":"2","codeSnippet":"public class ExampleChild extends Record {","annotation":"Declares an embedded class with a single text field.","originalLineNumber":2,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-7128-dc6e-a17f-71bcace50000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"4","codeSnippet":" @ToolUi.Unlabeled","annotation":"Suppresses the label My String Field in the content edit form.","originalLineNumber":4,"_id":"0000018b-62a7-db35-adab-6eb76f670000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":"public class ExampleParent extends Content {","annotation":"Declares a parent class with a field of type ExampleChild .","originalLineNumber":9,"_id":"0000018b-62a8-db35-adab-6ebb302d0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"_id":"0000017d-7128-dd18-a17d-ff29693a0000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"_id":"0000017d-7128-dd18-a17d-ff2969340000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"_id":"0000017d-7128-d029-adff-77b968d90000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000018b-62a5-d199-a3db-76f7b1f40000","_type":"bc197941-6969-3a80-8658-e03060c646aa"}"> The following examples illustrate the effect of this annotation. <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1698248450746,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1698248450746,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000018b-677b-d199-a3db-777f858b0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000018b-677e-d199-a3db-777fab7b0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000018b-677e-d199-a3db-777fab7b0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">Child class without @ToolUi.Unlabeled <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-e99b-d9c6-a5fa-eddf364e0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1698248468616,"cms.content.publishUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1698248468616,"cms.content.updateUser":{"_ref":"00000165-6c20-dfe9-abef-edbd9fd90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"image":{"image":{"_ref":"0000017d-7129-dc6e-a17f-71bd248f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000018b-677f-d199-a3db-777f06380000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._preset":null,"_id":"0000018b-677f-d199-a3db-777f06380001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">Child class with @ToolUi.Unlabeled @ToolUi.ValueGenerator Applies to: Field. Populates a drop-down list with properties available in the current page. The following table lists the elements available with this annotation. Element Description Valid Value value Class used to extract values from the current context. Any class that implements ValueGenerator . Implementing this annotation requires the following steps. Step 1: Declare a ValueGenerator class Declare a class that implements ValueGenerator . This interface includes a method generate that has access to the currently displayed page in Brightspot. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiValueGenerator1","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Site;\nimport com.psddev.cms.db.ValueGenerator;\nimport com.psddev.cms.tool.ToolPageContext;\n\npublic class SiteListValueGenerator implements ValueGenerator { \n\n @Override\n public List generate(ToolPageContext page, Object object, String input) { \n List otherAccessibleSites = page.findOtherAccessibleSites(); \n return otherAccessibleSites.stream() \n .map(e -> {\n Value value = new ValueGenerator.Value();\n value.setLabel(e.getLabel());\n value.setValue(e.getId().toString());\n return value;\n })\n .collect(Collectors.toList());\n }\n}","annotations":[{"lineNumber":"5","codeSnippet":"public class SiteListValueGenerator implements ValueGenerator { ","annotation":"Declares a class that implements ValueGenerator .","originalLineNumber":5,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712a-dc6e-a17f-71bec8050000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"8","codeSnippet":" public List generate(ToolPageContext page, Object object, String input) { ","annotation":"Method that returns a list of sites to which the current user has access excluding the current site.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712a-d029-adff-77bbf8ec0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":" List otherAccessibleSites = page.findOtherAccessibleSites(); ","annotation":"Retrieves the sites to which the user has access other than the current site.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712b-dc6e-a17f-71bf67ed0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"10","codeSnippet":" return otherAccessibleSites.stream() ","annotation":"Constructs a list of those sites using the sites’ label and ID.","originalLineNumber":10,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712b-d029-adff-77bbac520000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712a-dc6e-a17f-71be5d250000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-712a-dc6e-a17f-71be5d200000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712a-dd18-a17d-ff2b5cbf0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> Step 2: Declare a field annotated with the class In a model, declare a List or Set field annotated with the class from Step 1. <bsp-code-block data-code-block-type="brightspot.supportdesk.code.OneOffCodeBlock" data-code-block-state="{"codeBlock":{"title":"ToolUiValueGenerator2","code":{"codeType":"JAVA","code":"import com.psddev.cms.db.Content;\nimport com.psddev.cms.db.ToolUi;\n\npublic class ArticleWithDynamicList extends Content {\n\n private String headline;\n\n @ToolUi.ValueGeneratorClass(SiteListValueGenerator.class) \n private Set additionalSitesForPublication; \n\n}","annotations":[{"lineNumber":"8","codeSnippet":" @ToolUi.ValueGeneratorClass(SiteListValueGenerator.class) ","annotation":"Populates the list with the results from the method SiteListValueGenerator#generate implemented in Step 1.","originalLineNumber":8,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712c-d029-adff-77bd7ec70000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"},{"lineNumber":"9","codeSnippet":" private Set additionalSitesForPublication; ","annotation":"Declares a drop-down list of sites from which an editor can select to publish an item.","originalLineNumber":9,"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712c-dc6e-a17f-71bca9ff0000","_type":"4b1566b3-ea71-3efe-a0e4-5ca432ada867"}],"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712c-d029-adff-77bd45360000","_type":"3f4061fa-a6e7-3e24-af68-c847f5905a7b"},"rekognitionVideo.timeFrameMetadata":[],"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs.showLineNumbers":false,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:code:CodeBlock.hbs._template":null,"_id":"0000017d-712c-d029-adff-77bd45310000","_type":"9aa4179f-dd23-3c2a-b681-ad2b60c87a44"},"rekognitionVideo.timeFrameMetadata":[],"_id":"0000017d-712c-dd18-a17d-ff2d44cf0000","_type":"4a051501-b2f9-3529-a0a7-b0264ea5599c"}"> <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638281342321,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638281342321,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-712d-d029-adff-77bd27920001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-712d-dc6e-a17f-71bd1d7f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-712d-dc6e-a17f-71bd1d7f0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">ToolUi.ValueGenerator.png Viewing a model’s available annotations You can view the list of annotations used in or available for a model. To view a model’s available annotations: Open or create a new item based on the model whose annotations you want to view. In the editorial toolbar, click <bsp-snippet data-snippet-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638281419905,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638281419905,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"snippet":{"_ref":"0000017b-6409-de4e-afff-eedba7840001","_type":"d2a205aa-dd4d-3a6e-acf9-d4f7609d4d35"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-712e-dd18-a17d-ff2f833b0000","_type":"968481a3-3236-3bd5-82c4-ba78207b9d17"}"> , and select Tools . The Tools widget appears. Under For Developers , scroll down to Present Annotations and Possible Annotations . <bsp-image data-state="{"cms.site.owner":{"_ref":"0000017a-a154-d39c-a7ff-aff6dcf90000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30006"},"cms.content.publishDate":1638281451621,"cms.content.publishUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"cms.content.updateDate":1638281451621,"cms.content.updateUser":{"_ref":"00000171-7e3f-db90-a57b-7ebfd55a0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ee30018"},"rekognitionVideo.timeFrameMetadata":[],"image":{"rekognitionVideo.timeFrameMetadata":[],"image":{"_ref":"0000017d-712e-dd18-a17d-ff2fc6420001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00007"},"_id":"0000017d-712e-d029-adff-77bfb54f0001","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed0000b"},"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs.enhancementAlignment":null,"theme.0000017a-e99c-d9c6-a5fa-eddf027f0000.:core:enhancement:Enhancement.hbs._template":null,"_id":"0000017d-712e-d029-adff-77bfb54f0000","_type":"0000015d-56b9-d2db-a5dd-f6fd6ed00009"}">Model available annotations.png Using Expression Language in annotations Some annotations can generate dynamic text using Java’s Expression Language (EL). Brightspot provides the following objects you can use in EL statements: content—Reference to the object that contains the annotated field. ObjectField field—Annotated field’s ObjectField. ToolPageContext toolPageContext—General object for accessing the UI.