Support and Documentation

Visibility labels and selection fields

When an editor opens a selection field, Brightspot performs a query and lists those objects that satisfy the following conditions:

  • Is an instance of the associated class.

  • One of the following:

    • No visibility label in the class.

    • A visibility label is in the class, and the visibility label's value is null.

Brightspot uses two fields to control the visibility of objects in a selection field: draft and trash.

@DisplayName("Draft")
@Indexed(visibility = true)
@InternalName("cms.content.draft")
private Boolean draft;

@DisplayName("Archived")
@Indexed(visibility = true)
@InternalName("cms.content.trashed")
private Boolean trash;

In the previous snippet, the properties draft and trash are annotated with @Indexed(visibility = true). If the value of either field is non-null, Brightspot does not display the associated record in a selection field.

The following table summarizes the behavior of the properties draft and trash in an asset's life cycle.

Transition

draft

trash

Asset visible in selection field?

Editor creates an asset

Set to non-null

N/A

No

Editor publishes asset

Set to null

N/A

Yes

Editor re-publishes asset

No change

N/A

Yes

Editor archives asset

No change

Set to non-null

No