List (PRIM_MD.List)
Simple list control with inplace designable list entry
Ancestors - Control (PRIM_CTRL) Object (PRIM_OBJT)
PRIM_MD.List is a simple material list control that has inplace designable items. Each instance is presented as an item in a typical tree structure. It is the developer's responsibility to show indentation and expand/collapse information. However, when items are expanded or collapsed, the list will manage the items and show or hide the appropriate ones. The inline designer allows for dragging and dropping controls into the list. Supported column types - Edit, SpinEdit, DateTime, Flat Button, Raised Button, Switch and CheckBox.
This example shows a simple list with a number and button. 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(569) Width(633) Theme(#SYS_THEME) Layoutmanager(#LayoutPage) Define_Com Class(#PRIM_TBLO) Name(#LayoutPage) Define_Com Class(#PRIM_TBLO.Row) Name(#LayoutPageRow) Displayposition(1) Parent(#LayoutPage) Define_Com Class(#PRIM_TBLO.Column) Name(#LayoutPageColumn) Displayposition(1) Parent(#LayoutPage) Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutPageItem) Column(#LayoutPageColumn) Manage(#List) Parent(#LayoutPage) Row(#LayoutPageRow) Define_Com Class(#PRIM_TBLO) Name(#LayoutList) Define_Com Class(#PRIM_TBLO.Column) Name(#LayoutListColumn1) Parent(#LayoutList) Displayposition(1) Define_Com Class(#PRIM_TBLO.Column) Name(#LayoutListColumn2) Displayposition(2) Parent(#LayoutList) Units(Pixels) Width(120) Define_Com Class(#PRIM_TBLO.Row) Name(#LayoutListRow) Parent(#LayoutList) Displayposition(1) Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutListItem1) Manage(#ListSpinEdit) Parent(#LayoutList) Row(#LayoutListRow) Column(#LayoutListColumn1) Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutListItem2) Column(#LayoutListColumn2) Manage(#ListRaisedButton) Parent(#LayoutList) Row(#LayoutListRow) Marginbottom(20) Margintop(20) Define_Com Class(#prim_md.List) Name(#List) Parent(#COM_OWNER) Displayposition(1) Tabposition(1) Left(0) Top(0) Height(569) Width(633) Layoutmanager(#LayoutList) Rowheight(79) Define_Com Class(#PRIM_MD.ListSpinEdit) Name(#ListSpinEdit) Caption('Caption') Displayposition(2) Dragstyle(None) Left(0) Parent(#List) Tabposition(1) Top(0) Height(79) Width(513) Source(#xDemoNumber) Define_Com Class(#PRIM_MD.ListRaisedButton) Name(#ListRaisedButton) Caption('Delete') Displayposition(1) Dragstyle(None) Left(513) Parent(#List) Tabposition(3) Top(20) Height(39) Width(120) Evtroutine Handling(#Com_owner.CreateInstance) Begin_Loop Using(#xDemoNumber) To(10) Add_Entry To_List(#List) #ListRaisedButton.CurrentItem.Visible := (#xDemoNumber.mod( 2 ) = 0) End_Loop Endroutine Evtroutine Handling(#ListRaisedButton.Click) Dlt_Entry Number(#List.CurrentItem.Entry) Endroutine End_Com
| Name | Description |
|---|---|
| BusyUpdates | BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL) |
| BusyUpdatesOfParent | BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL) |
| CanFocus | CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL) |
| ComponentClassName | ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
| ComponentMembers | ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) |
| ComponentPatternName | ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) |
| ComponentTag | Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) |
| ComponentType | ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) |
| ComponentTypeName | ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) |
| CurrentItem | The last item in the list touched either in the UI or via a list related command |
| CurrentPage | Specifies the current page displayed by the list |
| Cursor | Cursor sets the cursor image Inherited from Control (PRIM_CTRL) |
| DisplayPosition | DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL) |
| DragStyle | DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL) |
| Enabled | Enable activates/deactivates the component Inherited from Control (PRIM_CTRL) |
| Filter | String to be searched for to filter the list |
| FixedPosition | Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL) |
| Focus | Focus tells whether the component has focus Inherited from Control (PRIM_CTRL) |
| FocusedStyle | Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
| FocusedStyles | Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
| FocusItem | Reference to the focus item in the list |
| Handle | Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL) |
| Height | The height of the control in pixels Inherited from Control (PRIM_CTRL) |
| Hint | Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL) |
| HintPopup | HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL) |
| HintShow | Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL) |
| HintShowOfParent | Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL) |
| HintTitle | HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL) |
| IsAnimating | IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL) |
| IsRealized | True if the control is currently realized Inherited from Control (PRIM_CTRL) |
| ItemMarginBottom | Bottom margin of an item in pixels |
| ItemMarginLeft | Left margin of an item in pixels |
| ItemMarginRight | Right margin of an item in pixels |
| ItemMarginTop | Top Margin of an item in pixels |
| Items | Collection of all items |
| ItemsPerRow | Number of Items to be presented in a row |
| ItemThemeDrawStyle | Name of the Theme DrawStyle to be applied to the items |
| LayoutManager | Reference to a layout manager used to control the position of child controls |
| Left | Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL) |
| Modified | Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL) |
| MouseOver | MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL) |
| MouseOverStyle | MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
| MouseOverStyles | MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| Opacity | Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL) |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL) |
| Popup | Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL) |
| PopupMenu | Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL) |
| Rotation | Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL) |
| RotationOriginLeft | RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
| RotationOriginTop | RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
| RowHeight | Height of a row in pixels |
| RowsPerPage | Amount of rows to be displayed on the page |
| ScaleHeight | ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
| ScaleOriginLeft | ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
| ScaleOriginTop | ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
| ScaleWidth | ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
| ScreenLeft | ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL) |
| ScreenTop | ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL) |
| ScrollLeft | Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
| ScrollTop | Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
| ShowPages | Specifies if the list will be displayed in pages |
| SkewLeft | SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL) |
| SkewOriginLeft | SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
| SkewOriginTop | SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
| SkewTop | SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL) |
| Style | Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL) |
| Styles | Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL) |
| TabPosition | TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL) |
| TabStop | Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL) |
| ThemeDrawStyle | Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL) |
| Top | Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL) |
| TouchMove | Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL) |
| TouchRotate | Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL) |
| TouchScale | Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL) |
| TouchSize | Determines whether a control can be resized Inherited from Control (PRIM_CTRL) |
| VerticalScrollPos | VerticalScrollPos sets the position of the vertical scroll bar |
| VerticalScrollRemainder | Specifies the pixels remaining to the bottom from the current scroll position |
| Visible | Show or hide the control Inherited from Control (PRIM_CTRL) |
| VisualStyle | VisualStyle sets the appearance Inherited from Control (PRIM_CTRL) |
| VisualStyleOfParent | Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL) |
| Width | Width of the component in pixels Inherited from Control (PRIM_CTRL) |
| Name | Description |
|---|---|
| AnimationEnded | Fired when an animation is ended Inherited from Control (PRIM_CTRL)
Cancelled |
| Changed | Fired when the list changes |
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL) |
| DragDrop | 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 |
| DragOver | 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 |
| EndDrag | Fired when the drag and drop process has completed Inherited from Control (PRIM_CTRL)
Source, Payload, DragResult, AggregatedSource, Origin, Handled |
| GotFocus | Fired when the item receives the focus |
| Initialize | Fired after a component has been realized for the first time Inherited from Control (PRIM_CTRL) |
| ItemClick | Fired when an item is clicked
Item |
| ItemCollapsed | An item in the list has collapsed
Item |
| ItemDoubleClick | Fired when the user double clicks an item in the list
Item |
| ItemExpanding | An item in the list is expanding
Item |
| ItemGotFocus | Fired when the item receives the focus
Item |
| ItemGotSelection | Fired when an item in the list becomes selected
Item |
| ItemLostFocus | Fired when the control loses focus
Item |
| ItemLostSelection | ItemLostSelection happens when another item is selected
Item |
| ItemMouseEnter | The mouse has entered the bounds of the item
Item |
| ItemMouseHover | The mouse is hovering over the item
Item |
| ItemMouseLeave | The mouse has left the bounds of the item
Item |
| ItemRealizing | Fired when an item design instance is realized, typically when the it comes in to the view port
Item |
| LostFocus | Fired when the item loses focus |
| MouseEnter | The mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL) |
| MouseHover | The mouse has hovered over the control Inherited from Control (PRIM_CTRL)
Origin, Handled |
| MouseLeave | The mouse has left the bounds of the control Inherited from Control (PRIM_CTRL) |
| ScrollChanged | Fired when the scrollbars in a composite control are moved
Orientation |
| StartDrag | Fired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled |
| TouchChange | 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 |
| TouchEnd | Fired when the user stops touching the screen Inherited from Control (PRIM_CTRL) |
| TouchStart | Fired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize |
| Name | Description |
|---|---|
| DeleteAll | Delete all items in the list |
| FadeIn | Animate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay |
| FadeOut | Animate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible |
| FindReference | Find an object stored as a RelatedReference
Result, RelatedReference, StartItem |
| MoveFrom | Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay |
| MoveTo | Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay |
| Realize | Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
| Scale | Animate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay |
| SetFocus | Sets the control to be the focus control Inherited from Control (PRIM_CTRL) |
| ShowMessages | LANSA Internal Use Inherited from Control (PRIM_CTRL) |
| SizeTo | Inherited from Control (PRIM_CTRL)
Width, Height, Duration, Delay |
| Unrealize | Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
| UpdateDisplay | UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL) |
EPC1420030 V14sp2 November 2018