ColumnConfig (domino-ui 1.0.0-RC13 API)

java.lang.Object
- org.dominokit.domino.ui.datatable.ColumnConfig<T>

Type Parameters:

T - the type of the data table records
```
public class ColumnConfig<T>
extends Object
```
Class to define a column in the data table

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ColumnConfig.CellStyler<T>
A hook interface to style a cell being rendered on the table

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ColumnConfig.CellStyler<T>` A hook interface to style a cell being rendered on the table

Constructor Summary

Constructors
Constructor and Description
`ColumnConfig(String name)` Creates an instance with a name which will also be used as a title
`ColumnConfig(String name, String title)` Creates an instance with a name and title

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ColumnConfig<T>`	`addShowHideListener(ColumnShowHideListener showHideListener)` Adds a listener to listen for column hide/show changes
`ColumnConfig<T>`	`alignCenter()` a shortcut to `setWidth(String)` with value center
`ColumnConfig<T>`	`alignLeft()` a shortcut to `setWidth(String)` with value left
`ColumnConfig<T>`	`alignRight()` a shortcut to `setWidth(String)` with value right
`void`	`applyScreenMedia(elemental2.dom.HTMLTableCellElement element)` force apply screen medias if exists to a cell in this column
`ColumnConfig<T>`	`asHeader()`
`void`	`clearShowHideListeners()` removes all `ColumnShowHideListener`s of this column except the permanent listeners
`void`	`clearShowHideListners()` Deprecated. use `clearShowHideListeners()`
`static <T> ColumnConfig<T>`	`create(String name)` Creates an instance with a name which will also be used as a title
`static <T> ColumnConfig<T>`	`create(String name, String title)` Creates an instance with a name and title
`CellRenderer<T>`	`getCellRenderer()`
`ColumnConfig.CellStyler<T>`	`getCellStyler()`
`CellRenderer<T>`	`getEditableCellRenderer()`
`DominoElement<elemental2.dom.HTMLTableCellElement>`	`getHeadElement()`
`HeaderElementSupplier`	`getHeaderElement()` Deprecated.
`HeaderElementSupplier`	`getHeaderElementSupplier()`
`FlexLayout`	`getHeaderLayout()`
`ColumnConfig.CellStyler<T>`	`getHeaderStyler()`
`ScreenMedia`	`getHideOn()`
`String`	`getMaxWidth()`
`String`	`getMinWidth()`
`String`	`getName()`
`ScreenMedia`	`getShowOn()`
`String`	`getSortKey()`
`String`	`getTextAlign()`
`String`	`getTitle()`
`elemental2.dom.Node`	`getTooltipNode()`
`String`	`getWidth()`
`ColumnConfig<T>`	`hide()` Hides the column and call the listeners
`ColumnConfig<T>`	`hideOn(ScreenMedia hideOn)`
`boolean`	`isDrawTitle()`
`boolean`	`isFixed()`
`boolean`	`isHeader()` While rendering the column this will determine if we should build the header with th or td elements
`boolean`	`isHidden()`
`boolean`	`isPluginColumn()`
`boolean`	`isShowTooltip()`
`boolean`	`isSortable()`
`boolean`	`isUtilityColumn()`
`ColumnConfig<T>`	`maxWidth(String maxWidth)`
`ColumnConfig<T>`	`minWidth(String minWidth)`
`ColumnConfig<T>`	`removeShowHideListener(ColumnShowHideListener showHideListener)` remove the listener
`ColumnConfig<T>`	`setCellRenderer(CellRenderer<T> cellRenderer)` sets the cell renderer for this column
`ColumnConfig<T>`	`setDrawTitle(boolean drawTitle)` Set if the column should render its title or not
`ColumnConfig<T>`	`setEditableCellRenderer(CellRenderer<T> editableCellRenderer)` sets the cell renderer to render this column cells in editable mode
`ColumnConfig<T>`	`setFixed(boolean fixed)`
`protected void`	`setHeadElement(elemental2.dom.HTMLTableCellElement headElement)` sets a custom element for the column header
`ColumnConfig<T>`	`setHeaderElement(HeaderElementSupplier headerElement)` Deprecated.
`ColumnConfig<T>`	`setHeaderElementSupplier(HeaderElementSupplier headerElement)` Sets a custom header element for the column
`ColumnConfig<T>`	`setPluginColumn(boolean pluginColumn)` flags the columns as a plugin column or not
`ColumnConfig<T>`	`setShowTooltip(boolean showTooltip)`
`ColumnConfig<T>`	`setSortable(boolean sortable)` set wither the column can be used to sort the data or not
`ColumnConfig<T>`	`setSortable(boolean sortable, String sortKey)` set wither the column can be used to sort the data or not
`ColumnConfig<T>`	`setTitle(String title)`
`ColumnConfig<T>`	`setTooltipNode(elemental2.dom.Node tooltipNode)` sets a custom tooltip element
`ColumnConfig<T>`	`setTooltipText(String tooltipText)` sets the tooltip text
`ColumnConfig<T>`	`setWidth(String width)`
`ColumnConfig<T>`	`show()` show the column and call the listeners
`ColumnConfig<T>`	`showOn(ScreenMedia showOn)`
`ColumnConfig<T>`	`sortable()` a shortcut for `setSortable(boolean)` with value true
`ColumnConfig<T>`	`sortable(String sortKey)` a shortcut for `setSortable(boolean)` with value true
`ColumnConfig<T>`	`styleCell(ColumnConfig.CellStyler<T> cellStyler)` a hook to style a cell in the column
`ColumnConfig<T>`	`styleHeader(ColumnConfig.CellStyler<T> headerStyler)` a hook to style a column header
`ColumnConfig<T>`	`textAlign(String textAlign)`
`ColumnConfig<T>`	`toggleDisplay(boolean visible)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ColumnConfig
```
public ColumnConfig(String name,
                    String title)
```
    Creates an instance with a name and title
    
    Parameters:
    
    name - String, the name of the column
    
    title - String, the title of the column
  - ColumnConfig
```
public ColumnConfig(String name)
```
    Creates an instance with a name which will also be used as a title
    
    Parameters:
    
    name - String, the name of the column
- Method Detail
  - create
```
public static <T> ColumnConfig<T> create(String name)
```
    Creates an instance with a name which will also be used as a title
    
    Type Parameters:
    
    T - the type of the data table records
    
    Parameters:
    
    name - String, the name of the column
    
    Returns:
    
    new ColumnConfig instance
  - create
```
public static <T> ColumnConfig<T> create(String name,
                                         String title)
```
    Creates an instance with a name and title
    
    Type Parameters:
    
    T - the type of the data table records
    
    Parameters:
    
    name - String, the name of the column
    
    title - String, the title of the column
    
    Returns:
    
    new ColumnConfig instance
  - getTitle
```
public String getTitle()
```
    Returns:
    
    String column title
  - getName
```
public String getName()
```
    Returns:
    
    String column name
  - asHeader
```
public ColumnConfig<T> asHeader()
```
  - minWidth
```
public ColumnConfig<T> minWidth(String minWidth)
```
    Parameters:
    
    minWidth - String css minimum width for the column
    
    Returns:
    
    same ColumnConfig instance
  - maxWidth
```
public ColumnConfig<T> maxWidth(String maxWidth)
```
    Parameters:
    
    maxWidth - String css maximum width for the column
    
    Returns:
    
    same ColumnConfig instance
  - getWidth
```
public String getWidth()
```
    Returns:
    
    String the width of the column that we set using the setWidth(String) not the actual width of the column
  - setWidth
```
public ColumnConfig<T> setWidth(String width)
```
    Parameters:
    
    width - String css width for the column
    
    Returns:
    
    same ColumnConfig instance
  - textAlign
```
public ColumnConfig<T> textAlign(String textAlign)
```
    Parameters:
    
    textAlign - String css text align for the column values left,right,center
    
    Returns:
    
    same ColumnConfig instance
  - alignLeft
```
public ColumnConfig<T> alignLeft()
```
    a shortcut to setWidth(String) with value left
    
    Returns:
    
    same ColumnConfig instance
  - alignRight
```
public ColumnConfig<T> alignRight()
```
    a shortcut to setWidth(String) with value right
    
    Returns:
    
    same ColumnConfig instance
  - alignCenter
```
public ColumnConfig<T> alignCenter()
```
    a shortcut to setWidth(String) with value center
    
    Returns:
    
    same ColumnConfig instance
  - getHeaderElement
```
@Deprecated
public HeaderElementSupplier getHeaderElement()
```
    Deprecated.
    
    Returns:
    
    the HeaderElementSupplier of the column
  - getHeaderElementSupplier
```
public HeaderElementSupplier getHeaderElementSupplier()
```
    Returns:
    
    the HeaderElementSupplier of the column
  - setHeaderElement
```
@Deprecated
public ColumnConfig<T> setHeaderElement(HeaderElementSupplier headerElement)
```
    Deprecated.
    
    Sets a custom header element for the column
    
    Parameters:
    
    headerElement - the HeaderElementSupplier
    
    Returns:
    
    same ColumnConfig instance
  - setHeaderElementSupplier
```
public ColumnConfig<T> setHeaderElementSupplier(HeaderElementSupplier headerElement)
```
    Sets a custom header element for the column
    
    Parameters:
    
    headerElement - the HeaderElementSupplier
    
    Returns:
    
    same ColumnConfig instance
  - isHeader
```
public boolean isHeader()
```
    While rendering the column this will determine if we should build the header with th or td elements
    
    Returns:
    
    boolean, if ture use th elements, otherwise use td elements
  - getMinWidth
```
public String getMinWidth()
```
    Returns:
    
    the String minimum width we set with minWidth(String)
  - getMaxWidth
```
public String getMaxWidth()
```
    Returns:
    
    the String maximum width we set with maxWidth(String)
  - getTextAlign
```
public String getTextAlign()
```
    Returns:
    
    the String text align we set with textAlign(String)
  - isFixed
```
public boolean isFixed()
```
    Returns:
    
    boolean, if true the column width will be fixed and wont change if the table size changed
  - setFixed
```
public ColumnConfig<T> setFixed(boolean fixed)
```
    Parameters:
    
    fixed - boolean, if true the column width will be fixed and wont change when the table size is changed.
    
    Returns:
    
    same ColumnConfig instance.
  - setTitle
```
public ColumnConfig<T> setTitle(String title)
```
  - getHeadElement
```
public DominoElement<elemental2.dom.HTMLTableCellElement> getHeadElement()
```
    Returns:
    
    the HTMLTableCellElement that represent this column element wrapped as DominoElement
  - setHeadElement
```
protected void setHeadElement(elemental2.dom.HTMLTableCellElement headElement)
```
    sets a custom element for the column header
    
    Parameters:
    
    headElement - HTMLTableCellElement
  - getCellRenderer
```
public CellRenderer<T> getCellRenderer()
```
    Returns:
    
    the CellRenderer of this column
  - setCellRenderer
```
public ColumnConfig<T> setCellRenderer(CellRenderer<T> cellRenderer)
```
    sets the cell renderer for this column
    
    Parameters:
    
    cellRenderer - CellRenderer
    
    Returns:
    
    same ColumnConfig instance
  - getEditableCellRenderer
```
public CellRenderer<T> getEditableCellRenderer()
```
    Returns:
    
    the CellRenderer of the editable version of this column
  - setEditableCellRenderer
```
public ColumnConfig<T> setEditableCellRenderer(CellRenderer<T> editableCellRenderer)
```
    sets the cell renderer to render this column cells in editable mode
    
    Parameters:
    
    editableCellRenderer - CellRenderer
    
    Returns:
    
    same ColumnConfig instance
  - styleHeader
```
public ColumnConfig<T> styleHeader(ColumnConfig.CellStyler<T> headerStyler)
```
    a hook to style a column header
    
    Parameters:
    
    headerStyler - ColumnConfig.CellStyler
    
    Returns:
    
    same ColumnConfig instance
  - styleCell
```
public ColumnConfig<T> styleCell(ColumnConfig.CellStyler<T> cellStyler)
```
    a hook to style a cell in the column
    
    Parameters:
    
    cellStyler - ColumnConfig.CellStyler
    
    Returns:
    
    same ColumnConfig instance
  - isSortable
```
public boolean isSortable()
```
    Returns:
    
    boolean, true if data can be sorted with this column, otherwise false
  - setSortable
```
public ColumnConfig<T> setSortable(boolean sortable)
```
    set wither the column can be used to sort the data or not
    
    Parameters:
    
    sortable - boolean, if true then data can be sorted with this column, otherwise it cant
    
    Returns:
    
    same ColumnConfig instance
  - setSortable
```
public ColumnConfig<T> setSortable(boolean sortable,
                                   String sortKey)
```
    set wither the column can be used to sort the data or not
    
    Parameters:
    
    sortable - boolean, if true then data can be sorted with this column, otherwise it cant
    
    Returns:
    
    same ColumnConfig instance
  - sortable
```
public ColumnConfig<T> sortable()
```
    a shortcut for setSortable(boolean) with value true
    
    Returns:
    
    same ColumnConfig instance
  - sortable
```
public ColumnConfig<T> sortable(String sortKey)
```
    a shortcut for setSortable(boolean) with value true
    
    Parameters:
    
    sortKey - String key for sort property
    
    Returns:
    
    same ColumnConfig instance
  - applyScreenMedia
```
public void applyScreenMedia(elemental2.dom.HTMLTableCellElement element)
```
    force apply screen medias if exists to a cell in this column
    
    Parameters:
    
    element - HTMLTableCellElement
  - getTooltipNode
```
public elemental2.dom.Node getTooltipNode()
```
    Returns:
    
    the Node representing the tooltip for this column header if exists otherwise return the title node
  - setTooltipNode
```
public ColumnConfig<T> setTooltipNode(elemental2.dom.Node tooltipNode)
```
    sets a custom tooltip element
    
    Parameters:
    
    tooltipNode - Node
    
    Returns:
    
    same ColumnConfig instance
  - setTooltipText
```
public ColumnConfig<T> setTooltipText(String tooltipText)
```
    sets the tooltip text
    
    Parameters:
    
    tooltipText - String
    
    Returns:
    
    same ColumnConfig instance
  - setShowTooltip
```
public ColumnConfig<T> setShowTooltip(boolean showTooltip)
```
    Parameters:
    
    showTooltip - boolean, if true a tooltip will show up when hover on the column otherwise it will not.
    
    Returns:
    
    same ColumnConfig instance
  - getShowOn
```
public ScreenMedia getShowOn()
```
    Returns:
    
    the ScreenMedia that result on showing the column
  - showOn
```
public ColumnConfig<T> showOn(ScreenMedia showOn)
```
    Parameters:
    
    showOn - ScreenMedia when is applied the column will be shown
    
    Returns:
    
    same ColumnConfig instance
  - getHideOn
```
public ScreenMedia getHideOn()
```
    Returns:
    
    the ScreenMedia that result on hiding the column
  - hideOn
```
public ColumnConfig<T> hideOn(ScreenMedia hideOn)
```
    Parameters:
    
    hideOn - ScreenMedia when is applied the column will be hidden
    
    Returns:
    
    same ColumnConfig instance
  - getHeaderStyler
```
public ColumnConfig.CellStyler<T> getHeaderStyler()
```
    Returns:
    
    the ColumnConfig.CellStyler of the header element
  - getCellStyler
```
public ColumnConfig.CellStyler<T> getCellStyler()
```
    Returns:
    
    the ColumnConfig.CellStyler of the cell element
  - isShowTooltip
```
public boolean isShowTooltip()
```
    Returns:
    
    boolean, if true this column show a tooltip otherwise it does not
  - addShowHideListener
```
public ColumnConfig<T> addShowHideListener(ColumnShowHideListener showHideListener)
```
    Adds a listener to listen for column hide/show changes
    
    Parameters:
    
    showHideListener - ColumnShowHideListener
    
    Returns:
    
    same ColumnConfig instance
  - removeShowHideListener
```
public ColumnConfig<T> removeShowHideListener(ColumnShowHideListener showHideListener)
```
    remove the listener
    
    Parameters:
    
    showHideListener - ColumnShowHideListener
    
    Returns:
    
    same ColumnConfig instance
  - show
```
public ColumnConfig<T> show()
```
    show the column and call the listeners
    
    Returns:
    
    same ColumnConfig instance
  - hide
```
public ColumnConfig<T> hide()
```
    Hides the column and call the listeners
    
    Returns:
    
    same ColumnConfig instance
  - toggleDisplay
```
public ColumnConfig<T> toggleDisplay(boolean visible)
```
    Parameters:
    
    visible - boolean, if true call show() otherwise call hide()
    
    Returns:
  - clearShowHideListners
```
@Deprecated
public void clearShowHideListners()
```
    Deprecated. use clearShowHideListeners()
  - clearShowHideListeners
```
public void clearShowHideListeners()
```
    removes all ColumnShowHideListeners of this column except the permanent listeners
  - isHidden
```
public boolean isHidden()
```
    Returns:
    
    boolean, true if the column is already hidden, otherwise false
  - isPluginColumn
```
public boolean isPluginColumn()
```
    Returns:
    
    boolean, true if the column is registered by a plugin, else false
  - setPluginColumn
```
public ColumnConfig<T> setPluginColumn(boolean pluginColumn)
```
    flags the columns as a plugin column or not
    
    Parameters:
    
    pluginColumn - boolean, true if the column is being registered by a plugin, else false
    
    Returns:
    
    same ColumnConfig instance
  - getSortKey
```
public String getSortKey()
```
    Returns:
    
    String key of the column
  - getHeaderLayout
```
public FlexLayout getHeaderLayout()
```
    Returns:
    
    The FlexLayout of the column header
  - isUtilityColumn
```
public final boolean isUtilityColumn()
```
    Returns:
    
    boolean, true of the column is the plugins utility column, otherwise return false
  - isDrawTitle
```
public boolean isDrawTitle()
```
    Returns:
    
    boolean, true if the column show render the title
  - setDrawTitle
```
public ColumnConfig<T> setDrawTitle(boolean drawTitle)
```
    Set if the column should render its title or not
    
    Parameters:
    
    drawTitle - boolean
    
    Returns:
    
    same ColumnConfig instance

Class ColumnConfig<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ColumnConfig

ColumnConfig

Method Detail

create

create

getTitle

getName

asHeader

minWidth

maxWidth

getWidth

setWidth

textAlign

alignLeft

alignRight

alignCenter

getHeaderElement

getHeaderElementSupplier

setHeaderElement

setHeaderElementSupplier

isHeader

getMinWidth

getMaxWidth

getTextAlign

isFixed

setFixed

setTitle

getHeadElement

setHeadElement

getCellRenderer

setCellRenderer

getEditableCellRenderer

setEditableCellRenderer

styleHeader

styleCell

isSortable

setSortable

setSortable

sortable

sortable

applyScreenMedia

getTooltipNode

setTooltipNode

setTooltipText

setShowTooltip

getShowOn

showOn

getHideOn

hideOn

getHeaderStyler

getCellStyler

isShowTooltip

addShowHideListener

removeShowHideListener

show

hide

toggleDisplay

clearShowHideListners

clearShowHideListeners

isHidden

isPluginColumn

setPluginColumn

getSortKey

getHeaderLayout

isUtilityColumn

isDrawTitle

setDrawTitle