ColumnPreference (eframe 0.5 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.simplemes.eframe.preference.ColumnPreference

```
@groovy.transform.ToString(includePackage: false, includeNames: true, includeSuper: true)
@groovy.transform.EqualsAndHashCode(includes: [column])
class ColumnPreference
extends BasePreferenceSetting
```
This holds the specific preferences for a single column in a list. The column's width, display order and sorting options are stored here.
User Preference Usage
This preference is stored in the user preference table under the keys:
- page - The URI of the page the column is in. Stripped of arguments.
- user - The user name.
- element - The HTML ID of the grid this column belongs to.

Properties Summary

Properties
Type	Name and description
`private java.lang.String`	`column` The column (name) for this preference.
`private java.lang.Integer`	`sequence` The sequence (order) this column is displayed in.
`private java.lang.Boolean`	`sortAscending` The sort direction (of sortLevel is non-null).
`private java.lang.Integer`	`sortLevel` If non-null, then this is the sorting order for this column.
`private BigDecimal`	`width` The width of the column, in percentage of screen width.

Constructor Summary

Constructors
Constructor and description
`ColumnPreference ()`
`ColumnPreference (java.util.Map options)` Standard map constructor.
`ColumnPreference ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`determineIfEmpty()` Determines if this column preference is empty (has not settings).
	`java.lang.String`	`getKey()` The key (column name) for this preference.

- Property Detail
  - private java.lang.String column
    
    The column (name) for this preference.
  - private java.lang.Integer sequence
    
    The sequence (order) this column is displayed in.
  - private java.lang.Boolean sortAscending
    
    The sort direction (of sortLevel is non-null). Defaults to ascending.
  - private java.lang.Integer sortLevel
    
    If non-null, then this is the sorting order for this column. sortLevel=1 is the primary sort key, etc.
  - private BigDecimal width
    
    The width of the column, in percentage of screen width. If null, then use the default width.
- Constructor Detail
  - ColumnPreference()
  - @java.lang.SuppressWarnings(value: GroovyAssignabilityCheck) ColumnPreference(java.util.Map options)
    
    Standard map constructor.
    Parameters:
    options - The options.
  - ColumnPreference()
- Method Detail
  - boolean determineIfEmpty()
    
    Determines if this column preference is empty (has not settings). This is used to keep the list of column preferences as small as possible.
    Note: This is not called isEmpty() to avoid XML parsing issues.
    Returns:
    True if the preference is empty of any settings.
  - @java.lang.Override java.lang.String getKey()
    
    The key (column name) for this preference. This is unique within a single Preference object's settings list.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation