Class sap.ui.table.ColumnModule: sap/ui/table/Column

extends Element
known direct subclasses: AnalyticalColumn

The column allows you to define column specific properties that will be applied when rendering the table.

Constructor Summary
new sap.ui.table.Column(sId?, mSettings?)Constructor for a new Column.
Event Summary
columnMenuOpen(oControlEvent)Fires before the column menu is opened.
Method Summary
sap.ui.table.Column.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.table.Column with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.table.Column.getMetadata()Returns a metadata object for class sap.ui.table.Column.
addMultiLabel(oMultiLabel)Adds some multiLabel to the aggregation multiLabels.
attachColumnMenuOpen(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the columnMenuOpen event of this sap.ui.table.Column.
destroyLabel()Destroys the label in the aggregation label.
destroyMenu()Destroys the menu in the aggregation menu.
destroyMultiLabels()Destroys all the multiLabels in the aggregation multiLabels.
destroyTemplate()Destroys the template in the aggregation template.
detachColumnMenuOpen(fnFunction, oListener)Detaches event handler fnFunction from the columnMenuOpen event of this sap.ui.table.Column.
fireColumnMenuOpen(mArguments?)Fires event columnMenuOpen to attached listeners.
getAutoResizable()Gets current value of property autoResizable.
getDefaultFilterOperator()Gets current value of property defaultFilterOperator.
getFiltered()Gets current value of property filtered.
getFilterOperator()Gets current value of property filterOperator.
getFilterProperty()Gets current value of property filterProperty.
getFilterType()Gets current value of property filterType.
getFilterValue()Gets current value of property filterValue.
getFlexible()Gets current value of property flexible.
getGrouped()Gets current value of property grouped.
getHAlign()Gets current value of property hAlign.
getHeaderSpan()Gets current value of property headerSpan.
getLabel()Gets content of aggregation label.
getMenu()Gets content of aggregation menu.
getMultiLabels()Gets content of aggregation multiLabels.
getName()Gets current value of property name.
getResizable()Gets current value of property resizable.
getShowFilterMenuEntry()Gets current value of property showFilterMenuEntry.
getShowSortMenuEntry()Gets current value of property showSortMenuEntry.
getSorted()Gets current value of property sorted.
getSortOrder()Gets current value of property sortOrder.
getSortProperty()Gets current value of property sortProperty.
getTemplate()Gets content of aggregation template.
getVisible()Gets current value of property visible.
getWidth()Gets current value of property width.
indexOfMultiLabel(oMultiLabel)Checks for the provided sap.ui.core.Control in the aggregation multiLabels.
insertMultiLabel(oMultiLabel, iIndex)Inserts a multiLabel into the aggregation multiLabels.
removeAllMultiLabels()Removes all the controls from the aggregation multiLabels.
removeMultiLabel(vMultiLabel)Removes a multiLabel from the aggregation multiLabels.
setAutoResizable(bAutoResizable)Sets a new value for property autoResizable.
setDefaultFilterOperator(sDefaultFilterOperator)Sets a new value for property defaultFilterOperator.
setFiltered(bFiltered)Sets a new value for property filtered.
setFilterOperator(sFilterOperator)Sets a new value for property filterOperator.
setFilterProperty(sFilterProperty)Sets a new value for property filterProperty.
setFilterType(oFilterType)Sets a new value for property filterType.
setFilterValue(sFilterValue)Sets a new value for property filterValue.
setFlexible(bFlexible)Sets a new value for property flexible.
setGrouped(bGrouped)Sets a new value for property grouped.
setHAlign(sHAlign)Sets a new value for property hAlign.
setHeaderSpan(oHeaderSpan)Sets a new value for property headerSpan.
setLabel(vLabel)Sets the aggregated label.
setMenu(oMenu)Sets the aggregated menu.
setName(sName)Sets a new value for property name.
setResizable(bResizable)Sets a new value for property resizable.
setShowFilterMenuEntry(bShowFilterMenuEntry)Sets a new value for property showFilterMenuEntry.
setShowSortMenuEntry(bShowSortMenuEntry)Sets a new value for property showSortMenuEntry.
setSorted(bSorted)Sets a new value for property sorted.
setSortOrder(sSortOrder)Sets a new value for property sortOrder.
setSortProperty(sSortProperty)Sets a new value for property sortProperty.
setTemplate(oTemplate)Sets the aggregated template.
setVisible(bVisible)Sets a new value for property visible.
setWidth(sWidth)Sets a new value for property width.
shouldRender()Returns whether the column should be rendered or not.
sort(bDescending)sorts the current column ascending or descending
toggleSort()Toggles the sort order of the column.
Constructor Detail
new sap.ui.table.Column(sId?, mSettings?)
Constructor for a new Column.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? ID for the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Event Detail
columnMenuOpen(oControlEvent)
Fires before the column menu is opened.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.unified.Menu}oControlEvent.getParameters.menu Refence to the selected menu instance to be opened.
Since:
1.33.0
Method Detail
sap.ui.table.Column.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.table.Column with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.table.Column.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.table.Column.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addMultiLabel(oMultiLabel): sap.ui.table.Column
Adds some multiLabel to the aggregation multiLabels.
Parameters:
{sap.ui.core.Control}oMultiLabel the multiLabel to add; if empty, nothing is inserted
Since:
1.13.1
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
attachColumnMenuOpen(oData?, fnFunction, oListener?): sap.ui.table.Column
Attaches event handler fnFunction to the columnMenuOpen event of this sap.ui.table.Column.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.table.Column itself.

Fires before the column menu is opened.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.table.Column itself
Since:
1.33.0
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
destroyLabel(): sap.ui.table.Column
Destroys the label in the aggregation label.
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
destroyMenu(): sap.ui.table.Column
Destroys the menu in the aggregation menu.
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
destroyMultiLabels(): sap.ui.table.Column
Destroys all the multiLabels in the aggregation multiLabels.
Since:
1.13.1
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
destroyTemplate(): sap.ui.table.Column
Destroys the template in the aggregation template.
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
detachColumnMenuOpen(fnFunction, oListener): sap.ui.table.Column
Detaches event handler fnFunction from the columnMenuOpen event of this sap.ui.table.Column.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.33.0
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
fireColumnMenuOpen(mArguments?): boolean
Fires event columnMenuOpen to attached listeners.

Listeners may prevent the default action of this event by using the preventDefault-method on the event object.

Expects the following event parameters:

  • menu of type sap.ui.unified.MenuRefence to the selected menu instance to be opened.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.33.0
Returns:
{boolean} Whether or not to prevent the default action
getAutoResizable(): boolean
Gets current value of property autoResizable.

Enables auto-resizing of the column on double-clicking the resizer. The width is determined on the widest currently displayed content. It does not consider rows which are currently not scrolled into view. Currently only implemented to work with the following controls: sap.m.Text, sap.m.Label, sap.m.Link, sap.m.Input, sap.ui.commons.TextView, sap.ui.commons.Label, sap.ui.commons.Link and sap.ui.commons.TextField, sap.ui.commons.Checkbox, sap.m.Checkbox

Default value is false.

Since:
1.21.1
Returns:
{boolean} Value of property autoResizable
getDefaultFilterOperator(): string
Gets current value of property defaultFilterOperator.

If this property is set, the default filter operator of the column is overridden. By default Contains is used for string and EQ for other types. A valid sap.ui.model.FilterOperator needs to be passed.

Returns:
{string} Value of property defaultFilterOperator
getFiltered(): boolean
Gets current value of property filtered.

Indicates if the column is filtered. This property only controls if a filter indicator is displayed in the column header - it does not trigger the filter function. The column has to be filtered by calling Column.sort()

Default value is false.

Returns:
{boolean} Value of property filtered
getFilterOperator(): string
Gets current value of property filterOperator.

Filter operator to use when filtering this column.

Returns:
{string} Value of property filterOperator
getFilterProperty(): string
Gets current value of property filterProperty.

Specifies the binding property on which the column shall be filtered. Since the column template may have composite bindings, it's not possible to figure out on which binding property the filter shall be applied. Therefore the binding property for filtering must be specified. For example, if the first name and last name are displayed in the same column, only one of the two can be defined as filterProperty.

A column menu entry for filtering can only be generated if the filterProperty is set. The default menu entry is a text input field.

Returns:
{string} Value of property filterProperty
getFilterType(): any
Gets current value of property filterType.

Type of Filter. This is used to transform the search term to the specified type, to make sure that the right columns are displayed. This should be the same as defined in binding for this column. As an alternative you can pass a function which does the conversion. The function receives the entered filter value as parameter and returns the proper value for the filter expression. Another option is to pass the class name of the type, e.g.: sap.ui.model.type.Date or an expression similar to the binding syntax, e.g.: "\{type: 'sap.ui.model.type.Date', formatOptions: \{UTC: true\}, constraints: {} \}". Here the escaping is mandatory to avoid handling by the binding parser. By default the filter type is sap.ui.model.type.String.

Since:
1.9.2
Returns:
{any} Value of property filterType
getFilterValue(): string
Gets current value of property filterValue.

Specifies the value of the filter as string (will be converted into the proper data type). It is possible to provide a filterOperator as string, as shown here:

> 50
< 100
>= 150
<= 200
= 250
!= 300
something    ends with
something*    starts with
something*   contains
some..thing   between
50..100       between
Returns:
{string} Value of property filterValue
getFlexible(): boolean
Gets current value of property flexible.

If the table is wider than the sum of widths of the visible columns, the columns will be resized proportionally to their widths that were set originally. If set to false, the column will be displayed in the original width. If all columns are set to not be flexible, an extra "dummy" column will be created at the end of the table.

Default value is true.

Returns:
{boolean} Value of property flexible
getGrouped(): boolean
Gets current value of property grouped.

Indicates if the column is grouped.

Default value is false.

Returns:
{boolean} Value of property grouped
Gets current value of property hAlign.

Horizontal alignment of the column content. Controls with a text align do not inherit the horizontal alignment. You have to set the text align directly on the template.

Default value is Begin.

Returns:
{sap.ui.core.HorizontalAlign} Value of property hAlign
getHeaderSpan(): any
Gets current value of property headerSpan.

If this property is set, a span is applied for the header. When moving columns, all columns which are part of the header will be moved. The headerSpan can be either an integer or an array of integers (if you use the multi header feature of the table). If you only specify an integer, this span is applied for all header rows, with multiple integers you can specify a separate span for each header row.

Default value is 1.

Returns:
{any} Value of property headerSpan
getLabel(): sap.ui.core.Control|string
Gets content of aggregation label.

Label of the column which is displayed in the column header. This aggregation is for the standard behavior, where you only want to display one single row header. If a string is supplied, a default label control will be created. Which control this is depends on the loaded libraries.

Returns:
{sap.ui.core.Control|string}
Gets content of aggregation menu.

The menu used by the column. By default the sap.ui.table.ColumnMenu is used.

Note: Applications must not use or change the default sap.ui.table.ColumnMenu of a column in any way or create own instances of sap.ui.table.ColumnMenu. To add a custom menu to a column, use the aggregation menu with a new instance of sap.ui.unified.Menu.

Returns:
{sap.ui.unified.Menu}
getMultiLabels(): sap.ui.core.Control[]
Gets content of aggregation multiLabels.

Labels of the column which are displayed in the column header. Define a control for each header row in the table. Use this aggregation if you want to use multiple headers per column.

Since:
1.13.1
Returns:
{sap.ui.core.Control[]}
getName(): string
Gets current value of property name.

The name of the column which is used in the column visibility menu item as text. If not set as a fallback the column menu tries to get the text from the nested Label.

Since:
1.11.1
Returns:
{string} Value of property name
getResizable(): boolean
Gets current value of property resizable.

If set to true, the column can be resized either using the resize-handle (by mouse) or using the keyboard (SHIFT + Left/Right Arrow keys)

Default value is true.

Returns:
{boolean} Value of property resizable
getShowFilterMenuEntry(): boolean
Gets current value of property showFilterMenuEntry.

Defines if the filter menu entry is displayed

Default value is true.

Since:
1.13.0
Returns:
{boolean} Value of property showFilterMenuEntry
getShowSortMenuEntry(): boolean
Gets current value of property showSortMenuEntry.

Defines if the sort menu entries are displayed

Default value is true.

Since:
1.13.0
Returns:
{boolean} Value of property showSortMenuEntry
getSorted(): boolean
Gets current value of property sorted.

Indicates if the column is sorted. This property only controls if a sort indicator is displayed in the column header - it does not trigger the sort function. The column has to be sorted by calling Column.sort()

Default value is false.

Returns:
{boolean} Value of property sorted
getSortOrder(): sap.ui.table.SortOrder
Gets current value of property sortOrder.

This property indicates the sort direction (Ascending or Descending). The corresponding icon will be rendered if the property sorted is true

Default value is Ascending.

Returns:
{sap.ui.table.SortOrder} Value of property sortOrder
getSortProperty(): string
Gets current value of property sortProperty.

Specifies the binding property on which the column will sort. Since the column template may have composite bindings, it's not possible to figure out on which binding property the sort shall be applied. Therefore the binding property for sorting must be specified. For example, if the first name and last name are displayed in the same column, only one of the two can be defined as sortProperty.

A column menu entry for sorting can only be generated if the sortProperty is set.

Returns:
{string} Value of property sortProperty
getTemplate(): sap.ui.core.Control
Gets content of aggregation template.

Template (cell renderer) of this column. A template is decoupled from the column, which means after changing the templates' properties or aggregations an explicit invalidation of the column or table is required. The default depends on the loaded libraries.

Returns:
{sap.ui.core.Control}
getVisible(): boolean
Gets current value of property visible.

Invisible controls are not rendered.

Default value is true.

Returns:
{boolean} Value of property visible
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Width of the column. Works only with px/em/rem values. Em are handled like rem values.

Returns:
{sap.ui.core.CSSSize} Value of property width
indexOfMultiLabel(oMultiLabel): int
Checks for the provided sap.ui.core.Control in the aggregation multiLabels. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oMultiLabel The multiLabel whose index is looked for
Since:
1.13.1
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertMultiLabel(oMultiLabel, iIndex): sap.ui.table.Column
Inserts a multiLabel into the aggregation multiLabels.
Parameters:
{sap.ui.core.Control}oMultiLabel the multiLabel to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the multiLabel should be inserted at; for a negative value of iIndex, the multiLabel is inserted at position 0; for a value greater than the current size of the aggregation, the multiLabel is inserted at the last position
Since:
1.13.1
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
removeAllMultiLabels(): sap.ui.core.Control[]
Removes all the controls from the aggregation multiLabels.

Additionally, it unregisters them from the hosting UIArea.

Since:
1.13.1
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeMultiLabel(vMultiLabel): sap.ui.core.Control
Removes a multiLabel from the aggregation multiLabels.
Parameters:
{int|string|sap.ui.core.Control}vMultiLabel The multiLabelto remove or its index or id
Since:
1.13.1
Returns:
{sap.ui.core.Control} The removed multiLabel or null
setAutoResizable(bAutoResizable): sap.ui.table.Column
Sets a new value for property autoResizable.

Enables auto-resizing of the column on double-clicking the resizer. The width is determined on the widest currently displayed content. It does not consider rows which are currently not scrolled into view. Currently only implemented to work with the following controls: sap.m.Text, sap.m.Label, sap.m.Link, sap.m.Input, sap.ui.commons.TextView, sap.ui.commons.Label, sap.ui.commons.Link and sap.ui.commons.TextField, sap.ui.commons.Checkbox, sap.m.Checkbox

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bAutoResizable New value for property autoResizable
Since:
1.21.1
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setDefaultFilterOperator(sDefaultFilterOperator): sap.ui.table.Column
Sets a new value for property defaultFilterOperator.

If this property is set, the default filter operator of the column is overridden. By default Contains is used for string and EQ for other types. A valid sap.ui.model.FilterOperator needs to be passed.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sDefaultFilterOperator New value for property defaultFilterOperator
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setFiltered(bFiltered): sap.ui.table.Column
Sets a new value for property filtered.

Indicates if the column is filtered. This property only controls if a filter indicator is displayed in the column header - it does not trigger the filter function. The column has to be filtered by calling Column.sort()

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bFiltered New value for property filtered
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setFilterOperator(sFilterOperator): sap.ui.table.Column
Sets a new value for property filterOperator.

Filter operator to use when filtering this column.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sFilterOperator New value for property filterOperator
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setFilterProperty(sFilterProperty): sap.ui.table.Column
Sets a new value for property filterProperty.

Specifies the binding property on which the column shall be filtered. Since the column template may have composite bindings, it's not possible to figure out on which binding property the filter shall be applied. Therefore the binding property for filtering must be specified. For example, if the first name and last name are displayed in the same column, only one of the two can be defined as filterProperty.

A column menu entry for filtering can only be generated if the filterProperty is set. The default menu entry is a text input field.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sFilterProperty New value for property filterProperty
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setFilterType(oFilterType): sap.ui.table.Column
Sets a new value for property filterType.

Type of Filter. This is used to transform the search term to the specified type, to make sure that the right columns are displayed. This should be the same as defined in binding for this column. As an alternative you can pass a function which does the conversion. The function receives the entered filter value as parameter and returns the proper value for the filter expression. Another option is to pass the class name of the type, e.g.: sap.ui.model.type.Date or an expression similar to the binding syntax, e.g.: "\{type: 'sap.ui.model.type.Date', formatOptions: \{UTC: true\}, constraints: {} \}". Here the escaping is mandatory to avoid handling by the binding parser. By default the filter type is sap.ui.model.type.String.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{any}oFilterType New value for property filterType
Since:
1.9.2
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setFilterValue(sFilterValue): sap.ui.table.Column
Sets a new value for property filterValue.

Specifies the value of the filter as string (will be converted into the proper data type). It is possible to provide a filterOperator as string, as shown here:

> 50
< 100
>= 150
<= 200
= 250
!= 300
something    ends with
something*    starts with
something*   contains
some..thing   between
50..100       between

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sFilterValue New value for property filterValue
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setFlexible(bFlexible): sap.ui.table.Column
Sets a new value for property flexible.

If the table is wider than the sum of widths of the visible columns, the columns will be resized proportionally to their widths that were set originally. If set to false, the column will be displayed in the original width. If all columns are set to not be flexible, an extra "dummy" column will be created at the end of the table.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bFlexible New value for property flexible
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setGrouped(bGrouped): sap.ui.table.Column
Sets a new value for property grouped.

Indicates if the column is grouped.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bGrouped New value for property grouped
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setHAlign(sHAlign): sap.ui.table.Column
Sets a new value for property hAlign.

Horizontal alignment of the column content. Controls with a text align do not inherit the horizontal alignment. You have to set the text align directly on the template.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Begin.

Parameters:
{sap.ui.core.HorizontalAlign}sHAlign New value for property hAlign
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setHeaderSpan(oHeaderSpan): sap.ui.table.Column
Sets a new value for property headerSpan.

If this property is set, a span is applied for the header. When moving columns, all columns which are part of the header will be moved. The headerSpan can be either an integer or an array of integers (if you use the multi header feature of the table). If you only specify an integer, this span is applied for all header rows, with multiple integers you can specify a separate span for each header row.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

Parameters:
{any}oHeaderSpan New value for property headerSpan
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setLabel(vLabel): sap.ui.table.Column
Sets the aggregated label.
Parameters:
{sap.ui.core.Control|string}vLabel The label to set
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setMenu(oMenu): sap.ui.table.Column
Sets the aggregated menu.
Parameters:
{sap.ui.unified.Menu}oMenu The menu to set
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setName(sName): sap.ui.table.Column
Sets a new value for property name.

The name of the column which is used in the column visibility menu item as text. If not set as a fallback the column menu tries to get the text from the nested Label.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sName New value for property name
Since:
1.11.1
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setResizable(bResizable): sap.ui.table.Column
Sets a new value for property resizable.

If set to true, the column can be resized either using the resize-handle (by mouse) or using the keyboard (SHIFT + Left/Right Arrow keys)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bResizable New value for property resizable
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setShowFilterMenuEntry(bShowFilterMenuEntry): sap.ui.table.Column
Sets a new value for property showFilterMenuEntry.

Defines if the filter menu entry is displayed

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bShowFilterMenuEntry New value for property showFilterMenuEntry
Since:
1.13.0
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setShowSortMenuEntry(bShowSortMenuEntry): sap.ui.table.Column
Sets a new value for property showSortMenuEntry.

Defines if the sort menu entries are displayed

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bShowSortMenuEntry New value for property showSortMenuEntry
Since:
1.13.0
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setSorted(bSorted): sap.ui.table.Column
Sets a new value for property sorted.

Indicates if the column is sorted. This property only controls if a sort indicator is displayed in the column header - it does not trigger the sort function. The column has to be sorted by calling Column.sort()

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bSorted New value for property sorted
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setSortOrder(sSortOrder): sap.ui.table.Column
Sets a new value for property sortOrder.

This property indicates the sort direction (Ascending or Descending). The corresponding icon will be rendered if the property sorted is true

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Ascending.

Parameters:
{sap.ui.table.SortOrder}sSortOrder New value for property sortOrder
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setSortProperty(sSortProperty): sap.ui.table.Column
Sets a new value for property sortProperty.

Specifies the binding property on which the column will sort. Since the column template may have composite bindings, it's not possible to figure out on which binding property the sort shall be applied. Therefore the binding property for sorting must be specified. For example, if the first name and last name are displayed in the same column, only one of the two can be defined as sortProperty.

A column menu entry for sorting can only be generated if the sortProperty is set.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sSortProperty New value for property sortProperty
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setTemplate(oTemplate): sap.ui.table.Column
Sets the aggregated template.
Parameters:
{sap.ui.core.Control}oTemplate The template to set
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setVisible(bVisible): sap.ui.table.Column
Sets a new value for property visible.

Invisible controls are not rendered.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bVisible New value for property visible
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.table.Column
Sets a new value for property width.

Width of the column. Works only with px/em/rem values. Em are handled like rem values.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.table.Column} Reference to this in order to allow method chaining
shouldRender(): boolean
Returns whether the column should be rendered or not.
Returns:
{boolean} true, if the column should be rendered
sort(bDescending): sap.ui.table.Column
sorts the current column ascending or descending
Parameters:
{boolean}bDescending sort order of the column (if undefined the default will be ascending)
Deprecated:
Since version 1.5.1. Please use the function "sap.ui.Table.prototype.sort".
Returns:
{sap.ui.table.Column}
toggleSort(): sap.ui.table.Column
Toggles the sort order of the column.
Deprecated:
Since version 1.5.1. Please use the function "sap.ui.Table.prototype.sort".
Returns:
{sap.ui.table.Column}