Package org.adempiere.webui.component

Class WListItemRenderer

java.lang.Object
org.adempiere.webui.component.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 Listbox.
Author:
Andrew Kimball

  • Field Details

  • Constructor Details

    • WListItemRenderer

      public WListItemRenderer()
      Default constructor.

    • WListItemRenderer

      public WListItemRenderer(List<? extends String> columnNames)
      Constructor specifying the column headers.
      Parameters:
      columnNames - List of column headers.

  • Method Details

    • getColumn

      public WTableColumn getColumn(int columnIndex)
      Get column details of specified column.
      Parameters:
      columnIndex - The index of the column for which details are to be retrieved.
      Returns:
      The details of the column at the specified index.

    • 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 value, int rowIndex, int columnIndex)
      Create cell for the given value.
      Parameters:
      table - The table into which the cell will be placed.
      value - Value 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 header of a Column.
      Parameters:
      index - The index of the column to update
      header - The header text for the column

    • addColumn

      public void addColumn(String header)
      Add column
      Parameters:
      header -

    • addColumn

      public void addColumn(String header, String description)
      Add column
      Parameters:
      header -
      description -

    • addColumn

      public void addColumn(String header, String description, int AD_Reference_ID)
      Add Table Column.
      Parameters:
      header - The header text for the column
      description -
      AD_Reference_ID -

    • getNoColumns

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

    • setRO

      @Deprecated(forRemoval=true, since="11") public void setRO(int colIndex, Boolean readOnly)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This is unused. The readonly property 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 - index of column
      header - ListHeader

    • getListHeader

      public ListHeader getListHeader(int index)
      get list header
      Parameters:
      index - index of column
      Returns:
      ListHeader

    • getColumnComparator

      protected Comparator<Object> getColumnComparator(boolean ascending, int columnIndex)
      Create comparator for a given column.
      Parameters:
      ascending - whether the comparator will sort ascending
      columnIndex - the index of column
      Returns:
      comparator for the given column for the given sort direction

    • renderListHead

      public void renderListHead(ListHead head)
      Render column headers
      Parameters:
      head - The ListHead component to render.
      See Also:

    • 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 or -1 if not found.

    • 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 selections

    • addTableValueChangeListener

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

    • removeTableValueChangeListener

      public void removeTableValueChangeListener(TableValueChangeListener listener)
      Remove listener
      Parameters:
      listener -

    • 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)
      Set column header text
      Parameters:
      index -
      header -

    • setColumnClass

      public void setColumnClass(int index, Class<?> classType)
      Set column type
      Parameters:
      index - index of column
      classType - Class Type of column

    • getTableColumns

      public List<WTableColumn> getTableColumns()
      Returns:
      Unmodifiable list of WTableColumn