Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.sap.ui.table.client
Class ColumnHeader

java.lang.Object
  extended by com.google.gwt.core.client.JavaScriptObject
      extended by com.sap.ui.core.client.Element
          extended by com.sap.ui.table.client.Column
              extended by com.sap.ui.table.client.ColumnHeader

public class ColumnHeader
extends Column

The class ColumnHeader is the GWT wrapper for the Phoenix control: sap.ui.table.ColumnHeader.

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

For further parameters see {@link com.sap.ui.table.client.Column

Version:
0.18.0-SNAPSHOT
Author:
GENERATOR (JavaScript control: sap.ui.table.ColumnHeader)

Constructor Summary
protected ColumnHeader()
          constructs the class ColumnHeader
hidden due to JavaScriptObject restriction
 
Method Summary
 ColumnHeader addFilter(Filter filter)
          Appends a filter to the aggregation filters.
static ColumnHeader create()
          Deprecated. Since version 0.17.0. Please use sap.ui.table.Column instead of sap.ui.table.ColumnHeader
static ColumnHeader create(String idOrConfig)
          Deprecated. Since version 0.17.0. Please use sap.ui.table.Column instead of sap.ui.table.ColumnHeader
static ColumnHeader create(String id, String config)
          Deprecated. Since version 0.17.0. Please use sap.ui.table.Column instead of sap.ui.table.ColumnHeader
 ColumnHeader destroyFilters()
          Destroys all the filters in the Filters-aggregation.
 String getFilteringProperty()
          Getter for property filteringProperty Specifies the binding property on which the column will be filtered
 com.sap.ui.core.client.js.JsArray<Filter> getFilters()
          Getter for aggregation filters What are the current filters applied to this column header.
 String getSortingProperty()
          Getter for property sortingProperty Specifies the binding property on which the column will be sorted
 int indexOfFilter(Filter filter)
          Checks for the provided com.sap.ui.table.client.data.Filter in the filters-aggregation and returns its index if found or -1 otherwise.
 ColumnHeader insertFilter(Filter filter, int index)
          Inserts some filter into the aggregation named filters.
 boolean isFilterByControl()
          Getter for property filterByControl If set to true, the values appearing in the multiple list filter will be displayed as a control
 boolean isHierarchyColumn()
          Getter for property hierarchyColumn If the column is used as the hierarchy column
 com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<Filter>> removeAllFilters()
          Removes all the items in the filters-aggregation.
 com.sap.ui.core.client.js.JsArray<Filter> removeFilter(int index)
          Removes a filter from the aggregation named filters.
 ColumnHeader setFilterByControl(boolean value)
          Setter for property filterByControl
Default value is: false
 ColumnHeader setFilteringProperty(String value)
          Setter for property filteringProperty
 ColumnHeader setHierarchyColumn(boolean value)
          Setter for property hierarchyColumn
Default value is: false
 ColumnHeader setSortingProperty(String value)
          Setter for property sortingProperty
 
Methods inherited from class com.sap.ui.table.client.Column
destroyLabel, destroyTemplate, getFilterProperty, getHAlign, getLabel, getSortProperty, getTemplate, getWidth, setFilterProperty, setHAlign, setLabel, setSortProperty, setTemplate, setWidth
 
Methods inherited from class com.sap.ui.core.client.Element
_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty
 
Methods inherited from class com.google.gwt.core.client.JavaScriptObject
cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ColumnHeader

protected ColumnHeader()
constructs the class ColumnHeader
hidden due to JavaScriptObject restriction

Method Detail

create

public static ColumnHeader create()
Deprecated. Since version 0.17.0. Please use sap.ui.table.Column instead of sap.ui.table.ColumnHeader

creates a new instance of the class ColumnHeader

create

public static ColumnHeader create(String idOrConfig)
Deprecated. Since version 0.17.0. Please use sap.ui.table.Column instead of sap.ui.table.ColumnHeader

creates a new instance of the class ColumnHeader

Parameters:
id - id of the ColumnHeader or configuration JSON string

create

public static ColumnHeader create(String id,
                                  String config)
Deprecated. Since version 0.17.0. Please use sap.ui.table.Column instead of sap.ui.table.ColumnHeader

creates a new instance of the class ColumnHeader

Parameters:
id - id of the ColumnHeader
config - configuration JSON string

isHierarchyColumn

public final boolean isHierarchyColumn()
Getter for property hierarchyColumn If the column is used as the hierarchy column

Returns:
the value of property hierarchyColumn

setHierarchyColumn

public final ColumnHeader setHierarchyColumn(boolean value)
Setter for property hierarchyColumn
Default value is: false

Parameters:
value - boolean
Returns:
this to allow method chaining

getSortingProperty

public final String getSortingProperty()
Getter for property sortingProperty Specifies the binding property on which the column will be sorted

Returns:
the value of property sortingProperty

setSortingProperty

public final ColumnHeader setSortingProperty(String value)
Setter for property sortingProperty

Parameters:
value - String
Returns:
this to allow method chaining

getFilteringProperty

public final String getFilteringProperty()
Getter for property filteringProperty Specifies the binding property on which the column will be filtered

Returns:
the value of property filteringProperty

setFilteringProperty

public final ColumnHeader setFilteringProperty(String value)
Setter for property filteringProperty

Parameters:
value - String
Returns:
this to allow method chaining

isFilterByControl

public final boolean isFilterByControl()
Getter for property filterByControl If set to true, the values appearing in the multiple list filter will be displayed as a control

Returns:
the value of property filterByControl

setFilterByControl

public final ColumnHeader setFilterByControl(boolean value)
Setter for property filterByControl
Default value is: false

Parameters:
value - boolean
Returns:
this to allow method chaining

getFilters

public final com.sap.ui.core.client.js.JsArray<Filter> getFilters()
Getter for aggregation filters What are the current filters applied to this column header. One column can have 0 to N filters applied at once.

Returns:
com.sap.ui.table.client.data.Filter[]

insertFilter

public final ColumnHeader insertFilter(Filter filter,
                                       int index)
Inserts some filter into the aggregation named filters.

Parameters:
filter - the filter to insert
index - int the 0-based index the filter should be inserted at.
Returns:
this to allow method chaining

addFilter

public final ColumnHeader addFilter(Filter filter)
Appends a filter to the aggregation filters.

Parameters:
filter - com.sap.ui.table.client.data.Filter the filter to add
Returns:
this to allow method chaining

removeFilter

public final com.sap.ui.core.client.js.JsArray<Filter> removeFilter(int index)
Removes a filter from the aggregation named filters.

Parameters:
index - int the position of the filter to remove.
Returns:
reference to this instance

removeAllFilters

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<Filter>> removeAllFilters()
Removes all the items in the filters-aggregation.

Returns:
an array of the removed elements (might be empty)

indexOfFilter

public final int indexOfFilter(Filter filter)
Checks for the provided com.sap.ui.table.client.data.Filter in the filters-aggregation and returns its index if found or -1 otherwise.

Parameters:
filter - the filter whose index is looked for.
Returns:
the index of the provided control in the aggregation.

destroyFilters

public final ColumnHeader destroyFilters()
Destroys all the filters in the Filters-aggregation.

Returns:
this to allow method chaining
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2011 SAP. All Rights Reserved.