DocumentView class final

Inheritance
  • Object
  • ContentItem
  • DocumentView
Annotations
  • @JsonSerializable()

Constructors

DocumentView({String? title, ObjectReference? reference, DocumentLoadStrategy loadStrategy = DocumentLoadStrategy.reference, List<ContentItem> items = const [], required QueryConfiguration? query, LayoutConfiguration<ContentItem>? layout, List<ContentModifierConfiguration>? modifiers})
DocumentView.fromJson(Map<String, dynamic> json)
factory

Properties

hashCode int
The hash code for this object.
no setterinherited
items List<ContentItem>
final
layout → LayoutConfiguration<ContentItem>?
The layout configuration for the content item.
finalinherited
loadStrategy DocumentLoadStrategy
final
modifiers List<ContentModifierConfiguration>?
finalinherited
parent ↔ ContentItem?
The parent content item of this content item. This is used internally by the content system.
getter/setter pairinherited
query QueryConfiguration?
final
reference → ObjectReference?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
schemaType String
The schema type of the content item.
finalinherited
title String?
final

Methods

getLayout() → LayoutConfiguration<ContentItem>?
Gets the layout to use for the ContentItem. By default its the layout itself. However this acts as an extension point for custom ContentItems that may have a different strategy for applying layouts.
inherited
getModifiers() List<ContentModifierConfiguration>?
Gets the modifiers to use for the ContentItem. By default its the modifiers itself. However this acts as an extension point for custom ContentItems that may have a different strategy for applying modifiers.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setParent(Iterable<ContentItem?> children) → void
Sets the parent content item for the given list of children.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

contentBuilder → _DocumentViewContentBuilder
final
typeDescriptor → TypeDescriptor<DocumentView>
final

Constants

schemaName → const String