IExtendedColumn (server-common-api)

All Known Implementing Classes:

BaseExtendedColumn, BaseSelectRow, BaseTreeControl, ChartDataColumn, ChartLabelColumn, HiddenColumn, HtmlTableColumn, RowHeadersColumn, ScrollbarPager, SelectRowCheckbox, TreeRowDataColumn, TruncatingColumn
```
public interface IExtendedColumn
```
Extended column component.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`encodeFooter(FacesContext context)` Renders this column's header.
`void`	`encodeHeader(FacesContext context)` Renders this column's header.
`String`	`getAlign()` Horizontal alignment of column content ("left", "center", or "right").
`String`	`getGroup()` Display title of column group (for Add/Remove Columns dialog, etc.).
`String`	`getLabel()` Display title of column (for Add/Remove Columns dialog, etc.).
`int`	`getOrdinal()` Primacy of this column in sorting the table.
`int`	`getSecondaryEnd()` Primary column under which this secondary column ends (zero-based, inclusive).
`int`	`getSecondaryStart()` Primary column under which this secondary column starts (zero-based, inclusive).
`Object`	`getSort()` Sort key for this column.
`String`	`getValign()` Vertical alignment of column content ("top", "middle", or "bottom").
`String`	`getWidth()` Fixed width of column in pixels ('100') or percent ('100%').
`boolean`	`isAscending()` True to sort column from A-Z or 1-100.
`boolean`	`isExportable()` Returns whether the column is exportable
`boolean`	`isHidden()` True if column is data column (not displayed).
`boolean`	`isNowrap()` True if column should be as wide as widest line in column content.
`boolean`	`isOptional()` True if column displayed only after user chooses via Add/Remove Columns dialog.
`boolean`	`isSecondary()` True if this column belongs in a sub-row beneath the main row.
`void`	`setAlign(String align)` Horizontal alignment of column content ("left", "center", or "right").
`void`	`setAscending(boolean ascending)` True to sort column from A-Z or 1-100.
`void`	`setExportable(boolean isExportable)` Sets whether the column is exportable
`void`	`setGroup(String group)` Display title of column group (for Add/Remove Columns dialog, etc.).
`void`	`setHidden(boolean hidden)` True if column is data column (not displayed).
`void`	`setLabel(String bale)` Display title of column (for Add/Remove Columns dialog, etc.).
`void`	`setNowrap(boolean nowrap)` True if column should be as wide as widest line in column content.
`void`	`setOptional(boolean optional)` True if column displayed only after user chooses via Add/Remove Columns dialog.
`void`	`setOrdinal(int ordinal)` Primacy of this column in sorting the table.
`void`	`setSecondary(boolean secondary)` True if this column belongs in a sub-row beneath the main row.
`void`	`setSecondaryEnd(int secondaryEnd)` Primary column under which this secondary column ends (zero-based, inclusive).
`void`	`setSecondaryStart(int secondaryStart)` Primary column under which this secondary column starts (zero-based, inclusive).
`void`	`setSort(Object sort)` Sort key for this column.
`void`	`setValign(String valign)` Vertical alignment of column content ("top", "middle", or "bottom").
`void`	`setWidth(String width)` Fixed width of column in pixels ('100') or percent ('100%').

- Method Detail
  - isExportable
```
boolean isExportable()
```
    Returns whether the column is exportable
    
    Returns:
    
    true or false
  - setExportable
```
void setExportable(boolean isExportable)
```
    Sets whether the column is exportable
    
    Parameters:
    
    isExportable - true if the column is exportable, false otherwise
  - getAlign
```
String getAlign()
```
    Horizontal alignment of column content ("left", "center", or "right").
  - setAlign
```
void setAlign(String align)
```
    Horizontal alignment of column content ("left", "center", or "right").
  - isAscending
```
boolean isAscending()
```
    True to sort column from A-Z or 1-100.
  - setAscending
```
void setAscending(boolean ascending)
```
    True to sort column from A-Z or 1-100.
  - getGroup
```
String getGroup()
```
    Display title of column group (for Add/Remove Columns dialog, etc.).
  - setGroup
```
void setGroup(String group)
```
    Display title of column group (for Add/Remove Columns dialog, etc.).
  - isHidden
```
boolean isHidden()
```
    True if column is data column (not displayed).
  - setHidden
```
void setHidden(boolean hidden)
```
    True if column is data column (not displayed).
  - getLabel
```
String getLabel()
```
    Display title of column (for Add/Remove Columns dialog, etc.).
  - setLabel
```
void setLabel(String bale)
```
    Display title of column (for Add/Remove Columns dialog, etc.).
  - isNowrap
```
boolean isNowrap()
```
    True if column should be as wide as widest line in column content.
  - setNowrap
```
void setNowrap(boolean nowrap)
```
    True if column should be as wide as widest line in column content.
  - isOptional
```
boolean isOptional()
```
    True if column displayed only after user chooses via Add/Remove Columns dialog.
  - setOptional
```
void setOptional(boolean optional)
```
    True if column displayed only after user chooses via Add/Remove Columns dialog.
  - getOrdinal
```
int getOrdinal()
```
    Primacy of this column in sorting the table. 0 = none, 1 = primary, 2 = secondary, etc.
  - setOrdinal
```
void setOrdinal(int ordinal)
```
    Primacy of this column in sorting the table. 0 = none, 1 = primary, 2 = secondary, etc.
  - isSecondary
```
boolean isSecondary()
```
    True if this column belongs in a sub-row beneath the main row.
  - setSecondary
```
void setSecondary(boolean secondary)
```
    True if this column belongs in a sub-row beneath the main row.
  - getSecondaryEnd
```
int getSecondaryEnd()
```
    Primary column under which this secondary column ends (zero-based, inclusive). -1 if not a secondary column.
  - setSecondaryEnd
```
void setSecondaryEnd(int secondaryEnd)
```
    Primary column under which this secondary column ends (zero-based, inclusive). -1 if not a secondary column.
  - getSecondaryStart
```
int getSecondaryStart()
```
    Primary column under which this secondary column starts (zero-based, inclusive). -1 if not a secondary column.
  - setSecondaryStart
```
void setSecondaryStart(int secondaryStart)
```
    Primary column under which this secondary column starts (zero-based, inclusive). -1 if not a secondary column.
  - getSort
```
Object getSort()
```
    Sort key for this column.
  - setSort
```
void setSort(Object sort)
```
    Sort key for this column.
  - getValign
```
String getValign()
```
    Vertical alignment of column content ("top", "middle", or "bottom").
  - setValign
```
void setValign(String valign)
```
    Vertical alignment of column content ("top", "middle", or "bottom").
  - getWidth
```
String getWidth()
```
    Fixed width of column in pixels ('100') or percent ('100%').
  - setWidth
```
void setWidth(String width)
```
    Fixed width of column in pixels ('100') or percent ('100%').
  - encodeHeader
```
void encodeHeader(FacesContext context)
           throws IOException
```
    Renders this column's header.
    
    Parameters:
    
    context - Current context.
    
    Throws:
    
    IOException
  - encodeFooter
```
void encodeFooter(FacesContext context)
           throws IOException
```
    Renders this column's header.
    
    Parameters:
    
    context - Current context.
    
    Throws:
    
    IOException

Interface IExtendedColumn

Method Summary

Method Detail

isExportable

setExportable

getAlign

setAlign

isAscending

setAscending

getGroup

setGroup

isHidden

setHidden

getLabel

setLabel

isNowrap

setNowrap

isOptional

setOptional

getOrdinal

setOrdinal

isSecondary

setSecondary

getSecondaryEnd

setSecondaryEnd

getSecondaryStart

setSecondaryStart

getSort

setSort

getValign

setValign

getWidth

setWidth

encodeHeader

encodeFooter