DSL for Grails

ColumnHeaderFieldSpec (taack-ui 0.3.6 API)

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

taack.ui.base.table.ColumnHeaderFieldSpec

```
@groovy.transform.CompileStatic
class ColumnHeaderFieldSpec
extends java.lang.Object
```
Base class to define fields in a table header, that will be optionally disposed in columns.
The header columns can contain simple fieldHeader, not sortable or a sortableFieldHeader which provide a bidirectional sortable field.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static enum`	`ColumnHeaderFieldSpec.DefaultSortingDirection`	Allow to define default sorting order direction.
`static class`	`ColumnHeaderFieldSpec.SortableDirection`	Helper class that store necessary info to specify the sort of the table.

Properties Summary

Properties
Type	Name and description
`IUiTableVisitor`	`tableVisitor`

Constructor Summary

Constructors
Constructor and description
`ColumnHeaderFieldSpec (IUiTableVisitor tableVisitor)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`fieldHeader(java.lang.String i18n)` Simple header with a label
	`void`	`groupFieldHeader(java.lang.String i18n, FieldInfo field)` Add a checkbox, if clicked, the table will group lines.
	`ColumnHeaderFieldSpec.SortableDirection`	`sortableFieldHeader(java.lang.String i18n, FieldInfo field, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)` Define an header that can be sorted.
	`ColumnHeaderFieldSpec.SortableDirection`	`sortableFieldHeader(ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection, FieldInfo[] fields)` See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection).
	`void`	`sortableFieldHeader(FieldInfo[] field)` See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection).
	`ColumnHeaderFieldSpec.SortableDirection`	`sortableFieldHeader(java.lang.String i18n, FieldInfo[] fields, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)` See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection).
	`ColumnHeaderFieldSpec.SortableDirection`	`sortableFieldHeader(java.lang.String i18n, java.util.List<FieldInfo> fields, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)` See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection).
	`ColumnHeaderFieldSpec.SortableDirection`	`sortableFieldHeader(java.lang.String i18n, FieldInfo[] fields)` See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection).
	`ColumnHeaderFieldSpec.SortableDirection`	`sortableFieldHeader(java.lang.String i18n, java.util.List<FieldInfo> fields)` See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection).
	`void`	`sortableFieldHeader(java.lang.String i18n, java.lang.String controller, java.lang.String action, java.util.Map<java.lang.String, ? extends java.lang.Object> params, java.util.Map<java.lang.String, ? extends java.lang.Object> additionalParams)` See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection).

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final IUiTableVisitor tableVisitor
- Constructor Detail
  - ColumnHeaderFieldSpec(IUiTableVisitor tableVisitor)
- Method Detail
  - void fieldHeader(java.lang.String i18n)
    
    Simple header with a label
    Parameters:
    i18n - The label
  - void groupFieldHeader(java.lang.String i18n, FieldInfo field)
    
    Add a checkbox, if clicked, the table will group lines. See TaackSimpleFilterService.listInGroup
    Parameters:
    i18n - Label of the column field
    field - Target field (has to be a direct field of the object)
  - ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, FieldInfo field, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)
    
    Define an header that can be sorted.
    Parameters:
    i18n - Label
    field - Target field
    defaultDirection - (optional) Default direction when the table is displayed for the first time.
    Returns:
    The SortableDirection to pass to TaackSimpleFilterService.list
  - ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection, FieldInfo[] fields)
    
    See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection). The label is automatically set.
    Parameters:
    defaultDirection - Default direction when the table is displayed for the first time
    fields - Target field pointing to the data to sort
    Returns:
    The SortableDirection to pass to TaackSimpleFilterService.list
  - void sortableFieldHeader(FieldInfo[] field)
    
    See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection). The label is automatically set.
    Parameters:
    fields - Target field pointing to the data to sort
  - ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, FieldInfo[] fields, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)
    
    See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection). @return
    Parameters:
    i18n
    fields
    defaultDirection
  - @java.lang.Deprecated ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, java.util.List<FieldInfo> fields, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)
    
    See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection). @return
    Parameters:
    i18n
    fields
    defaultDirection
  - ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, FieldInfo[] fields)
    
    See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection). @return
    Parameters:
    i18n
    fields
  - @java.lang.Deprecated ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, java.util.List<FieldInfo> fields)
    
    See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection). @return
    Parameters:
    i18n
    fields
  - void sortableFieldHeader(java.lang.String i18n, java.lang.String controller, java.lang.String action, java.util.Map<java.lang.String, ? extends java.lang.Object> params, java.util.Map<java.lang.String, ? extends java.lang.Object> additionalParams)
    
    See sortableFieldHeader(java.lang.String, taack.ast.type.FieldInfo, DefaultSortingDirection).
    Parameters:
    i18n
    controller
    action
    params
    additionalParams

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ColumnHeaderFieldSpec

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final IUiTableVisitor tableVisitor

Constructor Detail

ColumnHeaderFieldSpec(IUiTableVisitor tableVisitor)

Method Detail

void fieldHeader(java.lang.String i18n)

void groupFieldHeader(java.lang.String i18n, FieldInfo field)

ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, FieldInfo field, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)

ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection, FieldInfo[] fields)

void sortableFieldHeader(FieldInfo[] field)

ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, FieldInfo[] fields, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)

@java.lang.Deprecated ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, java.util.List<FieldInfo> fields, ColumnHeaderFieldSpec.DefaultSortingDirection defaultDirection)

ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, FieldInfo[] fields)

@java.lang.Deprecated ColumnHeaderFieldSpec.SortableDirection sortableFieldHeader(java.lang.String i18n, java.util.List<FieldInfo> fields)

void sortableFieldHeader(java.lang.String i18n, java.lang.String controller, java.lang.String action, java.util.Map<java.lang.String, ? extends java.lang.Object> params, java.util.Map<java.lang.String, ? extends java.lang.Object> additionalParams)