com.smartgwt.client.widgets.tree
Class TreeGridField

java.lang.Object
  com.smartgwt.client.core.JsObject
      com.smartgwt.client.core.DataClass
          com.smartgwt.client.widgets.grid.ListGridField
              com.smartgwt.client.widgets.tree.TreeGridField

All Implemented Interfaces:

HasHandlers, HasCellSavedHandlers, HasChangedHandlers, HasChangeHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasRecordClickHandlers

public class TreeGridField
extends ListGridField

An object literal with a particular set of properties used to configure the display of and interaction with the columns of a TreeGrid. TreeGrid is a subclass of ListGrid and as a result, for all fields except the field containing the Tree itself (specified by treeField, all properties settable on ListGridField apply to TreeGridField as well.

This class documents just those properties that are specific to TreeGridFields - see ListGridField for the set of inherited properties.

See Also:

ListGridField, ListGrid.getFields(), ListGrid.setFields(com.smartgwt.client.widgets.grid.ListGridField...)

Field Summary

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

TreeGridField()

TreeGridField(JavaScriptObject jsObj)

TreeGridField(String name)

TreeGridField(String name, int width)

TreeGridField(String name, String title)

TreeGridField(String name, String title, int width)

Method Summary

Boolean	getCanExport() Dictates whether the data in this field be exported.
static TreeGridField	getOrCreateRef(JavaScriptObject jsObj)
Boolean	getTreeField() The field containing treeField: true will display the Tree.
void	setCanExport(Boolean canExport) Dictates whether the data in this field be exported.
void	setTreeField(Boolean treeField) The field containing treeField: true will display the Tree.

Methods inherited from class com.smartgwt.client.widgets.grid.ListGridField

addCellSavedHandler, addChangedHandler, addChangeHandler, addEditorEnterHandler, addEditorExitHandler, addRecordClickHandler, addSummaryFunction, addSummaryFunction, getAlign, getAutoFetchDisplayMap, getAutoFitWidth, getAutoFitWidthApproach, getAutoFreeze, getBaseStyle, getCanDragResize, getCanEdit, getCanFilter, getCanFreeze, getCanGroupBy, getCanHide, getCanHilite, getCanReorder, getCanSort, getCanSortClientOnly, getCanToggle, getCellAlign, getCellIcon, getDataPath, getDateFormatter, getDefaultGroupingMode, getDefaultIconSrc, getDisplayField, getEditorIconHeight, getEditorIconWidth, getEditorImageURLPrefix, getEditorImageURLSuffix, getEditorValueIconHeight, getEditorValueIconWidth, getEmptyCellValue, getEnterKeyEditAction, getEscapeHTML, getEscapeKeyEditAction, getExportRawValues, getFieldTitle, getFilterOnKeypress, getFilterOperator, getFrozen, getGroupGranularity, getGroupingMode, getGroupingModes, getGroupPrecision, getHeaderBaseStyle, getHeaderTitleStyle, getIcon, getIconHeight, getIconOrientation, getIconSize, getIconSpacing, getIconVAlign, getIconWidth, getImageHeight, getImageSize, getImageURLPrefix, getImageURLSuffix, getImageWidth, getIncludeInRecordSummary, getIsRemoveField, getLinkText, getLinkTextProperty, getLinkURLPrefix, getLinkURLSuffix, getName, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getPartialSummary, getPrompt, getRecordSummaryFunction, getRequired, getShouldPrint, getShowAlternateStyle, getShowDefaultContextMenu, getShowDisabledIcon, getShowDownIcon, getShowFileInline, getShowFocusedIcon, getShowGridSummary, getShowGroupSummary, getShowHover, getShowRollOverIcon, getShowSelectedIcon, getShowValueIconOnly, getSortByDisplayField, getSortDirection, getSummaryTitle, getSummaryValueTitle, getSuppressValueIcon, getTarget, getTimeFormatter, getTitle, getType, getValidateOnChange, getValueField, getValueIconHeight, getValueIconLeftPadding, getValueIconOrientation, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getWidth, setAlign, setAutoFetchDisplayMap, setAutoFitWidth, setAutoFitWidthApproach, setAutoFreeze, setBaseStyle, setCanDragResize, setCanEdit, setCanFilter, setCanFreeze, setCanGroupBy, setCanHide, setCanHilite, setCanReorder, setCanSort, setCanSortClientOnly, setCanToggle, setCellAlign, setCellFormatter, setCellIcon, setDataPath, setDateFormatter, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultGroupingMode, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisplayField, setEditorIconHeight, setEditorIconWidth, setEditorImageURLPrefix, setEditorImageURLSuffix, setEditorType, setEditorValueIconHeight, setEditorValueIcons, setEditorValueIconWidth, setEditorValueMap, setEditorValueMapFunction, setEditValueFormatter, setEditValueParser, setEmptyCellValue, setEnterKeyEditAction, setEscapeHTML, setEscapeKeyEditAction, setExportRawValues, setFilterEditorProperties, setFilterEditorType, setFilterEditorValueMap, setFilterOnKeypress, setFilterOperator, setFrozen, setGroupGranularity, setGroupingMode, setGroupingModes, setGroupPrecision, setGroupTitleRenderer, setGroupValueFunction, setHeaderBaseStyle, setHeaderButtonProperties, setHeaderTitleStyle, setHidden, setHoverCustomizer, setIcon, setIconHeight, setIconOrientation, setIcons, setIconSize, setIconSpacing, setIconVAlign, setIconWidth, setImageHeight, setImageSize, setImageURLPrefix, setImageURLSuffix, setImageWidth, setImgDir, setIncludeInRecordSummary, setIsRemoveField, setLinkText, setLinkTextProperty, setLinkURLPrefix, setLinkURLSuffix, setMultiple, setName, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setPartialSummary, setPrompt, setRecordSummaryFunction, setRecordSummaryFunction, setRequired, setShouldPrint, setShowAlternateStyle, setShowDefaultContextMenu, setShowDisabledIcon, setShowDownIcon, setShowFileInline, setShowFocusedIcon, setShowGridSummary, setShowGroupSummary, setShowHover, setShowIfCondition, setShowRollOverIcon, setShowSelectedIcon, setShowValueIconOnly, setSortByDisplayField, setSortDirection, setSortNormalizer, setSummaryFunction, setSummaryFunction, setSummaryFunction, setSummaryTitle, setSummaryValueTitle, setSuppressValueIcon, setTarget, setTimeFormatter, setTitle, setType, setValidateOnChange, setValidators, setValueField, setValueIconHeight, setValueIconLeftPadding, setValueIconOrientation, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setWidth, setWidth, setWrap

Methods inherited from class com.smartgwt.client.core.DataClass

doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.smartgwt.client.core.JsObject

isCreated, setJsObj

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

TreeGridField

public TreeGridField()

TreeGridField

public TreeGridField(JavaScriptObject jsObj)

TreeGridField

public TreeGridField(String name)

TreeGridField

public TreeGridField(String name,
                     int width)

TreeGridField

public TreeGridField(String name,
                     String title)

TreeGridField

public TreeGridField(String name,
                     String title,
                     int width)

Method Detail

getOrCreateRef

public static TreeGridField getOrCreateRef(JavaScriptObject jsObj)

setCanExport

public void setCanExport(Boolean canExport)

Dictates whether the data in this field be exported. Explicitly set this to false to prevent exporting. Has no effect if the underlying dataSourceField is explicitly set to canExport: false.

Overrides:

setCanExport in class ListGridField

Parameters:

canExport - canExport Default value is null

getCanExport

public Boolean getCanExport()

Dictates whether the data in this field be exported. Explicitly set this to false to prevent exporting. Has no effect if the underlying dataSourceField is explicitly set to canExport: false.

Overrides:

getCanExport in class ListGridField

Returns:

Boolean

setTreeField

public void setTreeField(Boolean treeField)

The field containing treeField: true will display the Tree. If no field specifies this property, if a field named after the titleProperty of the Tree is present in fields, that field will show the tree. Note that when using a DataSource, you typically define the title field via titleField and the generated ResultTree automatically uses this field. If none of the above rules apply, the first field in fields is assigned to display the Tree.

Parameters:

treeField - treeField Default value is see below

getTreeField

public Boolean getTreeField()

The field containing treeField: true will display the Tree. If no field specifies this property, if a field named after the titleProperty of the Tree is present in fields, that field will show the tree. Note that when using a DataSource, you typically define the title field via titleField and the generated ResultTree automatically uses this field. If none of the above rules apply, the first field in fields is assigned to display the Tree.

Returns:

Boolean