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 ${isc.DocUtils.linkForRef('object:ListGridField')} apply to TreeGridField as well.

This class documents just those properties that are specific to TreeGridFields - see ${isc.DocUtils.linkForRef('object:ListGridField')} for the set of inherited properties.


Field Summary
 
Fields inherited from class com.smartgwt.client.core.JsObject
jsObj
 
Constructor Summary
TreeGridField()
           
TreeGridField(com.google.gwt.core.client.JavaScriptObject jsObj)
           
TreeGridField(java.lang.String name)
           
TreeGridField(java.lang.String name, int width)
           
TreeGridField(java.lang.String name, java.lang.String title)
           
TreeGridField(java.lang.String name, java.lang.String title, int width)
           
 
Method Summary
static TreeGridField getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.Boolean getTreeField()
          The field containing treeField: true will display the Tree.
 void setTreeField(java.lang.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, getAlign, getAutoFetchDisplayMap, getBaseStyle, getCanEdit, getCanFilter, getCanFreeze, getCanGroupBy, getCanHide, getCanSort, getCanSortClientOnly, getCanToggle, getCellAlign, getCellIcon, getDateFormatter, getDefaultGroupingMode, getDefaultIconSrc, getDisplayField, getEditorIconHeight, getEditorIconWidth, getEditorImageURLPrefix, getEditorImageURLSuffix, getEditorValueIconHeight, getEditorValueIconWidth, getEmptyCellValue, getEnterKeyEditAction, getEscapeKeyEditAction, getFieldTitle, getFilterOnKeypress, getFrozen, getGroupGranularity, getGroupingMode, getGroupingModes, getGroupPrecision, getHeaderBaseStyle, getHeaderTitleStyle, getIcon, getIconHeight, getIconOrientation, getIconSize, getIconSpacing, getIconVAlign, getIconWidth, getImageHeight, getImageSize, getImageURLPrefix, getImageURLSuffix, getImageWidth, getIsRemoveField, getLinkText, getName, getRequired, getShowDisabledIcon, getShowDownIcon, getShowFocusedIcon, getShowHover, getShowRollOverIcon, getShowSelectedIcon, getShowValueIconOnly, getSortDirection, getSummaryTitle, getSuppressValueIcon, getTarget, getTitle, getType, getValidateOnChange, getValueField, getValueIconHeight, getValueIconLeftPadding, getValueIconOrientation, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getWidth, setAlign, setAutoFetchDisplayMap, setBaseStyle, setCanEdit, setCanFilter, setCanFreeze, setCanGroupBy, setCanHide, setCanSort, setCanSortClientOnly, setCanToggle, setCellAlign, setCellFormatter, setCellIcon, setDateFormatter, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultFilterValue, setDefaultGroupingMode, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisplayField, setEditorIconHeight, setEditorIconWidth, setEditorImageURLPrefix, setEditorImageURLSuffix, setEditorType, setEditorValueIconHeight, setEditorValueIcons, setEditorValueIconWidth, setEditorValueMap, setEditorValueMapFunction, setEmptyCellValue, setEnterKeyEditAction, setEscapeKeyEditAction, setFilterEditorType, setFilterEditorValueMap, setFilterOnKeypress, setFrozen, setGroupGranularity, setGroupingMode, setGroupingModes, setGroupPrecision, setGroupTitleRenderer, setGroupValueFunction, setHeaderBaseStyle, setHeaderTitleStyle, setHidden, setHoverCustomizer, setIcon, setIconHeight, setIconOrientation, setIcons, setIconSize, setIconSpacing, setIconVAlign, setIconWidth, setImageHeight, setImageSize, setImageURLPrefix, setImageURLSuffix, setImageWidth, setImgDir, setIsRemoveField, setLinkText, setMultiple, setName, setOptionDataSource, setPrompt, setRequired, setShowDisabledIcon, setShowDownIcon, setShowFocusedIcon, setShowHover, setShowIfCondition, setShowRollOverIcon, setShowSelectedIcon, setShowValueIconOnly, setSortDirection, setSortNormalizer, setSummaryTitle, setSuppressValueIcon, setTarget, setTitle, setType, setValidateOnChange, setValidators, setValueField, setValueIconHeight, setValueIconLeftPadding, setValueIconOrientation, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setWidth, setWidth
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, 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
 
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
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

TreeGridField

public TreeGridField()

TreeGridField

public TreeGridField(com.google.gwt.core.client.JavaScriptObject jsObj)

TreeGridField

public TreeGridField(java.lang.String name)

TreeGridField

public TreeGridField(java.lang.String name,
                     int width)

TreeGridField

public TreeGridField(java.lang.String name,
                     java.lang.String title)

TreeGridField

public TreeGridField(java.lang.String name,
                     java.lang.String title,
                     int width)
Method Detail

getOrCreateRef

public static TreeGridField getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

setTreeField

public void setTreeField(java.lang.Boolean treeField)
The field containing treeField: true will display the Tree. If no field specifies this property, the first field in fields is assigned to display the Tree.

Parameters:
treeField - treeField Default value is see below

getTreeField

public java.lang.Boolean getTreeField()
The field containing treeField: true will display the Tree. If no field specifies this property, the first field in fields is assigned to display the Tree.

Returns:
Boolean