ExportRow (Structure API 17.26.0 API)

@PublicApi public interface ExportRow

An ExportRow represents a particular item in an exported Forest.

Method Summary

Modifier and Type

Method

Description

<T> T

get(AttributeSpec<T> attribute)

Gets a value of an attribute for this row.

int

getDepth()

StructureRow

getRow()

Returns the current StructureRow instance.

long

getRowId()

boolean

isExpanded()

boolean

isLeaf()

Method Details
- getRow
  
  @NotNull StructureRow getRow()
  
  Returns the current StructureRow instance.
  
  Returns:
  
  The current row.
- getRowId
  
  long getRowId()
- getDepth
  
  int getDepth()
  
  Returns:
  
  The depth of the current row in the exported Forest.
- isExpanded
  
  boolean isExpanded()
  
  Returns:
  
  true if the current row is expanded in the exported Forest.
- isLeaf
  
  boolean isLeaf()
  
  Returns:
  
  true if the current row has no sub-rows in the exported Forest.
- get
  
  @Nullable <T> T get(AttributeSpec<T> attribute)
  
  Gets a value of an attribute for this row. The attribute must have previously been requested by calling ExportRequestContext.requireAttribute(AttributeSpec) from ExportRenderer.prepare(ExportRequestContext) or ExportRendererProvider.getColumnRenderer(ExportFormat, ViewSpecification.Column, ExportRequestContext).
  
  Type Parameters:
  
  T - attribute format type
  
  Parameters:
  
  attribute - attribute specification
  
  Returns:
  
  the value or null