com.jwebmp.plugins.datatable.IDataTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jwebmp-data-tables Show documentation
The JWebSwing implementation for Data Tables
There is a newer version: 0.66.0.1
/*
 * Copyright (C) 2017 Marc Magon
 *
 * 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 .
 */

package com.jwebmp.plugins.datatable;

import com.jwebmp.core.base.html.*;
import com.jwebmp.plugins.datatable.events.DataTableDataFetchEvent;
import com.jwebmp.plugins.datatable.options.DataTableOptions;

import javax.validation.constraints.NotNull;

public interface IDataTable>
{
	/**
	 * Configures the data table to use the AJAX data loading
	 *
	 * @param event
	 *
	 * @return
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	J addServerDataSource(Class event);

	/**
	 * If dynamic features are enabled
	 *
	 * @return
	 */
	@SuppressWarnings("unchecked")
	boolean isEnableDynamicFeature();

	/**
	 * Gets the header group for this Data Table
	 *
	 * @return
	 */
	@SuppressWarnings({"unchecked"})
	@NotNull
	TableHeaderGroup getHeaderGroup();

	/**
	 * Sets the header group for this table
	 * 
	 *
	 * @param headerGroup
	 */
	@SuppressWarnings({"unchecked"})
	@NotNull
	J setHeaderGroup(TableHeaderGroup headerGroup);

	/**
	 * Returns all the options with this class
	 *
	 * @return
	 */
	@NotNull
	DataTableOptions getOptions();

	/**
	 * Sets if the dynamic features of this table must be rendered
	 *
	 * @param enableDynamicFeature
	 *
	 * @return
	 */
	@SuppressWarnings({"unchecked"})
	@NotNull
	J setEnableDynamicFeature(boolean enableDynamicFeature);

	/**
	 * Gets the footer group for this data table
	 *
	 * @return
	 */
	@SuppressWarnings({"unchecked"})
	@NotNull
	TableFooterGroup getFooterGroup();

	/**
	 * sets the footer group for this table
	 * 

	 *
	 * @param footerGroup
	 */
	@SuppressWarnings({"unchecked"})
	@NotNull
	J setFooterGroup(TableFooterGroup footerGroup);

	/**
	 * Gets the body group for this data table
	 *
	 * @return
	 */
	@SuppressWarnings({"unchecked"})
	@NotNull
	TableBodyGroup getBodyGroup();

	/**
	 * Returns the Table Caption associated with this object plus positioning utilities
	 *
	 * @return
	 */
	TableCaption getCaptionOfTable();

	/**
	 * Sets the body group for the table
	 * 
	 *
	 * @param bodyGroup
	 */
	@SuppressWarnings({"unchecked"})
	@NotNull
	J setBodyGroup(TableBodyGroup bodyGroup);

	/**
	 * Sets the caption for the table
	 *
	 * @param captionOfTable
	 */
	@SuppressWarnings({"unchecked"})
	@NotNull
	J setCaptionOfTable(TableCaption captionOfTable);
}