com.jwebmp.plugins.datatable.options.buttons.DataTablesButtonsOptions 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 have a Buttons instance created automatically when a new DataTable is created. The button
* collection can then be inserted into the DataTables controlled DOM by using the B option in the dom parameter, or through the buttons
* ().container() API method.
*
* @param
*/
@JsonAutoDetect(fieldVisibility = ANY,
getterVisibility = NONE,
setterVisibility = NONE)
@JsonInclude(NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public class DataTablesButtonsOptions>
extends JavaScriptPart
{
/**
* buttons.nameSince: Buttons 1.0.0
* Set a name for the instance for the group selector. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* As multiple Buttons instances can be attached to a single DataTable, it can be useful to be able to select each instance
* individually. This option provides the ability to set a name for the instance so it can later be selected using the
* button-group-selector option of the buttons() and button() API methods.
*
* The instance name does not need to be unique. If a group selector is given that matches multiple instances, all matching instances
* will be selected.
*/
private String name;
/**
* buttons.domSince: Buttons 1.0.0
* Options to control the DOM structure Buttons creates. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* The markup that is created by Buttons is quite flexible in that you can control the tags used and the class names. You can also
* optionally control the structure of the markup for the buttons.
*/
private DataTablesButtonsDomOptions dom;
/**
* buttons.buttonsSince: Buttons 1.0.0
* List of buttons to be created. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* The buttons array defines the buttons that will appear in the document to the end user. Each element in the array can be one of:
*
* string - The name of a built-in button type or plug-in button type. This is the equivalent of using { extend: ... }.
* object - A custom button or a customisation of an existing button type. The extend property (see buttons.buttons.extend) can be
* defined to tell Buttons which button type to base the button on, and any of the configuration options you wish to customise.
* Alternatively, if the extend option is not given, use the text and action options to define a button. Buttons has only a few built
* in configuration options for each button, but the various button types may provide additional options. Please refer to the
* documentation for each button type for information on the further options they provide.
*/
private Set> buttons;
/**
* buttonsSince: Buttons 1.0.0
* Buttons configuration object. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* This option provides the ability to have a Buttons instance created automatically when a new DataTable is created. The button
* collection can then be inserted into the DataTables controlled DOM by using the B option in the dom parameter, or through the
* buttons().container() API method.
*/
public DataTablesButtonsOptions()
{
//No config required
}
/**
* buttons.nameSince: Buttons 1.0.0
* Set a name for the instance for the group selector. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* As multiple Buttons instances can be attached to a single DataTable, it can be useful to be able to select each instance
* individually. This option provides the ability to set a name for the instance so it can later be selected using the
* button-group-selector option of the buttons() and button() API methods.
*
* The instance name does not need to be unique. If a group selector is given that matches multiple instances, all matching instances
* will be selected.
*
* @return
*/
public String getName()
{
return name;
}
/**
* buttons.nameSince: Buttons 1.0.0
* Set a name for the instance for the group selector. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* As multiple Buttons instances can be attached to a single DataTable, it can be useful to be able to select each instance
* individually. This option provides the ability to set a name for the instance so it can later be selected using the
* button-group-selector option of the buttons() and button() API methods.
*
* The instance name does not need to be unique. If a group selector is given that matches multiple instances, all matching instances
* will be selected.
*
* @param name
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setName(String name)
{
this.name = name;
return (J) this;
}
/**
* buttons.domSince: Buttons 1.0.0
* Options to control the DOM structure Buttons creates. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* The markup that is created by Buttons is quite flexible in that you can control the tags used and the class names. You can also
* optionally control the structure of the markup for the buttons.
*
* @return
*/
public DataTablesButtonsDomOptions getDom()
{
if (dom == null)
{
dom = new DataTablesButtonsDomOptions();
}
return dom;
}
/**
* buttons.domSince: Buttons 1.0.0
* Options to control the DOM structure Buttons creates. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* The markup that is created by Buttons is quite flexible in that you can control the tags used and the class names. You can also
* optionally control the structure of the markup for the buttons.
*
* @param dom
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setDom(DataTablesButtonsDomOptions dom)
{
this.dom = dom;
return (J) this;
}
/**
* buttons.buttonsSince: Buttons 1.0.0
* List of buttons to be created. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* The buttons array defines the buttons that will appear in the document to the end user. Each element in the array can be one of:
*
* string - The name of a built-in button type or plug-in button type. This is the equivalent of using { extend: ... }.
* object - A custom button or a customisation of an existing button type. The extend property (see buttons.buttons.extend) can be
* defined to tell Buttons which button type to base the button on, and any of the configuration options you wish to customise.
* Alternatively, if the extend option is not given, use the text and action options to define a button. Buttons has only a few built
* in configuration options for each button, but the various button types may provide additional options. Please refer to the
* documentation for each button type for information on the further options they provide.
*
* @return
*/
@NotNull
public Set> getButtons()
{
if (buttons == null)
{
buttons = new LinkedHashSet<>();
}
return buttons;
}
/**
* buttons.buttonsSince: Buttons 1.0.0
* List of buttons to be created. Please note - this property requires the Buttons extension for DataTables.
*
* Description
* The buttons array defines the buttons that will appear in the document to the end user. Each element in the array can be one of:
*
* string - The name of a built-in button type or plug-in button type. This is the equivalent of using { extend: ... }.
* object - A custom button or a customisation of an existing button type. The extend property (see buttons.buttons.extend) can be
* defined to tell Buttons which button type to base the button on, and any of the configuration options you wish to customise.
* Alternatively, if the extend option is not given, use the text and action options to define a button. Buttons has only a few built
* in configuration options for each button, but the various button types may provide additional options. Please refer to the
* documentation for each button type for information on the further options they provide.
*
* @param buttons
*
* @return
*/
@SuppressWarnings("unchecked")
@NotNull
public J setButtons(Set> buttons)
{
this.buttons = buttons;
return (J) this;
}
}