ExtGridCol (com.hfg API Documentation)

java.lang.Object
- com.hfg.javascript.ext.ExtGridCol

All Implemented Interfaces:

Cloneable, Comparable
```
public class ExtGridCol
extends Object
implements Cloneable, Comparable
```
Definition for a column from an ExtJs grid.

Constructor Summary

Constructors
Constructor and Description

ExtGridCol()

ExtGridCol(JsObjMap inJson)

ExtGridCol(XMLTag inXMLTag)

Constructors
Constructor and Description
`ExtGridCol()`
`ExtGridCol(JsObjMap inJson)`
`ExtGridCol(XMLTag inXMLTag)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGroupColumn(ExtGridCol inValue)`
`void`	`clearGroupColumns()`
`ExtGridCol`	`clone()`
`int`	`compareTo(Object inObj2)` Currently compares just dataIndex values or text if the dataIndex isn't set.
`boolean`	`equals(Object inObj2)`
`Align`	`getAlign()`
`AttributeMgr`	`getAttributeMgr()`
`String`	`getCustomField(String inName)`
`String`	`getDataIndex()`
`Boolean`	`getDraggable()`
`String`	`getEditor()`
`String`	`getEmptyCellText()`
`ExtFieldType`	`getFieldType()`
`String`	`getFilter()`
`Integer`	`getFlex()`
`Boolean`	`getGroupable()`
`List<ExtGridCol>`	`getGroupColumns()`
`int`	`getHeaderRowDepth()`
`Boolean`	`getHidden()`
`Boolean`	`getHideable()`
`String`	`getItemId()`
`Boolean`	`getLockable()`
`Boolean`	`getLocked()`
`Integer`	`getMaxWidth()`
`Integer`	`getMinWidth()`
`ExtGridCol`	`getParentCol()`
`String`	`getRenderer()`
`Boolean`	`getResizable()`
`Boolean`	`getSortable()`
`String`	`getSortType()`
`int`	`getTerminalColumnCount()`
`String`	`getText()`
`String`	`getTooltip()`
`Boolean`	`getVariableRowHeight()`
`Integer`	`getWidth()`
`String`	`getXType()`
`int`	`hashCode()`
`void`	`removeGroupColumn(ExtGridCol inValue)`
`ExtGridCol`	`setAlign(Align inValue)`
`ExtGridCol`	`setCustomField(String inName, String inValue)`
`ExtGridCol`	`setDataIndex(ExtModelField inValue)`
`ExtGridCol`	`setDataIndex(String inValue)`
`ExtGridCol`	`setDraggable(Boolean inValue)` Specifies whether the column header can be reordered by dragging.
`ExtGridCol`	`setEditor(String inValue)`
`ExtGridCol`	`setEmptyCellText(String inValue)`
`ExtGridCol`	`setFieldType(ExtFieldType inValue)` Specifies the field type to use for the column's model.
`ExtGridCol`	`setFilter(String inValue)`
`ExtGridCol`	`setFlex(Integer inValue)`
`ExtGridCol`	`setGroupable(Boolean inValue)` Specifies whether the grid can be grouped by the column dataIndex.
`void`	`setGroupColumn(int inIndex, ExtGridCol inValue)`
`ExtGridCol`	`setHidden(Boolean inValue)`
`ExtGridCol`	`setHideable(Boolean inValue)`
`ExtGridCol`	`setItemId(String inValue)`
`ExtGridCol`	`setLockable(Boolean inValue)`
`ExtGridCol`	`setLocked(Boolean inValue)`
`ExtGridCol`	`setMaxWidth(Integer inValue)`
`ExtGridCol`	`setMinWidth(Integer inValue)`
`ExtGridCol`	`setRenderer(String inValue)` Specifies a method name or method definition for composing the display ov column fields.
`ExtGridCol`	`setResizable(Boolean inValue)`
`ExtGridCol`	`setSortable(Boolean inValue)`
`ExtGridCol`	`setSortType(String inValue)` sortType isn't a true column property but is included here so that the information can be transferred to the corresponding model field if desired.
`ExtGridCol`	`setText(String inValue)`
`ExtGridCol`	`setTooltip(String inValue)`
`ExtGridCol`	`setVariableRowHeight(Boolean inValue)`
`ExtGridCol`	`setWidth(Integer inValue)`
`ExtGridCol`	`setXType(String inValue)`
`ExtModelField`	`toExtModelField()`
`JsObjMap`	`toJsObjMap()`
`String`	`toString()`
`XMLTag`	`toXMLTag()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtGridCol
```
public ExtGridCol()
```

ExtGridCol
```
public ExtGridCol(JsObjMap inJson)
```

ExtGridCol
```
public ExtGridCol(XMLTag inXMLTag)
```

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object inObj2)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

compareTo
```
public int compareTo(Object inObj2)
```
Currently compares just dataIndex values or text if the dataIndex isn't set.

Specified by:

compareTo in interface Comparable

Parameters:

inObj2 - the Object to compare to this ExtGridCol object.

Returns:

whether the specified object is less than, equal to, or greater than this object.

toExtModelField

public ExtModelField toExtModelField()

toJsObjMap
```
public JsObjMap toJsObjMap()
```

toXMLTag
```
public XMLTag toXMLTag()
```

clone
```
public ExtGridCol clone()
```
Overrides:

clone in class Object

getGroupColumns

public List<ExtGridCol> getGroupColumns()

addGroupColumn

public void addGroupColumn(ExtGridCol inValue)

setGroupColumn

public void setGroupColumn(int inIndex,
                           ExtGridCol inValue)

removeGroupColumn

public void removeGroupColumn(ExtGridCol inValue)

clearGroupColumns
```
public void clearGroupColumns()
```

getParentCol
```
public ExtGridCol getParentCol()
```

setCustomField

public ExtGridCol setCustomField(String inName,
                                 String inValue)

getCustomField

public String getCustomField(String inName)

setText

public ExtGridCol setText(String inValue)

getText
```
public String getText()
```

setEmptyCellText

public ExtGridCol setEmptyCellText(String inValue)

getEmptyCellText
```
public String getEmptyCellText()
```

setTooltip

public ExtGridCol setTooltip(String inValue)

getTooltip
```
public String getTooltip()
```

setDataIndex

public ExtGridCol setDataIndex(ExtModelField inValue)

setDataIndex

public ExtGridCol setDataIndex(String inValue)

getDataIndex
```
public String getDataIndex()
```

setWidth

public ExtGridCol setWidth(Integer inValue)

getWidth
```
public Integer getWidth()
```

setMinWidth

public ExtGridCol setMinWidth(Integer inValue)

getMinWidth
```
public Integer getMinWidth()
```

setMaxWidth

public ExtGridCol setMaxWidth(Integer inValue)

getMaxWidth
```
public Integer getMaxWidth()
```

setAlign

public ExtGridCol setAlign(Align inValue)

getAlign
```
public Align getAlign()
```

setRenderer
```
public ExtGridCol setRenderer(String inValue)
```
Specifies a method name or method definition for composing the display ov column fields.

Parameters:

inValue - either a javascript method name or a definition of a javascript method

Returns:

this ExtGridCol object - for method chaining

getRenderer
```
public String getRenderer()
```

setEditor

public ExtGridCol setEditor(String inValue)

getEditor
```
public String getEditor()
```

setSortable

public ExtGridCol setSortable(Boolean inValue)

getSortable
```
public Boolean getSortable()
```

setSortType
```
public ExtGridCol setSortType(String inValue)
```
sortType isn't a true column property but is included here so that the information can be transferred to the corresponding model field if desired.

Parameters:

inValue - name of the javascript SortType method.

Returns:

this grid column object to facilitate method chaining

getSortType
```
public String getSortType()
```

setHideable

public ExtGridCol setHideable(Boolean inValue)

getHideable
```
public Boolean getHideable()
```

setHidden

public ExtGridCol setHidden(Boolean inValue)

getHidden
```
public Boolean getHidden()
```

setLockable

public ExtGridCol setLockable(Boolean inValue)

getLockable
```
public Boolean getLockable()
```

setLocked

public ExtGridCol setLocked(Boolean inValue)

getLocked
```
public Boolean getLocked()
```

setDraggable
```
public ExtGridCol setDraggable(Boolean inValue)
```
Specifies whether the column header can be reordered by dragging.

Parameters:

inValue - whether or not the column can be reordered

Returns:

this ExtGridCol object - for method chaining

getDraggable
```
public Boolean getDraggable()
```

setGroupable
```
public ExtGridCol setGroupable(Boolean inValue)
```
Specifies whether the grid can be grouped by the column dataIndex.

Parameters:

inValue - whether or not the column can be grouped

Returns:

this ExtGridCol object - for method chaining

getGroupable
```
public Boolean getGroupable()
```

setResizable

public ExtGridCol setResizable(Boolean inValue)

getResizable
```
public Boolean getResizable()
```

setVariableRowHeight

public ExtGridCol setVariableRowHeight(Boolean inValue)

getVariableRowHeight
```
public Boolean getVariableRowHeight()
```

setItemId

public ExtGridCol setItemId(String inValue)

getItemId
```
public String getItemId()
```

setFilter

public ExtGridCol setFilter(String inValue)

getFilter
```
public String getFilter()
```

setFlex

public ExtGridCol setFlex(Integer inValue)

getFlex
```
public Integer getFlex()
```

setXType

public ExtGridCol setXType(String inValue)

getXType
```
public String getXType()
```

setFieldType
```
public ExtGridCol setFieldType(ExtFieldType inValue)
```
Specifies the field type to use for the column's model.

Parameters:

inValue - the field type

Returns:

this ExtGridCol object to enable method chaining

getFieldType
```
public ExtFieldType getFieldType()
```

getAttributeMgr
```
public AttributeMgr getAttributeMgr()
```

getHeaderRowDepth
```
public int getHeaderRowDepth()
```

getTerminalColumnCount
```
public int getTerminalColumnCount()
```

Class ExtGridCol

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExtGridCol

ExtGridCol

ExtGridCol

Method Detail

toString

equals

hashCode

compareTo

toExtModelField

toJsObjMap

toXMLTag

clone

getGroupColumns

addGroupColumn

setGroupColumn

removeGroupColumn

clearGroupColumns

getParentCol

setCustomField

getCustomField

setText

getText

setEmptyCellText

getEmptyCellText

setTooltip

getTooltip

setDataIndex

setDataIndex

getDataIndex

setWidth

getWidth

setMinWidth

getMinWidth

setMaxWidth

getMaxWidth

setAlign

getAlign

setRenderer

getRenderer

setEditor

getEditor

setSortable

getSortable

setSortType

getSortType

setHideable

getHideable

setHidden

getHidden

setLockable

getLockable

setLocked

getLocked

setDraggable

getDraggable

setGroupable

getGroupable

setResizable

getResizable

setVariableRowHeight

getVariableRowHeight

setItemId

getItemId

setFilter

getFilter

setFlex

getFlex

setXType

getXType

setFieldType

getFieldType

getAttributeMgr

getHeaderRowDepth

getTerminalColumnCount