List Badge control (PRIM_MD.ListBadge)
Badge that is repeated for each entry in the list
Ancestors - Badge (PRIM_MD.Badge) Label (PRIM_MD.Label) Control (PRIM_MD.Control) Control (PRIM_CTRL) Object (PRIM_OBJT)
Prim_MD.ListBadge is a Badge in a List. Each Badge type has a corresponding CurrentItem class that provides access to the individual entries accessible via the CurrentItem property. A list Badge control is created whenever a badge is dragged and dropped onto another control contained in a list from the controls view.
In this example the badge is the orphan of a flat button that is in the list. When the the button is clicked the badge of the current item will display the number of time the button was clicked as its caption.
Begin_Com Role(*EXTENDS #PRIM_WEB) Height(241) 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) sizing(FitBoth) Define_Com Class(#PRIM_TBLO) Name(#LayoutList) Define_Com Class(#PRIM_TBLO.Row) Name(#LayoutListRow) Parent(#LayoutList) Displayposition(1) Define_Com Class(#PRIM_TBLO.Column) Name(#LayoutListColumn) Parent(#LayoutList) Displayposition(1) Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutListItem) Column(#LayoutListColumn) Manage(#ListButton) Parent(#LayoutList) Row(#LayoutListRow) Row(#LayoutListRow) Marginbottom(10) Marginleft(10) Marginright(10) Margintop(10) sizing(FitBoth) Define_Com Class(#prim_md.List) Name(#List) Parent(#COM_OWNER) Displayposition(1) Tabposition(1) Left(0) Top(0) Height(241) Width(633) Layoutmanager(#LayoutList) Define_Com Class(#Prim_md.ListFlatButton) Name(#ListButton) Parent(#List) Displayposition(1) Tabposition(1) Height(30) Width(613) Define_Com Class(#PRIM_MD.ListBadge) Name(#ListBadge) Displayposition(1) Dragstyle(None) Tabposition(1) Height(16) Width(16) Parent(#ListButton) Left(607) Top(-10) Visible(False) Evtroutine Handling(#Com_owner.CreateInstance) Begin_Loop To(10) Add_Entry To_List(#List) #ListButton.CurrentItem.Caption := 'Click Me' End_Loop Endroutine Evtroutine Handling(#ListButton.Click) #ListBadge.CurrentItem.Visible := True #ListBadge.CurrentItem.Caption := (#ListBadge.CurrentItem.Caption.AsNumber + 1).AsString Endroutine End_Com
| Name | Description |
|---|---|
| BadgeAlignment | Position of the badge relative to the Control Inherited from Badge (PRIM_MD.Badge) |
| BadgeMarginBottom | Bottom margin in pixels Inherited from Badge (PRIM_MD.Badge) |
| BadgeMarginLeft | Left margin in pixels Inherited from Badge (PRIM_MD.Badge) |
| BadgeMarginRight | Right margin in pixels Inherited from Badge (PRIM_MD.Badge) |
| BadgeMarginTop | Top margin in pixels Inherited from Badge (PRIM_MD.Badge) |
| BadgeSizing | Specifies the sizing behaviour of the Badge Inherited from Badge (PRIM_MD.Badge) |
| 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) |
| Caption | Text to be displayed within the label Inherited from Label (PRIM_MD.Label) |
| CaptionAlignment | Position of the caption within the control Inherited from Label (PRIM_MD.Label) |
| CaptionMarginBottom | Bottom margin in pixels Inherited from Label (PRIM_MD.Label) |
| CaptionMarginLeft | Left margin in pixels Inherited from Label (PRIM_MD.Label) |
| CaptionMarginRight | Right margin in pixels Inherited from Label (PRIM_MD.Label) |
| CaptionMarginTop | Top margin in pixels Inherited from Label (PRIM_MD.Label) |
| 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 |
| 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) |
| Ellipses | Show ellipses for truncated text Inherited from Label (PRIM_MD.Label) |
| Enabled | Enable activates/deactivates the component Inherited from Control (PRIM_CTRL) |
| 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 badge in the focus entry of 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) |
| Icon | Image displayed within the control Inherited from Label (PRIM_MD.Label) |
| IconAlignment | Position of the icon within the control Inherited from Label (PRIM_MD.Label) |
| IconColor | Color to be applied to the icon Inherited from Label (PRIM_MD.Label) |
| IconFileName | FileName is the name of image file Inherited from Label (PRIM_MD.Label) |
| IconHeight | Height of the icon in pixels Inherited from Label (PRIM_MD.Label) |
| IconImage | Material design image to show on the control Inherited from Label (PRIM_MD.Label) |
| IconImageSizing | Specifies the sizing behaviour of the IconImage Inherited from Label (PRIM_MD.Label) |
| IconMarginBottom | Bottom margin in pixels Inherited from Label (PRIM_MD.Label) |
| IconMarginLeft | Left margin in pixels Inherited from Label (PRIM_MD.Label) |
| IconMarginRight | Right margin in pixels Inherited from Label (PRIM_MD.Label) |
| IconMarginTop | Top margin in pixels Inherited from Label (PRIM_MD.Label) |
| IconOpacity | Percentage opacity of the icon Inherited from Label (PRIM_MD.Label) |
| IconPadding | Padding of the icon in pixels Inherited from Label (PRIM_MD.Label) |
| IconThemeDrawStyle | Name of the Theme DrawStyle to be applied to the icon Inherited from Label (PRIM_MD.Label) |
| 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) |
| 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) |
| PaddingBottom | Bottom padding in pixels Inherited from Label (PRIM_MD.Label) |
| PaddingLeft | Left padding in pixels Inherited from Label (PRIM_MD.Label) |
| PaddingRight | Right padding in pixels Inherited from Label (PRIM_MD.Label) |
| PaddingTop | Top padding in pixels Inherited from Label (PRIM_MD.Label) |
| Parent | Reference to the prim_md.list containing the control |
| 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) |
| 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) |
| 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) |
| ThemeBackground | Background theme to be used Inherited from Control (PRIM_MD.Control) |
| 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) |
| 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) |
| WordWrap | Wrap text on to the next line if there is insufficient space Inherited from Label (PRIM_MD.Label) |
| Name | Description |
|---|---|
| AnimationEnded | Fired when an animation is ended Inherited from Label (PRIM_MD.Label)
Cancelled |
| Click | Fired when the mouse is clicked on the control Inherited from Label (PRIM_MD.Label)
Origin, Handled |
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from Label (PRIM_MD.Label) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Label (PRIM_MD.Label) |
| DragDrop | Fired on mouse up to signify the end of a drag process Inherited from Label (PRIM_MD.Label)
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 Label (PRIM_MD.Label)
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled |
| EndDrag | Fired when the drag and drop process has completed Inherited from Label (PRIM_MD.Label)
Source, Payload, DragResult, AggregatedSource, Origin, Handled |
| Initialize | Fired after a component has been realized for the first time Inherited from Label (PRIM_MD.Label) |
| MouseEnter | The mouse has entered the bounds of the control Inherited from Label (PRIM_MD.Label) |
| MouseHover | The mouse has hovered over the control Inherited from Label (PRIM_MD.Label)
Origin, Handled |
| MouseLeave | The mouse has left the bounds of the control Inherited from Label (PRIM_MD.Label) |
| StartDrag | Fired when the user starts a drag and drop process Inherited from Label (PRIM_MD.Label)
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 Label (PRIM_MD.Label)
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue |
| TouchEnd | Fired when the user stops touching the screen Inherited from Label (PRIM_MD.Label) |
| TouchStart | Fired when the user first makes physical contact with the screen Inherited from Label (PRIM_MD.Label)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize |
| Name | Description |
|---|---|
| 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 |
| 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