org.richfaces.component.UIDataTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of richfaces Show documentation
There is a newer version: 5.0.0.Alpha3
/*
 * JBoss, Home of Professional Open Source
 * Copyright , Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.richfaces.component;

import javax.annotation.Generated;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

import javax.faces.context.FacesContext;
import javax.faces.component.UIComponent;
import javax.faces.component.behavior.ClientBehaviorHolder;
import javax.el.MethodExpression;
import javax.el.ValueExpression;
import javax.faces.component.StateHelper;
import org.richfaces.component.AbstractDataTable;
import java.util.Collection;
import org.richfaces.component.attribute.AjaxActivatorProps;
import org.richfaces.component.attribute.EventsRowProps;
import org.richfaces.component.attribute.IterationProps;
import org.richfaces.component.attribute.RowsProps;
import org.richfaces.component.attribute.SequenceProps;
import org.richfaces.component.attribute.StyleClassProps;
import org.richfaces.component.attribute.StyleProps;
import org.richfaces.component.attribute.TableStyleProps;
import org.richfaces.model.SortMode;

/**
 *  
 The <rich:dataTable> component is used to render a table, including the table's caption. It works in conjunction with
 the <rich:column> and <rich:columnGroup> components to list the contents of a data model.
 

 @author Anton Belevich

 **/
@Generated({"RichFaces CDK", "4.5.0-SNAPSHOT"})
public class UIDataTable extends AbstractDataTable
    implements ClientBehaviorHolder,AjaxActivatorProps,EventsRowProps,IterationProps,RowsProps,SequenceProps,StyleClassProps,StyleProps,TableStyleProps    {

    public static final String COMPONENT_TYPE="org.richfaces.DataTable";

    public static final String COMPONENT_FAMILY="org.richfaces.Data";

    @Override
    public String getFamily() {
        return COMPONENT_FAMILY;
    }

    public UIDataTable() {
        super();
        setRendererType("org.richfaces.DataTableRenderer");
    }

    private static final Collection EVENT_NAMES = Collections.unmodifiableCollection(Arrays.asList(
        "beforedomupdate",
        "rowmouseup",
        "rowclick",
        "complete",
        "rowmouseover",
        "rowkeypress",
        "rowmousedown",
        "rowkeydown",
        "rowmouseout",
        "rowmousemove",
        "rowdblclick",
        "rowkeyup"
        ));
    
    public Collection getEventNames() {
        return EVENT_NAMES;
    }


    public String getDefaultEventName() {
        return null;
    }


    protected enum Properties {
        captionClass,
        cellClass,
        columnClasses,
        columnFooterCellClass,
        columnFooterClass,
        columnHeaderCellClass,
        columnHeaderClass,
        columnHeaderFirstClass,
        data,
        filterVar,
        firstColumnFooterClass,
        firstRowClass,
        footerCellClass,
        footerClass,
        footerFirstClass,
        headerCellClass,
        headerClass,
        headerFirstClass,
        limitRender,
        noDataLabel,
        onbeforedomupdate,
        oncomplete,
        onrowclick,
        onrowdblclick,
        onrowkeydown,
        onrowkeypress,
        onrowkeyup,
        onrowmousedown,
        onrowmousemove,
        onrowmouseout,
        onrowmouseover,
        onrowmouseup,
        render,
        rowClass,
        rowClasses,
        sortMode,
        sortPriority,
        style,
        styleClass
        
    }

 
    public String getCaptionClass() {
        String value = (String) getStateHelper().eval(Properties.captionClass);
        return value;
    }
    
    public void setCaptionClass(String captionClass) {
        getStateHelper().put(Properties.captionClass, captionClass);
    }

 
    public String getCellClass() {
        String value = (String) getStateHelper().eval(Properties.cellClass);
        return value;
    }
    
    public void setCellClass(String cellClass) {
        getStateHelper().put(Properties.cellClass, cellClass);
    }

 
    public String getColumnClasses() {
        String value = (String) getStateHelper().eval(Properties.columnClasses);
        return value;
    }
    
    public void setColumnClasses(String columnClasses) {
        getStateHelper().put(Properties.columnClasses, columnClasses);
    }

 
    public String getColumnFooterCellClass() {
        String value = (String) getStateHelper().eval(Properties.columnFooterCellClass);
        return value;
    }
    
    public void setColumnFooterCellClass(String columnFooterCellClass) {
        getStateHelper().put(Properties.columnFooterCellClass, columnFooterCellClass);
    }

 
    public String getColumnFooterClass() {
        String value = (String) getStateHelper().eval(Properties.columnFooterClass);
        return value;
    }
    
    public void setColumnFooterClass(String columnFooterClass) {
        getStateHelper().put(Properties.columnFooterClass, columnFooterClass);
    }

 
    public String getColumnHeaderCellClass() {
        String value = (String) getStateHelper().eval(Properties.columnHeaderCellClass);
        return value;
    }
    
    public void setColumnHeaderCellClass(String columnHeaderCellClass) {
        getStateHelper().put(Properties.columnHeaderCellClass, columnHeaderCellClass);
    }

 
    public String getColumnHeaderClass() {
        String value = (String) getStateHelper().eval(Properties.columnHeaderClass);
        return value;
    }
    
    public void setColumnHeaderClass(String columnHeaderClass) {
        getStateHelper().put(Properties.columnHeaderClass, columnHeaderClass);
    }

 
    public String getColumnHeaderFirstClass() {
        String value = (String) getStateHelper().eval(Properties.columnHeaderFirstClass);
        return value;
    }
    
    public void setColumnHeaderFirstClass(String columnHeaderFirstClass) {
        getStateHelper().put(Properties.columnHeaderFirstClass, columnHeaderFirstClass);
    }

 
    public Object getData() {
        Object value = (Object) getStateHelper().eval(Properties.data);
        return value;
    }
    
    public void setData(Object data) {
        getStateHelper().put(Properties.data, data);
    }

 
    public String getFilterVar() {
        String value = (String) getStateHelper().eval(Properties.filterVar);
        return value;
    }
    
    public void setFilterVar(String filterVar) {
        getStateHelper().put(Properties.filterVar, filterVar);
    }

 
    public String getFirstColumnFooterClass() {
        String value = (String) getStateHelper().eval(Properties.firstColumnFooterClass);
        return value;
    }
    
    public void setFirstColumnFooterClass(String firstColumnFooterClass) {
        getStateHelper().put(Properties.firstColumnFooterClass, firstColumnFooterClass);
    }

 
    public String getFirstRowClass() {
        String value = (String) getStateHelper().eval(Properties.firstRowClass);
        return value;
    }
    
    public void setFirstRowClass(String firstRowClass) {
        getStateHelper().put(Properties.firstRowClass, firstRowClass);
    }

 
    public String getFooterCellClass() {
        String value = (String) getStateHelper().eval(Properties.footerCellClass);
        return value;
    }
    
    public void setFooterCellClass(String footerCellClass) {
        getStateHelper().put(Properties.footerCellClass, footerCellClass);
    }

 
    public String getFooterClass() {
        String value = (String) getStateHelper().eval(Properties.footerClass);
        return value;
    }
    
    public void setFooterClass(String footerClass) {
        getStateHelper().put(Properties.footerClass, footerClass);
    }

 
    public String getFooterFirstClass() {
        String value = (String) getStateHelper().eval(Properties.footerFirstClass);
        return value;
    }
    
    public void setFooterFirstClass(String footerFirstClass) {
        getStateHelper().put(Properties.footerFirstClass, footerFirstClass);
    }

 
    public String getHeaderCellClass() {
        String value = (String) getStateHelper().eval(Properties.headerCellClass);
        return value;
    }
    
    public void setHeaderCellClass(String headerCellClass) {
        getStateHelper().put(Properties.headerCellClass, headerCellClass);
    }

 
    public String getHeaderClass() {
        String value = (String) getStateHelper().eval(Properties.headerClass);
        return value;
    }
    
    public void setHeaderClass(String headerClass) {
        getStateHelper().put(Properties.headerClass, headerClass);
    }

 
    public String getHeaderFirstClass() {
        String value = (String) getStateHelper().eval(Properties.headerFirstClass);
        return value;
    }
    
    public void setHeaderFirstClass(String headerFirstClass) {
        getStateHelper().put(Properties.headerFirstClass, headerFirstClass);
    }

 
    public boolean isLimitRender() {
        Boolean value = (Boolean) getStateHelper().eval(Properties.limitRender, false);
        return value;
    }
    
    public void setLimitRender(boolean limitRender) {
        getStateHelper().put(Properties.limitRender, limitRender);
    }

 
    public String getNoDataLabel() {
        String value = (String) getStateHelper().eval(Properties.noDataLabel);
        return value;
    }
    
    public void setNoDataLabel(String noDataLabel) {
        getStateHelper().put(Properties.noDataLabel, noDataLabel);
    }

 
    public String getOnbeforedomupdate() {
        String value = (String) getStateHelper().eval(Properties.onbeforedomupdate);
        return value;
    }
    
    public void setOnbeforedomupdate(String onbeforedomupdate) {
        getStateHelper().put(Properties.onbeforedomupdate, onbeforedomupdate);
    }

 
    public String getOncomplete() {
        String value = (String) getStateHelper().eval(Properties.oncomplete);
        return value;
    }
    
    public void setOncomplete(String oncomplete) {
        getStateHelper().put(Properties.oncomplete, oncomplete);
    }

 
    public String getOnrowclick() {
        String value = (String) getStateHelper().eval(Properties.onrowclick);
        return value;
    }
    
    public void setOnrowclick(String onrowclick) {
        getStateHelper().put(Properties.onrowclick, onrowclick);
        handleAttribute("onrowclick",onrowclick);
    }

 
    public String getOnrowdblclick() {
        String value = (String) getStateHelper().eval(Properties.onrowdblclick);
        return value;
    }
    
    public void setOnrowdblclick(String onrowdblclick) {
        getStateHelper().put(Properties.onrowdblclick, onrowdblclick);
        handleAttribute("onrowdblclick",onrowdblclick);
    }

 
    public String getOnrowkeydown() {
        String value = (String) getStateHelper().eval(Properties.onrowkeydown);
        return value;
    }
    
    public void setOnrowkeydown(String onrowkeydown) {
        getStateHelper().put(Properties.onrowkeydown, onrowkeydown);
        handleAttribute("onrowkeydown",onrowkeydown);
    }

 
    public String getOnrowkeypress() {
        String value = (String) getStateHelper().eval(Properties.onrowkeypress);
        return value;
    }
    
    public void setOnrowkeypress(String onrowkeypress) {
        getStateHelper().put(Properties.onrowkeypress, onrowkeypress);
        handleAttribute("onrowkeypress",onrowkeypress);
    }

 
    public String getOnrowkeyup() {
        String value = (String) getStateHelper().eval(Properties.onrowkeyup);
        return value;
    }
    
    public void setOnrowkeyup(String onrowkeyup) {
        getStateHelper().put(Properties.onrowkeyup, onrowkeyup);
        handleAttribute("onrowkeyup",onrowkeyup);
    }

 
    public String getOnrowmousedown() {
        String value = (String) getStateHelper().eval(Properties.onrowmousedown);
        return value;
    }
    
    public void setOnrowmousedown(String onrowmousedown) {
        getStateHelper().put(Properties.onrowmousedown, onrowmousedown);
        handleAttribute("onrowmousedown",onrowmousedown);
    }

 
    public String getOnrowmousemove() {
        String value = (String) getStateHelper().eval(Properties.onrowmousemove);
        return value;
    }
    
    public void setOnrowmousemove(String onrowmousemove) {
        getStateHelper().put(Properties.onrowmousemove, onrowmousemove);
        handleAttribute("onrowmousemove",onrowmousemove);
    }

 
    public String getOnrowmouseout() {
        String value = (String) getStateHelper().eval(Properties.onrowmouseout);
        return value;
    }
    
    public void setOnrowmouseout(String onrowmouseout) {
        getStateHelper().put(Properties.onrowmouseout, onrowmouseout);
        handleAttribute("onrowmouseout",onrowmouseout);
    }

 
    public String getOnrowmouseover() {
        String value = (String) getStateHelper().eval(Properties.onrowmouseover);
        return value;
    }
    
    public void setOnrowmouseover(String onrowmouseover) {
        getStateHelper().put(Properties.onrowmouseover, onrowmouseover);
        handleAttribute("onrowmouseover",onrowmouseover);
    }

 
    public String getOnrowmouseup() {
        String value = (String) getStateHelper().eval(Properties.onrowmouseup);
        return value;
    }
    
    public void setOnrowmouseup(String onrowmouseup) {
        getStateHelper().put(Properties.onrowmouseup, onrowmouseup);
        handleAttribute("onrowmouseup",onrowmouseup);
    }

 
    public Object getRender() {
        Object value = (Object) getStateHelper().eval(Properties.render);
        return value;
    }
    
    public void setRender(Object render) {
        getStateHelper().put(Properties.render, render);
    }

 
    public String getRowClass() {
        String value = (String) getStateHelper().eval(Properties.rowClass);
        return value;
    }
    
    public void setRowClass(String rowClass) {
        getStateHelper().put(Properties.rowClass, rowClass);
    }

 
    public String getRowClasses() {
        String value = (String) getStateHelper().eval(Properties.rowClasses);
        return value;
    }
    
    public void setRowClasses(String rowClasses) {
        getStateHelper().put(Properties.rowClasses, rowClasses);
    }

 
    public SortMode getSortMode() {
        SortMode value = (SortMode) getStateHelper().eval(Properties.sortMode);
        return value;
    }
    
    public void setSortMode(SortMode sortMode) {
        getStateHelper().put(Properties.sortMode, sortMode);
    }

 
    public Collection getSortPriority() {
        Collection value = (Collection) getStateHelper().eval(Properties.sortPriority);
        return value;
    }
    
    public void setSortPriority(Collection sortPriority) {
        getStateHelper().put(Properties.sortPriority, sortPriority);
    }

 
    public String getStyle() {
        String value = (String) getStateHelper().eval(Properties.style);
        return value;
    }
    
    public void setStyle(String style) {
        getStateHelper().put(Properties.style, style);
        handleAttribute("style",style);
    }

 
    public String getStyleClass() {
        String value = (String) getStateHelper().eval(Properties.styleClass);
        return value;
    }
    
    public void setStyleClass(String styleClass) {
        getStateHelper().put(Properties.styleClass, styleClass);
        handleAttribute("styleClass",styleClass);
    }
    private static final String ATTRIBUTES_THAT_ARE_SET_KEY = "javax.faces.component.UIComponentBase.attributesThatAreSet";
    
    private void handleAttribute(String name, Object value) {
        List setAttributes = (List) this.getAttributes().get(ATTRIBUTES_THAT_ARE_SET_KEY);
        if (setAttributes == null) {
                setAttributes = new ArrayList(12);
                this.getAttributes().put(ATTRIBUTES_THAT_ARE_SET_KEY, setAttributes);
        }
        if (value == null) {
                ValueExpression ve = getValueExpression(name);
                if (ve == null) {
                    setAttributes.remove(name);
                }
            } else if (!setAttributes.contains(name)) {
                setAttributes.add(name);
        }
    }    

    
    public UIComponent getCaption() {
        return getFacet("caption");
    }
    public void setCaption(UIComponent facet) {
        getFacets().put("caption", facet);
    }

    public UIComponent getFooter() {
        return getFacet("footer");
    }
    public void setFooter(UIComponent facet) {
        getFacets().put("footer", facet);
    }

    public UIComponent getNoData() {
        return getFacet("noData");
    }
    public void setNoData(UIComponent facet) {
        getFacets().put("noData", facet);
    }

    public UIComponent getHeader() {
        return getFacet("header");
    }
    public void setHeader(UIComponent facet) {
        getFacets().put("header", facet);
    }


}