com.jwebmp.plugins.datatable.DataTable Maven / Gradle / Ivy
Show all versions of jwebmp-data-tables Show documentation
/*
* Copyright (C) 2017 GedMarc
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see
* The table row type this table reflects
* @param
*
* @author MMagon
* @version 1.0
* @since 2014 09 30
*/
@SuppressWarnings("MissingClassJavaDoc")
@ComponentInformation(name = "Data Tables",
description = "The core data tables component",
url = "https://www.datatables.net/")
public class DataTable>
extends Table
implements IDataTable
{
/**
* The associated feature for the data table
*/
private DataTableFeature feature;
/**
* The header grouping for a data table
*/
private TableHeaderGroup headerGroup;
/**
* The footer grouping for a data table
*/
private TableFooterGroup footerGroup;
/**
* The table grouping for a data table
*/
private TableBodyGroup bodyGroup;
/**
* The caption item for a table
*/
private TableCaption captionOfTable;
/**
* If the dynamic features are enabled on this data table
*/
private boolean enableDynamicFeature;
/**
* Construct a new interactive table that is theme compatible, with cell spacing and padding as 0. Sets dynamic feature to disabled
*
*
* @param headerGroup
* The table header group creating for
*/
public DataTable(String id, TableHeaderGroup headerGroup)
{
this(id, headerGroup, false);
}
/**
* Construct a new interactive table that is theme compatible, with cell spacing and padding as 0.
*
*
* @param headerGroup
* The table header group creating for
* @param enableDynamicFeature
* Enables the DataTable Feature
*/
public DataTable(String id, TableHeaderGroup headerGroup, boolean enableDynamicFeature)
{
this.enableDynamicFeature = enableDynamicFeature;
addAttribute(TableAttributes.CellSpacing, 0);
addAttribute(TableAttributes.CellPadding, 0);
setHeaderGroup(headerGroup);
setID(id);
addFeature(getFeature());
addClass("table table-responsive w-100 d-block d-md-table");
}
@SuppressWarnings({"unchecked"})
@NotNull
public final DataTableFeature getFeature()
{
if (feature == null)
{
feature = new DataTableFeature(this);
}
return feature;
}
/**
* Returns this class as a trimmed down accessor for ease of use
*
* @return
*/
public IDataTable asMe()
{
return this;
}
@Override
@SuppressWarnings("unchecked")
public void init()
{
if (!isInitialized() && isEnableDynamicFeature())
{
TableHeaderGroup group = getHeaderGroup();
for (TableHeaderGroupChildren child : group.getChildren())
{
TableRow tr = (TableRow) child;
for (TableRowChildren rowChild : tr.getChildren())
{
DataTableColumnOptions columnOptions = new DataTableColumnOptions(rowChild.asBase()
.getText(0)
.toString());
getOptions().getColumns()
.add(columnOptions);
}
}
}
super.init();
}
@Override
public DataTableOptions getOptions()
{
return getFeature().getOptions();
}
@SuppressWarnings("unchecked")
@NotNull
public J addCopyButton(String className)
{
DataTablesButtonButtonsOptions dt = new DataTablesButtonButtonsOptions<>().setExtend(DataTableButtons.Copy);
if (className != null)
{
dt.setClassName(className);
}
getOptions()
.getButtons()
.add(dt);
return (J) this;
}
@SuppressWarnings("unchecked")
@NotNull
public J addCsvButton(String className)
{
DataTablesButtonButtonsOptions dt = new DataTablesButtonButtonsOptions<>().setExtend(DataTableButtons.Csv);
if (className != null)
{
dt.setClassName(className);
}
getOptions()
.getButtons()
.add(dt);
return (J) this;
}
@SuppressWarnings("unchecked")
@NotNull
public J addExcelButton(String className)
{
DataTablesButtonButtonsOptions dt = new DataTablesButtonButtonsOptions<>().setExtend(DataTableButtons.Excel);
if (className != null)
{
dt.setClassName(className);
}
getOptions()
.getButtons()
.add(dt);
return (J) this;
}
@SuppressWarnings("unchecked")
@NotNull
public J addPdfButton(String className)
{
DataTablesButtonButtonsOptions dt = new DataTablesButtonButtonsOptions<>().setExtend(DataTableButtons.Pdf);
if (className != null)
{
dt.setClassName(className);
}
getOptions()
.getButtons()
.add(dt);
return (J) this;
}
@SuppressWarnings("unchecked")
@NotNull
public J addPrintButton(String className)
{
DataTablesButtonButtonsOptions dt = new DataTablesButtonButtonsOptions<>().setExtend(DataTableButtons.Print);
if (className != null)
{
dt.setClassName(className);
}
getOptions()
.getButtons()
.add(dt);
return (J) this;
}
/**
* Configures the data table to use the AJAX data loading
*
* @param event
*
* @return
*/
@Override
@SuppressWarnings("unchecked")
@NotNull
public J addServerDataSource(Class event)
{
getOptions().setServerSide(true);
getOptions().getAjax()
.setUrl("/jwdatatables?c=" + event.getCanonicalName()
.replace(CHAR_DOT, CHAR_UNDERSCORE));
TableRow row = (TableRow) getHeaderGroup().getChildren()
.iterator()
.next();
int headers = row.getChildren()
.size();
for (int i = 0; i < headers; i++)
{
ComponentHierarchyBase[] arrs = new ComponentHierarchyBase[headers];
arrs = row.getChildren()
.toArray(arrs);
ComponentHierarchyBase me = arrs[i];
String text = me.getText(0)
.toString();
if (Strings.isNullOrEmpty(text) && !me.getChildren()
.isEmpty())
{
me = (ComponentHierarchyBase) me.getChildren()
.iterator()
.next();
text = me.getText(0)
.toString();
}
getOptions().getColumns()
.add(new DataTableColumnOptions<>(text));
}
return (J) this;
}
/**
* If dynamic features are enabled
*
* @return
*/
@Override
@SuppressWarnings("unchecked")
public boolean isEnableDynamicFeature()
{
return enableDynamicFeature;
}
/**
* Gets the header group for this Data Table
*
* @return
*/
@Override
@SuppressWarnings({"unchecked"})
@NotNull
public TableHeaderGroup getHeaderGroup()
{
if (headerGroup == null)
{
setHeaderGroup(new TableHeaderGroup());
}
return headerGroup;
}
/**
* Sets the header group for this table
*
*
* @param headerGroup
*/
@Override
@SuppressWarnings({"unchecked"})
@NotNull
public J setHeaderGroup(TableHeaderGroup headerGroup)
{
getChildren().remove(this.headerGroup);
this.headerGroup = headerGroup;
if (!getChildren().contains(headerGroup))
{
add(headerGroup);
}
return (J) this;
}
/**
* Sets if the dynamic features of this table must be rendered
*
* @param enableDynamicFeature
*
* @return
*/
@Override
@SuppressWarnings({"unchecked"})
@NotNull
public J setEnableDynamicFeature(boolean enableDynamicFeature)
{
this.enableDynamicFeature = enableDynamicFeature;
return (J) this;
}
/**
* Gets the footer group for this data table
*
* @return
*/
@Override
@SuppressWarnings({"unchecked"})
@NotNull
public TableFooterGroup getFooterGroup()
{
if (footerGroup == null)
{
setFooterGroup(new TableFooterGroup());
}
return footerGroup;
}
/**
* sets the footer group for this table
*
*
* @param footerGroup
*/
@Override
@SuppressWarnings({"unchecked"})
@NotNull
public J setFooterGroup(TableFooterGroup footerGroup)
{
getChildren().remove(this.footerGroup);
this.footerGroup = footerGroup;
if (!getChildren().contains(footerGroup))
{
add(footerGroup);
}
return (J) this;
}
/**
* Gets the body group for this data table
*
* @return
*/
@Override
@SuppressWarnings({"unchecked"})
@NotNull
public TableBodyGroup getBodyGroup()
{
if (bodyGroup == null)
{
setBodyGroup(new TableBodyGroup());
}
return bodyGroup;
}
/**
* Returns the Table Caption associated with this object plus positioning utilities
*
* @return
*/
@Override
public TableCaption getCaptionOfTable()
{
if (captionOfTable == null)
{
setCaptionOfTable(new TableCaption(null));
}
return captionOfTable;
}
/**
* Sets the caption for the table
*
* @param captionOfTable
*/
@Override
@SuppressWarnings({"unchecked"})
@NotNull
public J setCaptionOfTable(TableCaption captionOfTable)
{
this.captionOfTable = captionOfTable;
return (J) this;
}
/**
* Sets the body group for the table
*
*
* @param bodyGroup
*/
@Override
@SuppressWarnings({"unchecked"})
@NotNull
public J setBodyGroup(TableBodyGroup bodyGroup)
{
getChildren().remove(this.bodyGroup);
this.bodyGroup = bodyGroup;
if (!getChildren().contains(bodyGroup))
{
add(bodyGroup);
}
return (J) this;
}
@Override
public int hashCode()
{
return super.hashCode();
}
@Override
public boolean equals(Object o)
{
return super.equals(o);
}
}