All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.github.bordertech.wcomponents.addons.table.TableBeanModel Maven / Gradle / Ivy

Go to download

The newest version!
package com.github.bordertech.wcomponents.addons.table;

import com.github.bordertech.wcomponents.AbstractBeanBoundTableModel;
import com.github.bordertech.wcomponents.WTable;
import com.github.bordertech.wcomponents.WTableColumn;
import com.github.bordertech.wcomponents.addons.table.edit.RowActionable;
import com.github.bordertech.wcomponents.addons.table.edit.RowMode;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

/**
 * Bean bound table model with column definitions.
 *
 * @param  the bean class used by this model
 * @param  the table column definition
 * @author Jonathan Austin
 */
public class TableBeanModel> extends AbstractBeanBoundTableModel {

	/**
	 * Indicates whether rows are globally selectable.
	 */
	private boolean selectable;

	/**
	 * Columns for the table.
	 */
	private final List columns;

	/**
	 * The column used for row actions.
	 */
	private final RowActionable actionColumn;

	/**
	 * @param columns the columns for this table
	 */
	public TableBeanModel(final List columns) {
		this.columns = columns;
		RowActionable actionCol = null;
		for (U column : columns) {
			if (column.getRenderer() instanceof RowActionable) {
				actionCol = (RowActionable) column.getRenderer();
				break;
			}
		}
		this.actionColumn = actionCol;
	}

	/**
	 * @return the column used for row actions
	 */
	public final RowActionable getActionColumn() {
		return actionColumn;
	}

	@Override
	public Object getValueAt(final List row, final int col) {
		// Get the bean for the row
		T bean = getRowBean(row);
		// Get the column
		TableColumn column = getColumns().get(col);
		// Return the value for the column
		return column.getValue(bean);
	}

	@Override
	public void setValueAt(final Object value, final List row, final int col) {
		// Get the bean for the row
		T bean = getRowBean(row);
		// Get the column
		TableColumn column = getColumns().get(col);
		// Update the value
		column.setValue(bean, value);
	}

	@Override
	public int getRowCount() {
		return getBeanList().size();
	}

	@Override
	public int getChildCount(final List row) {
		return 0;
	}

	@Override
	public boolean isCellEditable(final List row, final int col) {
		TableColumn column = getColumn(col);
		return column.isEditable() && isRowEditable(getRowKey(row));
	}

	@Override
	public boolean isSortable(final int col) {
		TableColumn column = getColumn(col);
		return column.getComparator() != null;
	}

	@Override
	public Object getRowKey(final List row) {
		T bean = getRowBean(row);
		return getBeanKey(bean);
	}

	@Override
	public int[] sort(final int col, final boolean ascending) {
		TableColumn column = getColumn(col);
		Comparator comp = (Comparator) column.getComparator();
		if (comp == null) {
			return null;
		}
		return sort(comp, col, ascending);
	}

	/**
	 * Determine the bean identifier. Defaults to the bean itself.
	 *
	 * @param bean the bean
	 * @return the bean identifier
	 */
	public Object getBeanKey(final T bean) {
		return bean;
	}

	/**
	 * @return the columns for this table.
	 */
	public List getColumns() {
		return columns;
	}

	/**
	 * @param col the column index
	 * @return the column details for this column index
	 */
	public TableColumn getColumn(final int col) {
		return getColumns().get(col);
	}

	/**
	 * @param columnId the column id
	 * @return the index of this column id, or -1 if not found
	 */
	public int getColumnIdx(final String columnId) {
		List cols = getColumns();
		for (int i = 0; i < cols.size(); i++) {
			if (cols.get(i).getColumnId().equals(columnId)) {
				return i;
			}
		}
		return -1;
	}

	/**
	 * @return the list of beans for the table
	 */
	public List getBeanList() {
		List beans = (List) super.getBean();
		return beans == null ? Collections.EMPTY_LIST : beans;
	}

	/**
	 * @param row the row index
	 * @return the bean for the row
	 */
	public T getRowBean(final List row) {
		int idx = row.get(0);
		return getBeanList().get(idx);
	}

	/**
	 * Helper method to add the columns to the table.
	 *
	 * @param table the table to configure
	 */
	public static void configTable(final WTable table) {
		TableBeanModel beanModel = (TableBeanModel) table.getTableModel();
		for (TableColumn col : beanModel.getColumns()) {
			// Create column
			WTableColumn tblCol = new WTableColumn(col.getColumnLabel(), col.getRenderer());
			table.addColumn(tblCol);
		}
	}

	/**
	 * @param row ignored
	 * @return true if the model is globally selectable, otherwise false
	 */
	@Override
	public boolean isSelectable(final List row) {
		return selectable;
	}

	/**
	 * Sets whether the rows are globally selectable.
	 *
	 * @param selectable true if the rows are globally selectable, otherwise false
	 */
	public void setSelectable(final boolean selectable) {
		this.selectable = selectable;
	}

	/**
	 * @param key the row key
	 * @return true if the row is editable
	 */
	protected boolean isRowEditable(final Object key) {
		// Default to true if no action column provided
		return actionColumn == null || actionColumn.getRowMode(key) != RowMode.READ;
	}

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy