B4A Library [Class] CheckList

Informatix · Jul 27, 2012

New version 2.0:
I added more than 10 new functions;
I changed the ID type (formerly Int) to Object (that shouldn't break the existing code);
I added the Drag & Drop feature;
I optimized JumpToPosition (a lot quicker now);
I fixed a bug with colors.

COMPLETE LIST OF FUNCTIONS:

Initialize(Module As Object, svList As ScrollView, subCheck As String, subClick As String, subLongClick As String, DividerHeight As Int)
' Initializes the ScrollView.

AddItem(ID As Object, Checked As Boolean, Text1 As String, Text2 As String, Image As Bitmap)
' Adds a item (the created panel contains a checkbox, an optional bitmap and one or two labels)

AddItemNoChkbx(ID As Object, Text1 As String, Text2 As String, Image As Bitmap)
' Adds a item without checkbox (the created panel contains an optional bitmap and one or two labels)

AddCustomItem(ID As Object, pnl As Panel, pnlHeight As Int)
' Adds a custom item (a panel holding your custom layout)

AddHeader(Text As String)
' Adds a header

ResizePanel()
' Resizes the ScrollView panel height (must be called when all items are added)

MoveItem(StartPosition As Int, EndPosition As Int)
' Moves an item from StartPosition to EndPosition

SwapItems(PosItem1 As Int, PosItem2 As Int)
' Swaps the position of the given items

ReplaceItem(Position As Int, NewPanel As Panel, NewHeight As Int)
' Replaces an item panel by another

RemoveItemAt(Position As Int)
' Removes the item at the given position

RemoveItemID(ID As Object)
' Removes the item with the given ID

CreateTagList(ViewIndexInPanel As Int, FirstPosition As Int, LastPosition As Int) As List
' Creates a tag list with items between FirstPosition and LastPosition

CreateTextList(ViewIndexInPanel As Int, FirstPosition As Int, LastPosition As Int) As List
' Creates a text list with items between FirstPosition and LastPosition

CreateCheckedStateList(FirstPosition As Int, LastPosition As Int) As List
' Creates a checked state list (true/false) with items between FirstPosition and LastPosition

SortItems(ValuesToSort As List, FirstPosition As Int, LastPosition As Int, AscendingOrder As Boolean)
' Sorts the items between FirstPosition and LastPosition

getHeight()
' Gets the ScrollView height (works inside a TabHost)

getWidth()
' Gets the ScrollView width (works inside a TabHost)

NumberOfItems()
' Returns the number of items

FindPanelContaining(MyView As View) As Panel
' Returns the panel containing the given view.

AdjustBitmap(bmp As Bitmap, Width As Int, Height As Int) As Bitmap
' Resizes the bitmap to fit the given dimensions

GetFirstText(ID As Object) As String
' Returns the first label text found for the given ID

JumpToPosition(Position As Int) As Panel
' Scrolls the list to the given position

JumpToItem(ID As Object) As Panel
' Scrolls the list to the item with the given ID

JumpToView(MyView As View) As Panel
' Scrolls the list to the given view

CheckedList() As List
' Creates a list with ID of checked items

CheckedPanels() As List
' Creates a list with panels of checked items

CheckAllBoxes(Checked As Boolean)
' Checks/unchecks all checkboxes

RepaintAllItems()
' Applies the new colors (BackgroundColor, CheckedColor, DividerColor, ExtensionColor) to all items

ExtendItem(ItemID As Object, AddedContent As View, ContentHeight As Int)
' Adds an extra content (panel, label, edittext, imageview...) under an item

CollapseItem()
' Removes the extra content

HasExtraContent As Boolean
' Checks if there is an item with extra content

ExtendedItemID As Object
' Returns the ID of the item with extra content

StartDragAndDrop(pnl As Panel, subAfterDrop As String)
' Starts a drag&drop operation

AbortDragAndDrop()
' Aborts the current drag&drop operation

EDIT: New in version 2.1:

CreateIntegerList(ViewIndexInPanel As Int, FirstPosition As Int, LastPosition As Int) As List
' Creates an integer list with items between FirstPosition and LastPosition

FilterTag(ViewIndexInPanel As Int, ComparisonFunction As String) As Int
FilterText(ViewIndexInPanel As Int, ComparisonFunction As String) As Int
' Filters the items and returns the number of matching items.

IsFiltered(Position As Int) As Boolean
' Returns True if the item at the given position is filtered (not visible)

CancelFilter()
' Cancels the filter and displays all items

EDIT: New in version 2.2:

FindPanelWithID(ID As Object) As Object
' Returns the panel with the given ID

SetOnPaintListener(SubName As String)
' Defines an event handler called every time the item background is repaint

Repaint(pnlItem As Panel)
' Applies the new colors (BackgroundColor, CheckedColor, DividerColor, ExtensionColor) to the given item

Informatix · Jul 28, 2012

As you can see in the list, there's no Insert function. Technically, an insert is a add+move, so choose you Add method and move the added item to the right position (its StartPosition is NumberOfItems -1).

In demo #2, I didn't convert the quantities to numbers, hence the sort result with quantities > 9 (they are considered as strings).

Mahares · Jul 29, 2012

I tried to have ONE button to toggle between Check/Uncheck all items, but could not. I had to have 2 separate buttons: Error: Cannot parse as Boolean

B4X:

Sub tglCheck_CheckedChange(Checked As Boolean)
   If lst.CheckAllBoxes(False) Then
      lst.CheckAllBoxes(True) 
   Else
      lst.CheckAllBoxes(False) 
   End If
End Sub

Thank you

Informatix · Jul 29, 2012

Mahares said:
I tried to have ONE button to toggle between Check/Uncheck all items, but could not. I had to have 2 separate buttons: Error: Cannot parse as Boolean

B4X:

Sub tglCheck_CheckedChange(Checked As Boolean) If lst.CheckAllBoxes(False) Then lst.CheckAllBoxes(True) Else lst.CheckAllBoxes(False) End If End Sub

Thank you

CheckAllBoxes doesn't return anything, so you cannot use it this way.
You should use CheckedList to know how many checkboxes are checked and act accordingly. There's not only one answer because there are 3 states (all checked, all unchecked, mixed). One possible solution:

B4X:

If lst.CheckedList.Size > 0 Then
      lst.CheckAllBoxes(False) 
   Else
      lst.CheckAllBoxes(True) 
   End If

Mahares · Jul 29, 2012

You previous suggestion works well Fred.
As a minor observation, lst.CheckAllBoxes(True) takes a little bit of time as it navigates through all items one at a time, especially with 100 or more records, but lst.CheckAllBoxes(False) is instant.
Merci infiniment.

Informatix · Jul 29, 2012

Mahares said:
You previous suggestion works well Fred.
As a minor observation, lst.CheckAllBoxes(True) takes a little bit of time as it navigates through all items one at a time, especially with 100 or more records, but lst.CheckAllBoxes(False) is instant.
Merci infiniment.

This function should run as fast in the two situations, because I do exactly the same thing when the parameter is true and when the parameter is false. And even on a slow device, the function can examine at least one thousand items in less than one second. I suppose the slowness is due to a CheckedChange event which does something when the box is checked. You must block this event when you call CheckAllBoxes (and fire it at the end if needed). The simplest solution is to use a boolean like the one used in the class (BlockCheckEvent).

Mahares · Jul 29, 2012

I used a button click event: Even on a fast device with 4.03 OS, it takes several seconds to check 560 records and about 1 second to uncheck them.

B4X:

'UnCheck / check all boxes to start all over
Sub btnUnCheck_Click   
   If lst.CheckedList.Size > 0 Then lst.CheckAllBoxes(False) Else lst.CheckAllBoxes(True) 

End Sub

Thank you for your reply.

Edited 29 july 12: The reason it takes a while when checked is because of the expansion. If I comment one line, see below code, it is instant like the UNcheck:

B4X:

Sub ChkBx_CheckedChange(Checked As Boolean)
   Dim pnl As Panel
   pnl = lst.FindPanelContaining(Sender)
   If Checked Then
'      ExpandItem(pnl, pnl.Tag)
   Else

Informatix · Jul 30, 2012

My previous post explained how to prevent that.

Informatix · Aug 17, 2012

New version (v2.1):
I added functions to filter the list;
I added CreateIntegerList to ease the sorting and filtering of integer values;
Now you can change the item height in ReplaceItem.

The sorting issue in demo #2 is fixed.

Fred

Informatix · Sep 2, 2012

New version

v2.2:
I fixed a bug (BackgroundColor was not applied to new items)

I added new functions:
- FindPanelWithID(ID As Object) As Object
'Returns the panel with the given ID
- SetOnPaintListener(SubName As String)
'Defines an event handler called every time the item background is repaint
- Repaint(pnlItem As Panel)
'Applies the new colors (BackgroundColor, CheckedColor, DividerColor, ExtensionColor) to the given item

I renamed ApplyColors to RepaintAllItems
'Applies the new colors (BackgroundColor, CheckedColor, DividerColor, ExtensionColor) to all items

I updated the demo #2

You can set now a listener for the OnPaint events. That allows you to highly customize the appareance of the list.

moster67 · Sep 12, 2012

Fred,

Finally I found some time to study your code/demos and an opportunity to implement some of your work in an app. This class is so flexible and playing around with it, I see many possible scenarios where it will be useful.

Thank you Fred for this incredible class. :sign0188:

Informatix · Sep 12, 2012

moster67 said:
Fred,

Finally I found some time to study your code/demos and an opportunity to implement some of your work in an app. This class is so flexible and playing around with it, I see many possible scenarios where it will be useful.

Thank you Fred for this incredible class. :sign0188:

I am writing a class even better. With it you are able to load an almost unlimited number of items, including bitmaps, without risking an Out of Memory error. It also loads items faster. It won't probably be free (nothing is decided yet about the licensing model).
The idea is to offer exactly the same functions as CheckList. Thus a user will have just to substitute the old class by the new one.

moster67 · Sep 12, 2012

Wow!

I am really impressed with your creativeness and professional coding. Look forward to that class too.

moster67 · Sep 16, 2012

Fred,

maybe it is already possible (there are so many possibilities in your class) but I was unable to figure it out. Is there a way to make the LabelHeight adjust automatically - some kind of auto-wrapping?

For instance using this:

B4X:

lst.AddItemNoChkbx(i, "Example - Line #" & i, "Second line" & CRLF & "third line added by me", Null)

will not show third line added by me since the height of the label is not enough.

Normally I can use MeasureMultilineTextHeight from the StringUtil-library to adjust the label-height. I tried it within your class but I couldn't get it to work.

Any ideas how to to get auto-wrapping working?

Thanks!

Informatix · Sep 16, 2012

moster67 said:
Fred,

maybe it is already possible (there are so many possibilities in your class) but I was unable to figure it out. Is there a way to make the LabelHeight adjust automatically - some kind of auto-wrapping?

It's not done automatically, but it's easy to implement:
If you want to modify the AddItemNoChkbx function, you must replace PanelHeight by the new panel height and LabelHeight by the new label height wherever you find them.
If you don't want to modify the class, copy the AddItemNoChkbx function in your Activity. Customize it and feed the AddCustomItem function with the created panel.

Informatix · Oct 26, 2012

New version

v2.21:
I changed an incorrect declaration in the demo #1 and #2.
The class is now compatible with the obfuscation option.

cstangor · Dec 22, 2012

Checklist usage

I like this class a lot but I'm having trouble using it.

I'd like to have different checklists, but I don't know how to manage switching from one to another.

There seems to be only one possible instance of the class. Is this correct?

Thanks

fdx12345 · Dec 22, 2012

Cannot download

My computer states the file is a multi-volume and wants other files to go with it.

Bill

Informatix · Dec 22, 2012

cstangor said:
There seems to be only one possible instance of the class. Is this correct?

Not at all. You can see in the following screenshot (from the ScrollPanel class example) that you can have different checklists at the same time, on the same screen:

Informatix · Dec 22, 2012

fdx12345 said:
My computer states the file is a multi-volume and wants other files to go with it.

Bill

I think you're in the wrong thread. I don't know what you're talking about.

B4A Library [Class] CheckList

Attachments

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Member

Active Member

Expert

Expert