Package org.zkoss.zul.impl

Class MeshElement

    • Field Detail

      • CSS_FLEX_AUTO_DISABLED_COUNT

        public static final java.lang.String CSS_FLEX_AUTO_DISABLED_COUNT
        See Also:
        Constant Field Values

    • Constructor Detail

      • MeshElement

        public MeshElement()

    • Method Detail

      • getSpan

        public java.lang.String getSpan()
        Return column span hint of this component.

        Default: null

        Returns:
        column span hint of this component.
        Since:
        5.0.6
        See Also:
        setSpan(java.lang.String)

      • setSpan

        public void setSpan​(java.lang.String span)
        Sets column span hint of this component.

        String number span indicates how this component distributes remaining empty space to the specified column(0-based). "0" means distribute remaining empty space to the 1st column; "1" means distribute remaining empty space to the 2nd column, etc.. The spanning column will grow to fit the extra remaining space.

        Special span hint with "true" means span ALL columns proportionally per their original widths while null or "false" means NOT spanning any column.

        Default: null. That is, NOT span any column.

        Note span is meaningful only if there is remaining empty space for columns.

        Parameters:
        span - the column span hint.
        Since:
        5.0.6
        See Also:
        getSpan(), setSpan(boolean)

      • setSpan

        public void setSpan​(boolean span)
        Sets whether distributes remaining empty space of this component to ALL columns proportionally.

        Default: false. That is, NOT span any column.

        Note span is meaningful only if there is remaining empty space for columns.

        Parameters:
        span - whether to span the width of ALL columns to occupy the whole mesh element(grid/listbox/tree).
        Since:
        5.0.5

      • isSpan

        public boolean isSpan()
        Returns whether distributes remaining empty space of this component to ANY column.

        Default: false.

        Returns:
        whether distributes remaining empty space of this component to ANY column.
        Since:
        5.0.5
        See Also:
        getSpan(), setSpan(boolean), setSpan(String)

      • setSizedByContent

        public void setSizedByContent​(boolean byContent)
        Sets whether sizing grid/listbox/tree column width by its content; it equals set hflex="min" on each column.

        Default: false.

        Parameters:
        byContent -
        Since:
        5.0.0

      • isSizedByContent

        public boolean isSizedByContent()
        Returns whether sizing grid/listbox/tree column width by its content. Default is false.
        Since:
        5.0.0
        See Also:
        setSizedByContent(boolean)

      • setAutopaging

        public void setAutopaging​(boolean autopaging)
        Sets whether the auto-paging facility is turned on when mold is "paging". If it is set to true, the setPageSize(int) is ignored; rather, the page size is automatically determined by the height of the Listbox dynamically. Note: Due to performance concern, Autopaging functionality does not support Detail components.
        Parameters:
        autopaging - true to turn on the auto-paging facility.
        Since:
        5.0.2

      • isAutopaging

        public boolean isAutopaging()
        Returns whether the auto-paging facility is turned on when mold is "paging". If it is set to true, the setPageSize(int) is ignored; rather, the page size is automatically determined by the height of the Listbox dynamically.
        Returns:
        whether the "autopaging" facility is turned on.
        Since:
        5.0.2

      • setPagingPosition

        public void setPagingPosition​(java.lang.String pagingPosition)
        Sets how to position the paging of mesh element at the client screen. It is meaningless if the mold is not in "paging".
        Parameters:
        pagingPosition - how to position. It can only be "bottom" (the default), or "top", or "both".
        Since:
        3.0.4

      • isAutohidePaging

        protected abstract boolean isAutohidePaging()

      • getPagingPosition

        public java.lang.String getPagingPosition()
        Returns how to position the paging of mesh element at the client screen. It is meaningless if the mold is not in "paging".
        Specified by:
        getPagingPosition in interface Paginated
        Since:
        3.0.4

      • pgi

        protected abstract Paginal pgi()
        Returns the instance of the @{link Paginal}

      • getPageSize

        public int getPageSize()
        Returns the page size, a.k.a., the number rows per page.
        Throws:
        java.lang.IllegalStateException - if pgi() returns null, i.e., mold is not "paging" and no external controller is specified.

      • setPageSize

        public void setPageSize​(int pgsz)
                 throws WrongValueException
        Sets the page size, a.k.a., the number rows per page.
        Throws:
        java.lang.IllegalStateException - if pgi() returns null, i.e., mold is not "paging" and no external controller is specified.
        WrongValueException

      • getPageCount

        public int getPageCount()
        Returns the number of pages. Note: there is at least one page even no item at all.
        Since:
        3.0.4

      • getActivePage

        public int getActivePage()
        Returns the active page (starting from 0).
        Since:
        3.0.4

      • isPagingDisabled

        public boolean isPagingDisabled()
        Description copied from interface: Paginated
        Returns whether the Paging component of this component is disabled.

        Default: false.

        Specified by:
        isPagingDisabled in interface Paginated
        Returns:
        whether the paging component of this component is disabled
        Since:
        8.0.3

      • setPagingDisabled

        public void setPagingDisabled​(boolean pagingDisabled)
        Sets whether to disable the Paging component of this component
        Specified by:
        setPagingDisabled in interface Paginated
        Parameters:
        pagingDisabled -
        Since:
        8.0.3

      • checkBeforeSetRows

        protected void checkBeforeSetRows()
                           throws UiException
        Internal check if there is any use of vflex and height before setRows
        Throws:
        UiException