Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Object List

Control GrooperReview.Controls

Displays a list of objects in a tabular layout.

Remarks

The Object List control presents collections of objects in a flexible, interactive table format within the Grooper web client. It is designed for reviewing, selecting, and managing multiple items at once, such as documents, nodes, or configuration objects. The control supports both single and multi-selection, custom columns, and a variety of interactive features for efficient data navigation and manipulation.

UI Components

  • Table/Grid Layout:
    • Items are displayed as rows in a table, with each column representing a property or attribute.
    • Columns can be customized to show names, types, icons, checkboxes, or other relevant data.
    • Optional row headers display row numbers, selection checkboxes, or icons.
  • Selection Controls:
    • Click to select a row; use Ctrl + click for multi-select, Shift + click for range selection.
    • Checkboxes may be shown for bulk selection and actions.
  • Column Headers:
    • Display property names and may support sorting or grouping.
    • Headers can be hidden or stacked for advanced layouts.
  • Row Attributes:
    • Selected, checked, and focused rows are visually highlighted.
    • Custom HTML attributes can be added for integration with scripts or styling.

Interactive Features

  • Mouse Operations:
    • Click to select, Ctrl + click to multi-select, Shift + click to select a range.
  • Keyboard Navigation:
    • Up/Down: Move up and down the list.
    • Home/End: Jump to the first or last entry.
    • Shift + Up/Down: Multi-select.
    • Shift + Home/End: Multi-select to first or last entry.
  • Multi-Select and Bulk Actions:
    • Supports selecting multiple rows for batch operations.
    • Options such as MultiSelect, ShowCheckboxes, and SelectAll enable advanced selection scenarios.
  • Customizable Columns:
    • Developers can define custom columns by extending the ColumnInfo class.
    • Columns support custom names, widths, alignment, and value formatting.

Usage Guidance

Use Object List to display and manage collections of items in Grooper, such as Batch Folders, Documents, or configuration objects. Configure columns to show the most relevant data for your workflow. Enable multi-select and checkboxes for batch actions, and leverage keyboard shortcuts for rapid navigation.

  • For reviewing large sets of items, enable fixed-width and auto-select options for consistent layout and usability.
  • Use custom row attributes and icons to provide visual cues and integrate with client-side scripts.
  • Hide headers or stack columns for advanced layouts and compact displays.

Example

// Example: Object List with custom columns | Name | Type | Status | |--------------|--------------|----------| | Invoice 001 | Document | Complete | | Folder A | Batch Folder | Pending |

Accessibility

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

Derived Types

There are 13 implementations of Object List.

Candidate Type List Displays the list of candidate Content Types in a tabular format, including type name/path and similarity/confidence score.
CMIS Object List Displays a list of CMIS Objects (i.e. folders and documents).
CMIS Results List Displays a list of results from a CMISQL Query.
Data Row List Displays a list of rows returned from a database query.
Document List Displays a list of Batch Objects.
Instance List Displays a list of Data Instances with location attributes for anchor validation and review.
Instance Result Set Displays the results of a data instance search in a customizable, tabular grid.
Node List Displays a list of nodes.
Principal List Displays a list of security principals (i.e. users or groups) in a tabular, interactive format for selection and management.
Reflection List Displays a list of objects showing all listable properties for the object type as columns.
Search Result List Displays an AI Search result set in a tabular layout.
String List Displays a list of strings.
Table Info List Displays a list containing information about the tables and views available on a Data Connection.

Used By

Notification