Class type Ext_grid_column_Column.t

class type t = object .. end

method isColumn : bool Js.t Js.readonly_prop

Set in this class to identify, at runtime, instances which are not instances of the HeaderContainer base class, but are in fact simple column headers.

Defaults to: true

method textEl : Ext_dom_Element.t Js.t Js.prop

Element that contains the text in column header.

method triggerEl : Ext_dom_Element.t Js.t Js.prop

Element that acts as button for column header dropdown menu.

method afterComponentLayout : 'a 'b. Js.number Js.t -> Js.number Js.t -> 'a Js.t -> 'b Js.t -> unit Js.meth

private Inform the header container about the resize

Called by the layout system after the Component has been laid out.

Parameters:

• width: Js.number Js.t

  The width that was set

• height: Js.number Js.t

  The height that was set

• oldWidth: _ Js.t

  The old width, or undefined if this was the initial layout.

• oldHeight: _ Js.t

  The old height, or undefined if this was the initial layout.

method afterRender : unit Js.meth

Allows addition of behavior after rendering is complete. At this stage the Component’s Element will have been styled according to the configuration, will have had any configured CSS class names added, and will be in the configured visibility and the configured enable state.

method autoSize : 'c. 'c Js.t -> unit Js.meth

Sizes this Column to fit the max content width. Note that group columns shrinkwrap around the size of leaf columns. Auto sizing a group column autosizes descendant leaf columns.

Parameters:

• the: _ Js.t

  header (or index of header) to auto size.

method defaultRenderer : unit Js.meth

When defined this will take precedence over the renderer config. This is meant to be defined in subclasses that wish to supply their own renderer.

method getEditor : 'd 'e 'f. 'd Js.t -> 'e Js.t -> (#Ext_form_field_Field.t as 'f) Js.t Js.meth

Retrieves the editing field for editing associated with this header. Returns false if there is no field associated with the Header the method will return false. If the field has not been instantiated it will be created. Note: These methods only have an implementation if an Editing plugin has been enabled on the grid.

Parameters:

• record: _ Js.t

  The Model instance being edited.

• defaultField: _ Js.t

  An object representing a default field to be created

Returns:

• #Ext_form_field_Field.t Js.t

  field

method getIndex : Js.number Js.t Js.meth

Returns the index of this column only if this column is a base level Column. If it is a group column, it returns false.

method getSortParam : Js.js_string Js.t Js.meth

Returns the parameter to sort upon when sorting this header. By default this returns the dataIndex and will not need to be overriden in most cases.

method getVisibleIndex : Js.number Js.t Js.meth

Returns the index of this column in the list of visible columns only if this column is a base level Column. If it is a group column, it returns false.

method hide_column : 'g 'h 'i 'j.
         'g Js.t Js.optdef ->
         'h Js.callback Js.optdef ->
         'i Js.t Js.optdef -> (#Ext_Component.t as 'j) Js.t Js.meth

Hides this Component, setting it to invisible using the configured hideMode.

Parameters:

• animateTarget: _ Js.t (optional)

  only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true.. The target to which the Component should animate while hiding.

  Defaults to: null
• callback: _ Js.callback (optional)

  A callback function to call after the Component is hidden.

• scope: _ Js.t (optional)

  The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns:

• #Ext_Component.t Js.t

  this

method initComponent : unit Js.meth

The initComponent template method is an important initialization step for a Component. It is intended to be implemented by each subclass of Ext.Component to provide any needed constructor logic. The initComponent method of the class being created is called first, with each initComponent method up the hierarchy to Ext.Component being called thereafter. This makes it easy to implement and, if needed, override the constructor logic of the Component at any step in the hierarchy.

The initComponent method must contain a call to callParent in order to ensure that the parent class' initComponent method is also called.

All config options passed to the constructor are applied to this before initComponent is called, so you can simply access them with this.someOption.

The following example demonstrates using a dynamic string for the text of a button at the time of instantiation of the class.

Ext.define('DynamicButtonText', {
    extend: 'Ext.button.Button',

    initComponent: function() {
        this.text = new Date();
        this.renderTo = Ext.getBody();
        this.callParent();
    }
});

Ext.onReady(function() {
    Ext.create('DynamicButtonText');
});

method initRenderData : 'k. 'k Js.t Js.meth

Initialized the renderData to be used when rendering the renderTpl.

Returns:

• _ Js.t

  Object with keys and values that are going to be applied to the renderTpl

method isHideable : unit Js.meth

Determines whether the UI should be allowed to offer an option to hide this column.

A column may not be hidden if to do so would leave the grid with no visible columns.

This is used to determine the enabled/disabled state of header hide menu items.

method isLockable : unit Js.meth

Determines whether the UI should be allowed to offer an option to lock or unlock this column. Note that this includes dragging a column into the opposite side of a lockable grid.

A column may not be moved from one side to the other of a lockable grid if to do so would leave one side with no visible columns.

This is used to determine the enabled/disabled state of the lock/unlock menu item used in lockable grids, and to determine dropppabilty when dragging a header.

method onAdd : 'l. (#Ext_Component.t as 'l) Js.t -> Js.number Js.t -> unit Js.meth

This method is invoked after a new Component has been added. It is passed the Component which has been added. This method may be used to update any internal structure which may depend upon the state of the child items.

Parameters:

• component: #Ext_Component.t Js.t
• position: Js.number Js.t

method onDestroy : unit Js.meth

Allows addition of behavior to the destroy operation. After calling the superclass's onDestroy, the Component will be destroyed.

method onRemove : 'm. (#Ext_Component.t as 'm) Js.t -> bool Js.t -> unit Js.meth

This method is invoked after a new Component has been removed. It is passed the Component which has been removed. This method may be used to update any internal structure which may depend upon the state of the child items.

Parameters:

• component: #Ext_Component.t Js.t
• autoDestroy: bool Js.t

method setEditor : 'n. 'n Js.t -> unit Js.meth

Sets the form field to be used for editing. Note: This method only has an implementation if an Editing plugin has been enabled on the grid.

Parameters:

• field: _ Js.t

  An object representing a field to be created. If no xtype is specified a 'textfield' is assumed.

method setText : Js.js_string Js.t -> unit Js.meth

Sets the header text for this Column.

Parameters:

• text: Js.js_string Js.t

  The header to display on this Column.

method show_column : 'o 'p 'q 'r.
         'o Js.t Js.optdef ->
         'p Js.callback Js.optdef ->
         'q Js.t Js.optdef -> (#Ext_Component.t as 'r) Js.t Js.meth

Shows this Component, rendering it first if autoRender or floating are true.

After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of its z-index stack.

Parameters:

• animateTarget: _ Js.t (optional)

  only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true. The target from which the Component should animate from while opening.

  Defaults to: null
• callback: _ Js.callback (optional)

  A callback function to call after the Component is displayed. Only necessary if animation was specified.

• scope: _ Js.t (optional)

  The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns:

• #Ext_Component.t Js.t

  this