com.jwebmp.plugins.datatable.options.DataTablesSearchOptions Maven / Gradle / Ivy
Show all versions of jwebmp-data-tables Show documentation
/*
* 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
* Description
* The search option allows the way DataTables performs filtering to be set during the initialisation, and to set an initial global filter.
*
* The options that control how the filtering is performs are:
*
* search.caseInsensitive - Indicate is case-insensitive sorting should be performed.
* search.regex - Treat the search as a regular expression or not
* search.smart - Use DataTables' smart filtering or not
* Additionally, to set an initial filter:
*
* search.search - Set an initial global filter.
*
* @param
*/
public class DataTablesSearchOptions>
extends JavaScriptPart
{
/**
* search.caseInsensitiveSince: DataTables 1.10
* Control case-sensitive filtering option.
*
* Description
* Flag to indicate if the filtering should be case insensitive or not.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* true
*/
private Boolean caseInsensitive;
/**
* search.regexSince: DataTables 1.10
* Enable / disable escaping of regular expression characters in the search term.
*
* Description
* Regular expressions can be used to build fantastically complex filtering terms, but also it is perfectly valid for users to enter
* characters such as * into the filter, so a decision needs to be made if you wish to escape regular expression special characters or
* not. This option controls that ability in DataTables.
*
* It is simply a flag to indicate if the search term should be interpreted as a regular expression (true) or not (false) and
* therefore and special regex characters escaped.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* Value: false
*/
private Boolean regex;
/**
* search.searchSince: DataTables 1.10
* Set an initial filtering condition on the table.
*
* Description
* Search term that should be applied to the table.
*
* Type
* This option can be given in the following type(s):
*
* string
*/
private String search;
/**
* search.smartSince: DataTables 1.10
* Enable / disable DataTables' smart filtering.
*
* Description
* DataTables' built-in filtering is "smart" in that it breaks the user's input into individual words and then matches those words in
* any position and in any order in the table (rather than simple doing a simple string compare).
*
* Although this can significantly enhance usability of the filtering feature, it uses a complex regular expression to perform this
* task, and as such it can interfere with a custom regular expression input if you enable that option (search.regex). As such, this
* option is provided to disable this smart filtering ability.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* Value: true
*/
private Boolean smart;
public DataTablesSearchOptions()
{
//No Config Needed
}
/**
* search.caseInsensitiveSince: DataTables 1.10
* Control case-sensitive filtering option.
*
* Description
* Flag to indicate if the filtering should be case insensitive or not.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* true
*
* @return
*/
public Boolean getCaseInsensitive()
{
return caseInsensitive;
}
/**
* search.caseInsensitiveSince: DataTables 1.10
* Control case-sensitive filtering option.
*
* Description
* Flag to indicate if the filtering should be case insensitive or not.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* true
*
* @param caseInsensitive
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setCaseInsensitive(Boolean caseInsensitive)
{
this.caseInsensitive = caseInsensitive;
return (J) this;
}
/**
* search.regexSince: DataTables 1.10
* Enable / disable escaping of regular expression characters in the search term.
*
* Description
* Regular expressions can be used to build fantastically complex filtering terms, but also it is perfectly valid for users to enter
* characters such as * into the filter, so a decision needs to be made if you wish to escape regular expression special characters or
* not. This option controls that ability in DataTables.
*
* It is simply a flag to indicate if the search term should be interpreted as a regular expression (true) or not (false) and
* therefore and special regex characters escaped.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* Value: false
*
* @return
*/
public Boolean getRegex()
{
return regex;
}
/**
* search.regexSince: DataTables 1.10
* Enable / disable escaping of regular expression characters in the search term.
*
* Description
* Regular expressions can be used to build fantastically complex filtering terms, but also it is perfectly valid for users to enter
* characters such as * into the filter, so a decision needs to be made if you wish to escape regular expression special characters or
* not. This option controls that ability in DataTables.
*
* It is simply a flag to indicate if the search term should be interpreted as a regular expression (true) or not (false) and
* therefore and special regex characters escaped.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* Value: false
*
* @param regex
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setRegex(Boolean regex)
{
this.regex = regex;
return (J) this;
}
/**
* search.searchSince: DataTables 1.10
* Set an initial filtering condition on the table.
*
* Description
* Search term that should be applied to the table.
*
* Type
* This option can be given in the following type(s):
*
* string
*
* @return
*/
public String getSearch()
{
return search;
}
/**
* search.searchSince: DataTables 1.10
* Set an initial filtering condition on the table.
*
* Description
* Search term that should be applied to the table.
*
* Type
* This option can be given in the following type(s):
*
* string
*
* @param search
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSearch(String search)
{
this.search = search;
return (J) this;
}
/**
* search.smartSince: DataTables 1.10
* Enable / disable DataTables' smart filtering.
*
* Description
* DataTables' built-in filtering is "smart" in that it breaks the user's input into individual words and then matches those words in
* any position and in any order in the table (rather than simple doing a simple string compare).
*
* Although this can significantly enhance usability of the filtering feature, it uses a complex regular expression to perform this
* task, and as such it can interfere with a custom regular expression input if you enable that option (search.regex). As such, this
* option is provided to disable this smart filtering ability.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* Value: true
*
* @return
*/
public Boolean getSmart()
{
return smart;
}
/**
* search.smartSince: DataTables 1.10
* Enable / disable DataTables' smart filtering.
*
* Description
* DataTables' built-in filtering is "smart" in that it breaks the user's input into individual words and then matches those words in
* any position and in any order in the table (rather than simple doing a simple string compare).
*
* Although this can significantly enhance usability of the filtering feature, it uses a complex regular expression to perform this
* task, and as such it can interfere with a custom regular expression input if you enable that option (search.regex). As such, this
* option is provided to disable this smart filtering ability.
*
* Type
* This option can be given in the following type(s):
*
* boolean
* Default
* Value: true
*
* @param smart
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setSmart(Boolean smart)
{
this.smart = smart;
return (J) this;
}
}