ColumnConfig (GXT 4.0.2)

java.lang.Object
- com.sencha.gxt.widget.core.client.grid.ColumnConfig<M,N>

Direct Known Subclasses:

RowExpander, RowNumberer, SummaryColumnConfig
```
public class ColumnConfig<M,N>
extends Object
```
A column config for a column in a column model.

The column config is a configuration object that should only be used when creating a column model. After the column model is created, any changes should be made to the column model, not the column config.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean ariaIgnore
True to disable keyboard column navigation of this column.

Fields
Modifier and Type	Field and Description
`protected boolean`	`ariaIgnore` True to disable keyboard column navigation of this column.

Constructor Summary

Constructors
Constructor and Description
`ColumnConfig(ValueProvider<? super M,N> valueProvider)` Creates a new column config.
`ColumnConfig(ValueProvider<? super M,N> valueProvider, int width)` Creates a new column config.
`ColumnConfig(ValueProvider<? super M,N> valueProvider, int width, SafeHtml header)` Creates a new column config.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<any>`	`getCell()` Returns the column's cell renderer.
`String`	`getCellClassName()` Returns the cell's class name(s).
`String`	`getColumnHeaderClassName()` Returns the column class names(s).
`SafeStyles`	`getColumnStyle()` Returns the column cells styles.
`String`	`getColumnTextClassName()` Returns the column text class name(s).
`SafeStyles`	`getColumnTextStyle()` Returns the column text styles.
`Comparator<N>`	`getComparator()` Returns the comparator used to compare the items in this column when grouping or sorting.
`SafeHtml`	`getHeader()` Returns the column's header html.
`HorizontalAlignmentConstant`	`getHorizontalAlignment()` Returns the column's horizontal alignment.
`HorizontalAlignmentConstant`	`getHorizontalHeaderAlignment()` Returns the column's header horizontal alignment.
`String`	`getPath()` Returns the value provider path.
`SafeHtml`	`getToolTip()` Returns the column's tool tip.
`ValueProvider<? super M,N>`	`getValueProvider()` Returns the column's valueProvider.
`VerticalAlignmentConstant`	`getVerticalAlignment()` Returns the column's vertical alignment.
`Widget`	`getWidget()` Returns the column's widget.
`int`	`getWidth()` Returns the column's width.
`boolean`	`isCellPadding()`
`boolean`	`isFixed()` Returns true if the column width cannot be changed.
`boolean`	`isGroupable()` Returns true if the column can be grouped.
`boolean`	`isHidden()` Returns true if the column is hidden.
`boolean`	`isHideable()` Returns true if the column can be hidden.
`boolean`	`isMenuDisabled()` Returns true if the column's menu is disabled.
`boolean`	`isResizable()` Returns true if the column is resizable.
`boolean`	`isRowHeader()` Returns true if the column is marked as the row header.
`boolean`	`isSortable()` Returns `true` if the column is sortable (pre-render).
`void`	`setCell(<any> cell)` Sets the column's cell renderer (pre-render).
`void`	`setCellClassName(String cellClassName)` If provided, this value will be added to all table cells for the column.
`void`	`setCellPadding(boolean cellPadding)` Configures whether or not the column's cells should have the default padding around their contents.
`void`	`setColumnHeaderClassName(String classNames)` Sets the CSS class name(s) to be applied to the header element (defaults to null).
`void`	`setColumnStyle(SafeStyles columnStyles)` Sets the CSS class name(s) to be applied to the cell in the column (defaults to null).
`void`	`setColumnTextClassName(String columnTextClassName)` Sets the CSS class name(s) to be applied to the text element of each cell in the column (defaults to null).
`void`	`setColumnTextStyle(SafeStyles textStyles)` Sets one to many CSS styles to be applied to the text element of each cell in the column (defaults to null).
`void`	`setComparator(Comparator<N> comparator)` Sets the comparator used to compare the items in this column when grouping or sorting.
`void`	`setFixed(boolean fixed)` True if the column width cannot be changed either by column model or user resizing (defaults to false, pre-render).
`void`	`setGroupable(boolean groupable)` Sets if the column is groupable (defaults to true).
`void`	`setHeader(SafeHtml html)` Sets the column's header html.
`void`	`setHidden(boolean hidden)` Sets whether the column is hidden.
`void`	`setHideable(boolean hideable)` True to allow the column to be hidden via the context menu (defaults to true).
`void`	`setHorizontalAlignment(HorizontalAlignmentConstant horizontalAlignment)` Sets the column's horizontal alignment.
`void`	`setHorizontalHeaderAlignment(HorizontalAlignmentConstant horizontalHeaderAlignment)` Sets the column's header horizontal alignment.
`void`	`setMenuDisabled(boolean menuDisabled)` Sets whether the column's menu is disabled (pre-render).
`void`	`setResizable(boolean resizable)` Specifies if the column may be resized (defaults to true, pre-render).
`void`	`setRowHeader(boolean rowHeader)` True to mark this column as the row header.
`void`	`setSortable(boolean sortable)` Sets if the column can be sorted (defaults to true, pre-render).
`void`	`setToolTip(SafeHtml toolTip)` Sets the column's tool tip as html.
`void`	`setVerticalAlignment(VerticalAlignmentConstant verticalAlignment)` Sets the column's vertical alignment.
`void`	`setWidget(Widget widget, SafeHtml header)` Sets the column's widget.
`void`	`setWidth(int width)` Sets the column's width in pixels.

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

- Field Detail
  - ariaIgnore
```
protected boolean ariaIgnore
```
    True to disable keyboard column navigation of this column.
- Constructor Detail
  - ColumnConfig
```
public ColumnConfig(ValueProvider<? super M,N> valueProvider)
```
    Creates a new column config.
    
    Parameters:
    
    valueProvider - the value provider
  - ColumnConfig
```
public ColumnConfig(ValueProvider<? super M,N> valueProvider,
                    int width)
```
    Creates a new column config.
    
    Parameters:
    
    valueProvider - the value provider
    
    width - the column width
  - ColumnConfig
```
public ColumnConfig(ValueProvider<? super M,N> valueProvider,
                    int width,
                    SafeHtml header)
```
    Creates a new column config.
    
    Parameters:
    
    valueProvider - the value provider
    
    width - the column width
    
    header - the column header content
- Method Detail
  - getHorizontalAlignment
```
public HorizontalAlignmentConstant getHorizontalAlignment()
```
    Returns the column's horizontal alignment.
    
    Returns:
    
    the horizontalAlignment
  - getVerticalAlignment
```
public VerticalAlignmentConstant getVerticalAlignment()
```
    Returns the column's vertical alignment.
    
    Returns:
    
    the verticalAlignment
  - getHorizontalHeaderAlignment
```
public HorizontalAlignmentConstant getHorizontalHeaderAlignment()
```
    Returns the column's header horizontal alignment.
    
    Returns:
    
    the horizontalAlignment
  - getCell
```
public <any> getCell()
```
    Returns the column's cell renderer.
    
    Returns:
    
    the renderer
  - getCellClassName
```
public String getCellClassName()
```
    Returns the cell's class name(s).
    
    Returns:
    
    the cell's class name(s)
  - getColumnHeaderClassName
```
public String getColumnHeaderClassName()
```
    Returns the column class names(s).
    
    Returns:
    
    the column class names(s)
  - getColumnStyle
```
public SafeStyles getColumnStyle()
```
    Returns the column cells styles.
    
    Returns:
    
    the styles
  - getColumnTextClassName
```
public String getColumnTextClassName()
```
    Returns the column text class name(s).
    
    Returns:
    
    the class names(s)
  - getColumnTextStyle
```
public SafeStyles getColumnTextStyle()
```
    Returns the column text styles.
    
    Returns:
    
    the styles
  - getComparator
```
public Comparator<N> getComparator()
```
    Returns the comparator used to compare the items in this column when grouping or sorting. If N implements Comparable, this is not required to sort or group.
    
    Returns:
    
    the current comparator used or null if none has been set.
  - getHeader
```
public SafeHtml getHeader()
```
    Returns the column's header html.
    
    Returns:
    
    the header html
  - getPath
```
public String getPath()
```
    Returns the value provider path.
    
    Returns:
    
    the path
  - getToolTip
```
public SafeHtml getToolTip()
```
    Returns the column's tool tip.
    
    Returns:
    
    the tool tip
  - getValueProvider
```
public ValueProvider<? super M,N> getValueProvider()
```
    Returns the column's valueProvider.
    
    Returns:
    
    the valueProvider
  - getWidget
```
public Widget getWidget()
```
    Returns the column's widget.
    
    Returns:
    
    the widget
  - getWidth
```
public int getWidth()
```
    Returns the column's width.
    
    Returns:
    
    the column width
  - isCellPadding
```
public boolean isCellPadding()
```
  - isFixed
```
public boolean isFixed()
```
    Returns true if the column width cannot be changed. Applies to both column width calculations (auto fill, force fit, auto expand column) and user resizing.
    
    Returns:
    
    the fixed state
  - isGroupable
```
public boolean isGroupable()
```
    Returns true if the column can be grouped.
    
    Returns:
    
    true if groupable
  - isHidden
```
public boolean isHidden()
```
    Returns true if the column is hidden.
    
    Returns:
    
    the hidden state
  - isHideable
```
public boolean isHideable()
```
    Returns true if the column can be hidden.
    
    Returns:
    
    true if column can be hidden
  - isMenuDisabled
```
public boolean isMenuDisabled()
```
    Returns true if the column's menu is disabled.
    
    Returns:
    
    the menu disabled state
  - isResizable
```
public boolean isResizable()
```
    Returns true if the column is resizable.
    
    Returns:
    
    the resizable state
  - isRowHeader
```
public boolean isRowHeader()
```
    Returns true if the column is marked as the row header.
    
    Returns:
    
    true if row header
  - isSortable
```
public boolean isSortable()
```
    Returns true if the column is sortable (pre-render).
    
    Returns:
    
    the sortable state
  - setHorizontalAlignment
```
public void setHorizontalAlignment(HorizontalAlignmentConstant horizontalAlignment)
```
    Sets the column's horizontal alignment. This will affect cells with a rendering width less than 100%.
    
    Parameters:
    
    horizontalAlignment - the horizontal alignment
  - setHorizontalHeaderAlignment
```
public void setHorizontalHeaderAlignment(HorizontalAlignmentConstant horizontalHeaderAlignment)
```
    Sets the column's header horizontal alignment. This will affect cells with a rendering width less than 100%.
    
    Parameters:
    
    horizontalHeaderAlignment - the horizontal header alignment
  - setCell
```
public void setCell(<any> cell)
```
    Sets the column's cell renderer (pre-render).
    
    Parameters:
    
    cell - the cell renderer
  - setCellPadding
```
public void setCellPadding(boolean cellPadding)
```
    Configures whether or not the column's cells should have the default padding around their contents. Defaults to true
    
    Parameters:
    
    cellPadding - false to disable padding around the contents of a cell
  - setCellClassName
```
public void setCellClassName(String cellClassName)
```
    If provided, this value will be added to all table cells for the column.
    
    Parameters:
    
    cellClassName - the cell class name(s)
  - setColumnHeaderClassName
```
public void setColumnHeaderClassName(String classNames)
```
    Sets the CSS class name(s) to be applied to the header element (defaults to null). The class name(s) is only applied to the header cell, not the data rows.
    
    Parameters:
    
    classNames - the space separated list of class names
  - setColumnStyle
```
public void setColumnStyle(SafeStyles columnStyles)
```
    Sets the CSS class name(s) to be applied to the cell in the column (defaults to null).
    
    Parameters:
    
    columnStyles - the column styles
  - setColumnTextClassName
```
public void setColumnTextClassName(String columnTextClassName)
```
    Sets the CSS class name(s) to be applied to the text element of each cell in the column (defaults to null).
    
    Parameters:
    
    columnTextClassName - the space separated list of class names
  - setColumnTextStyle
```
public void setColumnTextStyle(SafeStyles textStyles)
```
    Sets one to many CSS styles to be applied to the text element of each cell in the column (defaults to null).
    
    Parameters:
    
    textStyles - the styles
  - setComparator
```
public void setComparator(Comparator<N> comparator)
```
    Sets the comparator used to compare the items in this column when grouping or sorting. If N implements Comparable, this is not required to sort or group.
    
    Parameters:
    
    comparator - the Comparator to use when locally sorting or grouping
  - setFixed
```
public void setFixed(boolean fixed)
```
    True if the column width cannot be changed either by column model or user resizing (defaults to false, pre-render).
    
    Parameters:
    
    fixed - true for fixed column width
  - setGroupable
```
public void setGroupable(boolean groupable)
```
    Sets if the column is groupable (defaults to true). Only applies when using a GroupingView.
    
    Parameters:
    
    groupable - true to allow grouping
  - setHeader
```
public void setHeader(SafeHtml html)
```
    Sets the column's header html.
    
    Parameters:
    
    html - the column's header html
    
    See Also:
    
    #setHeader(String)
  - setHidden
```
public void setHidden(boolean hidden)
```
    Sets whether the column is hidden.
    
    Parameters:
    
    hidden - true to hide
  - setHideable
```
public void setHideable(boolean hideable)
```
    True to allow the column to be hidden via the context menu (defaults to true).
    
    The setting only controls whether the check menu item is enabled / disabled in the grid context menu, controlling whether the user can hide / show a column. All programmatic calls to hide / show are unaffected by this setting.
    
    Parameters:
    
    hideable - true to allow hiding
  - setMenuDisabled
```
public void setMenuDisabled(boolean menuDisabled)
```
    Sets whether the column's menu is disabled (pre-render).
    
    Parameters:
    
    menuDisabled - true to disable the menu
  - setResizable
```
public void setResizable(boolean resizable)
```
    Specifies if the column may be resized (defaults to true, pre-render).
    
    Parameters:
    
    resizable - the resizable state
  - setRowHeader
```
public void setRowHeader(boolean rowHeader)
```
    True to mark this column as the row header. Only applicable when ARIA is enabled for accessibility. Screen reader will annouce the columns value when using a cell selection model.
    
    Parameters:
    
    rowHeader - true to mark the column as the row header
  - setSortable
```
public void setSortable(boolean sortable)
```
    Sets if the column can be sorted (defaults to true, pre-render).
    
    Parameters:
    
    sortable - the sortable state
  - setToolTip
```
public void setToolTip(SafeHtml toolTip)
```
    Sets the column's tool tip as html.
    
    Parameters:
    
    toolTip - the tool tip
  - setVerticalAlignment
```
public void setVerticalAlignment(VerticalAlignmentConstant verticalAlignment)
```
    Sets the column's vertical alignment. This will affect cells with a rendering height less than 100%.
    
    Parameters:
    
    verticalAlignment - the verticalAlignment
  - setWidget
```
public void setWidget(Widget widget,
                      SafeHtml header)
```
    Sets the column's widget.
    
    Parameters:
    
    widget - the widget
    
    header - the text used for the column context menu
  - setWidth
```
public void setWidth(int width)
```
    Sets the column's width in pixels.
    
    Parameters:
    
    width - the width

Class ColumnConfig<M,N>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ariaIgnore

Constructor Detail

ColumnConfig

ColumnConfig

ColumnConfig

Method Detail

getHorizontalAlignment

getVerticalAlignment

getHorizontalHeaderAlignment

getCell

getCellClassName

getColumnHeaderClassName

getColumnStyle

getColumnTextClassName

getColumnTextStyle

getComparator

getHeader

getPath

getToolTip

getValueProvider

getWidget

getWidth

isCellPadding

isFixed

isGroupable

isHidden

isHideable

isMenuDisabled

isResizable

isRowHeader

isSortable

setHorizontalAlignment

setHorizontalHeaderAlignment

setCell

setCellPadding

setCellClassName

setColumnHeaderClassName

setColumnStyle

setColumnTextClassName

setColumnTextStyle

setComparator

setFixed

setGroupable

setHeader

setHidden

setHideable

setMenuDisabled

setResizable

setRowHeader

setSortable

setToolTip

setVerticalAlignment

setWidget

setWidth