com.smartgwt.client.widgets.tree
Class TreeGridField

java.lang.Object
  extended by com.smartgwt.client.core.JsObject
      extended by com.smartgwt.client.core.DataClass
          extended by com.smartgwt.client.widgets.grid.ListGridField
              extended by 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, getApplyAfterSummary, getAutoFetchDisplayMap, getAutoFitWidth, getAutoFitWidthApproach, getAutoFreeze, getAutoFreezePosition, getBaseStyle, getCanDragResize, getCanEdit, getCanFilter, getCanFreeze, getCanGroupBy, getCanHide, getCanHilite, getCanReorder, getCanSort, getCanSortClientOnly, getCanToggle, getCellAlign, getCellIcon, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultGroupingMode, getDefaultIconSrc, getDisplayField, getDisplayValueFromRecord, getEditorIconHeight, getEditorIconWidth, getEditorImageURLPrefix, getEditorImageURLSuffix, getEditorValueIconHeight, getEditorValueIconWidth, getEmptyCellValue, getEnterKeyEditAction, getEscapeHTML, getEscapeKeyEditAction, getExportFieldWidth, getExportFormat, getExportRawValues, getFieldTitle, getFilterOnKeypress, getFilterOperator, getFormat, getFrozen, getGroupGranularity, getGroupingMode, getGroupingModes, getGroupPrecision, getHeaderBaseStyle, getHeaderTitle, getHeaderTitleStyle, getHidden, getHiliteHTMLAfterFormat, getHiliteIconHeight, getHiliteIconLeftPadding, getHiliteIconPosition, getHiliteIconRightPadding, getHiliteIconSize, getHiliteIconWidth, getIcon, getIconHeight, getIconOrientation, getIconSize, getIconSpacing, getIconVAlign, getIconWidth, getIgnoreKeyboardClicks, getImageHeight, getImageSize, getImageURLPrefix, getImageURLSuffix, getImageWidth, getIncludeFrom, getIncludeInRecordSummary, getIsRemoveField, getLinkText, getLinkTextProperty, getLinkURLPrefix, getLinkURLSuffix, getMultiple, getName, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getPartialSummary, getPrompt, getRecordSummaryFunction, getRequired, getShouldPrint, getShowAlternateStyle, getShowDefaultContextMenu, getShowDisabledIcon, getShowDownIcon, getShowFileInline, getShowFocusedIcon, getShowGridSummary, getShowGroupSummary, getShowHilitesInGroupSummary, getShowHover, getShowRollOverIcon, getShowSelectedIcon, getShowTitle, getShowValueIconOnly, getSortByDisplayField, getSortByMappedValue, getSortDirection, getSummaryTitle, getSummaryValue, getSummaryValueTitle, getSuppressValueIcon, getTarget, getTimeFormatter, getTitle, getType, getUserFormula, getUserSummary, getValidateOnChange, getValueField, getValueIconHeight, getValueIconLeftPadding, getValueIconOrientation, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getWidth, getWrap, setAlign, setApplyAfterSummary, setAutoFetchDisplayMap, setAutoFitWidth, setAutoFitWidthApproach, setAutoFreeze, setBaseStyle, setCanDragResize, setCanEdit, setCanFilter, setCanFreeze, setCanGroupBy, setCanHide, setCanHilite, setCanReorder, setCanSort, setCanSortClientOnly, setCanToggle, setCellAlign, setCellFormatter, setCellIcon, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultGroupingMode, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisplayField, setDisplayValueFromRecord, setEditorIconHeight, setEditorIconWidth, setEditorImageURLPrefix, setEditorImageURLSuffix, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueIconHeight, setEditorValueIcons, setEditorValueIconWidth, setEditorValueMap, setEditorValueMapFunction, setEditValueFormatter, setEditValueParser, setEmptyCellValue, setEnterKeyEditAction, setEscapeHTML, setEscapeKeyEditAction, setExportFieldWidth, setExportFormat, setExportRawValues, setFilterEditorProperties, setFilterEditorType, setFilterEditorType, setFilterEditorType, setFilterEditorValueMap, setFilterOnKeypress, setFilterOperator, setFormat, setFrozen, setGridSummaryCustomizer, setGroupGranularity, setGroupingMode, setGroupingModes, setGroupPrecision, setGroupSummaryCustomizer, setGroupTitleRenderer, setGroupValueFunction, setHeaderBaseStyle, setHeaderButtonProperties, setHeaderTitle, setHeaderTitleStyle, setHidden, setHiliteHTMLAfterFormat, setHiliteIconHeight, setHiliteIconLeftPadding, setHiliteIconPosition, setHiliteIconRightPadding, setHiliteIconSize, setHiliteIconWidth, setHoverCustomizer, setIcon, setIconHeight, setIconOrientation, setIcons, setIconSize, setIconSpacing, setIconVAlign, setIconWidth, setIgnoreKeyboardClicks, setImageHeight, setImageSize, setImageURLPrefix, setImageURLSuffix, setImageWidth, setImgDir, setIncludeFrom, setIncludeInRecordSummary, setIsRemoveField, setLeaveHeaderMenuButtonSpace, 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, setShowHilitesInGroupSummary, setShowHover, setShowIfCondition, setShowRollOverIcon, setShowSelectedIcon, setShowTitle, setShowValueIconOnly, setSortByDisplayField, setSortByMappedValue, setSortDirection, setSortNormalizer, setSummaryFunction, setSummaryFunction, setSummaryFunction, setSummaryTitle, setSummaryValue, setSummaryValueTitle, setSuppressValueIcon, setTarget, setTimeFormatter, setTitle, setType, setUserFormula, setUserSummary, setValidateOnChange, setValidators, setValueField, setValueIconHeight, setValueIconLeftPadding, setValueIconOrientation, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setWidth, setWidth, setWrap, 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, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject
 
Methods inherited from class com.smartgwt.client.core.JsObject
equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, 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 - 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 - 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