zkoss/zk

/* Listfooter.ts

    Purpose:

    Description:

    History:
        Tue Jun  9 18:03:07     2009, Created by jumperchen

Copyright (C) 2009 Potix Corporation. All Rights Reserved.

This program is distributed under LGPL Version 2.0 in the hope that
it will be useful, but WITHOUT ANY WARRANTY.
*/
/**
 * A column of the footer of a list box ({@link Listbox}).
 * Its parent must be {@link Listfoot}.
 *
 * <p>Unlike {@link Listheader}, you could place any child in a list footer.
 * <p>Note: {@link Listcell} also accepts children.
 * @defaultValue {@link getZclass}: z-listfooter.
 */
@zk.WrapClass('zul.sel.Listfooter')
export class Listfooter extends zul.mesh.FooterWidget {
    /**
     * @returns the listbox that this belongs to.
     */
    getListbox(): zul.sel.Listbox | undefined { // FIXME: solve with <parent>
        return this.getMeshWidget() as zul.sel.Listbox | undefined;
    }

    /**
     * @returns the list header that is in the same column as
     * this footer, or null if not available.
     */
    getListheader(): zul.sel.Listheader | undefined { // FIXME: solve with <parent>
        return this.getHeaderWidget() as zul.sel.Listheader | undefined;
    }

    /**
     * @returns the maximal length for this cell.
     * If listbox's mold is "select", it is the same as
     * {@link Select#getMaxlength}
     * If not, it is the same as the correponding {@link getListheader}'s
     * {@link Listheader#getMaxlength}.
     *
     * <p>Note: {@link Option#getMaxlength} is the same as {@link Select#getMaxlength}.
     * @since 5.0.5
     */
    getMaxlength(): number | undefined {
        var lc = this.getListheader();
        return lc ? lc.getMaxlength() : 0;
    }

    /** @internal */
    override domLabel_(): string {
        return zUtl.encodeXML(this.getLabel(), {maxlength: this.getMaxlength()});
    }
}