GUI component

A GUI component represents a part of the Graphical User Interface (GUI) for your application.

A GUI component consists of the following elements:

Name

This is used to identify the GUI component within the entity that it is associated with. When a GUI component is created it will be given a default name based on its entity and type.

Entity

A GUI component is associated with exactly one entity and there can be many GUI components for the same entity. The entity for a GUI component determines what data will be available to be displayed.

Type

The type determines how the GUI component will display its entity.

The following types are available:

Type Description
List A list GUI component displays a list of entity instances for its associated entity.
Detail A detail GUI component displays the details of entity instances for its associated entity.

Columns

Columns are only applicable to list GUI components. List GUI components have a column for each attribute in its associated entity.

Fields

Fields are only applicable to detail GUI components. Detail GUI components have a field for each attribute in its associated entity.

Paging enabled

This is only applicable to list GUI components. If a list GUI component has paging enabled, it will display only display a maximum of page size entity instances on a single page, and provide the user with a means of accessing the other pages.

Page size

This is only applicable to list GUI components that have paging enabled. This specifies that maximum number of entity instances that will be displayed on a single page.

Links

A GUI component has links to other GUI components. Links are used to define the navigation pathways between GUI components.

Related concepts

Entity

Related tasks

Creating a GUI component
Creating a link

Related reference

List details
Detail details