Column (Gwt Material Table 2.0.1 API)

java.lang.Object
- gwt.material.design.client.ui.table.cell.Column<T,C>

Type Parameters:

T - the row type

C - the column type

All Implemented Interfaces:

com.google.gwt.cell.client.HasCell<T,C>, gwt.material.design.client.base.HasHideOn, gwt.material.design.client.base.HasTextAlign

Direct Known Subclasses:

TextColumn, WidgetColumn
```
public abstract class Column<T,C>
extends Object
implements com.google.gwt.cell.client.HasCell<T,C>, gwt.material.design.client.base.HasHideOn, gwt.material.design.client.base.HasTextAlign
```
A representation of a column in a table.

Author:

Ben Dol

Constructor Summary

Constructors
Constructor and Description

Column(com.google.gwt.cell.client.Cell<C> cell)
Construct a new Column with a given Cell.

Constructors
Constructor and Description
`Column(com.google.gwt.cell.client.Cell<C> cell)` Construct a new Column with a given `Cell`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`autoSort()`
`boolean`	`defaultSortAscending()` Check if the default sort order of the column is ascending or descending.
`com.google.gwt.cell.client.FieldUpdater<T,C>`	`fieldUpdater()`
`com.google.gwt.cell.client.Cell<C>`	`getCell()` Returns the `Cell` responsible for rendering items in the column.
`com.google.gwt.cell.client.FieldUpdater<T,C>`	`getFieldUpdater()`
`gwt.material.design.client.constants.HideOn`	`getHideOn()`
`String`	`getName()`
`Comparator<? super RowComponent<T>>`	`getSortComparator()`
`Map<StyleName,String>`	`getStyleProperties()` Return the registered style properties.
`String`	`getStyleProperty(StyleName styleName)` Get a styles property.
`gwt.material.design.client.constants.TextAlign`	`getTextAlign()`
`abstract C`	`getValue(T object)` Returns the column value from within the underlying data object.
`String`	`getWidth()` Get the columns header width.
`gwt.material.design.client.constants.HideOn`	`hideOn()`
`boolean`	`isAutoSort()` Is this column auto sorting when rendered.
`boolean`	`isDefaultSortAscending()` Check if the default sort order of the column is ascending or descending.
`boolean`	`isNumeric()`
`boolean`	`isSortable()` Check if the column is sortable.
`String`	`name()`
`boolean`	`numeric()`
`void`	`onBrowserEvent(com.google.gwt.cell.client.Cell.Context context, com.google.gwt.dom.client.Element elem, T object, com.google.gwt.dom.client.NativeEvent event)` Handle a browser event that took place within the column.
`void`	`render(com.google.gwt.cell.client.Cell.Context context, T object, com.google.gwt.safehtml.shared.SafeHtmlBuilder sb)` Render the object into the cell.
`void`	`setAutoSort(boolean autoSort)` Make this column auto sort on rendering, if multiple columns are auto sorting it will be based on the first one set to auto sort.
`void`	`setDefaultSortAscending(boolean isAscending)` Set whether or not the default sort order is ascending.
`void`	`setFieldUpdater(com.google.gwt.cell.client.FieldUpdater<T,C> fieldUpdater)`
`void`	`setHideOn(gwt.material.design.client.constants.HideOn hideOn)`
`void`	`setName(String name)` Sets a string that identifies this column in a data query.
`void`	`setNumeric(boolean numeric)`
`void`	`setSortComparator(Comparator<? super RowComponent<T>> sortComparator)`
`void`	`setStyleProperties(Map<StyleName,String> styleProps)` Set the style properties map.
`void`	`setStyleProperty(StyleName styleName, String value)` Set a style property using its name as the key.
`void`	`setTextAlign(gwt.material.design.client.constants.TextAlign align)`
`void`	`setWidth(String width)` Set the columns header width.
`Comparator<? super RowComponent<T>>`	`sortComparator()`
`Map<StyleName,String>`	`styleProperties()`
`gwt.material.design.client.constants.TextAlign`	`textAlign()`
`String`	`toString()`
`String`	`width()`

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

- Constructor Detail
  - Column
```
public Column(com.google.gwt.cell.client.Cell<C> cell)
```
    Construct a new Column with a given Cell.
    
    Parameters:
    
    cell - the Cell used by this Column
- Method Detail
  - onBrowserEvent
```
public void onBrowserEvent(com.google.gwt.cell.client.Cell.Context context,
                           com.google.gwt.dom.client.Element elem,
                           T object,
                           com.google.gwt.dom.client.NativeEvent event)
```
    Handle a browser event that took place within the column.
    
    Parameters:
    
    context - the cell context
    
    elem - the parent Element
    
    object - the base object to be updated
    
    event - the native browser event
  - getCell
```
public final com.google.gwt.cell.client.Cell<C> getCell()
```
    Returns the Cell responsible for rendering items in the column.
    
    Specified by:
    
    getCell in interface com.google.gwt.cell.client.HasCell<T,C>
    
    Returns:
    
    a Cell
  - getValue
```
public abstract C getValue(T object)
```
    Returns the column value from within the underlying data object.
    
    Specified by:
    
    getValue in interface com.google.gwt.cell.client.HasCell<T,C>
  - render
```
public void render(com.google.gwt.cell.client.Cell.Context context,
                   T object,
                   com.google.gwt.safehtml.shared.SafeHtmlBuilder sb)
```
    Render the object into the cell.
    
    Parameters:
    
    object - the object to render
    
    sb - the buffer to render into
  - setName
```
public final void setName(String name)
```
    Sets a string that identifies this column in a data query.
    
    Parameters:
    
    name - name of the column from the data store's perspective
  - getName
```
public final String getName()
```
    Returns:
    
    the database name of the column, or null if it's never been set
  - name
```
public String name()
```
    Returns:
    
    the database name of the column, or null if it's never been set
  - isDefaultSortAscending
```
public final boolean isDefaultSortAscending()
```
    Check if the default sort order of the column is ascending or descending.
    
    Returns:
    
    true if default sort is ascending, false if not
  - setDefaultSortAscending
```
public final void setDefaultSortAscending(boolean isAscending)
```
    Set whether or not the default sort order is ascending.
    
    Parameters:
    
    isAscending - true to set the default order to ascending, false for descending
  - defaultSortAscending
```
public boolean defaultSortAscending()
```
    Check if the default sort order of the column is ascending or descending.
    
    Returns:
    
    true if default sort is ascending, false if not
  - isAutoSort
```
public final boolean isAutoSort()
```
    Is this column auto sorting when rendered.
    
    Returns:
    
    true if this column is auto sorted.
  - setAutoSort
```
public final void setAutoSort(boolean autoSort)
```
    Make this column auto sort on rendering, if multiple columns are auto sorting it will be based on the first one set to auto sort.
  - autoSort
```
public boolean autoSort()
```
  - isSortable
```
public boolean isSortable()
```
    Check if the column is sortable.
    
    Returns:
    
    true if sortable, false if not
  - setSortComparator
```
public final void setSortComparator(Comparator<? super RowComponent<T>> sortComparator)
```
  - getSortComparator
```
public final Comparator<? super RowComponent<T>> getSortComparator()
```
  - sortComparator
```
public Comparator<? super RowComponent<T>> sortComparator()
```
  - getFieldUpdater
```
public final com.google.gwt.cell.client.FieldUpdater<T,C> getFieldUpdater()
```
    Specified by:
    
    getFieldUpdater in interface com.google.gwt.cell.client.HasCell<T,C>
  - setFieldUpdater
```
public final void setFieldUpdater(com.google.gwt.cell.client.FieldUpdater<T,C> fieldUpdater)
```
  - fieldUpdater
```
public com.google.gwt.cell.client.FieldUpdater<T,C> fieldUpdater()
```
  - isNumeric
```
public final boolean isNumeric()
```
  - setNumeric
```
public final void setNumeric(boolean numeric)
```
  - numeric
```
public boolean numeric()
```
  - setHideOn
```
public final void setHideOn(gwt.material.design.client.constants.HideOn hideOn)
```
    Specified by:
    
    setHideOn in interface gwt.material.design.client.base.HasHideOn
  - getHideOn
```
public final gwt.material.design.client.constants.HideOn getHideOn()
```
    Specified by:
    
    getHideOn in interface gwt.material.design.client.base.HasHideOn
  - hideOn
```
public gwt.material.design.client.constants.HideOn hideOn()
```
  - setTextAlign
```
public final void setTextAlign(gwt.material.design.client.constants.TextAlign align)
```
    Specified by:
    
    setTextAlign in interface gwt.material.design.client.base.HasTextAlign
  - getTextAlign
```
public final gwt.material.design.client.constants.TextAlign getTextAlign()
```
    Specified by:
    
    getTextAlign in interface gwt.material.design.client.base.HasTextAlign
  - textAlign
```
public gwt.material.design.client.constants.TextAlign textAlign()
```
  - setStyleProperty
```
public final void setStyleProperty(StyleName styleName,
                                   String value)
```
    Set a style property using its name as the key. Please ensure the style name and value are appropriately configured or it may result in unexpected behavior.
    
    Parameters:
    
    styleName - the style name as seen here Style.STYLE_Z_INDEX for example.
    
    value - the string value required for the given style property.
  - getStyleProperty
```
public final String getStyleProperty(StyleName styleName)
```
    Get a styles property.
    
    Parameters:
    
    styleName - the styles name as represented in a Style class.
    
    Returns:
    
    null if the style property is not set.
  - getStyleProperties
```
public final Map<StyleName,String> getStyleProperties()
```
    Return the registered style properties.
    
    Returns:
    
    null if no styles are added.
  - setStyleProperties
```
public final void setStyleProperties(Map<StyleName,String> styleProps)
```
    Set the style properties map.
  - styleProperties
```
public Map<StyleName,String> styleProperties()
```
  - setWidth
```
public final void setWidth(String width)
```
    Set the columns header width.
  - getWidth
```
public final String getWidth()
```
    Get the columns header width.
    
    Returns:
    
    null if not defined.
  - width
```
public String width()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Column<T,C>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Column

Method Detail

onBrowserEvent

getCell

getValue

render

setName

getName

name

isDefaultSortAscending

setDefaultSortAscending

defaultSortAscending

isAutoSort

setAutoSort

autoSort

isSortable

setSortComparator

getSortComparator

sortComparator

getFieldUpdater

setFieldUpdater

fieldUpdater

isNumeric

setNumeric

numeric

setHideOn

getHideOn

hideOn

setTextAlign

getTextAlign

textAlign

setStyleProperty

getStyleProperty

getStyleProperties

setStyleProperties

styleProperties

setWidth

getWidth

width

toString