AppEntityDocPanel class final
Documentação conceitual de uma entidade: o que ela é, como se relaciona com as outras e quem troca dados com ela.
É a coluna esquerda do AppDocsWorkspace. Complementa o AppApiDocsPanel: um responde "o que isso significa", o outro "como eu chamo".
Não rola sozinho — quem hospeda dá o scroll (o contrato dos sheets).
Prosa livre entra como Markdown (overview e AppEntityDocSection),
porque ciclo de vida e regra de negócio não cabem numa estrutura fixa. Já
relações e integrações são estruturadas: são o que o leitor varre com o
olho, e uma lista de cartões varre melhor que um parágrafo.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- AppEntityDocPanel
Constructors
- AppEntityDocPanel({required AppEntityDoc doc, bool showHeader = true, String relationsTitle = 'Relações', String integrationsTitle = 'Integrações', void onTapLink(String href)?, Key? key})
-
Cria um AppEntityDocPanel.
const
Properties
- doc → AppEntityDoc
-
Documentação exibida.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- integrationsTitle → String
-
Título da seção de integrações.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onTapLink → void Function(String href)?
-
Toque num link do Markdown.
nullabre no navegador externo.final - relationsTitle → String
-
Título da seção de relações.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showHeader → bool
-
Mostra título e subtítulo próprios. Desligue quando quem hospeda já dá o
cabeçalho da coluna (é o caso do AppDocsWorkspace).
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited