Interface ListColumnAction<I,​V>

    • Method Detail

      • getId

        String getId()
        ID attribute of the column. This is requried and must be a unique id among all columns in the list.
      • getClazz

        String getClazz()
        Optional HTML class attribute that is used to style the column through CSS.
      • getStyle

        String getStyle()
        Optional HTML style attribute that is used to style the column through CSS.
      • getTitle

        String getTitle()
        The column title. Required.
      • getTooltip

        String getTooltip()
        An optional tooltip that is displayed when the mouse is over the column header.
      • getProperty

        String getProperty()
        The property name for referencing data in the column. This is optional but is needed to enable filtering, sorting and/or exporting.
        Returns:
        The property or null
      • getValueType

        Type getValueType()
        The data type of the values that are referenced by the property. Required if a property has been set.
        Returns:
        The data type of the values
      • isSortable

        boolean isSortable()
        A flag to indicate if sorting by this column is enabled for not. The sort uses the default property unless it has been overridden by getSortProperty().
        Returns:
        TRUE to enable sorting, FALSE to disable
      • getSortProperty

        String getSortProperty()
        Override the default property when this column is used for sorting.
        Returns:
        NULL if the default property should be used for sorting
      • isFilterable

        boolean isFilterable()
        A flag to indicate if filtering on this column is enabled or not. The filter uses the default property unless it has been overridden by getFilterProperty().
        Returns:
        TRUE to enable filtering, FALSE to disable
      • getFilterProperty

        String getFilterProperty()
        Override the default property when this column is used for filtering.
        Returns:
        NULL if the default property should be used for filtering
      • isExportable

        boolean isExportable()
        A flag to indicate if it is possible to export this column with the generic table exporter or not. The export uses the default property unless it has been overridden by getExportProperty().
        Returns:
        TRUE to enable exporting, FALSE to disable
      • getExportProperty

        String getExportProperty()
        Override the default property when this column is used for exporting.
        Returns:
        NULL if the default property should be used for exporting
      • getExportFormatter

        Formatter getExportFormatter()
        Get a formatter that converts the exported value to a string that is written to the file. The Formatter.format(Object) method is called once for every item that is listed in the table.
        Returns:
        A formatter, or null to simply use Object.toString()
      • getExportValue

        Object getExportValue​(DbControl dc,
                              I item)
        Get the value that should be used when exporting to a file. This method is called once for every item that is listed in the table. The returned value is then passed to the formatter (if any) that is retrieved from getExportFormatter().
        Parameters:
        dc - An open DbControl than can be used to query the database
        item - The current item
        Returns:
        The value that should be exported
      • getEnumeration

        Enumeration<String,​String> getEnumeration()
        Get an enumeration of possible values that can be found in the column. This is used to generate a filter with a drop-down containing checkboxes for each option. If no enumeration is specified, a default filter input field is used.
      • getFormatter

        Formatter<? super V> getFormatter()
        Get a formatter that converts the current value to a string that is displayed in the column. The string may include HTML that is required for proper display. The Formatter.format(Object) method is called once for every item that is listed in the table.
        Returns:
        A formatter, or null to simply use Object.toString()
      • getValue

        V getValue​(DbControl dc,
                   I item)
        Get the value that should be displayed in the column. This method is called once for every item that is listed in the table. The returned value is then passed to the formatter (if any) that is retrieved from getFormatter().
        Parameters:
        dc - An open DbControl than can be used to query the database
        item - The current item
        Returns:
        The value that should be displayed