Package io.jenkins.plugins.datatables

Enum Class TableConfiguration.SelectStyle

java.lang.Object

java.lang.Enum<TableConfiguration.SelectStyle>

io.jenkins.plugins.datatables.TableConfiguration.SelectStyle

All Implemented Interfaces:

Serializable, Comparable<TableConfiguration.SelectStyle>, Constable

Enclosing class:

TableConfiguration

public static enum TableConfiguration.SelectStyle
extends Enum<TableConfiguration.SelectStyle>

The possible values of the select.style option, which is used for enabling the selection for datatables and setting its style (the default is OS.

Author:

Florian Orendi

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
API	Selection can only be performed via the API.
MULTI	Multiple items can be selected.
MULTI_SHIFT	A hybrid between the OS style and MULTI, allowing easy multi-row selection without immediate de-selection when clicking on a row.
OS	Operating System (OS) style selection.
SINGLE	Only a single item can be selected, any other selected items will be automatically deselected when a new item is selected.

Method Summary

Modifier and Type	Method	Description
String	getStyle()
static TableConfiguration.SelectStyle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TableConfiguration.SelectStyle[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

API

public static final TableConfiguration.SelectStyle API

Selection can only be performed via the API.

SINGLE

public static final TableConfiguration.SelectStyle SINGLE

Only a single item can be selected, any other selected items will be automatically deselected when a new item is selected.

MULTI

public static final TableConfiguration.SelectStyle MULTI

Multiple items can be selected. Selection is performed by simply clicking on the items to be selected.

OS

public static final TableConfiguration.SelectStyle OS

Operating System (OS) style selection. This is the most comprehensive option and provides complex behaviours such as ctrl/cmd clicking to select / deselect individual items, shift clicking to select ranges and an unmodified click to select a single item.

MULTI_SHIFT

public static final TableConfiguration.SelectStyle MULTI_SHIFT

A hybrid between the OS style and MULTI, allowing easy multi-row selection without immediate de-selection when clicking on a row.

Method Details

values

public static TableConfiguration.SelectStyle[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TableConfiguration.SelectStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getStyle

public String getStyle()