list_checkbox.go

package control

import (
	"context"
	"fmt"
	"github.com/goradd/goradd/pkg/html"
	"github.com/goradd/goradd/pkg/page"
	"github.com/goradd/goradd/pkg/page/control"
	"github.com/goradd/goradd/pkg/page/control/data"
)

type ItemDirection int

const (
	HorizontalItemDirection ItemDirection = 0
	VerticalItemDirection                 = 1
)

type CheckboxListI interface {
	control.CheckboxListI
}

// CheckboxList is a multi-select control that presents its choices as a list of checkboxes.
// Styling is provided by divs and spans that you can provide css for in your style sheets. The
// goradd.css file has default styling to handle the basics. It wraps the whole thing in a div that can be set
// to scroll as well, so that the final structure can be styled like a multi-table table, or a single-table
// scrolling list much like a standard html select list.
type CheckboxList struct {
	control.CheckboxList
	isInline  bool
	cellClass string
}

func NewCheckboxList(parent page.ControlI, id string) *CheckboxList {
	l := &CheckboxList{}
	l.Init(l, parent, id)
	return l
}

func (l *CheckboxList) Init(self CheckboxListI, parent page.ControlI, id string) {
	l.CheckboxList.Init(self, parent, id)
	l.SetLabelDrawingMode(html.LabelAfter)
	l.SetRowClass("row")
}

func (l *CheckboxList) this() CheckboxListI {
	return l.Self.(CheckboxListI)
}

func (l *CheckboxList) SetIsInline(i bool) {
	l.isInline = i
}

// SetColumnClass sets a string that is applied to every cell. This is useful for setting responsive breakpoints
func (l *CheckboxList) SetCellClass(c string) {
	l.cellClass = c
}


// ΩDrawingAttributes retrieves the tag's attributes at draw time. You should not normally need to call this, and the
// attributes are disposed of after drawing, so they are essentially read-only.
func (l *CheckboxList) ΩDrawingAttributes() html.Attributes {
	a := l.Control.ΩDrawingAttributes() // skip default checkbox list attributes
	a.SetDataAttribute("grctl", "bs-checkboxlist")
	return a
}

// ΩRenderItem is called by the framework to render a single item in the list.
func (l *CheckboxList) ΩRenderItem(item control.ListItemI) (h string) {
	selected := l.IsIdSelected(item.ID())
	h = renderItemControl(item, "checkbox", selected, l.ID())
	h = renderCell(item, h, l.ColumnCount(), l.isInline, l.cellClass)
	return
}

func renderItemControl(item control.ListItemI, typ string, selected bool, name string) string {
	attributes := html.NewAttributes()
	attributes.SetID(item.ID())
	attributes.Set("name", name)
	attributes.Set("value", item.ID())
	attributes.Set("type", typ)
	attributes.AddClass("form-check-input")
	if selected {
		attributes.Set("checked", "")
	}
	ctrl := html.RenderVoidTag("input", attributes)
	return html.RenderLabel(html.NewAttributes().Set("for", item.ID()).AddClass("form-check-label"), item.Label(), ctrl, html.LabelAfter)
}

func renderCell(item control.ListItemI, controlHtml string, columnCount int, isInline bool, cellClass string) string {
	attributes := item.Attributes().Copy()
	attributes.SetID(item.ID() + "_item")
	attributes.AddClass("form-check")
	if isInline {
		attributes.AddClass("form-check-inline")
	}
	if columnCount > 0 {
		attributes.AddClass(fmt.Sprintf("col-%d", 12 / columnCount))
	}
	if cellClass != "" {
		attributes.AddClass(cellClass)
	}
	return html.RenderTag("div", attributes, controlHtml)
}

type CheckboxListCreator struct {
	ID string
	// Items is a static list of labels and values that will be in the list. Or, use a DataProvider to dynamically generate the items.
	Items []control.ListValue
	// DataProvider is the control that will dynamically provide the data for the list and that implements the DataBinder interface.
	DataProvider data.DataBinder
	// DataProviderID is the id of a control that will dynamically provide the data for the list and that implements the DataBinder interface.
	DataProviderID string
	// ColumnCount specifies how many columns to show
	ColumnCount int
	// LayoutDirection determines how the items are arranged in the columns
	LayoutDirection control.LayoutDirection
	// LabelDrawingMode specifies how the labels on the radio buttons will be associated with the buttons
	LabelDrawingMode html.LabelDrawingMode
	// IsScrolling will give the inner div a vertical scroll style. You will need to style the height of the outer control to have a fixed style as well.
	IsScrolling bool
	// RowClass is the class assigned to each row
	RowClass string
	// Value is the initial value of the textbox. Often its best to load the value in a separate Load step after creating the control.
	Value string
	// SaveState saves the selected value so that it is restored if the form is returned to.
	SaveState bool
	page.ControlOptions
}

// Create is called by the framework to create a new control from the Creator. You
// do not normally need to call this.
func (c CheckboxListCreator) Create(ctx context.Context, parent page.ControlI) page.ControlI {
	ctrl := NewCheckboxList(parent, c.ID)
	c.Init(ctx, ctrl)
	return ctrl
}

func (c CheckboxListCreator) Init(ctx context.Context, ctrl CheckboxListI) {
	sub := control.CheckboxListCreator{
		ID: c.ID,
		Items: c.Items,
		DataProvider: c.DataProvider,
		ColumnCount: c.ColumnCount,
		LayoutDirection: c.LayoutDirection,
		LabelDrawingMode: c.LabelDrawingMode,
		IsScrolling: c.IsScrolling,
		RowClass: c.RowClass,
		Value: c.Value,
		SaveState: c.SaveState,
		ControlOptions: c.ControlOptions,

	}
	sub.Init(ctx, ctrl)
}

// GetCheckboxList is a convenience method to return the control with the given id from the page.
func GetCheckboxList(c page.ControlI, id string) *CheckboxList {
	return c.Page().GetControl(id).(*CheckboxList)
}