com.sksamuel.jqm4gwt.plugins.datatables.ColumnDefEx Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jqm4gwt-datatables Show documentation
Plugin to jqm4gwt to use jQuery DataTables
The newest version!
package com.sksamuel.jqm4gwt.plugins.datatables;

import java.util.ArrayList;
import java.util.List;

import com.google.gwt.uibinder.client.UiChild;
import com.google.gwt.user.client.ui.Widget;
import com.sksamuel.jqm4gwt.Empty;
import com.sksamuel.jqm4gwt.table.ColumnDef;

/**
 * Additional column properties supported by DataTable.
 * 
 See DataTables Columns
 *
 * @author slavap
 *
 */
public class ColumnDefEx extends ColumnDef {

    private List widgets;

    private boolean visible = true;
    private boolean orderable = true;
    private boolean searchable = true;

    private String classNames;
    private boolean cellTypeTh;
    private String width;

    private boolean customCellRender;

    // must be in sync with dataTables-row-details.css
    private static final String ROW_DETAILS_CLASS = "details-control";

    public static enum DefaultContentType {
        BUTTON, CHECKBOX, CHECKBOX_ROWSELECT, ROW_DETAILS
    }

    private String defaultContent;
    private DefaultContentType defaultContentType;

    private Integer dataIdx;
    private String  data;

    @UiChild(tagname = "widget")
    public void addWidget(Widget w) {
        if (w != null) {
            if (widgets == null) widgets = new ArrayList<>();
            widgets.add(w);
        }
    }

    public boolean hasWidgets() {
        return !Empty.is(widgets);
    }

    public List getWidgets() {
        return widgets;
    }

    public boolean isOrderable() {
        return orderable;
    }

    public void setOrderable(boolean orderable) {
        this.orderable = orderable;
    }

    public ColumnDefEx withOrderable(boolean orderable) {
        setOrderable(orderable);
        return this;
    }

    public boolean isSearchable() {
        return searchable;
    }

    public void setSearchable(boolean searchable) {
        this.searchable = searchable;
    }

    public ColumnDefEx withSearchable(boolean searchable) {
        setSearchable(searchable);
        return this;
    }

    public boolean isVisible() {
        return visible;
    }

    public void setVisible(boolean visible) {
        this.visible = visible;
    }

    public String getClassNames() {
        String s = classNames;
        if (DefaultContentType.ROW_DETAILS.equals(defaultContentType)) {
            if (Empty.is(s)) s = ROW_DETAILS_CLASS;
            else s += " " + ROW_DETAILS_CLASS;
        }
        return s;
    }

    /** Space separated list of additional styling classes for table body cells. */
    public void setClassNames(String classNames) {
        this.classNames = classNames;
    }

    public boolean isCellTypeTh() {
        return cellTypeTh;
    }

    /**
     * This can be useful as TH cells have semantic meaning in the table body,
     * allowing them to act as a header for a row.
     */
    public void setCellTypeTh(boolean cellTypeTh) {
        this.cellTypeTh = cellTypeTh;
    }

    public String getDefaultContent() {
        return defaultContent;
    }

    /** Set default, static, content for a column, for example simple edit and/or delete buttons. */
    public void setDefaultContent(String defaultContent) {
        this.defaultContent = defaultContent;
    }

    public DefaultContentType getDefaultContentType() {
        return defaultContentType;
    }

    /** Set default, static, content for a column - predefined widgets, defaultContent will be used
     * for innerHtml if defined. */
    public void setDefaultContentType(DefaultContentType value) {
        defaultContentType = value;
        if (defaultContentType != null) {
            setData("");
            searchable = false;
            orderable = false;
        }
    }

    public ColumnDefEx withDefaultContentType(DefaultContentType value) {
        setDefaultContentType(value);
        return this;
    }

    /** Combines both defaultContentType and defaultContent and generates proper content. */
    public String calcDefaultContent() {
        if (defaultContentType == null) return defaultContent;
        String s;
        switch (defaultContentType) {
        case BUTTON:
            s = "";

        case CHECKBOX:
        case CHECKBOX_ROWSELECT:
            s = "";
            } else {
                s += ">";
            }
            return s;

        case ROW_DETAILS:
            return "";

        default:
            return defaultContent;
        }
    }

    public String getWidth() {
        return width;
    }

    /** Defines the width of a column, and may take any CSS value (3em, 20px, 10%, etc). */
    public void setWidth(String width) {
        this.width = width;
    }

    public String getData() {
        return data;
    }

    /**
     * Set the data source for the column from the rows data object/array.
     * 
 data and dataIdx are mutually exclusive, so you cannot use them simultaneously.
     * 
 See columns.data
     **/
    public void setData(String data) {
        this.dataIdx = null;
        this.data = data;
    }

    public Integer getDataIdx() {
        return dataIdx;
    }

    /** Treated as an array index for the data source. Also see data property. */
    public void setDataIdx(Integer dataIdx) {
        this.data = null;
        this.dataIdx = dataIdx;
    }

    public boolean isCustomCellRender() {
        return customCellRender;
    }

    /**
     * @param customCellRender - true means that JQMDataTable.cellRender should be called for this column.
     */
    public void setCustomCellRender(boolean customCellRender) {
        this.customCellRender = customCellRender;
    }

    public ColumnDefEx withTitle(String title) {
        setTitle(title);
        return this;
    }

    public ColumnDefEx withName(String name) {
        setName(name);
        return this;
    }

}