com.jwebmp.plugins.datatable.options.responsive.DataTablesResponsiveOptions 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
* Description
* This option provides the ability to enable and configure Responsive for DataTables. In its simplest form as the boolean true it will
* enable Responsive with the default configuration options (as defined by $.fn.dataTable.Responsive.defaults). It can also be used as an
* object to provide custom configuration options as described below.
*
* Please note that as with all other configuration options for Responsive, this option is an extension to the default set of DataTables
* options. This property should be set in the DataTables initialisation object.
*
* @param
*/
public class DataTablesResponsiveOptions>
extends JavaScriptPart
{
/**
* responsive.breakpointsSince: Responsive Responsive 1.0.0
* Set the breakpoints for a Responsive instance. Please note - this property requires the Responsive extension for DataTables.
*
* Description
* The visibility of columns in a DataTable with Responsive enabled can be controlled by breakpoints and class names matching those
* breakpoints (and other logical operations) . This provides the ability to exactly control which columns in a table will be visible
* in each device type. See the Responsive manual for more information.
*
* The breakpoints that are used by a Responsive instance are unique to that instance (i.e. each table) allowing different breakpoints
* to be set for different tables is needed.
*/
private Set> breakpoints;
/**
* responsive.detailsSince: Responsive Responsive 1.0.0
* Enable and configure the child rows shown by Responsive for collapsed tables. Please note - this property requires the Responsive
* extension for DataTables.
*
* Description
* Responsive has the ability to use DataTables' child rows feature to show information about any columns which have been removed from
* the display as a child row, which can be particularly useful for display complex information on small screen devices. Please see
* the Responsive manual on the details rows for further information.
*
* This options provides the ability to configure how the details rows are handled by Responsive. In its simplest form as a boolean
* value, the details row display can be enabled or disabled, while as an object you have the ability to control how the rows are
* displayed and the control to show / hide the child rows.
*
* Please note that as with all other configuration options for Responsive, this option is an extension to the default set of
* DataTables options. This property should be set in the DataTables initialisation object.
*/
private DataTablesResponsiveDetailOptions details;
/**
* responsiveSince: Responsive Responsive 1.0.0
* Enable and configure the Responsive extension for DataTables. Please note - this property requires the Responsive extension for
* DataTables.
*
* Description
* This option provides the ability to enable and configure Responsive for DataTables. In its simplest form as the boolean true it
* will enable Responsive with the default configuration options (as defined by $.fn.dataTable.Responsive.defaults). It can also be
* used as an object to provide custom configuration options as described below.
*
* Please note that as with all other configuration options for Responsive, this option is an extension to the default set of
* DataTables options. This property should be set in the DataTables initialisation object.
*/
public DataTablesResponsiveOptions()
{
//No config required
}
/**
* responsive.breakpointsSince: Responsive Responsive 1.0.0
* Set the breakpoints for a Responsive instance. Please note - this property requires the Responsive extension for DataTables.
*
* Description
* The visibility of columns in a DataTable with Responsive enabled can be controlled by breakpoints and class names matching those
* breakpoints (and other logical operations) . This provides the ability to exactly control which columns in a table will be visible
* in each device type. See the Responsive manual for more information.
*
* The breakpoints that are used by a Responsive instance are unique to that instance (i.e. each table) allowing different breakpoints
* to be set for different tables is needed.
*
* @return
*/
@NotNull
public Set> getBreakpoints()
{
if (breakpoints == null)
{
breakpoints = new TreeSet<>();
}
return breakpoints;
}
/**
* responsive.breakpointsSince: Responsive Responsive 1.0.0
* Set the breakpoints for a Responsive instance. Please note - this property requires the Responsive extension for DataTables.
*
* Description
* The visibility of columns in a DataTable with Responsive enabled can be controlled by breakpoints and class names matching those
* breakpoints (and other logical operations) . This provides the ability to exactly control which columns in a table will be visible
* in each device type. See the Responsive manual for more information.
*
* The breakpoints that are used by a Responsive instance are unique to that instance (i.e. each table) allowing different breakpoints
* to be set for different tables is needed.
*
* @param breakpoints
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setBreakpoints(Set> breakpoints)
{
this.breakpoints = breakpoints;
return (J) this;
}
/**
* responsive.detailsSince: Responsive Responsive 1.0.0
* Enable and configure the child rows shown by Responsive for collapsed tables. Please note - this property requires the Responsive
* extension for DataTables.
*
* Description
* Responsive has the ability to use DataTables' child rows feature to show information about any columns which have been removed from
* the display as a child row, which can be particularly useful for display complex information on small screen devices. Please see
* the Responsive manual on the details rows for further information.
*
* This options provides the ability to configure how the details rows are handled by Responsive. In its simplest form as a boolean
* value, the details row display can be enabled or disabled, while as an object you have the ability to control how the rows are
* displayed and the control to show / hide the child rows.
*
* Please note that as with all other configuration options for Responsive, this option is an extension to the default set of
* DataTables options. This property should be set in the DataTables initialisation object.
*
* @return
*/
public DataTablesResponsiveDetailOptions getDetails()
{
if (details == null)
{
details = new DataTablesResponsiveDetailOptions<>();
}
return details;
}
/**
* responsive.detailsSince: Responsive Responsive 1.0.0
* Enable and configure the child rows shown by Responsive for collapsed tables. Please note - this property requires the Responsive
* extension for DataTables.
*
* Description
* Responsive has the ability to use DataTables' child rows feature to show information about any columns which have been removed from
* the display as a child row, which can be particularly useful for display complex information on small screen devices. Please see
* the Responsive manual on the details rows for further information.
*
* This options provides the ability to configure how the details rows are handled by Responsive. In its simplest form as a boolean
* value, the details row display can be enabled or disabled, while as an object you have the ability to control how the rows are
* displayed and the control to show / hide the child rows.
*
* Please note that as with all other configuration options for Responsive, this option is an extension to the default set of
* DataTables options. This property should be set in the DataTables initialisation object.
*
* @param details
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setDetails(DataTablesResponsiveDetailOptions details)
{
this.details = details;
return (J) this;
}
}