List (PRIM_LIST)
Tree and list control supporting data entry and user defined cells
Ancestors - Control (PRIM_CTRL)Object (PRIM_OBJT)
Details
The List control is a highly functional list that supports tree structures, data entry and user defined cell content.
In its simplest form, List is a typical two dimensional column based LANSA list control managed by the LANSA list commands, such as ADD_ENTRY, GET_ENTRY, SELECTLIST etc. Each column has a source field and data values are mapped in and out of the list as items are used.
List can also be used as a tree. List Items can be parented to other list items and the List control will manage the appearance, expanding and collapsing items as required.
Unlike other LANSA list controls such as Tree and Grid which use a single column type, List has specific column types to support the different types of content. This extends beyond the typical field based columns to include image, check box, button and reusable part.
Supported column types - string, number, date time, image, button, check box and reusable part.
List also supports the use of dataless columns. For example, a list may consist of nothing more that checkboxes if required. Rather than relying on field values the column currentitem property can be accessed.
Columns work in 2 ways. Firstly, the definition of the column is used as a prototype when an entry is added. So, a button column defined with a caption of "Delete" will show a button in each item with a caption of "Delete". Secondly, all column types have a CurrentItem property that provides access to the individual instance.
List is also used as the basis for the DropDown control. The result is that all the features available in list are also available in the drop down area of DropDown.
Note
Example
This example shows a simple list with a number and button columns. The button is hidden if the row is an even numbered row. Clicking the button will delete the row.
Begin_Com Role(*EXTENDS #PRIM_WEB) Height(456) Width(864) Layoutmanager(#TableLayout1)
Define_Com Class(#PRIM_TBLO) Name(#TableLayout1)
Define_Com Class(#PRIM_TBLO.Column) Name(#Column1) Displayposition(1) Parent(#TableLayout1)
Define_Com Class(#PRIM_TBLO.Row) Name(#Row1) Displayposition(1) Parent(#TableLayout1)
Define_Com Class(#PRIM_TBLO.Item) Name(#List1Item1) Column(#Column1) Manage(#List) Parent(#TableLayout1) Row(#Row1)
Define_Com Class(#PRIM_LIST) Name(#List) Displayposition(1) Left(0) Parent(#COM_OWNER) Tabposition(1) Top(0) Height(456) Width(864) Rowheight(33)
Define_Com Class(#PRIM_LIST.Number) Name(#ColumnXDEMONUMB1) Displayposition(1) Increment(1) Parent(#List) Source(#xDemoNumber) Wrap(False)
Define_Com Class(#PRIM_LIST.Button) Name(#ColumnButton1) Columnwidth(100) Displayposition(2) Parent(#List) Caption('Delete') Cellsizing(None) Cellwidth(80)
Evtroutine Handling(#Com_Owner.CreateInstance)
Begin_Loop Using(#xDemoNumber) To(10)
Add_Entry To_List(#List)
#ColumnButton1.CurrentItem.Visible := (#xDemoNumber.mod( 2 ) = 0)
End_Loop
Endroutine
Evtroutine Handling(#ColumnButton1.Click)
Dlt_Entry Number(#List.CurrentItem.Entry)
Endroutine
End_Com
Properties
Name | Description |
|---|---|
ThemeDrawStyle to be applied to alternate items | |
Automatically select the first item when the list is loaded | |
BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL) | |
BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL) | |
CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL) | |
Show a checkbox for each item in the list | |
Specifies whether columns can be reordered by the user | |
Height of the column header area in pixels | |
Determines how column headers will resize | |
Show the column separator lines | |
Left Margin of column in pixels | |
Right Margin of column in pixels | |
Style applied to the column heading when mouse over | |
Collection of styles applied to the column heading when mouse over | |
Style applied to the column heading on mouse down | |
Collection of styles applied to the column heading on mouse down | |
Collection of columns defined for the list | |
Show the column sort arrow if the primary sort | |
Style applied to the column heading on mouse down | |
Collection of styles applied to the column heading | |
Name of the Theme DrawStyle to be applied to the column headings | |
ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) | |
ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) | |
ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) | |
Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) | |
ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) | |
ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) | |
Base class for all Prim_List Current Item classes | |
Specifies the current page to be displayed | |
Cursor sets the cursor image Inherited from Control (PRIM_CTRL) | |
DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL) | |
DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL) | |
Enable activates/deactivates the component Inherited from Control (PRIM_CTRL) | |
EnterKeyStyle determines what happens when Enter key is pressed in a list | |
String to be searched for to filter the list | |
Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL) | |
Focus tells whether the component has focus Inherited from Control (PRIM_CTRL) | |
Reference to the active column in the list | |
Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL) | |
Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL) | |
Reference to the focus item in the list | |
Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL) | |
The height of the control in pixels Inherited from Control (PRIM_CTRL) | |
Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL) | |
HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL) | |
Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL) | |
Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL) | |
HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL) | |
HorizontalScrollInc specifies the pixel increment for horizontal scroll bar. | |
HorizontalScrollPos sets the position of the horizontal scroll bar | |
IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL) | |
True if the control is currently realized Inherited from Control (PRIM_CTRL) | |
Collection of items in the list | |
Name of the Theme DrawStyle to be applied to the items | |
Determines how the list will position based on keyboard input | |
Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL) | |
Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL) | |
Controls when the Modified property is set to True | |
MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL) | |
MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) | |
MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) | |
Name identifies the component Inherited from Object (PRIM_OBJT) | |
NotificationStyle controls how events are triggered | |
Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL) | |
Owner owns this component Inherited from Object (PRIM_OBJT) | |
Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL) | |
Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL) | |
Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL) | |
Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL) | |
RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) | |
RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) | |
Height of a row in pixels | |
Show the row separator lines | |
Allow rows to be resized | |
Determines how rows will resize | |
Specifies how many rows will appear per page | |
ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) | |
ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) | |
ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) | |
ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) | |
ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL) | |
ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL) | |
Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) | |
Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) | |
SelectedRowCount shows how many columns have been selected | |
Specifies the rules for item selection within the list | |
Show or hide the paging buttons | |
SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL) | |
SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) | |
SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) | |
SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL) | |
Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL) | |
Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL) | |
TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL) | |
Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL) | |
Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL) | |
Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL) | |
Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL) | |
Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL) | |
Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL) | |
Determines whether a control can be resized Inherited from Control (PRIM_CTRL) | |
Show or hide the expand/collapse images | |
VerticalScrollInc specifies the pixel increment for vertical scroll bar. | |
VerticalScrollPos sets the position of the vertical scroll bar | |
Specifies if a list is a virtualized. | |
Show or hide the control Inherited from Control (PRIM_CTRL) | |
VisualStyle sets the appearance Inherited from Control (PRIM_CTRL) | |
Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL) | |
Width of the component in pixels Inherited from Control (PRIM_CTRL) |
Events
Name | Description |
|---|---|
Fired when an animation is ended Inherited from Control (PRIM_CTRL) Cancelled | |
Changed is a change in the component | |
CreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL) | |
DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL) | |
Fired on mouse up to signify the end of a drag process Inherited from Control (PRIM_CTRL) PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult | |
Fired during the drag and drop process when the cursor moves over the control Inherited from Control (PRIM_CTRL) PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled | |
Fired when the drag and drop process has completed Inherited from Control (PRIM_CTRL) Source, Payload, DragResult, AggregatedSource, Origin, Handled | |
Fired when the Enter key is pressed KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled | |
Fired when the control receives the focus | |
Fired after a component has been realized for the first time Inherited from Control (PRIM_CTRL) | |
ItemChanged happens when an item is changed Item | |
Fired when an item is clicked Item | |
An item in the list has collapsed Item | |
Fired when the user double clicks an item in the list Item | |
An item in the list is expanding Item | |
Fired when an item receives the focus Item | |
Fired when an item in the list becomes selected Item | |
Fired when the item loses focus Item | |
ItemLostSelection happens when another item is selected Item | |
The mouse has entered the bounds of the item Item | |
The mouse is hovering over the item Item | |
The mouse has left the bounds of the item Item | |
Fired when an item design instance is realized, typically when the it comes in to the view port Item | |
Fired when a key is pressed on the keyboard KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled | |
LostFocus happens when a component is no longer active | |
The mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL) | |
The mouse has hovered over the control Inherited from Control (PRIM_CTRL) Origin, Handled | |
The mouse has left the bounds of the control Inherited from Control (PRIM_CTRL) | |
Fired when the scrollbars in a composite control are moved Orientation | |
Fired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL) Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled | |
Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Control (PRIM_CTRL) MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue | |
Fired when the user stops touching the screen Inherited from Control (PRIM_CTRL) | |
Fired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL) Origin, TouchMove, TouchRotate, TouchScale, TouchSize |
Methods
Name | Description |
|---|---|
Exports list data to text file FileName, Type | |
Animate from invisible to visible Inherited from Control (PRIM_CTRL) Duration, Delay | |
Animate from visible to invisible Inherited from Control (PRIM_CTRL) Duration, Delay, Visible | |
Executes the OnFind method on the design interface for all list items Result, Key, StartItem | |
Find an object stored as a RelatedReference Result, RelatedReference, StartItem | |
Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay | |
Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay | |
Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) | |
Animate a change of scale Inherited from Control (PRIM_CTRL) ScaleWidth, ScaleHeight, Duration, Delay | |
Sets the control to be the focus control Inherited from Control (PRIM_CTRL) | |
LANSA Internal Use Inherited from Control (PRIM_CTRL) | |
Changes and animates control size changing Inherited from Control (PRIM_CTRL) Width, Height, Duration, Delay | |
Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) | |
UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL) | |
Set the vertical scroll position using an item Item, ScrollPosition |