TreeGrid

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.smartgwt.client.widgets.tree
Class TreeGrid

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.smartgwt.client.widgets.BaseWidget
              com.smartgwt.client.widgets.Canvas
                  com.smartgwt.client.widgets.grid.ListGrid
                      com.smartgwt.client.widgets.tree.TreeGrid

All Implemented Interfaces:: HasHandlers, EventListener, DataBoundComponent, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasCellClickHandlers, HasCellContextClickHandlers, HasCellDoubleClickHandlers, HasCellHoverHandlers, HasCellMouseDownHandlers, HasCellMouseUpHandlers, HasCellOutHandlers, HasCellOverHandlers, HasCellSavedHandlers, HasDataArrivedHandlers, HasDrawAreaChangedHandlers, HasEditCompleteHandlers, HasEditFailedHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFieldStateChangedHandlers, HasHeaderClickHandlers, HasRecordClickHandlers, HasRecordCollapseHandlers, HasRecordDoubleClickHandlers, HasRecordDropHandlers, HasRecordExpandHandlers, HasRowContextClickHandlers, HasRowEditorEnterHandlers, HasRowEditorExitHandlers, HasRowHoverHandlers, HasRowMouseDownHandlers, HasRowMouseUpHandlers, HasRowOutHandlers, HasRowOverHandlers, HasSelectionChangedHandlers, HasFolderClickHandlers, HasFolderClosedHandlers, HasFolderContextClickHandlers, HasFolderDropHandlers, HasFolderOpenedHandlers, HasLeafClickHandlers, HasLeafContextClickHandlers, HasNodeClickHandlers, HasNodeContextClickHandlers

public class TreeGrid
extends ListGrid
implements HasFolderDropHandlers, HasDataArrivedHandlers, HasFolderOpenedHandlers, HasFolderClosedHandlers, HasFolderClickHandlers, HasLeafClickHandlers, HasNodeClickHandlers, HasFolderContextClickHandlers, HasLeafContextClickHandlers, HasNodeContextClickHandlers
extends ListGrid
implements HasFolderDropHandlers, HasDataArrivedHandlers, HasFolderOpenedHandlers, HasFolderClosedHandlers, HasFolderClickHandlers, HasLeafClickHandlers, HasNodeClickHandlers, HasFolderContextClickHandlers, HasLeafContextClickHandlers, HasNodeContextClickHandlers

The Smart GWT system supports hierarchical data (also referred to as tree data due to its "branching" organization) with:

the Tree class, which manipulates hierarchical data sets
the TreeGrid widget class, which extends the ListGrid class to visually present tree data in an expandable/collapsible format.

For information on DataBinding Trees, see TreeDataBinding.

A TreeGrid works just like a ListGrid, except one column (specified by treeField shows a hierarchical Tree. A TreeGrid is not limited to displaying just the Tree column - you can define additional columns (via fields) which will render just like the columns of a ListGrid, and support all of the functionality of ListGrid columns, such as formatters.

Except where explicitly overridden, ListGrid methods, callbacks, and properties apply to TreeGrids as well. The ListGrid defines some methods as taking/returning ListGridField and ListGridRecord. When using those methods in a TreeGrid, those types will be TreeGridField and TreeNode, respectively.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
`UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled`

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget
`config, configOnly, id, isElementSet, scClassName`

Fields inherited from class com.google.gwt.user.client.ui.UIObject
`DEBUG_ID_PREFIX`

Constructor Summary
`TreeGrid()`
`TreeGrid(JavaScriptObject jsObj)`

Method Summary
`HandlerRegistration`	`addDataArrivedHandler(DataArrivedHandler handler)` Add a dataArrived handler.
`HandlerRegistration`	`addFolderClickHandler(FolderClickHandler handler)` Add a folderClick handler.
`HandlerRegistration`	`addFolderClosedHandler(FolderClosedHandler handler)` Add a folderClosed handler.
`HandlerRegistration`	`addFolderContextClickHandler(FolderContextClickHandler handler)` Add a folderContextClick handler.
`HandlerRegistration`	`addFolderDropHandler(FolderDropHandler handler)` Add a onFolderDrop handler.
`HandlerRegistration`	`addFolderOpenedHandler(FolderOpenedHandler handler)` Add a folderOpened handler.
`HandlerRegistration`	`addLeafClickHandler(LeafClickHandler handler)` Add a leafClick handler.
`HandlerRegistration`	`addLeafContextClickHandler(LeafContextClickHandler handler)` Add a leafContextClick handler.
`HandlerRegistration`	`addNodeClickHandler(NodeClickHandler handler)` Add a nodeClick handler.
`HandlerRegistration`	`addNodeContextClickHandler(NodeContextClickHandler handler)` Add a nodeContextClick handler.
`HandlerRegistration`	`addRecordDropHandler(RecordDropHandler handler)` This ListGrid suporclass event does not fire on a TreeGrid, use `addFolderDropHandler(com.smartgwt.client.widgets.tree.events.FolderDropHandler)` instead.
`Boolean`	`canEditCell()` Overridden to disallow editing of the `name` field of this grid's data tree.
`protected JavaScriptObject`	`create()`
`void`	`fetchData()` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the provided criteria, and displays the matching data in this component as a tree.
`void`	`fetchData(Criteria criteria)` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the provided criteria, and displays the matching data in this component as a tree.
`void`	`fetchData(Criteria criteria, DSCallback callback)` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the provided criteria, and displays the matching data in this component as a tree.
`void`	`fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the provided criteria, and displays the matching data in this component as a tree.
`void`	`filterData(Criteria criteria)` Retrieves data that matches the provided criteria and displays the matching data in this component.
`void`	`filterData(Criteria criteria, DSCallback callback)` Retrieves data that matches the provided criteria and displays the matching data in this component.
`void`	`filterData(Criteria criteria, DSCallback callback, DSRequest requestProperties)` Retrieves data that matches the provided criteria and displays the matching data in this component.
`AnimationAcceleration`	`getAnimateFolderEffect()` When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
`Integer`	`getAnimateFolderMaxRows()` If `animateFolders` is true for this treeGrid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.
`Boolean`	`getAnimateFolders()` If true, when folders are opened / closed children will be animated into view.
`int`	`getAnimateFolderSpeed()` When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden) per second.
`int`	`getAnimateFolderTime()` When animating folder opening / closing, if `animateFolderSpeed` is not set, this property designates the duration of the animation in ms.
`TextMatchStyle`	`getAutoFetchTextMatchStyle()` With `loadDataOnDemand`:true, TreeGrids fetch data by selecting the child nodes of each parent, which should be exact match, so we default to `autoFetchTextMatchStyle:"exact"`.
`Boolean`	`getCanAcceptDroppedRecords()` Indicates whether records can be dropped into this listGrid.
`Boolean`	`getCanDragRecordsOut()` Indicates whether records can be dragged from this listGrid and dropped elsewhere.
`Boolean`	`getCanDropOnLeaves()` Whether drops are allowed on leaf nodes.
`Boolean`	`getCanReorderRecords()` Indicates whether records can be reordered by dragging within this listGrid.
`Boolean`	`getCanReparentNodes()` If set this property allows the user to reparent nodes by dragging them from their current folder to a new folder. Backcompat: For backwards compatibility with versions prior to Smart GWT 1.5, if this property is unset, but `this.canAcceptDroppedRecords` is true, we allow nodes to be dragged to different folders.
`String`	`getCantDragIntoChildMessage()` Message displayed when user attempts to drop a node into a child of itself.
`String`	`getCantDragIntoSelfMessage()` Message displayed when user attempts to drop a dragged node onto itself.
`Boolean`	`getCascadeSelection()` Should children be selected when parent is selected? And should parent be selected when any child is selected?
`Alignment`	`getCellAlign(ListGridRecord record, int rowNum, int colNum)` Return the horizontal alignment for cell contents.
`String`	`getClosedIconSuffix()` This suffix will be appended to the `folderIcon` for closed folders.
`String`	`getConnectorImage()` The base filename for connector icons shown when `showConnectors` is true.
`String`	`getCustomIconDropProperty()` This property allows the developer to rename the `default node.showDropIcon` property.
`String`	`getCustomIconOpenProperty()` This property allows the developer to rename the `default node.showOpenIcon` property.
`String`	`getCustomIconProperty()` This property allows the developer to rename the `default node.icon` property.
`Tree`	`getData()` A `Tree` object containing of nested `TreeNode`s to display as rows in this TreeGrid.
`DisplayNodeType`	`getDisplayNodeType()` Specifies the type of nodes displayed in the treeGrid.
`TreeNode`	`getDropFolder()` When the user is dragging a droppable element over this grid, this method returns the folder which would contain the item if dropped.
`String`	`getDropIconSuffix()` If `showDropIcons` is true, this suffix will be appended to the `folderIcon` when the user drop-hovers over some folder.
`int`	`getEventRow()` Returns the row number of the most recent mouse event.
`int`	`getEventRow(int y)` Returns the row number of the most recent mouse event.
`String`	`getExtraIcon(TreeNode node)` Get an additional icon to show between the open icon and folder/node icon for a particular node.
`int`	`getExtraIconGap()` The amount of gap (in pixels) between the extraIcon (see `TreeGrid.getExtraIcon`) or checkbox icon and the `nodeIcon`/ `folderIcon` or node text.
`String`	`getFolderIcon()` The URL of the base icon for all folder nodes in this treeGrid.
`protected String`	`getIcon(Record node, boolean defaultState)` Get the appropriate icon for a node.
`int`	`getIconSize()` The standard size (same height and width, in pixels) of node icons in this treeGrid.
`int`	`getIndentSize()` The amount of indentation (in pixels) to add to a node's icon/title for each level down in this tree's hierarchy.
`Boolean`	`getLoadDataOnDemand()` For databound treeGrid instances, should the entire tree of data be loaded on initial fetch, or should folders load their children as they are opened.
`String`	`getManyItemsImage()` The filename of the icon displayed use as the default drag tracker when for multiple files and/or folders are being dragged.
`String`	`getNodeIcon()` The filename of the default icon for all leaf nodes in this grid.
`protected String`	`getNodeTitle(Record node, int recordNum, ListGridField field)` Returns the title to show for a node in the tree column.
`Integer`	`getOpenerIconSize()` Width and height in pixels of the opener icons, that is, the icons which show the open or closed state of the node, typically a [+] or [-] symbol.
`String`	`getOpenerImage()` The base filename of the opener icon for the folder node when 'showConnectors' is false for this TreeGrid. The opener icon is displayed beside the folder icon in the Tree column for folder nodes.
`String`	`getOpenIcon(TreeNode node)` Get the appropriate open/close opener icon for a node.
`String`	`getOpenIconSuffix()` If `showOpenIcons` is true, this suffix will be appended to the `folderIcon` for open folders in this grid.
`String`	`getOpenState()` Returns a snapshot of the current open state of this grid's data as a `String` object. This object can be passed to `TreeGrid.setOpenState` to open the same set of folders within the treeGrid's data (assuming the nodes are still present in the data).
`static TreeGrid`	`getOrCreateRef(JavaScriptObject jsObj)`
`String`	`getParentAlreadyContainsChildMessage()` Message displayed when user attempts to drag a node into a parent that already contains a child of the same name.
`ListGridRecord`	`getRecord(int recordNum)` Return the pointer to a particular record by record number.
`ListGridRecord[]`	`getRecords()` Return the tree nodes as a flat array of ListGridRecords.
`String`	`getSelectedPaths()` Returns a snapshot of the current selection within this treeGrid as a `String` object. This object can be passed to `TreeGrid.setSelectedPaths` to reset this grid's selection the current state (assuming the same data is present in the grid).
`ListGridRecord`	`getSelectedRecord()` Return the first selected record in this component. This method is appropriate if `selectionType` is `"single"`, or if you only care about the first selected record in a multiple-record selection.
`Boolean`	`getSeparateFolders()` If specified, this attribute will override `separateFolders` on the data for this treeGrid.
`Boolean`	`getShowConnectors()` Should this treeGrid show connector lines illustrating the tree's hierarchy?
`Boolean`	`getShowCustomIconDrop()` Should folder nodes showing custom icons (set via the `customIconProperty`, default `icon`), show drop state images when the user is drop-hovering over the folder.
`Boolean`	`getShowCustomIconOpen()` Should folder nodes showing custom icons (set via the `customIconProperty`), show open state images when the folder is opened.
`Boolean`	`getShowDropIcons()` If true, when the user drags a droppable target over a folder in this TreeGrid, show a different icon folder icon.
`Boolean`	`getShowFullConnectors()` If `showConnectors` is true, this property determines whether we should show showing vertical continuation lines for each level of indenting within the tree.
`Boolean`	`getShowOpenIcons()` If true, show a different icon for `open` folders than closed folders.
`Boolean`	`getShowPartialSelection()` Should partially selected parents be shown with special icon?
`Boolean`	`getShowRoot()` Specifies whether the root node should be displayed in the treeGrid.
`Boolean`	`getSortFoldersBeforeLeaves()` If specified, this attribute will override `sortFoldersBeforeLeaves` on the data for this treeGrid.
`Tree`	`getTree()` Synonmy for {#link #getData)
`String`	`getTreeFieldTitle()` Visible title for the tree column (field).
`String`	`getTreeRootValue()` For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.
`protected void`	`onInit()`
`void`	`recordDoubleClick()` Handle a doubleClick on a tree node - override of ListGrid stringMethod of same name.
`void`	`setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)` When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
`void`	`setAnimateFolderMaxRows(Integer animateFolderMaxRows)` If `animateFolders` is true for this treeGrid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.
`void`	`setAnimateFolders(Boolean animateFolders)` If true, when folders are opened / closed children will be animated into view.
`void`	`setAnimateFolderSpeed(int animateFolderSpeed)` When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden) per second.
`void`	`setAnimateFolderTime(int animateFolderTime)` When animating folder opening / closing, if `animateFolderSpeed` is not set, this property designates the duration of the animation in ms.
`void`	`setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)` With `loadDataOnDemand`:true, TreeGrids fetch data by selecting the child nodes of each parent, which should be exact match, so we default to `autoFetchTextMatchStyle:"exact"`.
`void`	`setCanAcceptDroppedRecords(Boolean canAcceptDroppedRecords)` Indicates whether records can be dropped into this listGrid.
`void`	`setCanDragRecordsOut(Boolean canDragRecordsOut)` Indicates whether records can be dragged from this listGrid and dropped elsewhere.
`void`	`setCanDropOnLeaves(Boolean canDropOnLeaves)` Whether drops are allowed on leaf nodes.
`void`	`setCanReorderRecords(Boolean canReorderRecords)` Indicates whether records can be reordered by dragging within this listGrid.
`void`	`setCanReparentNodes(Boolean canReparentNodes)` If set this property allows the user to reparent nodes by dragging them from their current folder to a new folder. Backcompat: For backwards compatibility with versions prior to Smart GWT 1.5, if this property is unset, but `this.canAcceptDroppedRecords` is true, we allow nodes to be dragged to different folders.
`void`	`setCantDragIntoChildMessage(String cantDragIntoChildMessage)` Message displayed when user attempts to drop a node into a child of itself.
`void`	`setCantDragIntoSelfMessage(String cantDragIntoSelfMessage)` Message displayed when user attempts to drop a dragged node onto itself.
`void`	`setCascadeSelection(Boolean cascadeSelection)` Should children be selected when parent is selected? And should parent be selected when any child is selected?
`void`	`setClosedIconSuffix(String closedIconSuffix)` This suffix will be appended to the `folderIcon` for closed folders.
`void`	`setConnectorImage(String connectorImage)` The base filename for connector icons shown when `showConnectors` is true.
`void`	`setCustomIconDropProperty(String customIconDropProperty)` This property allows the developer to rename the `default node.showDropIcon` property.
`void`	`setCustomIconOpenProperty(String customIconOpenProperty)` This property allows the developer to rename the `default node.showOpenIcon` property.
`void`	`setCustomIconProperty(String customIconProperty)` This property allows the developer to rename the `default node.icon` property.
`void`	`setCustomNodeIcon(Record node, String icon)` Set the icon for a particular treenode to a specified URL
`void`	`setData(Tree data)` A `Tree` object containing of nested `TreeNode`s to display as rows in this TreeGrid.
`void`	`setDataProperties(Tree resultTreeProperties)` For databound TreeGrids, this attribute can be used to customize the ResultTree object created for this treegrid when data is fetched
`static void`	`setDefaultProperties(TreeGrid treeGridProperties)` Class level method to set the default properties of this class.
`void`	`setDisplayNodeType(DisplayNodeType displayNodeType)` Specifies the type of nodes displayed in the treeGrid.
`void`	`setDropIconSuffix(String dropIconSuffix)` If `showDropIcons` is true, this suffix will be appended to the `folderIcon` when the user drop-hovers over some folder.
`void`	`setExtraIconGap(int extraIconGap)` The amount of gap (in pixels) between the extraIcon (see `TreeGrid.getExtraIcon`) or checkbox icon and the `nodeIcon`/ `folderIcon` or node text.
`void`	`setFields(TreeGridField... fields)` An array of field objects, specifying the order, layout, dynamic calculation, and sorting behavior of each field in the treeGrid object.
`void`	`setFolderIcon(String folderIcon)` The URL of the base icon for all folder nodes in this treeGrid.
`void`	`setIconSize(int iconSize)` The standard size (same height and width, in pixels) of node icons in this treeGrid.
`void`	`setIndentSize(int indentSize)` The amount of indentation (in pixels) to add to a node's icon/title for each level down in this tree's hierarchy.
`void`	`setInitialData(TreeNode[] initialData)` You can specify the initial set of data for a databound TreeGrid using this property.
`void`	`setLoadDataOnDemand(Boolean loadDataOnDemand)` For databound treeGrid instances, should the entire tree of data be loaded on initial fetch, or should folders load their children as they are opened.
`void`	`setManyItemsImage(String manyItemsImage)` The filename of the icon displayed use as the default drag tracker when for multiple files and/or folders are being dragged.
`void`	`setNodeIcon(String nodeIcon)` The filename of the default icon for all leaf nodes in this grid.
`void`	`setOpenerIconSize(Integer openerIconSize)` Width and height in pixels of the opener icons, that is, the icons which show the open or closed state of the node, typically a [+] or [-] symbol.
`void`	`setOpenerImage(String openerImage)` The base filename of the opener icon for the folder node when 'showConnectors' is false for this TreeGrid. The opener icon is displayed beside the folder icon in the Tree column for folder nodes.
`void`	`setOpenIconSuffix(String openIconSuffix)` If `showOpenIcons` is true, this suffix will be appended to the `folderIcon` for open folders in this grid.
`void`	`setOpenState(String openState)` Reset this set of open folders within this grid's data to match the `String` object passed in. Used to restore previous state retrieved from the grid by a call to `TreeGrid.getOpenState`.
`void`	`setParentAlreadyContainsChildMessage(String parentAlreadyContainsChildMessage)` Message displayed when user attempts to drag a node into a parent that already contains a child of the same name.
`void`	`setSelectedPaths(String selectedPaths)` Reset this grid's selection to match the `String` object passed in. Used to restore previous state retrieved from the grid by a call to `TreeGrid.getSelectedPaths`.
`void`	`setSeparateFolders(Boolean separateFolders)` If specified, this attribute will override `separateFolders` on the data for this treeGrid.
`void`	`setShowConnectors(Boolean showConnectors)` Should this treeGrid show connector lines illustrating the tree's hierarchy?
`void`	`setShowCustomIconDrop(Boolean showCustomIconDrop)` Should folder nodes showing custom icons (set via the `customIconProperty`, default `icon`), show drop state images when the user is drop-hovering over the folder.
`void`	`setShowCustomIconOpen(Boolean showCustomIconOpen)` Should folder nodes showing custom icons (set via the `customIconProperty`), show open state images when the folder is opened.
`void`	`setShowDropIcons(Boolean showDropIcons)` If true, when the user drags a droppable target over a folder in this TreeGrid, show a different icon folder icon.
`void`	`setShowFullConnectors(Boolean showFullConnectors)` If `showConnectors` is true, this property determines whether we should show showing vertical continuation lines for each level of indenting within the tree.
`void`	`setShowOpenIcons(Boolean showOpenIcons)` If true, show a different icon for `open` folders than closed folders.
`void`	`setShowPartialSelection(Boolean showPartialSelection)` Should partially selected parents be shown with special icon?
`void`	`setShowRoot(Boolean showRoot)` Specifies whether the root node should be displayed in the treeGrid.
`void`	`setSortFoldersBeforeLeaves(Boolean sortFoldersBeforeLeaves)` If specified, this attribute will override `sortFoldersBeforeLeaves` on the data for this treeGrid.
`void`	`setTreeFieldTitle(String treeFieldTitle)` Visible title for the tree column (field).
`void`	`setTreeRootValue(Integer treeRootValue)` For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.
`void`	`setTreeRootValue(String treeRootValue)` For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.
`Boolean`	`willAcceptDrop()` This method overrides `ListGrid.willAcceptDrop()` and works as follows: First, `ListGrid.willAcceptDrop()` (the superclass definition) is consulted.

Methods inherited from class com.smartgwt.client.widgets.grid.ListGrid
addCellClickHandler, addCellContextClickHandler, addCellDoubleClickHandler, addCellHoverHandler, addCellMouseDownHandler, addCellMouseUpHandler, addCellOutHandler, addCellOverHandler, addCellSavedHandler, addData, addData, addData, addDataArrivedHandler, addDrawAreaChangedHandler, addEditCompleteHandler, addEditFailedHandler, addEditorEnterHandler, addEditorExitHandler, addEmbeddedComponent, addEmbeddedComponent, addFieldStateChangedHandler, addFormulaField, addHeaderClickHandler, addRecordClickHandler, addRecordCollapseHandler, addRecordDoubleClickHandler, addRecordExpandHandler, addRowContextClickHandler, addRowEditorEnterHandler, addRowEditorExitHandler, addRowHoverHandler, addRowMouseDownHandler, addRowMouseUpHandler, addRowOutHandler, addRowOverHandler, addSelectionChangedHandler, addSort, addSummaryField, anySelected, cancelEditing, canEditCell, canExpandRecord, cellHasChanges, cellHasErrors, cellHasErrors, clearCriteria, clearCriteria, clearEditValue, clearFieldError, clearFieldError, clearRowErrors, clearSort, closeRecord, collapseRecord, createRecordComponent, deselectAllRecords, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, discardAllEdits, discardAllEdits, discardEdits, discardEdits, enableHilite, enableHilite, enableHiliting, enableHiliting, endEditing, expandRecord, exportData, exportData, fetchRelatedData, fetchRelatedData, fieldIsVisible, filterByEditor, filterData, focusInFilterEditor, focusInFilterEditor, freezeField, freezeField, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAllEditRows, getAllFields, getAlternateBodyStyleName, getAlternateRecordFrequency, getAlternateRecordStyles, getAlwaysShowEditors, getAnimateRemoveRecord, getAnimateRemoveSpeed, getAnimateRemoveTime, getAnimateRollOver, getAnimateRollUnder, getAnimateSelectionUnder, getArrowKeyAction, getAutoFetchAsFilter, getAutoFetchData, getAutoFetchDisplayMap, getAutoFitData, getAutoFitExtraRecords, getAutoFitMaxColumns, getAutoFitMaxHeight, getAutoFitMaxRecords, getAutoFitMaxWidth, getAutoSaveEdits, getBackgroundComponent, getBaseStyle, getBaseStyle, getBodyBackgroundColor, getBodyOverflow, getBodyStyleName, getBooleanFalseImage, getBooleanImageHeight, getBooleanImageWidth, getBooleanPartialImage, getBooleanTrueImage, getCanAddFormulaFields, getCanAddSummaryFields, getCancelEditingConfirmationMessage, getCanDragSelect, getCanDragSelectText, getCanEdit, getCanExpandMultipleRecords, getCanExpandRecordProperty, getCanExpandRecords, getCanFreezeFields, getCanGroupBy, getCanHover, getCanMultiSort, getCanPickFields, getCanRemoveRecords, getCanReorderFields, getCanResizeFields, getCanSelectAll, getCanSort, getCellCSSText, getCellErrors, getCellHeight, getCellPadding, getCheckboxFieldFalseImage, getCheckboxFieldImageHeight, getCheckboxFieldImageWidth, getCheckboxFieldPartialImage, getCheckboxFieldTrueImage, getChildExpansionMode, getClearAllSortingText, getClearFilterText, getClearSortFieldText, getConfigureSortText, getConfirmCancelEditing, getConfirmDiscardEdits, getConfirmDiscardEditsMessage, getCriteria, getDataAsRecordList, getDataFetchMode, getDataPageSize, getDataSource, getDateFormatter, getDatetimeFormatter, getDefaultFields, getDetailField, getDiscardEditsSaveButtonTitle, getDragData, getDragDataAction, getDragTrackerMode, getDragTrackerStyle, getDragTrackerTitle, getDrawAheadRatio, getDrawAllMaxCells, getDrawArea, getDrawnRowHeight, getDrawnRows, getDropValues, getDuplicateDragMessage, getEditByCell, getEditCol, getEditedCell, getEditedCell, getEditedCell, getEditedCell, getEditedRecord, getEditEvent, getEditFailedBaseStyle, getEditFailedCSSText, getEditFormulaFieldText, getEditOnFocus, getEditPendingBaseStyle, getEditPendingCSSText, getEditRow, getEditSummaryFieldText, getEditValue, getEditValue, getEditValues, getEditValues, getEmptyCellValue, getEmptyMessage, getEmptyMessageStyle, getEnforceVClipping, getEnterKeyEditAction, getEnumCriteriaAsInitialValues, getEscapeKeyEditAction, getEventColumn, getEventColumn, getExpansionCanEdit, getExpansionComponent, getExpansionFieldFalseImage, getExpansionFieldImageHeight, getExpansionFieldImageWidth, getExpansionFieldTrueImage, getExpansionMode, getExportAll, getExportFields, getFetchDelay, getFetchOperation, getField, getField, getFieldName, getFieldName, getFieldNum, getFields, getFieldState, getFieldVisibilitySubmenuTitle, getFieldWidth, getFieldWidth, getFilterByCell, getFilterEditorCriteria, getFilterEditorHeight, getFilterOnKeypress, getFixedFieldWidths, getFixedRecordHeights, getFocusRow, getFormulaFieldValue, getFreezeFieldText, getFreezeOnLeftText, getFreezeOnRightText, getFrozenBaseStyle, getFrozenHeaderBaseStyle, getFrozenHeaderTitleStyle, getGenerateClickOnEnter, getGenerateClickOnSpace, getGenerateDoubleClickOnEnter, getGenerateDoubleClickOnSpace, getGridRenderer, getGridSummary, getGridSummaryRecordProperty, getGroupByMaxRecords, getGroupByText, getGroupIcon, getGroupIconSize, getGroupIndentSize, getGroupLeadingIndent, getGroupNodeStyle, getGroupSummaryRecordProperty, getGroupSummaryStyle, getGroupTitleField, getGroupTree, getHeaderBackgroundColor, getHeaderBarStyle, getHeaderBaseStyle, getHeaderContextMenuItems, getHeaderHeight, getHeaderMenuButtonHeight, getHeaderMenuButtonIcon, getHeaderMenuButtonIconHeight, getHeaderMenuButtonIconWidth, getHeaderMenuButtonWidth, getHeaderSpanHeight, getHeaderTitleStyle, getHiliteProperty, getHoverStyle, getImageSize, getIncludeInSummaryProperty, getInitialCriteria, getInitialSort, getInvalidSummaryValue, getIsGrouped, getIsSeparatorProperty, getLeaveScrollbarGap, getLinkTextProperty, getListEndEditAction, getLoadingDataMessage, getLoadingDataMessageStyle, getLoadingMessage, getLocateColumnsBy, getLocateRowsBy, getLongTextEditorThreshold, getLongTextEditorType, getMaxExpandedRecords, getMaxExpandedRecordsPrompt, getMinFieldWidth, getModalEditing, getNeverValidate, getNormalBaseStyle, getNormalCellHeight, getNullGroupTitle, getOriginalRecordList, getOriginalResultSet, getPoolComponentsPerColumn, getPreventDuplicates, getPrintAutoFit, getPrintBaseStyle, getPrintHeaderStyle, getPrintMaxRows, getPrintWrapCells, getQuickDrawAheadRatio, getRecordBaseStyleProperty, getRecordComponentPoolingMode, getRecordComponentPosition, getRecordDetailDSProperty, getRecordEditProperty, getRecordEnabledProperty, getRecordIndex, getRecordIndex, getRecordList, getRecordSummaryBaseStyle, getRelatedDataSource, getRemoveFieldTitle, getRemoveIcon, getRemoveOperation, getResizeFieldsInRealTime, getResultSet, getRollOverCanvas, getRollUnderCanvas, getRowEndEditAction, getRowErrors, getRowNumberStart, getRowNumberStyle, getSaveByCell, getSaveLocally, getScrollRedrawDelay, getSelectedState, getSelection, getSelection, getSelectionAppearance, getSelectionType, getSelectOnEdit, getShowAllColumns, getShowAllRecords, getShowComplexFields, getShowDetailFields, getShowEmptyMessage, getShowFilterEditor, getShowGridSummary, getShowGroupSummary, getShowHeader, getShowHeaderContextMenu, getShowHeaderMenuButton, getShowHiddenFields, getShowHover, getShowRecordComponents, getShowRecordComponentsByCell, getShowRollOver, getShowRollOverCanvas, getShowRowNumbers, getShowSelectedStyle, getShowSelectionCanvas, getShowSortArrow, getShowTreeColumnPicker, getShrinkForFreeze, getSingleCellValueProperty, getSkinImgDir, getSort, getSortAscendingImage, getSortDescendingImage, getSortDirection, getSortField, getSortFieldAscendingText, getSortFieldCount, getSortFieldDescendingText, getSortNumeralHTML, getSortNumeralStyle, getSortSpecifier, getSortState, getStopOnErrors, getStyleName, getSummaryFieldValue, getSummaryRowCriteria, getSummaryRowDataSource, getSummaryRowFetchRequestProperties, getSummaryRowHeight, getSummaryRowStyle, getTallBaseStyle, getTitleField, getTitleFieldValue, getToggleFreezeText, getTotalRows, getTrackerImage, getUnfreezeFieldText, getUngroupText, getUpdateOperation, getUseAllDataSourceFields, getUseCellRollOvers, getUseFlatFields, getValidateByCell, getValidateOnChange, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getViewState, getVirtualScrolling, getVisibleRows, getWaitForSave, getWrapCells, groupBy, hasChanges, hasErrors, hideField, hideField, invalidateCache, isCheckboxField, isExpansionField, isGrouped, isPartiallySelected, isRowNumberField, isSelected, isSortField, markForRedraw, markForRedraw, onInit_ListGrid, openRecordDetailGrid, openRecordEditor, preloadImages, refreshCell, refreshCell, refreshCellStyle, refreshFields, refreshRow, removeData, removeData, removeData, removeEmbeddedComponent, removeEmbeddedComponent, removeEmbeddedComponent, removeSelectedData, removeSelectedData, reorderField, reorderFields, resizeField, rowClick, rowDoubleClick, rowHasChanges, rowHasErrors, saveAllEdits, saveAllEdits, saveAllEdits, scrollBodyTo, scrollToRow, selectAllRecords, selectRecord, selectRecord, selectRecord, selectRecord, selectRecords, selectRecords, selectRecords, selectRecords, selectSingleRecord, selectSingleRecord, setAddDropValues, setAddFormulaFieldText, setAddOperation, setAddSummaryFieldText, setAlternateBodyStyleName, setAlternateRecordFrequency, setAlternateRecordStyles, setAlwaysShowEditors, setAnimateRemoveRecord, setAnimateRemoveSpeed, setAnimateRemoveTime, setAnimateRollOver, setAnimateRollUnder, setAnimateSelectionUnder, setArrowKeyAction, setAutoFetchAsFilter, setAutoFetchData, setAutoFetchDisplayMap, setAutoFitData, setAutoFitExtraRecords, setAutoFitMaxColumns, setAutoFitMaxHeight, setAutoFitMaxRecords, setAutoFitMaxWidth, setAutoSaveEdits, setBackgroundComponent, setBaseStyle, setBodyBackgroundColor, setBodyOverflow, setBodyStyleName, setBooleanFalseImage, setBooleanImageHeight, setBooleanImageWidth, setBooleanPartialImage, setBooleanTrueImage, setCanAddFormulaFields, setCanAddSummaryFields, setCancelEditingConfirmationMessage, setCanDragSelect, setCanDragSelectText, setCanEdit, setCanExpandMultipleRecords, setCanExpandRecordProperty, setCanExpandRecords, setCanFreezeFields, setCanGroupBy, setCanHover, setCanMultiSort, setCanPickFields, setCanRemoveRecords, setCanReorderFields, setCanResizeFields, setCanSelectAll, setCanSort, setCellFormatter, setCellHeight, setCellPadding, setCheckboxFieldFalseImage, setCheckboxFieldImageHeight, setCheckboxFieldImageWidth, setCheckboxFieldPartialImage, setCheckboxFieldTrueImage, setChildExpansionMode, setClearAllSortingText, setClearFilterText, setClearSortFieldText, setConfigureSortText, setConfirmCancelEditing, setConfirmDiscardEdits, setConfirmDiscardEditsMessage, setCriteria, setData, setData, setData, setDataFetchMode, setDataPageSize, setDataProperties, setDataSource, setDateFormatter, setDateInputFormat, setDatetimeFormatter, setDefaultFields, setDefaultProperties, setDetailField, setDiscardEditsSaveButtonTitle, setDragDataAction, setDragTrackerMode, setDragTrackerStyle, setDrawAheadRatio, setDrawAllMaxCells, setDropValues, setDuplicateDragMessage, setEditByCell, setEditEvent, setEditFailedBaseStyle, setEditFailedCSSText, setEditFormulaFieldText, setEditOnFocus, setEditPendingCSSText, setEditSummaryFieldText, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValues, setEmptyCellValue, setEmptyMessage, setEmptyMessageStyle, setEnforceVClipping, setEnterKeyEditAction, setEnumCriteriaAsInitialValues, setEscapeKeyEditAction, setExpansionCanEdit, setExpansionFieldFalseImage, setExpansionFieldImageHeight, setExpansionFieldImageWidth, setExpansionFieldTrueImage, setExpansionMode, setExportAll, setExportFields, setFastCellUpdates, setFetchDelay, setFetchOperation, setFieldError, setFieldError, setFields, setFieldState, setFieldTitle, setFieldTitle, setFieldVisibilitySubmenuTitle, setFilterByCell, setFilterEditorCriteria, setFilterEditorHeight, setFilterOnKeypress, setFixedFieldWidths, setFixedRecordHeights, setFreezeFieldText, setFreezeOnLeftText, setFreezeOnRightText, setFrozenBaseStyle, setFrozenHeaderBaseStyle, setFrozenHeaderTitleStyle, setGenerateClickOnEnter, setGenerateClickOnSpace, setGenerateDoubleClickOnEnter, setGenerateDoubleClickOnSpace, setGridSummaryRecordProperty, setGroupByField, setGroupByMaxRecords, setGroupByText, setGroupIcon, setGroupIconSize, setGroupIndentSize, setGroupLeadingIndent, setGroupNodeStyle, setGroupStartOpen, setGroupStartOpen, setGroupSummaryRecordProperty, setGroupSummaryStyle, setGroupTitleField, setHeaderBackgroundColor, setHeaderBarStyle, setHeaderBaseStyle, setHeaderHeight, setHeaderMenuButtonHeight, setHeaderMenuButtonIcon, setHeaderMenuButtonIconHeight, setHeaderMenuButtonIconWidth, setHeaderMenuButtonWidth, setHeaderSpanHeight, setHeaderSpans, setHeaderSpanTitle, setHeaderTitleStyle, setHiliteProperty, setHoverCustomizer, setHoverStyle, setImageSize, setIncludeInSummaryProperty, setInitialCriteria, setInitialSort, setInvalidSummaryValue, setIsSeparatorProperty, setLeaveScrollbarGap, setLinkTextProperty, setListEndEditAction, setLoadingDataMessage, setLoadingDataMessageStyle, setLoadingMessage, setLocateColumnsBy, setLocateRowsBy, setLongTextEditorThreshold, setLongTextEditorType, setMaxExpandedRecords, setMaxExpandedRecordsPrompt, setMinFieldWidth, setModalEditing, setNeverValidate, setNormalBaseStyle, setNormalCellHeight, setNullGroupTitle, setPoolComponentsPerColumn, setPreventDuplicates, setPrintAutoFit, setPrintBaseStyle, setPrintHeaderStyle, setPrintMaxRows, setPrintWrapCells, setQuickDrawAheadRatio, setRecordBaseStyleProperty, setRecordComponentPoolingMode, setRecordComponentPosition, setRecordDetailDSProperty, setRecordEditProperty, setRecordEnabledProperty, setRecords, setRecordSummaryBaseStyle, setRemoveFieldTitle, setRemoveIcon, setRemoveOperation, setResizeFieldsInRealTime, setRollUnderCanvasProperties, setRowEndEditAction, setRowErrors, setRowNumberFieldProperties, setRowNumberStart, setRowNumberStyle, setSaveByCell, setSaveLocally, setScrollRedrawDelay, setSelectedState, setSelectionAppearance, setSelectionType, setSelectionUnderCanvasProperties, setSelectOnEdit, setShowAllColumns, setShowAllRecords, setShowComplexFields, setShowDetailFields, setShowEmptyMessage, setShowFilterEditor, setShowGridSummary, setShowGroupSummary, setShowHeader, setShowHeaderContextMenu, setShowHeaderMenuButton, setShowHiddenFields, setShowHover, setShowRecordComponents, setShowRecordComponentsByCell, setShowRollOver, setShowRollOverCanvas, setShowRowNumbers, setShowSelectedStyle, setShowSelectionCanvas, setShowSelectionCanvas, setShowSortArrow, setShowTreeColumnPicker, setShrinkForFreeze, setSingleCellValueProperty, setSkinImgDir, setSort, setSortAscendingImage, setSortDescendingImage, setSortDirection, setSortField, setSortField, setSortFieldAscendingText, setSortFieldDescendingText, setSortNumeralStyle, setSortState, setStopOnErrors, setStyleName, setSummaryRowCriteria, setSummaryRowDataSource, setSummaryRowFetchRequestProperties, setSummaryRowHeight, setSummaryRowStyle, setTallBaseStyle, setTitleField, setTrackerImage, setUnfreezeFieldText, setUngroupText, setUpdateOperation, setUseAllDataSourceFields, setUseCellRollOvers, setUseFlatFields, setValidateByCell, setValidateOnChange, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setViewState, setVirtualScrolling, setWaitForSave, setWrapCells, showField, showField, showRecordComponent, sort, sort, sort, startEditing, startEditing, startEditingNew, startEditingNew, stopHover, toggleSort, transferSelectedData, transferSelectedData, unfreezeField, unfreezeField, ungroup, unsort, updateData, updateData, updateData, updateRecordComponent, validateCell, validateCell, validateRow, willFetchData, willFetchData

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

addCellClickHandler, addCellContextClickHandler, addCellDoubleClickHandler, addCellHoverHandler, addCellMouseDownHandler, addCellMouseUpHandler, addCellOutHandler, addCellOverHandler, addCellSavedHandler, addData, addData, addData, addDataArrivedHandler, addDrawAreaChangedHandler, addEditCompleteHandler, addEditFailedHandler, addEditorEnterHandler, addEditorExitHandler, addEmbeddedComponent, addEmbeddedComponent, addFieldStateChangedHandler, addFormulaField, addHeaderClickHandler, addRecordClickHandler, addRecordCollapseHandler, addRecordDoubleClickHandler, addRecordExpandHandler, addRowContextClickHandler, addRowEditorEnterHandler, addRowEditorExitHandler, addRowHoverHandler, addRowMouseDownHandler, addRowMouseUpHandler, addRowOutHandler, addRowOverHandler, addSelectionChangedHandler, addSort, addSummaryField, anySelected, cancelEditing, canEditCell, canExpandRecord, cellHasChanges, cellHasErrors, cellHasErrors, clearCriteria, clearCriteria, clearEditValue, clearFieldError, clearFieldError, clearRowErrors, clearSort, closeRecord, collapseRecord, createRecordComponent, deselectAllRecords, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, discardAllEdits, discardAllEdits, discardEdits, discardEdits, enableHilite, enableHilite, enableHiliting, enableHiliting, endEditing, expandRecord, exportData, exportData, fetchRelatedData, fetchRelatedData, fieldIsVisible, filterByEditor, filterData, focusInFilterEditor, focusInFilterEditor, freezeField, freezeField, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAllEditRows, getAllFields, getAlternateBodyStyleName, getAlternateRecordFrequency, getAlternateRecordStyles, getAlwaysShowEditors, getAnimateRemoveRecord, getAnimateRemoveSpeed, getAnimateRemoveTime, getAnimateRollOver, getAnimateRollUnder, getAnimateSelectionUnder, getArrowKeyAction, getAutoFetchAsFilter, getAutoFetchData, getAutoFetchDisplayMap, getAutoFitData, getAutoFitExtraRecords, getAutoFitMaxColumns, getAutoFitMaxHeight, getAutoFitMaxRecords, getAutoFitMaxWidth, getAutoSaveEdits, getBackgroundComponent, getBaseStyle, getBaseStyle, getBodyBackgroundColor, getBodyOverflow, getBodyStyleName, getBooleanFalseImage, getBooleanImageHeight, getBooleanImageWidth, getBooleanPartialImage, getBooleanTrueImage, getCanAddFormulaFields, getCanAddSummaryFields, getCancelEditingConfirmationMessage, getCanDragSelect, getCanDragSelectText, getCanEdit, getCanExpandMultipleRecords, getCanExpandRecordProperty, getCanExpandRecords, getCanFreezeFields, getCanGroupBy, getCanHover, getCanMultiSort, getCanPickFields, getCanRemoveRecords, getCanReorderFields, getCanResizeFields, getCanSelectAll, getCanSort, getCellCSSText, getCellErrors, getCellHeight, getCellPadding, getCheckboxFieldFalseImage, getCheckboxFieldImageHeight, getCheckboxFieldImageWidth, getCheckboxFieldPartialImage, getCheckboxFieldTrueImage, getChildExpansionMode, getClearAllSortingText, getClearFilterText, getClearSortFieldText, getConfigureSortText, getConfirmCancelEditing, getConfirmDiscardEdits, getConfirmDiscardEditsMessage, getCriteria, getDataAsRecordList, getDataFetchMode, getDataPageSize, getDataSource, getDateFormatter, getDatetimeFormatter, getDefaultFields, getDetailField, getDiscardEditsSaveButtonTitle, getDragData, getDragDataAction, getDragTrackerMode, getDragTrackerStyle, getDragTrackerTitle, getDrawAheadRatio, getDrawAllMaxCells, getDrawArea, getDrawnRowHeight, getDrawnRows, getDropValues, getDuplicateDragMessage, getEditByCell, getEditCol, getEditedCell, getEditedCell, getEditedCell, getEditedCell, getEditedRecord, getEditEvent, getEditFailedBaseStyle, getEditFailedCSSText, getEditFormulaFieldText, getEditOnFocus, getEditPendingBaseStyle, getEditPendingCSSText, getEditRow, getEditSummaryFieldText, getEditValue, getEditValue, getEditValues, getEditValues, getEmptyCellValue, getEmptyMessage, getEmptyMessageStyle, getEnforceVClipping, getEnterKeyEditAction, getEnumCriteriaAsInitialValues, getEscapeKeyEditAction, getEventColumn, getEventColumn, getExpansionCanEdit, getExpansionComponent, getExpansionFieldFalseImage, getExpansionFieldImageHeight, getExpansionFieldImageWidth, getExpansionFieldTrueImage, getExpansionMode, getExportAll, getExportFields, getFetchDelay, getFetchOperation, getField, getField, getFieldName, getFieldName, getFieldNum, getFields, getFieldState, getFieldVisibilitySubmenuTitle, getFieldWidth, getFieldWidth, getFilterByCell, getFilterEditorCriteria, getFilterEditorHeight, getFilterOnKeypress, getFixedFieldWidths, getFixedRecordHeights, getFocusRow, getFormulaFieldValue, getFreezeFieldText, getFreezeOnLeftText, getFreezeOnRightText, getFrozenBaseStyle, getFrozenHeaderBaseStyle, getFrozenHeaderTitleStyle, getGenerateClickOnEnter, getGenerateClickOnSpace, getGenerateDoubleClickOnEnter, getGenerateDoubleClickOnSpace, getGridRenderer, getGridSummary, getGridSummaryRecordProperty, getGroupByMaxRecords, getGroupByText, getGroupIcon, getGroupIconSize, getGroupIndentSize, getGroupLeadingIndent, getGroupNodeStyle, getGroupSummaryRecordProperty, getGroupSummaryStyle, getGroupTitleField, getGroupTree, getHeaderBackgroundColor, getHeaderBarStyle, getHeaderBaseStyle, getHeaderContextMenuItems, getHeaderHeight, getHeaderMenuButtonHeight, getHeaderMenuButtonIcon, getHeaderMenuButtonIconHeight, getHeaderMenuButtonIconWidth, getHeaderMenuButtonWidth, getHeaderSpanHeight, getHeaderTitleStyle, getHiliteProperty, getHoverStyle, getImageSize, getIncludeInSummaryProperty, getInitialCriteria, getInitialSort, getInvalidSummaryValue, getIsGrouped, getIsSeparatorProperty, getLeaveScrollbarGap, getLinkTextProperty, getListEndEditAction, getLoadingDataMessage, getLoadingDataMessageStyle, getLoadingMessage, getLocateColumnsBy, getLocateRowsBy, getLongTextEditorThreshold, getLongTextEditorType, getMaxExpandedRecords, getMaxExpandedRecordsPrompt, getMinFieldWidth, getModalEditing, getNeverValidate, getNormalBaseStyle, getNormalCellHeight, getNullGroupTitle, getOriginalRecordList, getOriginalResultSet, getPoolComponentsPerColumn, getPreventDuplicates, getPrintAutoFit, getPrintBaseStyle, getPrintHeaderStyle, getPrintMaxRows, getPrintWrapCells, getQuickDrawAheadRatio, getRecordBaseStyleProperty, getRecordComponentPoolingMode, getRecordComponentPosition, getRecordDetailDSProperty, getRecordEditProperty, getRecordEnabledProperty, getRecordIndex, getRecordIndex, getRecordList, getRecordSummaryBaseStyle, getRelatedDataSource, getRemoveFieldTitle, getRemoveIcon, getRemoveOperation, getResizeFieldsInRealTime, getResultSet, getRollOverCanvas, getRollUnderCanvas, getRowEndEditAction, getRowErrors, getRowNumberStart, getRowNumberStyle, getSaveByCell, getSaveLocally, getScrollRedrawDelay, getSelectedState, getSelection, getSelection, getSelectionAppearance, getSelectionType, getSelectOnEdit, getShowAllColumns, getShowAllRecords, getShowComplexFields, getShowDetailFields, getShowEmptyMessage, getShowFilterEditor, getShowGridSummary, getShowGroupSummary, getShowHeader, getShowHeaderContextMenu, getShowHeaderMenuButton, getShowHiddenFields, getShowHover, getShowRecordComponents, getShowRecordComponentsByCell, getShowRollOver, getShowRollOverCanvas, getShowRowNumbers, getShowSelectedStyle, getShowSelectionCanvas, getShowSortArrow, getShowTreeColumnPicker, getShrinkForFreeze, getSingleCellValueProperty, getSkinImgDir, getSort, getSortAscendingImage, getSortDescendingImage, getSortDirection, getSortField, getSortFieldAscendingText, getSortFieldCount, getSortFieldDescendingText, getSortNumeralHTML, getSortNumeralStyle, getSortSpecifier, getSortState, getStopOnErrors, getStyleName, getSummaryFieldValue, getSummaryRowCriteria, getSummaryRowDataSource, getSummaryRowFetchRequestProperties, getSummaryRowHeight, getSummaryRowStyle, getTallBaseStyle, getTitleField, getTitleFieldValue, getToggleFreezeText, getTotalRows, getTrackerImage, getUnfreezeFieldText, getUngroupText, getUpdateOperation, getUseAllDataSourceFields, getUseCellRollOvers, getUseFlatFields, getValidateByCell, getValidateOnChange, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getViewState, getVirtualScrolling, getVisibleRows, getWaitForSave, getWrapCells, groupBy, hasChanges, hasErrors, hideField, hideField, invalidateCache, isCheckboxField, isExpansionField, isGrouped, isPartiallySelected, isRowNumberField, isSelected, isSortField, markForRedraw, markForRedraw, onInit_ListGrid, openRecordDetailGrid, openRecordEditor, preloadImages, refreshCell, refreshCell, refreshCellStyle, refreshFields, refreshRow, removeData, removeData, removeData, removeEmbeddedComponent, removeEmbeddedComponent, removeEmbeddedComponent, removeSelectedData, removeSelectedData, reorderField, reorderFields, resizeField, rowClick, rowDoubleClick, rowHasChanges, rowHasErrors, saveAllEdits, saveAllEdits, saveAllEdits, scrollBodyTo, scrollToRow, selectAllRecords, selectRecord, selectRecord, selectRecord, selectRecord, selectRecords, selectRecords, selectRecords, selectRecords, selectSingleRecord, selectSingleRecord, setAddDropValues, setAddFormulaFieldText, setAddOperation, setAddSummaryFieldText, setAlternateBodyStyleName, setAlternateRecordFrequency, setAlternateRecordStyles, setAlwaysShowEditors, setAnimateRemoveRecord, setAnimateRemoveSpeed, setAnimateRemoveTime, setAnimateRollOver, setAnimateRollUnder, setAnimateSelectionUnder, setArrowKeyAction, setAutoFetchAsFilter, setAutoFetchData, setAutoFetchDisplayMap, setAutoFitData, setAutoFitExtraRecords, setAutoFitMaxColumns, setAutoFitMaxHeight, setAutoFitMaxRecords, setAutoFitMaxWidth, setAutoSaveEdits, setBackgroundComponent, setBaseStyle, setBodyBackgroundColor, setBodyOverflow, setBodyStyleName, setBooleanFalseImage, setBooleanImageHeight, setBooleanImageWidth, setBooleanPartialImage, setBooleanTrueImage, setCanAddFormulaFields, setCanAddSummaryFields, setCancelEditingConfirmationMessage, setCanDragSelect, setCanDragSelectText, setCanEdit, setCanExpandMultipleRecords, setCanExpandRecordProperty, setCanExpandRecords, setCanFreezeFields, setCanGroupBy, setCanHover, setCanMultiSort, setCanPickFields, setCanRemoveRecords, setCanReorderFields, setCanResizeFields, setCanSelectAll, setCanSort, setCellFormatter, setCellHeight, setCellPadding, setCheckboxFieldFalseImage, setCheckboxFieldImageHeight, setCheckboxFieldImageWidth, setCheckboxFieldPartialImage, setCheckboxFieldTrueImage, setChildExpansionMode, setClearAllSortingText, setClearFilterText, setClearSortFieldText, setConfigureSortText, setConfirmCancelEditing, setConfirmDiscardEdits, setConfirmDiscardEditsMessage, setCriteria, setData, setData, setData, setDataFetchMode, setDataPageSize, setDataProperties, setDataSource, setDateFormatter, setDateInputFormat, setDatetimeFormatter, setDefaultFields, setDefaultProperties, setDetailField, setDiscardEditsSaveButtonTitle, setDragDataAction, setDragTrackerMode, setDragTrackerStyle, setDrawAheadRatio, setDrawAllMaxCells, setDropValues, setDuplicateDragMessage, setEditByCell, setEditEvent, setEditFailedBaseStyle, setEditFailedCSSText, setEditFormulaFieldText, setEditOnFocus, setEditPendingCSSText, setEditSummaryFieldText, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValues, setEmptyCellValue, setEmptyMessage, setEmptyMessageStyle, setEnforceVClipping, setEnterKeyEditAction, setEnumCriteriaAsInitialValues, setEscapeKeyEditAction, setExpansionCanEdit, setExpansionFieldFalseImage, setExpansionFieldImageHeight, setExpansionFieldImageWidth, setExpansionFieldTrueImage, setExpansionMode, setExportAll, setExportFields, setFastCellUpdates, setFetchDelay, setFetchOperation, setFieldError, setFieldError, setFields, setFieldState, setFieldTitle, setFieldTitle, setFieldVisibilitySubmenuTitle, setFilterByCell, setFilterEditorCriteria, setFilterEditorHeight, setFilterOnKeypress, setFixedFieldWidths, setFixedRecordHeights, setFreezeFieldText, setFreezeOnLeftText, setFreezeOnRightText, setFrozenBaseStyle, setFrozenHeaderBaseStyle, setFrozenHeaderTitleStyle, setGenerateClickOnEnter, setGenerateClickOnSpace, setGenerateDoubleClickOnEnter, setGenerateDoubleClickOnSpace, setGridSummaryRecordProperty, setGroupByField, setGroupByMaxRecords, setGroupByText, setGroupIcon, setGroupIconSize, setGroupIndentSize, setGroupLeadingIndent, setGroupNodeStyle, setGroupStartOpen, setGroupStartOpen, setGroupSummaryRecordProperty, setGroupSummaryStyle, setGroupTitleField, setHeaderBackgroundColor, setHeaderBarStyle, setHeaderBaseStyle, setHeaderHeight, setHeaderMenuButtonHeight, setHeaderMenuButtonIcon, setHeaderMenuButtonIconHeight, setHeaderMenuButtonIconWidth, setHeaderMenuButtonWidth, setHeaderSpanHeight, setHeaderSpans, setHeaderSpanTitle, setHeaderTitleStyle, setHiliteProperty, setHoverCustomizer, setHoverStyle, setImageSize, setIncludeInSummaryProperty, setInitialCriteria, setInitialSort, setInvalidSummaryValue, setIsSeparatorProperty, setLeaveScrollbarGap, setLinkTextProperty, setListEndEditAction, setLoadingDataMessage, setLoadingDataMessageStyle, setLoadingMessage, setLocateColumnsBy, setLocateRowsBy, setLongTextEditorThreshold, setLongTextEditorType, setMaxExpandedRecords, setMaxExpandedRecordsPrompt, setMinFieldWidth, setModalEditing, setNeverValidate, setNormalBaseStyle, setNormalCellHeight, setNullGroupTitle, setPoolComponentsPerColumn, setPreventDuplicates, setPrintAutoFit, setPrintBaseStyle, setPrintHeaderStyle, setPrintMaxRows, setPrintWrapCells, setQuickDrawAheadRatio, setRecordBaseStyleProperty, setRecordComponentPoolingMode, setRecordComponentPosition, setRecordDetailDSProperty, setRecordEditProperty, setRecordEnabledProperty, setRecords, setRecordSummaryBaseStyle, setRemoveFieldTitle, setRemoveIcon, setRemoveOperation, setResizeFieldsInRealTime, setRollUnderCanvasProperties, setRowEndEditAction, setRowErrors, setRowNumberFieldProperties, setRowNumberStart, setRowNumberStyle, setSaveByCell, setSaveLocally, setScrollRedrawDelay, setSelectedState, setSelectionAppearance, setSelectionType, setSelectionUnderCanvasProperties, setSelectOnEdit, setShowAllColumns, setShowAllRecords, setShowComplexFields, setShowDetailFields, setShowEmptyMessage, setShowFilterEditor, setShowGridSummary, setShowGroupSummary, setShowHeader, setShowHeaderContextMenu, setShowHeaderMenuButton, setShowHiddenFields, setShowHover, setShowRecordComponents, setShowRecordComponentsByCell, setShowRollOver, setShowRollOverCanvas, setShowRowNumbers, setShowSelectedStyle, setShowSelectionCanvas, setShowSelectionCanvas, setShowSortArrow, setShowTreeColumnPicker, setShrinkForFreeze, setSingleCellValueProperty, setSkinImgDir, setSort, setSortAscendingImage, setSortDescendingImage, setSortDirection, setSortField, setSortField, setSortFieldAscendingText, setSortFieldDescendingText, setSortNumeralStyle, setSortState, setStopOnErrors, setStyleName, setSummaryRowCriteria, setSummaryRowDataSource, setSummaryRowFetchRequestProperties, setSummaryRowHeight, setSummaryRowStyle, setTallBaseStyle, setTitleField, setTrackerImage, setUnfreezeFieldText, setUngroupText, setUpdateOperation, setUseAllDataSourceFields, setUseCellRollOvers, setUseFlatFields, setValidateByCell, setValidateOnChange, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setViewState, setVirtualScrolling, setWaitForSave, setWrapCells, showField, showField, showRecordComponent, sort, sort, sort, startEditing, startEditing, startEditingNew, startEditingNew, stopHover, toggleSort, transferSelectedData, transferSelectedData, unfreezeField, unfreezeField, ungroup, unsort, updateData, updateData, updateData, updateRecordComponent, validateCell, validateCell, validateRow, willFetchData, willFetchData

Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowResizeBar, getShowShadow, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, moveAbove, moveBelow, moveBy, moveTo, parentResized, printComponents, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowResizeBar, setShowShadow, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint

Methods inherited from class com.smartgwt.client.widgets.Canvas

addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowResizeBar, getShowShadow, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, moveAbove, moveBelow, moveBy, moveTo, parentResized, printComponents, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowResizeBar, setShowShadow, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint

Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget
`addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents`

Methods inherited from class com.google.gwt.user.client.ui.UIObject
`addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, unsinkEvents`

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

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

Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
`getOrCreateJsObj`

Constructor Detail

TreeGrid

public TreeGrid()

TreeGrid

public TreeGrid(JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static TreeGrid getOrCreateRef(JavaScriptObject jsObj)

create

protected JavaScriptObject create()

Overrides:: create in class ListGrid

setAnimateFolderEffect

public void setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)

When animating folder opening / closing, this property can be set to apply an animated acceleration effect. This allows the animation speed to be "weighted", for example expanding or collapsing at a faster rate toward the beginning of the animation than at the end.

Parameters:: animateFolderEffect - animateFolderEffect Default value is null

getAnimateFolderEffect

public AnimationAcceleration getAnimateFolderEffect()

Returns:: AnimationAcceleration

setAnimateFolderMaxRows

public void setAnimateFolderMaxRows(Integer animateFolderMaxRows)

If animateFolders is true for this treeGrid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.

Parameters:: animateFolderMaxRows - animateFolderMaxRows Default value is null

getAnimateFolderMaxRows

public Integer getAnimateFolderMaxRows()

If animateFolders is true for this treeGrid, this number can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.

Returns:: If animateFolders is true for this treeGrid, this method returns the the maximum number of rows to animate at a time when opening / closing a folder. This method will return animateFolderMaxRows if set. Otherwise the value will be calculated as 3x the number of rows required to fill a viewport, capped at a maximum value of 75.

setAnimateFolders

public void setAnimateFolders(Boolean animateFolders)

If true, when folders are opened / closed children will be animated into view.

Parameters:: animateFolders - animateFolders Default value is true
See Also:: Tree Folders Example

getAnimateFolders

public Boolean getAnimateFolders()

If true, when folders are opened / closed children will be animated into view.

Returns:: Boolean
See Also:: Tree Folders Example

setAnimateFolderSpeed

public void setAnimateFolderSpeed(int animateFolderSpeed)

When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden) per second. Takes precedence over the animateFolderTime property, which allows the developer to specify a duration for the animation rather than a speed.

Parameters:: animateFolderSpeed - animateFolderSpeed Default value is 1000
See Also:: Tree Folders Example

getAnimateFolderSpeed

public int getAnimateFolderSpeed()

Returns:: int
See Also:: Tree Folders Example

setAnimateFolderTime

public void setAnimateFolderTime(int animateFolderTime)

When animating folder opening / closing, if animateFolderSpeed is not set, this property designates the duration of the animation in ms.

Parameters:: animateFolderTime - animateFolderTime Default value is 100

getAnimateFolderTime

public int getAnimateFolderTime()

When animating folder opening / closing, if animateFolderSpeed is not set, this property designates the duration of the animation in ms.

Returns:: int

setAutoFetchTextMatchStyle

public void setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
                                throws IllegalStateException

With loadDataOnDemand:true, TreeGrids fetch data by selecting the child nodes of each parent, which should be exact match, so we default to autoFetchTextMatchStyle:"exact". See autoFetchTextMatchStyle for details.

Overrides:: setAutoFetchTextMatchStyle in class ListGrid

Parameters:: autoFetchTextMatchStyle - autoFetchTextMatchStyle Default value is "exact"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getAutoFetchTextMatchStyle

public TextMatchStyle getAutoFetchTextMatchStyle()

Overrides:: getAutoFetchTextMatchStyle in class ListGrid

Returns:: TextMatchStyle

setCanAcceptDroppedRecords

public void setCanAcceptDroppedRecords(Boolean canAcceptDroppedRecords)

Indicates whether records can be dropped into this listGrid.

Overrides:: setCanAcceptDroppedRecords in class ListGrid

Parameters:: canAcceptDroppedRecords - canAcceptDroppedRecords Default value is false
See Also:: Dragdrop overview and related methods, Tree Reparent Example

getCanAcceptDroppedRecords

public Boolean getCanAcceptDroppedRecords()

Indicates whether records can be dropped into this listGrid.

Overrides:: getCanAcceptDroppedRecords in class ListGrid

Returns:: Boolean
See Also:: Dragdrop overview and related methods, Tree Reparent Example

setCanDragRecordsOut

public void setCanDragRecordsOut(Boolean canDragRecordsOut)

Indicates whether records can be dragged from this listGrid and dropped elsewhere.

Overrides:: setCanDragRecordsOut in class ListGrid

Parameters:: canDragRecordsOut - canDragRecordsOut Default value is false
See Also:: Dragdrop overview and related methods, Drop Events Example

getCanDragRecordsOut

public Boolean getCanDragRecordsOut()

Indicates whether records can be dragged from this listGrid and dropped elsewhere.

Overrides:: getCanDragRecordsOut in class ListGrid

Returns:: Boolean
See Also:: Dragdrop overview and related methods, Drop Events Example

setCanDropOnLeaves

public void setCanDropOnLeaves(Boolean canDropOnLeaves)

Whether drops are allowed on leaf nodes.

Dropping is ordinarily not allowed on leaf nodes unless canReorderRecords is set.

The default action for a drop on a leaf node is to place the node in that leaf's parent folder. This can be customized by overriding TreeGrid.folderDrop.

Note that enabling canDropOnLeaves is usually only appropriate where you intend to add a custom TreeGrid.folderDrop implementation that does not add a child node under the leaf. If you want to add a child nodes to a leaf, instead of enabling canDropOnLeaves, use empty folders instead - see Tree.isFolder for how to control whether a node is considered a folder.

Note : This is an advanced setting

Parameters:: canDropOnLeaves - canDropOnLeaves Default value is false

getCanDropOnLeaves

public Boolean getCanDropOnLeaves()

Whether drops are allowed on leaf nodes.

Dropping is ordinarily not allowed on leaf nodes unless canReorderRecords is set.

The default action for a drop on a leaf node is to place the node in that leaf's parent folder. This can be customized by overriding TreeGrid.folderDrop.

Returns:: Boolean

setCanReorderRecords

public void setCanReorderRecords(Boolean canReorderRecords)

Indicates whether records can be reordered by dragging within this listGrid.

Note : This is an advanced setting

Overrides:: setCanReorderRecords in class ListGrid

Parameters:: canReorderRecords - canReorderRecords Default value is false
See Also:: Dragdrop overview and related methods, Tree Reparent Example

getCanReorderRecords

public Boolean getCanReorderRecords()

Indicates whether records can be reordered by dragging within this listGrid.

Overrides:: getCanReorderRecords in class ListGrid

Returns:: Boolean
See Also:: Dragdrop overview and related methods, Tree Reparent Example

setCanReparentNodes

public void setCanReparentNodes(Boolean canReparentNodes)

If set this property allows the user to reparent nodes by dragging them from their current folder to a new folder.
Backcompat: For backwards compatibility with versions prior to Smart GWT 1.5, if this property is unset, but this.canAcceptDroppedRecords is true, we allow nodes to be dragged to different folders.

Parameters:: canReparentNodes - canReparentNodes Default value is null
See Also:: Dragdrop overview and related methods

getCanReparentNodes

public Boolean getCanReparentNodes()

Returns:: Boolean
See Also:: Dragdrop overview and related methods

setCantDragIntoChildMessage

public void setCantDragIntoChildMessage(String cantDragIntoChildMessage)
                                 throws IllegalStateException

Message displayed when user attempts to drop a node into a child of itself.

Parameters:: cantDragIntoChildMessage - cantDragIntoChildMessage Default value is "You can't drag an item into one of it's children."
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getCantDragIntoChildMessage

public String getCantDragIntoChildMessage()

Message displayed when user attempts to drop a node into a child of itself.

Returns:: String

setCantDragIntoSelfMessage

public void setCantDragIntoSelfMessage(String cantDragIntoSelfMessage)
                                throws IllegalStateException

Message displayed when user attempts to drop a dragged node onto itself.

Parameters:: cantDragIntoSelfMessage - cantDragIntoSelfMessage Default value is "You can't drag an item into itself."
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getCantDragIntoSelfMessage

public String getCantDragIntoSelfMessage()

Message displayed when user attempts to drop a dragged node onto itself.

Returns:: String

setCascadeSelection

public void setCascadeSelection(Boolean cascadeSelection)
                         throws IllegalStateException

Should children be selected when parent is selected? And should parent be selected when any child is selected?

Parameters:: cascadeSelection - cascadeSelection Default value is false
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getCascadeSelection

public Boolean getCascadeSelection()

Should children be selected when parent is selected? And should parent be selected when any child is selected?

Returns:: Boolean

setClosedIconSuffix

public void setClosedIconSuffix(String closedIconSuffix)

This suffix will be appended to the folderIcon for closed folders. If showOpenIcons is set to false this suffix will also be appended to open folders' icons.

Parameters:: closedIconSuffix - closedIconSuffix Default value is "closed"

getClosedIconSuffix

public String getClosedIconSuffix()

This suffix will be appended to the folderIcon for closed folders. If showOpenIcons is set to false this suffix will also be appended to open folders' icons.

Returns:: String

setConnectorImage

public void setConnectorImage(String connectorImage)
                       throws IllegalStateException

The base filename for connector icons shown when showConnectors is true. Connector icons are rendered into the title field of each row and show the dotted hierarchy lines between siblings of the same parent node. For each node, a connector icon may be shown:

As an opener icon for folder nodes, next to the folder icon
In place of an opener icon for leaf nodes, next to the leaf icon
As a standalone vertical continuation line in the indent to the left of the node, to show a connection between some ancestor node's siblings (only relevant if showFullConnectors is true).

Note that showFullConnectors governs whether connector lines will be displayed for all indent levels, or just for the innermost level of the tree.

The filenames for these icons are assembled from this base filename and the state of the node. Assuming the connectorImage is set to {baseName}.{extension}, the full set of images to be displayed will be:

{baseName}_ancestor[_rtl].{extension} if showFullConnectors is true, this is the URL for the vertical continuation image to be displayed at the appropriate indent levels for ancestor nodes with subsequent children.

For nodes with no children:

{baseName}_single[_rtl].{extension}: Shown when there is no connector line attached to the parent or previous sibling, and no connector line to the next sibling. For showFullConnectors:true trees, there will always be a connector leading to the parent or previous sibling if its present in the tree so this icon can only be displayed for the first row.
{baseName}_start[_rtl].{extension}: Shown when the there is no connector line attached to the parent or previous sibling, but there is a connector to the next sibling. As with _single this will only ever be used for the first row if showFullConnectors is true
{baseName}_end[_rtl].{extension}: Shown if we are not showing a connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or parent).
{baseName}_middle[_rtl].{extension}: Shown where the we have a connector line leading to both the previous sibling (or parent) and the next sibling.

For folders with children. Note that if showFullConnectors is false, open folders will never show a connector to subsequent siblings:

{baseName}_opened_single[_rtl].{extension} opened folder node with children when no connector line is shown attaching to either the folder's previous sibling or parent, or to any subsequent siblings.
{baseName}_opened_start[_rtl].{extension}: opened folder with children when the there is no connector line attached to the parent or previous sibling, but there is a connector to the next sibling.
{baseName}_opened_end[_rtl].{extension}: opened folder with children if we are not showing a connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or parent).
{baseName}_opened_middle[_rtl].{extension}: opened folder with children where the we have a connector line leading to both the previous sibling (or parent) and the next sibling.

{baseName}_closed_single[_rtl].{extension} closed folder node with children when no connector line is shown attaching to either the folder's previous sibling or parent, or to any subsequent siblings.
{baseName}_closed_start[_rtl].{extension}: closed folder with children when the there is no connector line attached to the parent or previous sibling, but there is a connector to the next sibling.
{baseName}_closed_end[_rtl].{extension}: closed folder with children if we are not showing a connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or parent).
{baseName}_closed_middle[_rtl].{extension}: closed folder with children where the we have a connector line leading to both the previous sibling (or parent) and the next sibling.

(Note '[_rtl]' means that "_rtl" will be attached if isRTL() is true for this widget).

Parameters:: connectorImage - connectorImage Default value is "[SKIN]connector.gif"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getConnectorImage

public String getConnectorImage()

As an opener icon for folder nodes, next to the folder icon
In place of an opener icon for leaf nodes, next to the leaf icon
As a standalone vertical continuation line in the indent to the left of the node, to show a connection between some ancestor node's siblings (only relevant if showFullConnectors is true).

Note that showFullConnectors governs whether connector lines will be displayed for all indent levels, or just for the innermost level of the tree.

For nodes with no children:

{baseName}_single[_rtl].{extension}: Shown when there is no connector line attached to the parent or previous sibling, and no connector line to the next sibling. For showFullConnectors:true trees, there will always be a connector leading to the parent or previous sibling if its present in the tree so this icon can only be displayed for the first row.
{baseName}_start[_rtl].{extension}: Shown when the there is no connector line attached to the parent or previous sibling, but there is a connector to the next sibling. As with _single this will only ever be used for the first row if showFullConnectors is true
{baseName}_end[_rtl].{extension}: Shown if we are not showing a connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or parent).
{baseName}_middle[_rtl].{extension}: Shown where the we have a connector line leading to both the previous sibling (or parent) and the next sibling.

For folders with children. Note that if showFullConnectors is false, open folders will never show a connector to subsequent siblings:

{baseName}_opened_single[_rtl].{extension} opened folder node with children when no connector line is shown attaching to either the folder's previous sibling or parent, or to any subsequent siblings.
{baseName}_opened_start[_rtl].{extension}: opened folder with children when the there is no connector line attached to the parent or previous sibling, but there is a connector to the next sibling.
{baseName}_opened_end[_rtl].{extension}: opened folder with children if we are not showing a connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or parent).
{baseName}_opened_middle[_rtl].{extension}: opened folder with children where the we have a connector line leading to both the previous sibling (or parent) and the next sibling.

{baseName}_closed_single[_rtl].{extension} closed folder node with children when no connector line is shown attaching to either the folder's previous sibling or parent, or to any subsequent siblings.
{baseName}_closed_start[_rtl].{extension}: closed folder with children when the there is no connector line attached to the parent or previous sibling, but there is a connector to the next sibling.
{baseName}_closed_end[_rtl].{extension}: closed folder with children if we are not showing a connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or parent).
{baseName}_closed_middle[_rtl].{extension}: closed folder with children where the we have a connector line leading to both the previous sibling (or parent) and the next sibling.

(Note '[_rtl]' means that "_rtl" will be attached if isRTL() is true for this widget).

Returns:: String

setCustomIconDropProperty

public void setCustomIconDropProperty(String customIconDropProperty)

This property allows the developer to rename the default node.showDropIcon property.

Note : This is an advanced setting

Parameters:: customIconDropProperty - customIconDropProperty Default value is "showDropIcon"

getCustomIconDropProperty

public String getCustomIconDropProperty()

This property allows the developer to rename the default node.showDropIcon property.

Returns:: String

setCustomIconOpenProperty

public void setCustomIconOpenProperty(String customIconOpenProperty)

This property allows the developer to rename the default node.showOpenIcon property.

Note : This is an advanced setting

Parameters:: customIconOpenProperty - customIconOpenProperty Default value is "showOpenIcon"

getCustomIconOpenProperty

public String getCustomIconOpenProperty()

This property allows the developer to rename the default node.showOpenIcon property.

Returns:: String

setCustomIconProperty

public void setCustomIconProperty(String customIconProperty)

This property allows the developer to rename the

default
 node.icon

property.

Parameters:: customIconProperty - customIconProperty Default value is "icon"

getCustomIconProperty

public String getCustomIconProperty()

This property allows the developer to rename the

default
 node.icon

property.

Returns:: String

setData

public void setData(Tree data)

A Tree object containing of nested TreeNodes to display as rows in this TreeGrid. The data property will typically not be explicitly specified for databound TreeGrids, where the data is returned from the server via databound component methods such as fetchData() Set the Tree object this TreeGrid will view and manipulate.

Parameters:: data - Tree to show. Default value is null

getData

public Tree getData()

Returns:: Tree

setDisplayNodeType

public void setDisplayNodeType(DisplayNodeType displayNodeType)

Specifies the type of nodes displayed in the treeGrid.

Parameters:: displayNodeType - displayNodeType Default value is Tree.FOLDERS_AND_LEAVES

getDisplayNodeType

public DisplayNodeType getDisplayNodeType()

Specifies the type of nodes displayed in the treeGrid.

Returns:: DisplayNodeType

setDropIconSuffix

public void setDropIconSuffix(String dropIconSuffix)

If showDropIcons is true, this suffix will be appended to the folderIcon when the user drop-hovers over some folder.

Parameters:: dropIconSuffix - dropIconSuffix Default value is "drop"

getDropIconSuffix

public String getDropIconSuffix()

If showDropIcons is true, this suffix will be appended to the folderIcon when the user drop-hovers over some folder.

Returns:: String

setExtraIconGap

public void setExtraIconGap(int extraIconGap)
                     throws IllegalStateException

The amount of gap (in pixels) between the extraIcon (see TreeGrid.getExtraIcon) or checkbox icon and the nodeIcon/ folderIcon or node text.

Parameters:: extraIconGap - extraIconGap Default value is 2
Throws:: IllegalStateException - this property cannot be changed after the component has been created
See Also:: Appearance overview and related methods

getExtraIconGap

public int getExtraIconGap()

The amount of gap (in pixels) between the extraIcon (see TreeGrid.getExtraIcon) or checkbox icon and the nodeIcon/ folderIcon or node text.

Returns:: int
See Also:: Appearance overview and related methods

setFolderIcon

public void setFolderIcon(String folderIcon)

The URL of the base icon for all folder nodes in this treeGrid. Note that this URL will have openIconSuffix, closedIconSuffix or dropIconSuffix appended to indicate state changes if appropriate - see documentation on showOpenIcons and showDropIcons.

Parameters:: folderIcon - folderIcon Default value is "[SKIN]folder.gif"
See Also:: Node Titles Example

getFolderIcon

public String getFolderIcon()

Returns:: String
See Also:: Node Titles Example

setIconSize

public void setIconSize(int iconSize)

The standard size (same height and width, in pixels) of node icons in this treeGrid.

Parameters:: iconSize - iconSize Default value is 16

getIconSize

public int getIconSize()

The standard size (same height and width, in pixels) of node icons in this treeGrid.

Returns:: int

setIndentSize

public void setIndentSize(int indentSize)

The amount of indentation (in pixels) to add to a node's icon/title for each level down in this tree's hierarchy.

Parameters:: indentSize - indentSize Default value is 20
See Also:: Appearance overview and related methods

getIndentSize

public int getIndentSize()

The amount of indentation (in pixels) to add to a node's icon/title for each level down in this tree's hierarchy.

Returns:: int
See Also:: Appearance overview and related methods

setLoadDataOnDemand

public void setLoadDataOnDemand(Boolean loadDataOnDemand)

For databound treeGrid instances, should the entire tree of data be loaded on initial fetch, or should folders load their children as they are opened.

If unset, calling TreeGrid.fetchData will default it to true, otherwise, if a ResultTree is passed to TreeGrid.setData, the loadDataOnDemand setting is respected.

Note that when using loadDataOnDemand, every node returned by the server is assumed be a folder which may load further children. See defaultIsFolder for how to control this behavior.

Parameters:: loadDataOnDemand - loadDataOnDemand Default value is null
See Also:: Databinding overview and related methods, Initial Data & Load on Demand Example

getLoadDataOnDemand

public Boolean getLoadDataOnDemand()

For databound treeGrid instances, should the entire tree of data be loaded on initial fetch, or should folders load their children as they are opened.

If unset, calling TreeGrid.fetchData will default it to true, otherwise, if a ResultTree is passed to TreeGrid.setData, the loadDataOnDemand setting is respected.

Note that when using loadDataOnDemand, every node returned by the server is assumed be a folder which may load further children. See defaultIsFolder for how to control this behavior.

Returns:: Boolean
See Also:: Databinding overview and related methods, Initial Data & Load on Demand Example

setManyItemsImage

public void setManyItemsImage(String manyItemsImage)

The filename of the icon displayed use as the default drag tracker when for multiple files and/or folders are being dragged.

Parameters:: manyItemsImage - manyItemsImage Default value is "[SKIN]folder_file.gif"
See Also:: Dragdrop overview and related methods

getManyItemsImage

public String getManyItemsImage()

The filename of the icon displayed use as the default drag tracker when for multiple files and/or folders are being dragged.

Returns:: String
See Also:: Dragdrop overview and related methods

setNodeIcon

public void setNodeIcon(String nodeIcon)

The filename of the default icon for all leaf nodes in this grid. To specify a custom image for an individual node, set the customIconProperty directly on the node. Set the icon for a particular treenode to a specified URL

Parameters:: nodeIcon - tree node. Default value is "[SKIN]file.gif"
See Also:: Node Titles Example

getNodeIcon

public String getNodeIcon()

The filename of the default icon for all leaf nodes in this grid. To specify a custom image for an individual node, set the customIconProperty directly on the node.

Returns:: String
See Also:: Node Titles Example

setOpenerIconSize

public void setOpenerIconSize(Integer openerIconSize)

Width and height in pixels of the opener icons, that is, the icons which show the open or closed state of the node, typically a [+] or [-] symbol.

If showConnectors is true, the opener icon includes the connector line, and defaults to cellHeight.

Otherwise, openerIconSize defaults to iconSize.

Parameters:: openerIconSize - openerIconSize Default value is null

getOpenerIconSize

public Integer getOpenerIconSize()

Width and height in pixels of the opener icons, that is, the icons which show the open or closed state of the node, typically a [+] or [-] symbol.

If showConnectors is true, the opener icon includes the connector line, and defaults to cellHeight.

Otherwise, openerIconSize defaults to iconSize.

Returns:: Integer

setOpenerImage

public void setOpenerImage(String openerImage)
                    throws IllegalStateException

The base filename of the opener icon for the folder node when 'showConnectors' is false for this TreeGrid.
The opener icon is displayed beside the folder icon in the Tree column for folder nodes. Clicking on this icon will toggle the open state of the folder.
The filenames for these icons are assembled from this base filename and the state of the node, as follows:
If the openerImage is set to {baseName}.{extension}, {baseName}_opened.{extension} will be displayed next to opened folders, and {baseName}_closed.{extension} will be displayed next to closed folders, or if this page is in RTL mode, {baseName}_opened_rtl.{extension} and {baseName}_closed_rtl.{extension} will be used.

Parameters:: openerImage - openerImage Default value is "[SKIN]opener.gif"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getOpenerImage

public String getOpenerImage()

Returns:: String

setOpenIconSuffix

public void setOpenIconSuffix(String openIconSuffix)

If showOpenIcons is true, this suffix will be appended to the folderIcon for open folders in this grid.

Parameters:: openIconSuffix - openIconSuffix Default value is "open"

getOpenIconSuffix

public String getOpenIconSuffix()

If showOpenIcons is true, this suffix will be appended to the folderIcon for open folders in this grid.

Returns:: String

setParentAlreadyContainsChildMessage

public void setParentAlreadyContainsChildMessage(String parentAlreadyContainsChildMessage)
                                          throws IllegalStateException

Message displayed when user attempts to drag a node into a parent that already contains a child of the same name.

Parameters:: parentAlreadyContainsChildMessage - parentAlreadyContainsChildMessage Default value is "This item already contains a child item with that name."
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getParentAlreadyContainsChildMessage

public String getParentAlreadyContainsChildMessage()

Message displayed when user attempts to drag a node into a parent that already contains a child of the same name.

Returns:: String

setSeparateFolders

public void setSeparateFolders(Boolean separateFolders)
                        throws IllegalStateException

If specified, this attribute will override separateFolders on the data for this treeGrid.

Specifies whether folders and leaves should be segregated in the treeGrid display. Use sortFoldersBeforeLeaves to customize whether folders appear before or after their sibling leaves.

If unset, at the treeGrid level, the property can be set directly on the tree data object or for dataBound TreeGrids on the dataProperties configuration object.

Parameters:: separateFolders - separateFolders Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getSeparateFolders

public Boolean getSeparateFolders()

If specified, this attribute will override separateFolders on the data for this treeGrid.

Specifies whether folders and leaves should be segregated in the treeGrid display. Use sortFoldersBeforeLeaves to customize whether folders appear before or after their sibling leaves.

If unset, at the treeGrid level, the property can be set directly on the tree data object or for dataBound TreeGrids on the dataProperties configuration object.

Returns:: Boolean

setShowConnectors

public void setShowConnectors(Boolean showConnectors)

Should this treeGrid show connector lines illustrating the tree's hierarchy?

For the set of images used to show connectors, see connectorImage.

Note: in order for connector images to be perfectly connected, all styles for cells must have no top or bottom border or padding. If you see small gaps in connector lines, check your CSS files. See the example below for an example of correct configuration, including example CSS.

Parameters:: showConnectors - showConnectors Default value is false
See Also:: Connectors Example

getShowConnectors

public Boolean getShowConnectors()

Should this treeGrid show connector lines illustrating the tree's hierarchy?

For the set of images used to show connectors, see connectorImage.

Returns:: Boolean
See Also:: Connectors Example

setShowCustomIconDrop

public void setShowCustomIconDrop(Boolean showCustomIconDrop)

Should folder nodes showing custom icons (set via the customIconProperty, default icon), show drop state images when the user is drop-hovering over the folder. If true, the dropIconSuffix will be appended to the image URL (so "customFolder.gif" might be replaced with "customFolder_drop.gif").
Can be overridden at the node level via the default property showDropIcon and that property can be renamed via customIconDropProperty.

Note : This is an advanced setting

Parameters:: showCustomIconDrop - showCustomIconDrop Default value is false

getShowCustomIconDrop

public Boolean getShowCustomIconDrop()

Returns:: Boolean

setShowCustomIconOpen

public void setShowCustomIconOpen(Boolean showCustomIconOpen)

Should folder nodes showing custom icons (set via the customIconProperty), show open state images when the folder is opened. If true, the openIconSuffix will be appended to the image URL (so "customFolder.gif" might be replaced with "customFolder_open.gif").
Note that the closedIconSuffix is never appended to custom folder icons.
Can be overridden at the node level via the default property showOpenIcon and that property can be renamed via customIconOpenProperty.

Note : This is an advanced setting

Parameters:: showCustomIconOpen - showCustomIconOpen Default value is false

getShowCustomIconOpen

public Boolean getShowCustomIconOpen()

Returns:: Boolean

setShowDropIcons

public void setShowDropIcons(Boolean showDropIcons)

If true, when the user drags a droppable target over a folder in this TreeGrid, show a different icon folder icon. This is achieved by appending the dropIconSuffix onto the folderIcon URL (for example "[SKIN]/folder.gif" may be replaced by "[SKIN]/folder_drop.gif").

Parameters:: showDropIcons - showDropIcons Default value is true
See Also:: Node Titles Example

getShowDropIcons

public Boolean getShowDropIcons()

Returns:: Boolean
See Also:: Node Titles Example

setShowFullConnectors

public void setShowFullConnectors(Boolean showFullConnectors)

If showConnectors is true, this property determines whether we should show showing vertical continuation lines for each level of indenting within the tree. Setting to false will show only the hierarchy lines are only shown for the most indented path ("sparse" connectors).

Parameters:: showFullConnectors - showFullConnectors Default value is true

getShowFullConnectors

public Boolean getShowFullConnectors()

Returns:: Boolean

setShowOpenIcons

public void setShowOpenIcons(Boolean showOpenIcons)

If true, show a different icon for open folders than closed folders. This is achieved by appending the openIconSuffix onto the folderIcon URL [for example "[SKIN]/folder.gif" might be replaced by "[SKIN]/folder_open.gif".
Note If this property is set to false the same icon is shown for open folders as for closed folders, unless a custom folder icon was specified. This will be determined by folderIcon plus the closedIconSuffix.

Parameters:: showOpenIcons - showOpenIcons Default value is true
See Also:: Node Titles Example

getShowOpenIcons

public Boolean getShowOpenIcons()

Returns:: Boolean
See Also:: Node Titles Example

setShowPartialSelection

public void setShowPartialSelection(Boolean showPartialSelection)

Should partially selected parents be shown with special icon?

Parameters:: showPartialSelection - showPartialSelection Default value is false

getShowPartialSelection

public Boolean getShowPartialSelection()

Should partially selected parents be shown with special icon?

Returns:: Boolean

setShowRoot

public void setShowRoot(Boolean showRoot)
                 throws IllegalStateException

Specifies whether the root node should be displayed in the treeGrid.

This property is only available for "children" modelType trees, hence is not allowed for trees that load data from the server dynamically via TreeGrid.fetchData.

To get the equivalent of a visible "root" node in a tree that loads data dynamically, add a singular, top-level parent to the data. However, note that this top-level parent will technically be the only child of root, and the implicit root object will be returned by this.data.getRoot().

Parameters:: showRoot - showRoot Default value is false
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getShowRoot

public Boolean getShowRoot()

Specifies whether the root node should be displayed in the treeGrid.

This property is only available for "children" modelType trees, hence is not allowed for trees that load data from the server dynamically via TreeGrid.fetchData.

Returns:: Boolean

setSortFoldersBeforeLeaves

public void setSortFoldersBeforeLeaves(Boolean sortFoldersBeforeLeaves)
                                throws IllegalStateException

If specified, this attribute will override sortFoldersBeforeLeaves on the data for this treeGrid.

Specifies whether when separateFolders is true, folders should be displayed before or after their sibling leaves in a sorted tree. If set to true, with sortDirection set to Array.ASCENDING, folders are displayed before their sibling leaves and with sort direction set to Array.DESCENDING they are displayed after. To invert this behavior, set this property to false.

Parameters:: sortFoldersBeforeLeaves - sortFoldersBeforeLeaves Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getSortFoldersBeforeLeaves

public Boolean getSortFoldersBeforeLeaves()

If specified, this attribute will override sortFoldersBeforeLeaves on the data for this treeGrid.

Returns:: Boolean

setTreeFieldTitle

public void setTreeFieldTitle(String treeFieldTitle)
                       throws IllegalStateException

Visible title for the tree column (field).

Parameters:: treeFieldTitle - treeFieldTitle Default value is "Name"
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getTreeFieldTitle

public String getTreeFieldTitle()

Visible title for the tree column (field).

Returns:: String

canEditCell

public Boolean canEditCell()

Overridden to disallow editing of the name field of this grid's data tree. Also disallows editing of the auto-generated tree field, which displays the result of Tree.getTitle on the node.

Returns:: Whether to allow editing this cell

addDataArrivedHandler

public HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)

Add a dataArrived handler.

Notification method fired whenever this TreeGrid receives new data nodes from the dataSource. Only applies to databound TreeGrids where data is a ResultTree - either explicitly created and applied via TreeGrid.setData or automatically generated via a fetchData() call.

Parameters:: handler - the dataArrived handler
Returns:: HandlerRegistration used to remove this handler

addFolderClickHandler

public HandlerRegistration addFolderClickHandler(FolderClickHandler handler)

Add a folderClick handler.

This method is called when a folder record is clicked on.

Specified by:: addFolderClickHandler in interface HasFolderClickHandlers

Parameters:: handler - the folderClick handler
Returns:: HandlerRegistration used to remove this handler

addFolderClosedHandler

public HandlerRegistration addFolderClosedHandler(FolderClosedHandler handler)

Add a folderClosed handler.

This method is called when a folder is closed either via the user manipulating the expand/collapse control in the UI or via TreeGrid.closeFolder. You can return false to cancel the close.

Specified by:: addFolderClosedHandler in interface HasFolderClosedHandlers

Parameters:: handler - the folderClosed handler
Returns:: HandlerRegistration used to remove this handler

addFolderContextClickHandler

public HandlerRegistration addFolderContextClickHandler(FolderContextClickHandler handler)

Add a folderContextClick handler.

This method is called when a context click occurs on a folder record.

Specified by:: addFolderContextClickHandler in interface HasFolderContextClickHandlers

Parameters:: handler - the folderContextClick handler
Returns:: HandlerRegistration used to remove this handler

addFolderOpenedHandler

public HandlerRegistration addFolderOpenedHandler(FolderOpenedHandler handler)

Add a folderOpened handler.

This method is called when a folder is opened either via the user manipulating the expand/collapse control in the UI or via TreeGrid.openFolder. You can return false to cancel the open.

Specified by:: addFolderOpenedHandler in interface HasFolderOpenedHandlers

Parameters:: handler - the folderOpened handler
Returns:: HandlerRegistration used to remove this handler

getEventRow

public int getEventRow()

Returns the row number of the most recent mouse event.

Overrides:: getEventRow in class ListGrid

Returns:: row number, or -2 if beyond last drawn row

getEventRow

public int getEventRow(int y)

Returns the row number of the most recent mouse event.

Overrides:: getEventRow in class ListGrid

Parameters:: y - optional y-coordinate to obtain row number, in lieu of the y coordinate of the last mouse event
Returns:: row number, or -2 if beyond last drawn row

getExtraIcon

public String getExtraIcon(TreeNode node)

Get an additional icon to show between the open icon and folder/node icon for a particular node.

NOTE: If selectionAppearance is "checkbox", this method will NOT be called. Extra icons cannot be shown for that appearance.

Parameters:: node - tree node in question
Returns:: URL for the extra icon (null if none required)

getOpenIcon

public String getOpenIcon(TreeNode node)

Get the appropriate open/close opener icon for a node.

Parameters:: node - tree node in question
Returns:: URL for the icon to show the node's open state

getOpenState

public String getOpenState()

Returns a snapshot of the current open state of this grid's data as a String object.
This object can be passed to TreeGrid.setOpenState to open the same set of folders within the treeGrid's data (assuming the nodes are still present in the data).

Returns:: current sort state for the grid.

getSelectedPaths

public String getSelectedPaths()

Returns a snapshot of the current selection within this treeGrid as a String object.
This object can be passed to TreeGrid.setSelectedPaths to reset this grid's selection the current state (assuming the same data is present in the grid).

Returns:: current state of this grid's selection

addLeafClickHandler

public HandlerRegistration addLeafClickHandler(LeafClickHandler handler)

Add a leafClick handler.

This method is called when a leaf record is clicked on.

Specified by:: addLeafClickHandler in interface HasLeafClickHandlers

Parameters:: handler - the leafClick handler
Returns:: HandlerRegistration used to remove this handler

addLeafContextClickHandler

public HandlerRegistration addLeafContextClickHandler(LeafContextClickHandler handler)

Add a leafContextClick handler.

This method is called when a context click occurs on a leaf record.

Specified by:: addLeafContextClickHandler in interface HasLeafContextClickHandlers

Parameters:: handler - the leafContextClick handler
Returns:: HandlerRegistration used to remove this handler

addNodeClickHandler

public HandlerRegistration addNodeClickHandler(NodeClickHandler handler)

Add a nodeClick handler.

This method is called when a leaf or folder record is clicked on. Note that if you set up a callback for nodeClick() and e.g. TreeGrid.leafClick, then both will fire (in that order) if a leaf is clicked on.

Specified by:: addNodeClickHandler in interface HasNodeClickHandlers

Parameters:: handler - the nodeClick handler
Returns:: HandlerRegistration used to remove this handler

addNodeContextClickHandler

public HandlerRegistration addNodeContextClickHandler(NodeContextClickHandler handler)

Add a nodeContextClick handler.

This method is called when a context click occurs on a leaf or folder record. Note that if you set up a callback for nodeContextClick() and e.g. TreeGrid.leafContextClick, then both will fire (in that order) if a leaf is contextclicked - unless nodeContextClick() returns false, in which case no further contextClick callbacks will be called.

Specified by:: addNodeContextClickHandler in interface HasNodeContextClickHandlers

Parameters:: handler - the nodeContextClick handler
Returns:: HandlerRegistration used to remove this handler

recordDoubleClick

public void recordDoubleClick()

Handle a doubleClick on a tree node - override of ListGrid stringMethod of same name. If the node is a folder, this implementation calls TreeGrid.toggleFolder on it. If the node is a leaf, calls TreeGrid.openLeaf on it.

setOpenState

public void setOpenState(String openState)

Reset this set of open folders within this grid's data to match the String object passed in.
Used to restore previous state retrieved from the grid by a call to TreeGrid.getOpenState.

Parameters:: openState - Object describing the desired set of open folders.

setSelectedPaths

public void setSelectedPaths(String selectedPaths)

Reset this grid's selection to match the String object passed in.
Used to restore previous state retrieved from the grid by a call to TreeGrid.getSelectedPaths.

Parameters:: selectedPaths - Object describing the desired selection state of the grid

setDefaultProperties

public static void setDefaultProperties(TreeGrid treeGridProperties)

Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

Parameters:: treeGridProperties - properties that should be used as new defaults when instances of this class are created

onInit

protected void onInit()

Overrides:: onInit in class ListGrid

getNodeTitle

protected String getNodeTitle(Record node,
                              int recordNum,
                              ListGridField field)

Returns the title to show for a node in the tree column. If the field specifies the name attribute, then the current node[field.name] is returned. Otherwise, the result of calling Tree.getTitle(com.smartgwt.client.widgets.tree.TreeNode) on the node is called.

You can override this method to return a custom title for node titles in the tree column. Note : This is an override point

Parameters:: node - The node for which the title is being requested.; recordNum - The index of the node.; field - The field for which the title is being requested.
Returns:: the title to display.

getIcon

protected String getIcon(Record node,
                         boolean defaultState)

Get the appropriate icon for a node.

By default icons are derived from folderIcon and nodeIcon. Custom icons for individual nodes can be overriden by setting the customIconProperty on a node.

If you want to suppress icons altogether, provide an override of this method that simply returns null.

Note that the full icon URL will be derived by applying Canvas.getImgURL(java.lang.String) to the value returned from this method.

Note: This is an override point

Parameters:: node - tree node in question; defaultState - defaultState
Returns:: URL for icon to show for this node

setCustomNodeIcon

public void setCustomNodeIcon(Record node,
                              String icon)

Set the icon for a particular treenode to a specified URL

Parameters:: node - the tree node; icon - path to the resource

getDropFolder

public TreeNode getDropFolder()

When the user is dragging a droppable element over this grid, this method returns the folder which would contain the item if dropped. This is the current drop node if the user is hovering over a folder, or the node's parent if the user is hovering over a leaf.

Returns:: target drop folder

setFields

public void setFields(TreeGridField... fields)

An array of field objects, specifying the order, layout, dynamic calculation, and sorting behavior of each field in the treeGrid object. In TreeGrids, the fields array specifies columns. Each field in the fields array is TreeGridField object.

If dataSource is also set, this value acts as a set of overrides as explained in fields.

Parameters:: fields - fields Default value is null

getTree

public Tree getTree()

Synonmy for {#link #getData)

Returns:: the underlying tree

setDataProperties

public void setDataProperties(Tree resultTreeProperties)

For databound TreeGrids, this attribute can be used to customize the ResultTree object created for this treegrid when data is fetched

Parameters:: resultTreeProperties - the data properties

getRecords

public ListGridRecord[] getRecords()

Return the tree nodes as a flat array of ListGridRecords. Internally this method retrieves all the nodes via Tree.getOpenList(TreeNode). You should favor working with the underlying Tree data structure when working with a TreeGrid.

Overrides:: getRecords in class ListGrid

Returns:: the tree nodes as ListGridRecord's

setInitialData

public void setInitialData(TreeNode[] initialData)
                    throws IllegalStateException

You can specify the initial set of data for a databound TreeGrid using this property. The value of this attribute should be a list of parentId linked ${isc.DocUtils.linkForRef('object:TreeNode')}s in a format equivalent to that documented on data.

Parameters:: initialData - initialData Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

fetchData

public void fetchData()

Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component as a tree.

This method will create a com.smartgwt.client.data.ResultTree to manage tree data, which will subsequently be available as treeGrid.data. DataSource records returned by the "fetch" operation are linked into a tree structure according to primaryKey and foreignKey declarations on DataSource fields. See the TreeDataBinding topic for complete details.

By default, the created ResultTree will use folder-by-folder load on demand, asking the server for the children of each folder as the user opens it.

The com.smartgwt.client.data.ResultTree created by fetchData() can be customized by setting dataProperties to an Object containing properties and methods to apply to the created ResultTree. For example, the property that determines whether a node is a folder (isFolderProperty) can be customized, or level-by-level loading can be disabled via loadDataOnDemand.

The callback passed to fetchData will fire once, the first time that data is loaded from the server. If using folder-by-folder load on demand, use the com.smartgwt.client.data.ResultTree#dataArrived notification to be notified each time new nodes are loaded.

Note that, if criteria are passed to fetchData(), they will be passed every time a new "fetch" operation is sent to the server. This allows you to retrieve multiple different tree structures from the same DataSource. However note that the server is expected to always respond with an intact tree - returned nodes which do not have parents are dropped from the dataset and not displayed.

Specified by:: fetchData in interface DataBoundComponent
Overrides:: fetchData in class ListGrid

fetchData

public void fetchData(Criteria criteria)

Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component as a tree.

By default, the created ResultTree will use folder-by-folder load on demand, asking the server for the children of each folder as the user opens it.

Specified by:: fetchData in interface DataBoundComponent
Overrides:: fetchData in class ListGrid

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback)

Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component as a tree.

By default, the created ResultTree will use folder-by-folder load on demand, asking the server for the children of each folder as the user opens it.

Specified by:: fetchData in interface DataBoundComponent
Overrides:: fetchData in class ListGrid

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria(); callback - callback to invoke when a fetch is complete. Fires only if server contact was required

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback,
                      DSRequest requestProperties)

Uses a "fetch" operation on the current DataSource to retrieve data that matches the provided criteria, and displays the matching data in this component as a tree.

By default, the created ResultTree will use folder-by-folder load on demand, asking the server for the children of each folder as the user opens it.

Specified by:: fetchData in interface DataBoundComponent
Overrides:: fetchData in class ListGrid

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria(); callback - callback to invoke when a fetch is complete. Fires only if server contact was required; requestProperties - additional properties to set on the DSRequest that will be issued

filterData

public void filterData(Criteria criteria)

Retrieves data that matches the provided criteria and displays the matching data in this component.

This method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:: filterData in interface DataBoundComponent
Overrides:: filterData in class ListGrid

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria()

filterData

public void filterData(Criteria criteria,
                       DSCallback callback)

Retrieves data that matches the provided criteria and displays the matching data in this component.

This method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:: filterData in interface DataBoundComponent
Overrides:: filterData in class ListGrid

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria(); callback - callback to invoke when a fetch is complete. Fires only if server contact was required; see DataBoundComponent.fetchData() for details

filterData

public void filterData(Criteria criteria,
                       DSCallback callback,
                       DSRequest requestProperties)

Retrieves data that matches the provided criteria and displays the matching data in this component.

This method behaves exactly like fetchData() except that textMatchStyle is automatically set to "substring" so that String-valued fields are matched by case-insensitive substring comparison.

Specified by:: filterData in interface DataBoundComponent
Overrides:: filterData in class ListGrid

Parameters:: criteria - Search criteria. If a DynamicForm is passed in as this argument instead of a raw criteria object, will be derived by calling DynamicForm.getValuesAsCriteria(); callback - callback to invoke when a fetch is complete. Fires only if server contact was required; see DataBoundComponent.fetchData() for details; requestProperties - for databound components only - optional additional properties to set on the DSRequest that will be issued

getSelectedRecord

public ListGridRecord getSelectedRecord()

Return the first selected record in this component.

This method is appropriate if selectionType is "single", or if you only care about the first selected record in a multiple-record selection. To access all selected records, use ListGrid.getSelection() instead.

Overrides:: getSelectedRecord in class ListGrid

Returns:: first selected record, or null if nothing selected
See Also:: Selection overview and related methods, Databound remove Example

getRecord

public ListGridRecord getRecord(int recordNum)

Return the pointer to a particular record by record number. Synonym for com.smartgwt.client.widgets.grid.ListGrid#getCellRecord.

Overrides:: getRecord in class ListGrid

Parameters:: recordNum - row index of record to return.
Returns:: Record object for the row.

setTreeRootValue

public void setTreeRootValue(String treeRootValue)
                      throws IllegalStateException

For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.

This property allows you to have a particular component navigate a tree starting from any given node as the root.

Note : This is an advanced setting

Parameters:: treeRootValue - treeRootValue Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

setTreeRootValue

public void setTreeRootValue(Integer treeRootValue)
                      throws IllegalStateException

For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.

This property allows you to have a particular component navigate a tree starting from any given node as the root.

Note : This is an advanced setting

Parameters:: treeRootValue - treeRootValue Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getTreeRootValue

public String getTreeRootValue()

For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.

This property allows you to have a particular component navigate a tree starting from any given node as the root.

Returns:: tree root value as String

getCellAlign

public Alignment getCellAlign(ListGridRecord record,
                              int rowNum,
                              int colNum)

Return the horizontal alignment for cell contents. Default implementation will always left-align the special treeField [or right-align if the page is in RTL mode] - otherwise will return cellAlign if specified, otherwise align.

Parameters:: record - this cell's record; rowNum - row number for the cell; colNum - column number of the cell
Returns:: Horizontal alignment of cell contents: 'right', 'center', or 'left'

addFolderDropHandler

public HandlerRegistration addFolderDropHandler(FolderDropHandler handler)

Add a onFolderDrop handler.

Notification method fired when treeNode(s) are dropped into a folder of this TreeGrid. This method fires before the standard com.smartgwt.client.widgets.tree.TreeGrid#folderDrop processing occurs and returning false will suppress that default behavior.

Specified by:: addFolderDropHandler in interface HasFolderDropHandlers

Parameters:: handler - the onFolderDrop handler
Returns:: HandlerRegistration used to remove this handler

willAcceptDrop

public Boolean willAcceptDrop()

This method overrides ListGrid.willAcceptDrop() and works as follows:

First, ListGrid.willAcceptDrop() (the superclass definition) is consulted. If it returns false, then this method returns false immediately.
This handles the following cases:
- reordering of records withing this TreeGrid when canReorderRecords is true
- accepting dropped records from another dragTarget when canAcceptDroppedRecords is true and the dragTarget gives us a valid set of records to drop into place.
- disallowing drop over disabled nodes, or nodes with canAcceptDrop:false
This method will also return false if the drop occurred over a leaf node whos immediate parent has canAcceptDrop set to false
If canReparentNodes is true, and the user is dragging a node from one folder to another, this method will return true to allow the change of parent folder.

Otherwise this method returns true. Note: This is an override point.

Overrides:: willAcceptDrop in class ListGrid

Returns:: true if this component will accept a drop of the dragData

addRecordDropHandler

public HandlerRegistration addRecordDropHandler(RecordDropHandler handler)
                                         throws UnsupportedOperationException

This ListGrid suporclass event does not fire on a TreeGrid, use addFolderDropHandler(com.smartgwt.client.widgets.tree.events.FolderDropHandler) instead.

Specified by:: addRecordDropHandler in interface HasRecordDropHandlers
Overrides:: addRecordDropHandler in class ListGrid

Parameters:: handler - the onRecordDrop handler
Returns:: HandlerRegistration used to remove this handler
Throws:: UnsupportedOperationException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.smartgwt.client.widgets.tree Class TreeGrid

TreeGrid

TreeGrid

getOrCreateRef

create

setAnimateFolderEffect

getAnimateFolderEffect

setAnimateFolderMaxRows

getAnimateFolderMaxRows

setAnimateFolders

getAnimateFolders

setAnimateFolderSpeed

getAnimateFolderSpeed

setAnimateFolderTime

getAnimateFolderTime

setAutoFetchTextMatchStyle

getAutoFetchTextMatchStyle

setCanAcceptDroppedRecords

getCanAcceptDroppedRecords

setCanDragRecordsOut

getCanDragRecordsOut

setCanDropOnLeaves

getCanDropOnLeaves

setCanReorderRecords

getCanReorderRecords

setCanReparentNodes

getCanReparentNodes

setCantDragIntoChildMessage

getCantDragIntoChildMessage

setCantDragIntoSelfMessage

getCantDragIntoSelfMessage

setCascadeSelection

getCascadeSelection

setClosedIconSuffix

getClosedIconSuffix

setConnectorImage

getConnectorImage

setCustomIconDropProperty

getCustomIconDropProperty

setCustomIconOpenProperty

getCustomIconOpenProperty

setCustomIconProperty

getCustomIconProperty

setData

getData

setDisplayNodeType

getDisplayNodeType

setDropIconSuffix

getDropIconSuffix

setExtraIconGap

getExtraIconGap

setFolderIcon

getFolderIcon

setIconSize

getIconSize

setIndentSize

getIndentSize

setLoadDataOnDemand

getLoadDataOnDemand

setManyItemsImage

getManyItemsImage

setNodeIcon

getNodeIcon

setOpenerIconSize

getOpenerIconSize

setOpenerImage

getOpenerImage

setOpenIconSuffix

getOpenIconSuffix

setParentAlreadyContainsChildMessage

getParentAlreadyContainsChildMessage

setSeparateFolders

getSeparateFolders

setShowConnectors

getShowConnectors

setShowCustomIconDrop

getShowCustomIconDrop

setShowCustomIconOpen

getShowCustomIconOpen

setShowDropIcons

com.smartgwt.client.widgets.tree
Class TreeGrid