Hierarchical List ComponentLocate this document in the navigation structure

Definition

A generic design template for displaying data in a hierarchical list (also known as a tree list). A hierarchical list is a list of items arranged on interdependent successive levels. Certain items in a hierarchical list are associated with nodes that may be expanded to display further lists below them. Each item in a lower level list has a parent/child relationship with the item in the higher level list whose node was expanded.

It is implemented using the Web Dynpro component FPM_TREE_UIBB.

The information displayed in a hierarchical list at runtime is determined by the feeder class assigned to the configuration of the Web Dynpro component FPM_TREE_UIBB.

Use

You use this design template in application-specific views where you want to display data in a hierarchical list. You can determine the concrete display of the data in a hierarchical list when configuring the Web Dynpro component FPM_TREE_UIBB.

Structure

A hierarchical list consists of a number of rows and columns. It is displayed as a table at runtime. It has the following components:

  • Master Column

    The master column displays all the items in a list. When the system first displays the list, each top-level, parent item in the master column is preceded by an Expand or Collapse icon, which allows you to see the child (sub) items contained within it. A top-level item in the master column with no child items has no Expand or Collapse icon preceding it.

    The master column is always visible; you cannot hide this column.

    The master column is always displayed as the first column in a table; you cannot move its position in a table.

    The hierarchical list component permits incremental loading of data, meaning that data relating to sub-lists can be loaded into the application only when the node is expanded.

  • Non master columns

    These columns display the details of each list item.

  • Rows

    Each item in a list is displayed in a separate row.

  • Toolbar

    A toolbar displays the Collapse All and Expand All buttons (if selected) and other buttons that you or the application have created.

If the application has enabled sorting, a small arrow appears in the bottom-right corner of the column heading at runtime allowing you to perform this function.

Hierarchical list components may contain an action column containing several one-click action controls.

Integration

You configure this component using the FPM configuration editor, FLUID.

You can configure, amongst others, the following attributes of this component:

  • The appearance of the list at runtime

    You can determine the number of columns and rows that the system displays, the order in which the columns are arranged, and which display types are used in each column (for example, Caption, Link to URL, Link to Action, Checkbox display types). You can also determine the width of the table. You can choose not to display empty rows in the list and also choose to hide an entire table if all the rows are empty. The No. of Fixed Columns field allows you to determine the number of columns that remain fixed on the screen as you scroll through the column headings. You can export the list to a spreadsheet.

  • Lead selection when the list is first displayed

    The Set Lead Selection on Open field determines whether a lead selection in the list is set when it is displayed by the system for the first time. An FPM event is associated with a lead selection at runtime. You can change this to one that may be defined in the relevant feeder class of the component by choosing the Lead Selection Action Assignment button on the object schema table.

  • Show or hide the Expand All Nodes and Collapse All Nodes buttons on the toolbar

    You can choose to hide this button set; an extremely large list could cause performance issues if these buttons are selected by a user at runtime.

  • Sort Function

    Sorting is enabled or disabled by the application. However, the Sorting field allows you to configure these settings yourself. You can decide how the user accesses the sorting function (through the column headings, through the Personalization dialog box, or through both of these) or if the function should be disabled. If the sorting function is enabled only in the column headers, the Sorting tab is not visible in the Personalization dialog box. If the application disables the sort function, you cannot enable it by configuration.

For more information on the attributes of this component, choose the More Field Help option from the context menus of the individual GUIBB elements.

This component can be personalized by the user at runtime.