Document List

Displays a list of Batch Objects.

Remarks

The Document List control presents a collection of Batch Objects—such as documents, folders, or attachments—in a tabular, interactive format within the Grooper web client. It is designed for reviewing, selecting, and managing items in a batch or repository, supporting both single and multi-selection, custom columns, and a variety of interactive features for efficient navigation and batch operations.

UI Components

• Results Table:
  • Displays each Batch Object as a row, with columns for properties such as Name, Attachment, and Path.
  • Column widths are optimized for readability and can be customized.
  • Supports both single and multi-selection for batch actions.
• Column Headers:
  • Show property names (e.g., Name, Attachment, Path) and may include tooltips for additional context.
  • Columns are generated dynamically and can be extended to include more properties.
• Row Attributes:
  • Each row includes data attributes such as data-id and data-dirty for integration with scripts and UI logic.
  • Dirty rows (items with unsaved changes) are visually indicated.
  • Selected and focused rows are highlighted for clarity.

Interactive Features

• Selection Controls:
  • Click to select a row; use Ctrl + click for multi-select, Shift + click for range selection.
  • Supports batch operations on selected items.
• Keyboard Navigation:
  • Up/Down: Move between rows.
  • Home/End: Jump to the first or last item.
  • Shift + Up/Down: Multi-select.
• Customizable Columns:
  • Columns are created for key properties of Batch Objects, such as Name, Attachment, and Path.
  • Additional columns (e.g., Content Type) can be added for more detailed views.
• Row Data Integration:
  • Data attributes on each row enable advanced client-side scripting, filtering, and UI feedback.

Usage Guidance

Use Document List to review and interact with Batch Objects in a batch or repository. Configure columns to display the most relevant properties for your workflow. Leverage multi-select and keyboard shortcuts for efficient batch operations and navigation.

• For large sets of documents, use column sizing and selection features to quickly locate and act on relevant items.
• Integrate with client-side scripts using row data attributes for advanced workflows.
• Use tooltips and custom column titles to provide additional context for users.

Example

// Example: Document List columns | Name | Attachment | Path | |--------------|-----------------|---------------------| | Invoice.pdf | invoice.tif | /Batches/2025/July | | Contract.doc | contract.tif | /Batches/2025/Legal |

Accessibility

• Fully navigable by keyboard and mouse.
• Screen reader support for row and column data.
• Visual highlighting for selection, focus, and dirty state.

For more information, see the documentation for Batch Object, Node, and Object List.

Used By

Imports PageActive Task ListAI Assistant - Chat HistoryFRX VisualizerNode FinderWeightings ListCMIS Tree BrowserCMIS Connection - GeneralCMIS Repository - TypesList SearcherService CollectionACL EditorChoice EditorCollection EditorOrdered Reference Editor