|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.extjs.gxt.ui.client.event.BaseObservable
com.extjs.gxt.ui.client.widget.grid.ColumnConfig
public class ColumnConfig
A column config for a column in a column model.
The column config is a configuration object that should only be used when creating a column model. After the column model is created, any changes should be made to the column model, not the column config.
Field Summary | |
---|---|
protected boolean |
ariaIgnore
True to disable keyboard column navigation of this column. |
Constructor Summary | |
---|---|
ColumnConfig()
Creates a new column config. |
|
ColumnConfig(java.lang.String id,
int width)
Creates a new column config. |
|
ColumnConfig(java.lang.String id,
java.lang.String name,
int width)
Creates a new column config. |
Method Summary | |
---|---|
Style.HorizontalAlignment |
getAlignment()
Returns the column's horizontal alignment. |
java.lang.String |
getColumnStyleName()
Returns the column style name. |
java.lang.String |
getDataIndex()
Returns the column's data index. |
com.google.gwt.i18n.client.DateTimeFormat |
getDateTimeFormat()
Returns the column's data time format. |
CellEditor |
getEditor()
Returns the column's cell editor. |
java.lang.String |
getHeader()
Returns the column's header text. |
java.lang.String |
getId()
Returns the column's id. |
com.google.gwt.i18n.client.NumberFormat |
getNumberFormat()
Returns the column's number format. |
GridCellRenderer<ModelData> |
getRenderer()
Returns the column's cell renderer. |
java.lang.String |
getStyle()
Returns the column style. |
java.lang.String |
getToolTip()
Returns the column's tool tip. |
com.google.gwt.user.client.ui.Widget |
getWidget()
Returns the column's widget. |
int |
getWidth()
Returns the column's width. |
boolean |
isFixed()
Returns true if the column width cannot be changed. |
boolean |
isGroupable()
Returns true if the column can be grouped. |
boolean |
isHidden()
Returns true if the column is hidden. |
boolean |
isMenuDisabled()
Returns true if the column's menu is disabled. |
boolean |
isResizable()
Returns true if the column is resizable. |
boolean |
isRowHeader()
Returns true if the column is marked as the row header. |
boolean |
isSortable()
Returns true if the column is sortable (pre-render). |
void |
setAlignment(Style.HorizontalAlignment alignment)
Sets the column's horizontal alignment. |
void |
setColumnStyleName(java.lang.String columnStyleName)
Sets the style name to be applied to the header element (defaults to null). |
void |
setDataIndex(java.lang.String dataIndex)
Sets the column's data index. |
void |
setDateTimeFormat(com.google.gwt.i18n.client.DateTimeFormat dateTimeFormat)
Sets the column's date time format. |
void |
setEditor(CellEditor editor)
Sets the column's cell editor. |
void |
setFixed(boolean fixed)
True if the column width cannot be changed either by column model or user resizing (defaults to false, pre-render). |
void |
setGroupable(boolean groupable)
Sets if the column is groupable (defaults to true). |
void |
setHeader(java.lang.String header)
Sets the column's header text. |
void |
setHidden(boolean hidden)
Sets whether the column is hidden. |
void |
setId(java.lang.String id)
Sets the column's id. |
void |
setMenuDisabled(boolean menuDisabled)
Sets whether the column's menu is disabled (pre-render). |
void |
setNumberFormat(com.google.gwt.i18n.client.NumberFormat format)
Sets the column's number format. |
void |
setRenderer(GridCellRenderer renderer)
Sets the column's cell renderer (pre-render). |
void |
setResizable(boolean resizable)
Specifies if the column may be resized (defaults to true, pre-render). |
void |
setRowHeader(boolean rowHeader)
True to mark this column as the row header. |
void |
setSortable(boolean sortable)
Sets if the column can be sorted (defaults to true, pre-render). |
void |
setStyle(java.lang.String style)
Sets one to many styles. |
void |
setToolTip(java.lang.String toolTip)
Sets the column's tool tip. |
void |
setWidget(com.google.gwt.user.client.ui.Widget widget,
java.lang.String header)
Sets the column's widget. |
void |
setWidth(int width)
Sets the column's width in pixels. |
Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable |
---|
addListener, callListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean ariaIgnore
Constructor Detail |
---|
public ColumnConfig()
public ColumnConfig(java.lang.String id, int width)
id
- the column idwidth
- the column widthpublic ColumnConfig(java.lang.String id, java.lang.String name, int width)
id
- the column idname
- the column namewidth
- the column widthMethod Detail |
---|
public Style.HorizontalAlignment getAlignment()
public java.lang.String getColumnStyleName()
public java.lang.String getDataIndex()
public com.google.gwt.i18n.client.DateTimeFormat getDateTimeFormat()
public CellEditor getEditor()
public java.lang.String getHeader()
public java.lang.String getId()
public com.google.gwt.i18n.client.NumberFormat getNumberFormat()
public GridCellRenderer<ModelData> getRenderer()
public java.lang.String getStyle()
public java.lang.String getToolTip()
public com.google.gwt.user.client.ui.Widget getWidget()
public int getWidth()
public boolean isFixed()
public boolean isGroupable()
public boolean isHidden()
public boolean isMenuDisabled()
public boolean isResizable()
public boolean isRowHeader()
public boolean isSortable()
true
if the column is sortable (pre-render).
public void setAlignment(Style.HorizontalAlignment alignment)
alignment
- the alignmentpublic void setColumnStyleName(java.lang.String columnStyleName)
columnStyleName
- the CSS style namepublic void setDataIndex(java.lang.String dataIndex)
dataIndex
- the data indexpublic void setDateTimeFormat(com.google.gwt.i18n.client.DateTimeFormat dateTimeFormat)
dateTimeFormat
- the date time formatpublic void setEditor(CellEditor editor)
editor
- the cell editorpublic void setFixed(boolean fixed)
fixed
- true for fixed column widthpublic void setGroupable(boolean groupable)
groupable
- true to allow groupingpublic void setHeader(java.lang.String header)
header
- the header textpublic void setHidden(boolean hidden)
hidden
- true to hidepublic void setId(java.lang.String id)
id
- the column idpublic void setMenuDisabled(boolean menuDisabled)
menuDisabled
- true to disable the menupublic void setNumberFormat(com.google.gwt.i18n.client.NumberFormat format)
format
- the number formatpublic void setRenderer(GridCellRenderer renderer)
renderer
- the cell rendererpublic void setResizable(boolean resizable)
resizable
- the resizable statepublic void setRowHeader(boolean rowHeader)
rowHeader
- true to mark the column as the row headerpublic void setSortable(boolean sortable)
sortable
- the sortable statepublic void setStyle(java.lang.String style)
<code> setStyle("color:red;font-weight: bold"); </code>
style
- the stylepublic void setToolTip(java.lang.String toolTip)
toolTip
- the tool tippublic void setWidget(com.google.gwt.user.client.ui.Widget widget, java.lang.String header)
widget
- the widgetheader
- the text used for the column context menupublic void setWidth(int width)
width
- the width
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |