Class WListItemRenderer

  • All Implemented Interfaces:
    org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, org.zkoss.zul.ListitemRenderer<Object>, org.zkoss.zul.ListitemRendererExt
    Direct Known Subclasses:
    WInfoWindowListItemRenderer

    public class WListItemRenderer
    extends Object
    implements org.zkoss.zul.ListitemRenderer<Object>, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, org.zkoss.zul.ListitemRendererExt
    Renderer for ListItem for the Listbox.
    Author:
    Andrew Kimball
    • Constructor Detail

      • WListItemRenderer

        public WListItemRenderer()
        Default constructor.
      • WListItemRenderer

        public WListItemRenderer​(List<? extends String> columnNames)
        Constructor specifying the column headers.
        Parameters:
        columnNames - vector of column titles.
    • Method Detail

      • render

        public void render​(org.zkoss.zul.Listitem item,
                           Object data,
                           int index)
                    throws Exception
        Specified by:
        render in interface org.zkoss.zul.ListitemRenderer<Object>
        Throws:
        Exception
      • getCellComponent

        protected org.zkoss.zul.Listcell getCellComponent​(WListbox table,
                                                          Object field,
                                                          int rowIndex,
                                                          int columnIndex)
        Generate the cell for the given field.
        Parameters:
        table - The table into which the cell will be placed.
        field - The data field for which the cell is to be created.
        rowIndex - The row in which the cell is to be placed.
        columnIndex - The column in which the cell is to be placed.
        Returns:
        The list cell component.
      • updateColumn

        public void updateColumn​(int index,
                                 String header)
        Update Table Column.
        Parameters:
        index - The index of the column to update
        header - The header text for the column
      • addColumn

        public void addColumn​(String header)
        Parameters:
        header -
      • addColumn

        public void addColumn​(String header,
                              String description)
      • addColumn

        public void addColumn​(String header,
                              String description,
                              int AD_Reference_ID)
        Add Table Column. after adding a column, you need to set the column classes again (DefaultTableModel fires TableStructureChanged, which calls JTable.tableChanged .. createDefaultColumnsFromModel
        Parameters:
        header - The header text for the column
        description -
      • getNoColumns

        public int getNoColumns()
        Get the number of columns.
        Returns:
        the number of columns
      • setRO

        public void setRO​(int colIndex,
                          Boolean readOnly)
        Deprecated.
        This is unused. The readonly proprty of a column should be set in the parent table.
        Parameters:
        colIndex -
        readOnly -
      • setListHeader

        public void setListHeader​(int index,
                                  ListHeader header)
        set custom list header
        Parameters:
        index -
        header -
      • getColumnComparator

        protected Comparator<Object> getColumnComparator​(boolean ascending,
                                                         int columnIndex)
        Obtain the comparator for a given column.
        Parameters:
        ascending - whether the comparator will sort ascending
        columnIndex - the index of the column for which the comparator is required
        Returns:
        comparator for the given column for the given direction
      • renderListHead

        public void renderListHead​(ListHead head)
        Render the ListHead for the table with headers for the table columns.
        Parameters:
        head - The ListHead component to render.
        See Also:
        addColumn(String), WListItemRenderer(List)
      • onEvent

        public void onEvent​(org.zkoss.zk.ui.event.Event event)
                     throws Exception
        Specified by:
        onEvent in interface org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>
        Throws:
        Exception
      • getRowPosition

        protected int getRowPosition​(org.zkoss.zk.ui.Component source)
        Get the row index of the given source component.
        Parameters:
        source - The component for which the row index is to be found.
        Returns:
        The row index of the given component.
      • getColumnPosition

        protected int getColumnPosition​(org.zkoss.zk.ui.Component source)
        Get the column index of the given source component.
        Parameters:
        source - The component for which the column index is to be found.
        Returns:
        The column index of the given component.
      • clearColumns

        public void clearColumns()
        Reset the renderer. This should be called if the table using this renderer is cleared.
      • clearSelection

        public void clearSelection()
        Clear the renderer. This should be called if the table using this renderer is cleared.
      • addTableValueChangeListener

        public void addTableValueChangeListener​(TableValueChangeListener listener)
        Add a listener for changes in the table's component values.
        Parameters:
        listener - The listener to add.
      • getControls

        public int getControls()
        Specified by:
        getControls in interface org.zkoss.zul.ListitemRendererExt
      • newListcell

        public org.zkoss.zul.Listcell newListcell​(org.zkoss.zul.Listitem item)
        Specified by:
        newListcell in interface org.zkoss.zul.ListitemRendererExt
      • newListitem

        public org.zkoss.zul.Listitem newListitem​(org.zkoss.zul.Listbox listbox)
        Specified by:
        newListitem in interface org.zkoss.zul.ListitemRendererExt
      • setColumnHeader

        public void setColumnHeader​(int index,
                                    String header)
        Parameters:
        index -
        header -
      • setColumnClass

        public void setColumnClass​(int index,
                                   Class<?> classType)