ColumnTree (Smart GWT LGPL Edition API 6.1p (2024-07-30))

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.layout.Layout
        
        com.smartgwt.client.widgets.grid.ColumnTree

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, DataBoundComponent, HasClearHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragCompleteHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropCompleteHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFetchDataHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers, HasNodeSelectedHandlers, HasMembersChangedHandlers
```
public class ColumnTree
extends Layout
implements HasNodeSelectedHandlers, DataBoundComponent
```
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.
- the ColumnTree widget class, which visually presents tree data in a so-called "Miller Column" format.
For information on DataBinding Trees, see TreeDataBinding.
A ColumnTree shows a single branch of the underlying Tree horizontally, from left to right. Thus, the leftmost column shows all the top-level nodes. When the user clicks one of those nodes, a new column is shown immediately to the right of the top-level column, showing the selected node's children. Additional columns are shown as required to present lower-level children. The behavior of ColumnTree is similar to that of the Browser interface in the Apple™ iTunes™ application.

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

Field Summary
- Fields inherited from class com.smartgwt.client.widgets.BaseWidget
  config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
- Fields inherited from class com.google.gwt.user.client.ui.UIObject
  DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description

ColumnTree()

ColumnTree(com.google.gwt.core.client.JavaScriptObject jsObj)

Constructors
Constructor and Description
`ColumnTree()`
`ColumnTree(com.google.gwt.core.client.JavaScriptObject jsObj)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.gwt.event.shared.HandlerRegistration`	`addDragCompleteHandler(DragCompleteHandler handler)` Add a `com.smartgwt.client.widgets.DragCompleteHandler`.
`com.google.gwt.event.shared.HandlerRegistration`	`addDropCompleteHandler(DropCompleteHandler handler)` Add a `com.smartgwt.client.widgets.DropCompleteHandler`.
`com.google.gwt.event.shared.HandlerRegistration`	`addFetchDataHandler(FetchDataHandler handler)` Add a fetchData handler.
`void`	`addFormulaField()` Convenience method to display a `com.smartgwt.client..FormulaBuilder` to create a new Formula Field.
`com.google.gwt.event.shared.HandlerRegistration`	`addNodeSelectedHandler(NodeSelectedHandler handler)` Add a onNodeSelected handler.
`void`	`addSummaryField()` Convenience method to display a `com.smartgwt.client..SummaryBuilder` to create a new Summary Field.
`java.lang.Boolean`	`anySelected()` Whether at least one item is selected
`java.lang.Boolean`	`anySelected(int colNum)` Whether at least one item is selected in the supplied column (the first column if none is passed)
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)` Changes the defaults for Canvas AutoChildren named `autoChildName`.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)` Changes the defaults for FormItem AutoChildren named `autoChildName`.
`protected com.google.gwt.core.client.JavaScriptObject`	`create()`
`void`	`deselectAllRecords()` Deselect all records
`void`	`deselectAllRecords(int colNum)` Deselect all records in the supplied column (the first column if none is passed)
`void`	`deselectRecord(int record)` Deselect a `Record` passed in explicitly, or by index.
`void`	`deselectRecord(int record, int colNum)` Deselect a `Record` passed in explicitly, or by index.
`void`	`deselectRecord(Record record)` Deselect a `Record` passed in explicitly, or by index.
`void`	`deselectRecord(Record[] records)` Deselect a list of `Record`s passed in explicitly, or by index.
`void`	`deselectRecord(Record record, int colNum)`
`void`	`deselectRecords(int[] records)` Deselect a list of `Record`s passed in explicitly, or by index.
`void`	`deselectRecords(int[] records, int colNum)` Deselect a list of `Record`s passed in explicitly, or by index.
`void`	`deselectRecords(Record[] records)` Deselect a list of `Record`s passed in explicitly, or by index.
`void`	`deselectRecords(Record[] records, int colNum)` Deselect a list of `Record`s passed in explicitly, or by index.
`void`	`disableHilite(java.lang.String hiliteID)` Disable a hilite
`void`	`disableHiliting()` Disable all hilites.
`void`	`editFields()` Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent.
`void`	`editHilites()` Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.
`void`	`enableHilite(java.lang.String hiliteID)` Enable / disable a `hilites`
`void`	`enableHilite(java.lang.String hiliteID, boolean enable)` Enable / disable a `hilites`
`void`	`enableHiliting()` Enable all hilites.
`void`	`enableHiliting(boolean enable)` Enable all hilites.
`void`	`exportData()` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.
`void`	`exportData(DSRequest requestProperties)` Uses a "fetch" operation on the current `DataSource` to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.
`void`	`fetchData()` Retrieves data from the DataSource that matches the specified criteria.
`void`	`fetchData(Criteria criteria)` Retrieves data from the DataSource that matches the specified criteria.
`void`	`fetchData(Criteria criteria, DSCallback callback)` Retrieves data from the DataSource that matches the specified criteria.
`void`	`fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)` Retrieves data from the DataSource that matches the specified criteria.
`void`	`filterData()` Retrieves data that matches the provided criteria and displays the matching data in this component.
`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.
`Record`	`find(AdvancedCriteria adCriteria)` Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not found
`Record[]`	`findAll(AdvancedCriteria adCriteria)` Filters all objects according to the AdvancedCriteria passed
`int`	`findIndex(AdvancedCriteria adCriteria)` Finds the index of the first Record that matches with the AdvacendCriteria passed.
`int`	`findNextIndex(int startIndex, AdvancedCriteria adCriteria)` Like `RecordList.findIndex(java.util.Map)`, but considering the startIndex parameter.
`int`	`findNextIndex(int startIndex, AdvancedCriteria adCriteria, int endIndex)` Like `RecordList.findIndex(java.util.Map)`, but considering the startIndex and endIndex parameters.
`java.lang.Boolean`	`getAddDropValues()` Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.
`java.lang.String`	`getAddFormulaFieldText()` Text for a menu item allowing users to add a formula field
`java.lang.String`	`getAddOperation()` `operationId` this component should use when performing add operations.
`java.lang.String`	`getAddSummaryFieldText()` Text for a menu item allowing users to add a formula field
`java.lang.Boolean`	`getAutoFetchAsFilter()` If `DataBoundComponent.setAutoFetchData(Boolean)` is true, this attribute determines whether the initial fetch operation should be performed via `DataBoundComponent.fetchData()` or `DataBoundComponent.filterData()`
`java.lang.Boolean`	`getAutoFetchData()` If true, when this component is first drawn, automatically call `DataBoundComponent.fetchData()` or `DataBoundComponent.filterData()` depending on `DataBoundComponent.getAutoFetchAsFilter()` .
`TextMatchStyle`	`getAutoFetchTextMatchStyle()` If `autoFetchData` is `true`, this attribute allows the developer to specify a textMatchStyle for the initial `DataBoundComponent.fetchData()` call.
`IButton`	`getBackButton()` When using `single-column mode`, this is the "Back" button that you see hovering above the column UI and that allows backward navigation.
`java.lang.String`	`getBackButtonTitle()` When using `single-column mode`, this i18n property dictates the title for the `button` docked to the top left which allows navigation back through the column tree.
`java.lang.Boolean`	`getCanAddFormulaFields()` Adds an item to the header context menu allowing users to launch a dialog to define a new field based on values present in other fields, using the `com.smartgwt.client..FormulaBuilder`.
`java.lang.Boolean`	`getCanAddSummaryFields()` Adds an item to the header context menu allowing users to launch a dialog to define a new text field that can contain both user-defined text and the formatted values present in other fields, using the `com.smartgwt.client..SummaryBuilder`.
`java.lang.String`	`getClosedIconSuffix()` This suffix will be appended to the `folderIcon` for closed folders.
`ListGrid`	`getColumn()` Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
`ListGrid`	`getColumnProperties()` Standard set of properties to apply to each generated `column` in this columnTree.
`void`	`getColumnTitle(TreeNode node, int colNum)` Returns the title to show for the header of indicated column.
`ListGrid`	`getCustomColumnProperties(TreeNode node, int colNum)` Additional properties to apply to the ListGrid that will show the indicated column.
`java.lang.String`	`getCustomIconOpenProperty()` This property allows the developer to rename the `default node.showOpenIcon` property.
`java.lang.String`	`getCustomIconProperty()` This property allows the developer to customize the icon displayed next to a node.
`Tree`	`getData()` A `Tree` object consisting of nested `TreeNode`s to display in this ColumnTree.
`com.google.gwt.core.client.JavaScriptObject`	`getDataAsJSList()`
`FetchMode`	`getDataFetchMode()` How to fetch and manage records retrieve from the server.
`int`	`getDataPageSize()` When using `data paging`, how many records to fetch at a time.
`Tree`	`getDataProperties()` For a `ColumnTree` that uses a DataSource, these properties will be passed to the automatically-created ResultTree.
`DataSource`	`getDataSource()` The DataSource that this component should bind to for default fields and for performing `DataSource requests`.
`java.lang.Boolean`	`getDeepCloneOnEdit()` Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.
`Record[]`	`getDragData()` During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.
`DragDataAction`	`getDragDataAction()` Indicates what to do with data dragged into another DataBoundComponent.
`java.lang.String`	`getDragTrackerStyle()` CSS Style to apply to the drag tracker when dragging occurs on this component.
`java.lang.String`	`getDropIconSuffix()` If `showDropIcons` is true, this suffix will be appended to the `folderIcon` when the user drop-hovers over some folder.
`java.util.Map`	`getDropValues()` When an item is dropped on this component, and `addDropValues` is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.
`java.lang.String`	`getDuplicateDragMessage()` Message to show when a user attempts to transfer duplicate records into this component, and `preventDuplicates` is enabled.
`java.lang.String`	`getEditFormulaFieldText()` Text for a menu item allowing users to edit a formula field
`java.lang.String`	`getEditSummaryFieldText()` Text for a menu item allowing users to edit the formatter for a field
`java.lang.Boolean`	`getExportAll()` Setting exportAll to true prevents the component from passing its list of fields to the export call.
`java.lang.String[]`	`getExportFields()` The list of field-names to export.
`java.lang.Boolean`	`getExportIncludeSummaries()` If Summary rows exist for this component, whether to include them when exporting client data.
`java.lang.String`	`getFetchOperation()` Operation ID this component should use when performing fetch operations.
`Alignment[]`	`getFieldAlignments()` Returna an array of field alignments for this grid
`int`	`getFieldCount()` Return the number of fields.
`com.google.gwt.core.client.JavaScriptObject[]`	`getFieldsAsJavaScriptObjects()` Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g.
`java.lang.String`	`getFirstColumnTitle()` A title for the leftmost column if `showHeaders` is set (the remaining columns have their titles derived from the item selected in the column to the left).
`java.lang.String`	`getFolderIcon()` The URL of the base icon for all folder nodes in this columnTree.
`java.lang.String`	`getHiliteProperty()` Marker that can be set on a record to flag that record as hilited.
`Hilite[]`	`getHilites()` Return the set of hilite-objects currently applied to this DataBoundComponent.
`java.lang.String`	`getHiliteState()` Get the current hilites encoded as a String, for saving.
`java.lang.String`	`getIcon(TreeNode node)` Get the appropriate icon for a node.
`Criteria`	`getImplicitCriteria()` Criteria that are never shown to or edited by the user and are cumulative with any criteria provided via `DataBoundComponent.initialCriteria`, `DataBoundComponent.setCriteria()` etc.
`Criteria`	`getInitialCriteria()` Criteria to use when `DataBoundComponent.setAutoFetchData(Boolean)` is used.
`java.lang.Boolean`	`getLoadDataOnDemand()` For databound columnTree instances, should the entire tree of data be loaded on initial fetch, or should each column be loaded as needed.
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`getLogicalStructure()` Getter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
`java.lang.String`	`getNodeIcon()` The filename of the default icon for all leaf nodes in this grid.
`java.lang.String`	`getOpenIconSuffix()` If `showOpenIcons` is true, this suffix will be appended to the `folderIcon` for open folders in this grid.
`static ColumnTree`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`java.lang.Boolean`	`getPreventDuplicates()` If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via `DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)`.
`java.lang.Boolean`	`getProgressiveLoading()` Indicates whether or not this component will load its data `progressively`
`TreeNode`	`getRecord(int index)` Retrieve a record by index.
`TreeNode`	`getRecord(int index, java.lang.Integer colNum)` Retrieve a record by index.
`int`	`getRecordIndex(Record record)` Get the index of the provided record.
`RecordList`	`getRecordList()` Return the underlying data of this DataBoundComponent as a `RecordList`.
`java.lang.String`	`getRemoveOperation()` `operationId` this component should use when performing remove operations.
`ResultSet`	`getResultSet()` Return the underlying data of this DataBoundComponent as a `ResultSet`.
`Record`	`getSelectedRecord()` Get the selected record, that is, the parent of the nodes in the rightmost visible column.
`ListGridRecord[]`	`getSelection(int colNum)` Returns the array of objects selected in the specified column of the columnTree
`java.lang.Boolean`	`getShowComplexFields()` Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no `component.fields`.
`java.lang.Boolean`	`getShowCustomIconOpen()` Should folder nodes showing custom icons (set via the `customIconProperty`), show open state images when the folder is opened.
`java.lang.Boolean`	`getShowDetailFields()` Whether to show fields marked `detail:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`java.lang.Boolean`	`getShowDropIcons()` If true, when the user drags a droppable target over a folder in this TreeGrid, show a different icon folder icon.
`java.lang.Boolean`	`getShowHeaders()` If set, each column in the ColumnTree will show a header with the title of the selected node from the column to the left.
`java.lang.Boolean`	`getShowHiddenFields()` Whether to show fields marked `hidden:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`java.lang.Boolean`	`getShowMultipleColumns()` When set to false, only displays a single column at a time, showing a slide animation when moving between columns.
`java.lang.Boolean`	`getShowNodeCount()` If set, and `showHeaders` is also set, each column's header will show a count of the number of nodes in that column
`java.lang.Boolean`	`getShowOpenIcons()` If true, show a different icon for `open` folders than closed folders.
`java.lang.String`	`getTitleField()` Method to return the fieldName which represents the "title" for records in this Component. If this.titleField is explicitly specified it will always be used. Otherwise, default implementation will check `titleField` for databound components. For non databound components returns the first defined field name of `"title"`, `"name"`, or `"id"`.
`java.lang.String`	`getTitleFieldValue(Record record)` Get the value of the titleField for the passed record
`java.lang.String`	`getUpdateOperation()` `operationId` this component should use when performing update operations.
`java.lang.Boolean`	`getUseAllDataSourceFields()` If true, the set of fields given by the "default binding" (see `fields`) is used, with any fields specified in `component.fields` acting as overrides that can suppress or modify the display of individual fields, without having to list the entire set of fields that should be shown.
`java.lang.Boolean`	`getUseFlatFields()` The `useFlatFields` flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.
`void`	`invalidateCache()` Invalidate the current data cache for this databound component via a call to the dataset's `invalidateCache()` method, for example, `ResultSet.invalidateCache()`.
`void`	`navigateBack()` Navigate to the previous column.
`protected void`	`onInit_ColumnTree()`
`protected void`	`onInit()`
`void`	`selectAllRecords()` Select all records
`void`	`selectAllRecords(int colNum)` Select all records in the supplied column (the first column if none is passed)
`void`	`selectRecord(int record)` Select/deselect a `Record` passed in explicitly, or by index.
`void`	`selectRecord(int record, boolean newState)` Select/deselect a `Record` passed in explicitly, or by index.
`void`	`selectRecord(int record, boolean newState, int colNum)` Select/deselect a `Record` passed in explicitly, or by index.
`void`	`selectRecord(Record record)` Select/deselect a `Record` passed in explicitly, or by index.
`void`	`selectRecord(Record record, boolean newState)` Select/deselect a `Record` passed in explicitly, or by index.
`void`	`selectRecord(Record record, boolean newState, int colNum)` Select/deselect a `Record` passed in explicitly, or by index.
`void`	`selectRecords(int[] records)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`selectRecords(int[] records, boolean newState)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`selectRecords(int[] records, boolean newState, int colNum)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`selectRecords(Record[] records)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`selectRecords(Record[] records, boolean newState)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`selectRecords(Record[] records, boolean newState, int colNum)` Select/deselect a list of `Record`s passed in explicitly, or by index.
`void`	`setAddDropValues(java.lang.Boolean addDropValues)` Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.
`void`	`setAddFormulaFieldText(java.lang.String addFormulaFieldText)` Text for a menu item allowing users to add a formula field
`void`	`setAddOperation(java.lang.String addOperation)` `operationId` this component should use when performing add operations.
`void`	`setAddSummaryFieldText(java.lang.String addSummaryFieldText)` Text for a menu item allowing users to add a formula field
`void`	`setAutoFetchAsFilter(java.lang.Boolean autoFetchAsFilter)` If `DataBoundComponent.setAutoFetchData(Boolean)` is true, this attribute determines whether the initial fetch operation should be performed via `DataBoundComponent.fetchData()` or `DataBoundComponent.filterData()`
`void`	`setAutoFetchData(java.lang.Boolean autoFetchData)` If true, when this component is first drawn, automatically call `DataBoundComponent.fetchData()` or `DataBoundComponent.filterData()` depending on `DataBoundComponent.getAutoFetchAsFilter()` .
`void`	`setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)` If `autoFetchData` is `true`, this attribute allows the developer to specify a textMatchStyle for the initial `DataBoundComponent.fetchData()` call.
`void`	`setBackButtonTitle(java.lang.String backButtonTitle)` When using `single-column mode`, this i18n property dictates the title for the `button` docked to the top left which allows navigation back through the column tree.
`void`	`setCanAddFormulaFields(java.lang.Boolean canAddFormulaFields)` Adds an item to the header context menu allowing users to launch a dialog to define a new field based on values present in other fields, using the `com.smartgwt.client..FormulaBuilder`.
`void`	`setCanAddSummaryFields(java.lang.Boolean canAddSummaryFields)` Adds an item to the header context menu allowing users to launch a dialog to define a new text field that can contain both user-defined text and the formatted values present in other fields, using the `com.smartgwt.client..SummaryBuilder`.
`void`	`setClosedIconSuffix(java.lang.String closedIconSuffix)` This suffix will be appended to the `folderIcon` for closed folders.
`void`	`setColumnProperties(ListGrid columnProperties)` Standard set of properties to apply to each generated `column` in this columnTree.
`void`	`setCustomIconOpenProperty(java.lang.String customIconOpenProperty)` This property allows the developer to rename the `default node.showOpenIcon` property.
`void`	`setCustomIconProperty(java.lang.String customIconProperty)` This property allows the developer to customize the icon displayed next to a node.
`void`	`setData(Tree data)` A `Tree` object consisting of nested `TreeNode`s to display in this ColumnTree.
`void`	`setDataFetchMode(FetchMode dataFetchMode)` How to fetch and manage records retrieve from the server.
`void`	`setDataPageSize(int dataPageSize)` When using `data paging`, how many records to fetch at a time.
`void`	`setDataProperties(Tree resultTreeProperties)` For databound ColumnTrees, this attribute can be used to customize the ResultTree object created for this ColumnTree when data is fetched.
`void`	`setDataSource(DataSource dataSource)` The DataSource that this component should bind to for default fields and for performing `DataSource requests`.
`void`	`setDataSource(DataSource dataSource, ListGridField... fields)` Bind to a DataSource.
`void`	`setDataSource(java.lang.String dataSource)` The DataSource that this component should bind to for default fields and for performing `DataSource requests`.
`void`	`setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)` Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.
`static void`	`setDefaultProperties(ColumnTree columnTreeProperties)` Class level method to set the default properties of this class.
`void`	`setDragDataAction(DragDataAction dragDataAction)` Indicates what to do with data dragged into another DataBoundComponent.
`void`	`setDragDataCustomizer(DragDataCustomizer customizer)` During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.
`void`	`setDragTrackerStyle(java.lang.String dragTrackerStyle)` CSS Style to apply to the drag tracker when dragging occurs on this component.
`void`	`setDropIconSuffix(java.lang.String dropIconSuffix)` If `showDropIcons` is true, this suffix will be appended to the `folderIcon` when the user drop-hovers over some folder.
`void`	`setDropValues(java.util.Map dropValues)` When an item is dropped on this component, and `addDropValues` is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.
`void`	`setDuplicateDragMessage(java.lang.String duplicateDragMessage)` Message to show when a user attempts to transfer duplicate records into this component, and `preventDuplicates` is enabled.
`void`	`setEditFormulaFieldText(java.lang.String editFormulaFieldText)` Text for a menu item allowing users to edit a formula field
`void`	`setEditSummaryFieldText(java.lang.String editSummaryFieldText)` Text for a menu item allowing users to edit the formatter for a field
`void`	`setExportAll(java.lang.Boolean exportAll)` Setting exportAll to true prevents the component from passing its list of fields to the export call.
`void`	`setExportFields(java.lang.String[] exportFields)` The list of field-names to export.
`void`	`setExportIncludeSummaries(java.lang.Boolean exportIncludeSummaries)` If Summary rows exist for this component, whether to include them when exporting client data.
`void`	`setFetchOperation(java.lang.String fetchOperation)` Operation ID this component should use when performing fetch operations.
`void`	`setFields(com.google.gwt.core.client.JavaScriptObject... fields)` Field setter variant (alternative to `setFields(FormItem...)`, `setFields(ListGridField...)`, etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT Java wrappers of the field class type (e.g.
`void`	`setFields(ListGridField... fields)` An array of field objects, specifying the order, layout, dynamic calculation, and sorting behavior of each field in each column in the columnTree object.
`void`	`setFirstColumnTitle(java.lang.String firstColumnTitle)` A title for the leftmost column if `showHeaders` is set (the remaining columns have their titles derived from the item selected in the column to the left).
`void`	`setFolderIcon(java.lang.String folderIcon)` The URL of the base icon for all folder nodes in this columnTree.
`void`	`setHiliteProperty(java.lang.String hiliteProperty)` Marker that can be set on a record to flag that record as hilited.
`void`	`setHilites(Hilite[] hilites)` Accepts an array of hilite objects and applies them to this DataBoundComponent.
`void`	`setHiliteState(java.lang.String hiliteState)` Set the current hilites based on a hiliteState String previously returned from getHilitesState.
`void`	`setImplicitCriteria(Criteria implicitCriteria)` Criteria that are never shown to or edited by the user and are cumulative with any criteria provided via `DataBoundComponent.initialCriteria`, `DataBoundComponent.setCriteria()` etc.
`void`	`setInitialCriteria(Criteria initialCriteria)` Criteria to use when `DataBoundComponent.setAutoFetchData(Boolean)` is used.
`void`	`setLoadDataOnDemand(java.lang.Boolean loadDataOnDemand)` For databound columnTree instances, should the entire tree of data be loaded on initial fetch, or should each column be loaded as needed.
`com.smartgwt.logicalstructure.core.LogicalStructureObject`	`setLogicalStructure(com.smartgwt.logicalstructure.widgets.grid.ColumnTreeLogicalStructure s)` Setter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.
`void`	`setNodeIcon(java.lang.String nodeIcon)` The filename of the default icon for all leaf nodes in this grid.
`void`	`setOpenIconSuffix(java.lang.String openIconSuffix)` If `showOpenIcons` is true, this suffix will be appended to the `folderIcon` for open folders in this grid.
`void`	`setPreventDuplicates(java.lang.Boolean preventDuplicates)` If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via `DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)`.
`void`	`setProgressiveLoading(java.lang.Boolean progressiveLoading)` Indicates whether or not this component will load its data `progressively`
`void`	`setRemoveOperation(java.lang.String removeOperation)` `operationId` this component should use when performing remove operations.
`void`	`setShowComplexFields(java.lang.Boolean showComplexFields)` Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no `component.fields`.
`void`	`setShowCustomIconOpen(java.lang.Boolean showCustomIconOpen)` Should folder nodes showing custom icons (set via the `customIconProperty`), show open state images when the folder is opened.
`void`	`setShowDetailFields(java.lang.Boolean showDetailFields)` Whether to show fields marked `detail:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`void`	`setShowDropIcons(java.lang.Boolean showDropIcons)` If true, when the user drags a droppable target over a folder in this TreeGrid, show a different icon folder icon.
`void`	`setShowHeaders(java.lang.Boolean showHeaders)` If set, each column in the ColumnTree will show a header with the title of the selected node from the column to the left.
`void`	`setShowHiddenFields(java.lang.Boolean showHiddenFields)` Whether to show fields marked `hidden:true` when a DataBoundComponent is given a DataSource but no `component.fields`.
`void`	`setShowMultipleColumns(java.lang.Boolean showMultipleColumns)` When set to false, only displays a single column at a time, showing a slide animation when moving between columns.
`void`	`setShowNodeCount(java.lang.Boolean showNodeCount)` If set, and `showHeaders` is also set, each column's header will show a count of the number of nodes in that column
`void`	`setShowOpenIcons(java.lang.Boolean showOpenIcons)` If true, show a different icon for `open` folders than closed folders.
`void`	`setTitleField(java.lang.String titleField)` Sets the best field to use for a user-visible title for an individual record from this component.
`void`	`setUpdateOperation(java.lang.String updateOperation)` `operationId` this component should use when performing update operations.
`void`	`setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)` If true, the set of fields given by the "default binding" (see `fields`) is used, with any fields specified in `component.fields` acting as overrides that can suppress or modify the display of individual fields, without having to list the entire set of fields that should be shown.
`void`	`setUseFlatFields(java.lang.Boolean useFlatFields)` The `useFlatFields` flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.
`void`	`shouldShowHeader(TreeNode node, int colNum)` Whether the indicated column should show a header.
`void`	`transferSelectedData(DataBoundComponent source)` Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
`void`	`transferSelectedData(DataBoundComponent source, int index)` Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.

Methods inherited from class com.smartgwt.client.widgets.layout.Layout
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEditProxyConstructor, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, revealChild, revealChild, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEditProxyConstructor, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember

Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeFonts, resizeIcons, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, applyFactoryProperties, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

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

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

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

- Constructor Detail
  - ColumnTree
```
public ColumnTree()
```
  - ColumnTree
```
public ColumnTree(com.google.gwt.core.client.JavaScriptObject jsObj)
```
- Method Detail
  - getOrCreateRef
```
public static ColumnTree getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)
```
    Changes the defaults for Canvas AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)
```
    Changes the defaults for FormItem AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - create
```
protected com.google.gwt.core.client.JavaScriptObject create()
```
    Overrides:
    
    create in class Layout
  - getBackButton
```
public IButton getBackButton()
                      throws java.lang.IllegalStateException
```
    When using single-column mode, this is the "Back" button that you see hovering above the column UI and that allows backward navigation.
    This component is an AutoChild named "backButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    Current backButton value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - if this widget has not yet been rendered.
  - setBackButtonTitle
```
public void setBackButtonTitle(java.lang.String backButtonTitle)
```
    When using single-column mode, this i18n property dictates the title for the button docked to the top left which allows navigation back through the column tree.
    
    Parameters:
    
    backButtonTitle - New backButtonTitle value. Default value is "Back"
  - getBackButtonTitle
```
public java.lang.String getBackButtonTitle()
```
    When using single-column mode, this i18n property dictates the title for the button docked to the top left which allows navigation back through the column tree.
    
    Returns:
    
    Current backButtonTitle value. Default value is "Back"
  - setClosedIconSuffix
```
public void setClosedIconSuffix(java.lang.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 - New closedIconSuffix value. Default value is "closed"
  - getClosedIconSuffix
```
public java.lang.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:
    
    Current closedIconSuffix value. Default value is "closed"
  - getColumn
```
public ListGrid getColumn()
```
    Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.
    Instance of ListGrid used to display each column of the tree.
    
    Returns:
    
    null
  - setCustomIconOpenProperty
```
public void setCustomIconOpenProperty(java.lang.String customIconOpenProperty)
```
    This property allows the developer to rename the default node.showOpenIcon property.
    Note : This is an advanced setting
    
    Parameters:
    
    customIconOpenProperty - New customIconOpenProperty value. Default value is "showOpenIcon"
    
    See Also:
    
    TreeGrid.setCustomIconProperty(java.lang.String), TreeGrid.setShowCustomIconOpen(java.lang.Boolean)
  - getCustomIconOpenProperty
```
public java.lang.String getCustomIconOpenProperty()
```
    This property allows the developer to rename the default node.showOpenIcon property.
    
    Returns:
    
    Current customIconOpenProperty value. Default value is "showOpenIcon"
    
    See Also:
    
    TreeGrid.getCustomIconProperty(), TreeGrid.getShowCustomIconOpen()
  - setCustomIconProperty
```
public void setCustomIconProperty(java.lang.String customIconProperty)
```
    This property allows the developer to customize the icon displayed next to a node. Set node[grid.customIconProperty] to the URL of the desired icon to display and it will be shown instead of the standard nodeIcon for this node.
    Note that if showCustomIconOpen is true for this grid, customized icons for folder nodes will be appended with the openIconSuffix suffix on state change, as with the standard folderIcon. Also note that for custom folder icons, the closedIconSuffix will never be appended.
    
    Parameters:
    
    customIconProperty - New customIconProperty value. Default value is "icon"
  - getCustomIconProperty
```
public java.lang.String getCustomIconProperty()
```
    This property allows the developer to customize the icon displayed next to a node. Set node[grid.customIconProperty] to the URL of the desired icon to display and it will be shown instead of the standard nodeIcon for this node.
    Note that if showCustomIconOpen is true for this grid, customized icons for folder nodes will be appended with the openIconSuffix suffix on state change, as with the standard folderIcon. Also note that for custom folder icons, the closedIconSuffix will never be appended.
    
    Returns:
    
    Current customIconProperty value. Default value is "icon"
  - setData
```
public void setData(Tree data)
```
    A Tree object consisting of nested TreeNodes to display in this ColumnTree. The data property will typically not be explicitly specified for databound ColumnTrees, where the data is returned from the server via databound component methods such as fetchData()
    
    If this method is called after the component has been drawn/initialized: Set the Tree object this ColumnTree will view
    
    Parameters:
    
    data - Tree to show. Default value is null
  - getData
```
public Tree getData()
```
    A Tree object consisting of nested TreeNodes to display in this ColumnTree. The data property will typically not be explicitly specified for databound ColumnTrees, where the data is returned from the server via databound component methods such as fetchData()
    
    Returns:
    
    Returns the Tree object this ColumnTree is viewing. Default value is null
  - setDataFetchMode
```
public void setDataFetchMode(FetchMode dataFetchMode)
```
    How to fetch and manage records retrieve from the server. See FetchMode.
    This setting only applies to the ResultSet automatically created by calling fetchData(). If a pre-existing ResultSet is passed to setData() instead, it's existing setting for ResultSet.fetchMode applies.
    
    Specified by:
    
    setDataFetchMode in interface DataBoundComponent
    
    Parameters:
    
    dataFetchMode - New dataFetchMode value. Default value is "paged"
    
    See Also:
    
    Databinding overview and related methods
  - getDataFetchMode
```
public FetchMode getDataFetchMode()
```
    How to fetch and manage records retrieve from the server. See FetchMode.
    This setting only applies to the ResultSet automatically created by calling fetchData(). If a pre-existing ResultSet is passed to setData() instead, it's existing setting for ResultSet.fetchMode applies.
    
    Specified by:
    
    getDataFetchMode in interface DataBoundComponent
    
    Returns:
    
    Current dataFetchMode value. Default value is "paged"
    
    See Also:
    
    Databinding overview and related methods
  - getDataProperties
```
public Tree getDataProperties()
```
    For a ColumnTree that uses a DataSource, these properties will be passed to the automatically-created ResultTree. This can be used for various customizations such as modifying the automatically-chosen Tree.parentIdField.
    
    Returns:
    
    Current dataProperties value. Default value is null
    
    See Also:
    
    Databinding overview and related methods
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
    The DataSource that this component should bind to for default fields and for performing DataSource requests.
    Can be specified as either a DataSource instance or the String ID of a DataSource.
    
    Specified by:
    
    setDataSource in interface DataBoundComponent
    
    Parameters:
    
    dataSource - New dataSource value. Default value is null
    
    See Also:
    
    Databinding overview and related methods, DataSource fields Example
  - setDataSource
```
public void setDataSource(java.lang.String dataSource)
```
    The DataSource that this component should bind to for default fields and for performing DataSource requests.
    Can be specified as either a DataSource instance or the String ID of a DataSource.
    
    Specified by:
    
    setDataSource in interface DataBoundComponent
    
    Parameters:
    
    dataSource - New dataSource value. Default value is null
    
    See Also:
    
    Databinding overview and related methods, DataSource fields Example
  - setFields
```
public void setFields(ListGridField... fields)
```
    An array of field objects, specifying the order, layout, dynamic calculation, and sorting behavior of each field in each column in the columnTree object. In ColumnTrees, the fields array specifies sub-columns within each main column. Each field in the fields array is a ListGridField object.
    If dataSource is also set, this value acts as a set of overrides as explained in DataBoundComponent.fields.
    
    Parameters:
    
    fields - New fields value. Default value is null
    
    See Also:
    
    ListGridField, Databinding overview and related methods
  - setFirstColumnTitle
```
public void setFirstColumnTitle(java.lang.String firstColumnTitle)
                         throws java.lang.IllegalStateException
```
    A title for the leftmost column if showHeaders is set (the remaining columns have their titles derived from the item selected in the column to the left). Ignored if showHeaders is not set.
    
    Note: if you do not want a heading for the first column leave this attribute at its default value of " ". If you set it to null or the empty string, Smart GWT will fall back to displaying the field's name in the heading.
    
    Parameters:
    
    firstColumnTitle - New firstColumnTitle value. Default value is " "
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getFirstColumnTitle
```
public java.lang.String getFirstColumnTitle()
```
    A title for the leftmost column if showHeaders is set (the remaining columns have their titles derived from the item selected in the column to the left). Ignored if showHeaders is not set.
    
    Note: if you do not want a heading for the first column leave this attribute at its default value of " ". If you set it to null or the empty string, Smart GWT will fall back to displaying the field's name in the heading.
    
    Returns:
    
    Current firstColumnTitle value. Default value is " "
  - setFolderIcon
```
public void setFolderIcon(java.lang.String folderIcon)
```
    The URL of the base icon for all folder nodes in this columnTree. Note that this URL will have openIconSuffix or closedIconSuffix appended to indicate state changes if appropriate - see documentation on showOpenIcons
    
    Parameters:
    
    folderIcon - New folderIcon value. Default value is "[SKIN]folder.gif"
    
    See Also:
    
    SCImgURL
  - getFolderIcon
```
public java.lang.String getFolderIcon()
```
    The URL of the base icon for all folder nodes in this columnTree. Note that this URL will have openIconSuffix or closedIconSuffix appended to indicate state changes if appropriate - see documentation on showOpenIcons
    
    Returns:
    
    Current folderIcon value. Default value is "[SKIN]folder.gif"
    
    See Also:
    
    SCImgURL
  - setLoadDataOnDemand
```
public void setLoadDataOnDemand(java.lang.Boolean loadDataOnDemand)
                         throws java.lang.IllegalStateException
```
    For databound columnTree instances, should the entire tree of data be loaded on initial fetch, or should each column be loaded as needed. If unset the default ResultTree.loadDataOnDemand setting will be used.
    
    Parameters:
    
    loadDataOnDemand - New loadDataOnDemand value. Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Databinding overview and related methods
  - getLoadDataOnDemand
```
public java.lang.Boolean getLoadDataOnDemand()
```
    For databound columnTree instances, should the entire tree of data be loaded on initial fetch, or should each column be loaded as needed. If unset the default ResultTree.loadDataOnDemand setting will be used.
    
    Returns:
    
    Current loadDataOnDemand value. Default value is null
    
    See Also:
    
    Databinding overview and related methods
  - setNodeIcon
```
public void setNodeIcon(java.lang.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.
    
    Parameters:
    
    nodeIcon - New nodeIcon value. Default value is "[SKIN]file.gif"
    
    See Also:
    
    SCImgURL, Miller Columns Example
  - getNodeIcon
```
public java.lang.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:
    
    Current nodeIcon value. Default value is "[SKIN]file.gif"
    
    See Also:
    
    SCImgURL, Miller Columns Example
  - setOpenIconSuffix
```
public void setOpenIconSuffix(java.lang.String openIconSuffix)
```
    If showOpenIcons is true, this suffix will be appended to the folderIcon for open folders in this grid.
    
    Parameters:
    
    openIconSuffix - New openIconSuffix value. Default value is "open"
  - getOpenIconSuffix
```
public java.lang.String getOpenIconSuffix()
```
    If showOpenIcons is true, this suffix will be appended to the folderIcon for open folders in this grid.
    
    Returns:
    
    Current openIconSuffix value. Default value is "open"
  - setShowCustomIconOpen
```
public void setShowCustomIconOpen(java.lang.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 TreeNode.showOpenIcon and that property can be renamed via TreeGrid.customIconOpenProperty.
    Note : This is an advanced setting
    
    Parameters:
    
    showCustomIconOpen - New showCustomIconOpen value. Default value is false
  - getShowCustomIconOpen
```
public java.lang.Boolean getShowCustomIconOpen()
```
    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 TreeNode.showOpenIcon and that property can be renamed via TreeGrid.customIconOpenProperty.
    
    Returns:
    
    Current showCustomIconOpen value. Default value is false
  - setShowDetailFields
```
public void setShowDetailFields(java.lang.Boolean showDetailFields)
                         throws java.lang.IllegalStateException
```
    Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.
    The detail property is used on DataSource fields to mark fields that shouldn't appear by default in a view that tries to show many records in a small space.
    
    Specified by:
    
    setShowDetailFields in interface DataBoundComponent
    
    Parameters:
    
    showDetailFields - New showDetailFields value. Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
    
    See Also:
    
    Databinding overview and related methods
  - getShowDetailFields
```
public java.lang.Boolean getShowDetailFields()
```
    Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.
    The detail property is used on DataSource fields to mark fields that shouldn't appear by default in a view that tries to show many records in a small space.
    
    Specified by:
    
    getShowDetailFields in interface DataBoundComponent
    
    Returns:
    
    Current showDetailFields value. Default value is true
    
    See Also:
    
    Databinding overview and related methods
  - setShowHeaders
```
public void setShowHeaders(java.lang.Boolean showHeaders)
                    throws java.lang.IllegalStateException
```
    If set, each column in the ColumnTree will show a header with the title of the selected node from the column to the left.
    
    Parameters:
    
    showHeaders - New showHeaders value. Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShowHeaders
```
public java.lang.Boolean getShowHeaders()
```
    If set, each column in the ColumnTree will show a header with the title of the selected node from the column to the left.
    
    Returns:
    
    Current showHeaders value. Default value is false
  - setShowMultipleColumns
```
public void setShowMultipleColumns(java.lang.Boolean showMultipleColumns)
```
    When set to false, only displays a single column at a time, showing a slide animation when moving between columns.
    
    Parameters:
    
    showMultipleColumns - New showMultipleColumns value. Default value is null
  - getShowMultipleColumns
```
public java.lang.Boolean getShowMultipleColumns()
```
    When set to false, only displays a single column at a time, showing a slide animation when moving between columns.
    
    Returns:
    
    Current showMultipleColumns value. Default value is null
  - setShowNodeCount
```
public void setShowNodeCount(java.lang.Boolean showNodeCount)
                      throws java.lang.IllegalStateException
```
    If set, and showHeaders is also set, each column's header will show a count of the number of nodes in that column
    
    Parameters:
    
    showNodeCount - New showNodeCount value. Default value is false
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getShowNodeCount
```
public java.lang.Boolean getShowNodeCount()
```
    If set, and showHeaders is also set, each column's header will show a count of the number of nodes in that column
    
    Returns:
    
    Current showNodeCount value. Default value is false
  - setShowOpenIcons
```
public void setShowOpenIcons(java.lang.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 - New showOpenIcons value. Default value is true
    
    See Also:
    
    Miller Columns Example
  - getShowOpenIcons
```
public java.lang.Boolean getShowOpenIcons()
```
    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.
    
    Returns:
    
    Current showOpenIcons value. Default value is true
    
    See Also:
    
    Miller Columns Example
  - getColumnTitle
```
public void getColumnTitle(TreeNode node,
                           int colNum)
```
    Returns the title to show for the header of indicated column. Only called if shouldShowHeader() returns true for this column.
    By default, returns firstColumnTitle for the first column, and for subsequent columns, the result of this.data.getTitle() called on the node passed to this function.
    
    Parameters:
    
    node - parent node for the nodes to be shown in the column
    
    colNum - index of the column
  - getIcon
```
public java.lang.String getIcon(TreeNode node)
```
    Get the appropriate icon for a node.
    By default icons are derived from folderIcon and nodeIcon. Custom icons for individual nodes can be overridden 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() to the value returned from this method.
    
    Parameters:
    
    node - tree node in question
    
    Returns:
    
    URL for the icon to show for this node. See URL
  - getRecord
```
public TreeNode getRecord(int index)
```
    Retrieve a record by index.
    If colNum is passed, returns the record found in that column at that index, or null if the column doesn't exist or the index is too high.
    With no colNum parameter, a record's index is it's position counting from the first record of the first column and including all records in each column. Note that both index and colNum are zero-based - so the first column is column 0, not column 1.
    
    Parameters:
    
    index - index of record to return.
    
    Returns:
    
    node at the specified index
  - getRecord
```
public TreeNode getRecord(int index,
                          java.lang.Integer colNum)
```
    Retrieve a record by index.
    If colNum is passed, returns the record found in that column at that index, or null if the column doesn't exist or the index is too high.
    With no colNum parameter, a record's index is it's position counting from the first record of the first column and including all records in each column. Note that both index and colNum are zero-based - so the first column is column 0, not column 1.
    
    Parameters:
    
    index - index of record to return.
    
    colNum - optional index of the column
    
    Returns:
    
    node at the specified index
  - getSelectedRecord
```
public Record getSelectedRecord()
```
    Get the selected record, that is, the parent of the nodes in the rightmost visible column.
    This is generally the most recently clicked node unless programmatic navigation has taken place.
    If only the first column is showing, the root node is returned (which can be detected via Tree.isRoot()).
    
    Returns:
    
    the selected record
  - navigateBack
```
public void navigateBack()
```
    Navigate to the previous column.
  - shouldShowHeader
```
public void shouldShowHeader(TreeNode node,
                             int colNum)
```
    Whether the indicated column should show a header. Returns this.showHeaders by default, override for different behavior.
    
    Parameters:
    
    node - parent node for the nodes to be shown in the column
    
    colNum - index of the column
  - setDefaultProperties
```
public static void setDefaultProperties(ColumnTree columnTreeProperties)
```
    Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. 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.
    Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
    
    Parameters:
    
    columnTreeProperties - properties that should be used as new defaults when instances of this class are created
    
    See Also:
    
    SGWTProperties
  - onInit
```
protected void onInit()
```
    Overrides:
    
    onInit in class Layout
  - onInit_ColumnTree
```
protected void onInit_ColumnTree()
```
  - setDropIconSuffix
```
public void setDropIconSuffix(java.lang.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 java.lang.String getDropIconSuffix()
```
    If showDropIcons is true, this suffix will be appended to the folderIcon when the user drop-hovers over some folder.
    
    Returns:
    
    String
  - setShowDropIcons
```
public void setShowDropIcons(java.lang.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
  - getShowDropIcons
```
public java.lang.Boolean getShowDropIcons()
```
    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").
    
    Returns:
    
    Boolean
  - deselectRecord
```
public void deselectRecord(Record record,
                           int colNum)
```
  - deselectRecord
```
public void deselectRecord(int record,
                           int colNum)
```
    Deselect a Record passed in explicitly, or by index.
    Synonym for selectRecord(record, false)
    
    Parameters:
    
    record - row number to deselect
    
    colNum - the column number
  - deselectRecords
```
public void deselectRecords(int[] records,
                            int colNum)
```
    Deselect a list of Records passed in explicitly, or by index.
    Synonym for selectRecords(records, false)
    
    Parameters:
    
    records - records (or row numbers) to deselect
    
    colNum - the col num
  - deselectRecord
```
public void deselectRecord(Record[] records)
```
    Deselect a list of Records passed in explicitly, or by index.
    Synonym for selectRecords(records, false)
    
    Parameters:
    
    records - records (or row numbers) to deselect
  - deselectRecords
```
public void deselectRecords(Record[] records,
                            int colNum)
```
    Deselect a list of Records passed in explicitly, or by index.
    Synonym for selectRecords(records, false)
    
    Parameters:
    
    records - records (or row numbers) to deselect
    
    colNum - the col num
  - selectRecord
```
public void selectRecord(int record,
                         boolean newState,
                         int colNum)
```
    Select/deselect a Record passed in explicitly, or by index.
    
    Parameters:
    
    record - record (or row number) to select
    
    newState - new selection state (if null, defaults to true)
    
    colNum - Column number
  - selectRecord
```
public void selectRecord(Record record,
                         boolean newState,
                         int colNum)
```
    Select/deselect a Record passed in explicitly, or by index.
    
    Parameters:
    
    record - record (or row number) to select
    
    newState - new selection state (if null, defaults to true)
    
    colNum - Column number
  - selectRecords
```
public void selectRecords(int[] records,
                          boolean newState,
                          int colNum)
```
    Select/deselect a list of Records passed in explicitly, or by index.
    
    Parameters:
    
    records - records (or row numbers) to select
    
    newState - new selection state (if null, defaults to true)
    
    colNum - Column number
  - selectRecords
```
public void selectRecords(Record[] records,
                          boolean newState,
                          int colNum)
```
    Select/deselect a list of Records passed in explicitly, or by index.
    
    Parameters:
    
    records - records (or row numbers) to select
    
    newState - new selection state (if null, defaults to true)
    
    colNum - Column number
  - getSelection
```
public ListGridRecord[] getSelection(int colNum)
```
    Returns the array of objects selected in the specified column of the columnTree
    
    Parameters:
    
    colNum - Column within the columnTree to return the selection for
    
    Returns:
    
    (ArrayofListGridRecord) list of records, empty list if nothing selected
  - selectAllRecords
```
public void selectAllRecords(int colNum)
```
    Select all records in the supplied column (the first column if none is passed)
    
    Parameters:
    
    colNum - Column number
  - deselectAllRecords
```
public void deselectAllRecords(int colNum)
```
    Deselect all records in the supplied column (the first column if none is passed)
    
    Parameters:
    
    colNum - Column number
  - anySelected
```
public java.lang.Boolean anySelected(int colNum)
```
    Whether at least one item is selected in the supplied column (the first column if none is passed)
    
    Parameters:
    
    colNum - Column number
    
    Returns:
    
    true == at least one item is selected in the supplied column, false == nothing at all is selected in the supplied column (note that there may be selections in other columns in this columnTree)
  - addNodeSelectedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addNodeSelectedHandler(NodeSelectedHandler handler)
```
    Add a onNodeSelected handler.
    Notification method fired when a node is selected. Return false to suppress default behavior.
    
    Specified by:
    
    addNodeSelectedHandler in interface HasNodeSelectedHandlers
    
    Parameters:
    
    handler - the onNodeSelected handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - setColumnProperties
```
public void setColumnProperties(ListGrid columnProperties)
                         throws java.lang.IllegalStateException
```
    Standard set of properties to apply to each generated column in this columnTree. Developers may also override ColumnTree.getCustomColumnProperties to return dynamic properties based on the node being displayed.
    Note : This is an advanced setting
    
    Parameters:
    
    columnProperties - columnProperties Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getColumnProperties
```
public ListGrid getColumnProperties()
```
    Standard set of properties to apply to each generated column in this columnTree. Developers may also override ColumnTree.getColumnProperties to return dynamic properties based on the node being displayed.
    
    Returns:
    
    "template" listGrid with attributes that will be applied to each generated column
  - getCustomColumnProperties
```
public ListGrid getCustomColumnProperties(TreeNode node,
                                          int colNum)
```
    Additional properties to apply to the ListGrid that will show the indicated column. Returns null by default. This method can be overridden to allow, for example, different styling, icons or row heights per column.
    
    Parameters:
    
    node - parent node for the nodes to be shown in the column
    
    colNum - index of the column
    
    Returns:
    
    "template" listgrid with dynamically determined attributes to apply to the generated column.
  - setDataSource
```
public void setDataSource(DataSource dataSource,
                          ListGridField... fields)
```
    Bind to a DataSource.
    Binding to a DataSource means that the component will use the DataSource to provide default data for its fields.
    When binding to a new DataSource, if the component has any existing "fields" or has a dataset, these will be discarded by default, since it is assumed the new DataSource may represent a completely unrelated set of objects. If the old "fields" are still relevant, pass them to setDataSource().
    
    Parameters:
    
    dataSource -
    
    fields -
  - setDataProperties
```
public void setDataProperties(Tree resultTreeProperties)
```
    For databound ColumnTrees, this attribute can be used to customize the ResultTree object created for this ColumnTree when data is fetched.
    
    Parameters:
    
    resultTreeProperties - the data properties
  - setDataPageSize
```
public void setDataPageSize(int dataPageSize)
```
    Description copied from interface: DataBoundComponent
    
    When using data paging, how many records to fetch at a time. If set to a positive integer, dataPageSize will override the default resultSize for ResultSets automatically created when you call fetchData() (and similarly for the resultSize of ResultTrees). The default of 0 means to just use the default page size of the data container.
    Note that regardless of the dataPageSize setting, a component will always fetch all of data that it needs to draw. Settings such as showAllRecords:true, drawAllMaxCells and drawAheadRatio can cause more rows than the configured dataPageSize to be fetched.
    
    Specified by:
    
    setDataPageSize in interface DataBoundComponent
    
    Parameters:
    
    dataPageSize - dataPageSize Default value is 0
    
    See Also:
    
    Databinding overview and related methods
  - getDataPageSize
```
public int getDataPageSize()
```
    Description copied from interface: DataBoundComponent
    
    When using data paging, how many records to fetch at a time. If set to a positive integer, dataPageSize will override the default resultSize for ResultSets automatically created when you call fetchData() (and similarly for the resultSize of ResultTrees). The default of 0 means to just use the default page size of the data container.
    Note that regardless of the dataPageSize setting, a component will always fetch all of data that it needs to draw. Settings such as showAllRecords:true, drawAllMaxCells and drawAheadRatio can cause more rows than the configured dataPageSize to be fetched.
    
    Specified by:
    
    getDataPageSize in interface DataBoundComponent
    
    Returns:
    
    int
    
    See Also:
    
    Databinding overview and related methods
  - setUseAllDataSourceFields
```
public void setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
```
    Description copied from interface: DataBoundComponent
    
    If true, the set of fields given by the "default binding" (see fields) is used, with any fields specified in component.fields acting as overrides that can suppress or modify the display of individual fields, without having to list the entire set of fields that should be shown.
    If component.fields contains fields that are not found in the DataSource, they will be shown after the most recently referred to DataSource field. If the new fields appear first, they will be shown first.
    
    Specified by:
    
    setUseAllDataSourceFields in interface DataBoundComponent
    
    Parameters:
    
    useAllDataSourceFields - useAllDataSourceFields Default value is false
  - getUseAllDataSourceFields
```
public java.lang.Boolean getUseAllDataSourceFields()
```
    Description copied from interface: DataBoundComponent
    
    If true, the set of fields given by the "default binding" (see fields) is used, with any fields specified in component.fields acting as overrides that can suppress or modify the display of individual fields, without having to list the entire set of fields that should be shown.
    If component.fields contains fields that are not found in the DataSource, they will be shown after the most recently referred to DataSource field. If the new fields appear first, they will be shown first.
    
    Specified by:
    
    getUseAllDataSourceFields in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setShowHiddenFields
```
public void setShowHiddenFields(java.lang.Boolean showHiddenFields)
```
    Description copied from interface: DataBoundComponent
    
    Whether to show fields marked hidden:true when a DataBoundComponent is given a DataSource but no component.fields.
    The hidden property is used on DataSource fields to mark fields that are never of meaning to an end user.
    
    Specified by:
    
    setShowHiddenFields in interface DataBoundComponent
    
    Parameters:
    
    showHiddenFields - showHiddenFields Default value is false
  - getShowHiddenFields
```
public java.lang.Boolean getShowHiddenFields()
```
    Description copied from interface: DataBoundComponent
    
    Whether to show fields marked hidden:true when a DataBoundComponent is given a DataSource but no component.fields.
    The hidden property is used on DataSource fields to mark fields that are never of meaning to an end user.
    
    Specified by:
    
    getShowHiddenFields in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setShowComplexFields
```
public void setShowComplexFields(java.lang.Boolean showComplexFields)
```
    Description copied from interface: DataBoundComponent
    
    Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no component.fields.
    If true, the component will show fields that declare a complex type, for example, a field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a DataSource that declares the fields of a shipping address (city, street name, etc).
    Such fields may need custom formatters or editors in order to create a usable interface, for example, an Address field in a ListGrid might use a custom formatter to combine the relevant fields of an address into one column, and might use a pop-up dialog for editing.
    Note : This is an advanced setting
    
    Specified by:
    
    setShowComplexFields in interface DataBoundComponent
    
    Parameters:
    
    showComplexFields - showComplexFields Default value is true
  - getShowComplexFields
```
public java.lang.Boolean getShowComplexFields()
```
    Description copied from interface: DataBoundComponent
    
    Whether to show fields of non-atomic types when a DataBoundComponent is given a DataSource but no component.fields.
    If true, the component will show fields that declare a complex type, for example, a field 'shippingAddress' that declares type 'Address', where 'Address' is the ID of a DataSource that declares the fields of a shipping address (city, street name, etc).
    Such fields may need custom formatters or editors in order to create a usable interface, for example, an Address field in a ListGrid might use a custom formatter to combine the relevant fields of an address into one column, and might use a pop-up dialog for editing.
    
    Specified by:
    
    getShowComplexFields in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setFetchOperation
```
public void setFetchOperation(java.lang.String fetchOperation)
```
    Description copied from interface: DataBoundComponent
    
    Operation ID this component should use when performing fetch operations.
    
    Specified by:
    
    setFetchOperation in interface DataBoundComponent
    
    Parameters:
    
    fetchOperation - fetchOperation Default value is null
  - getFetchOperation
```
public java.lang.String getFetchOperation()
```
    Description copied from interface: DataBoundComponent
    
    Operation ID this component should use when performing fetch operations.
    
    Specified by:
    
    getFetchOperation in interface DataBoundComponent
    
    Returns:
    
    String
  - setUpdateOperation
```
public void setUpdateOperation(java.lang.String updateOperation)
```
    Description copied from interface: DataBoundComponent
    
    operationId this component should use when performing update operations.
    
    Specified by:
    
    setUpdateOperation in interface DataBoundComponent
    
    Parameters:
    
    updateOperation - Default value is null
    
    See Also:
    
    Operations overview and related methods
  - getUpdateOperation
```
public java.lang.String getUpdateOperation()
```
    Description copied from interface: DataBoundComponent
    
    operationId this component should use when performing update operations.
    
    Specified by:
    
    getUpdateOperation in interface DataBoundComponent
    
    Returns:
    
    String
    
    See Also:
    
    Operations overview and related methods
  - setAddOperation
```
public void setAddOperation(java.lang.String addOperation)
```
    Description copied from interface: DataBoundComponent
    
    operationId this component should use when performing add operations.
    
    Specified by:
    
    setAddOperation in interface DataBoundComponent
    
    Parameters:
    
    addOperation - Default value is null
    
    See Also:
    
    Operations overview and related methods
  - getAddOperation
```
public java.lang.String getAddOperation()
```
    Description copied from interface: DataBoundComponent
    
    operationId this component should use when performing add operations.
    
    Specified by:
    
    getAddOperation in interface DataBoundComponent
    
    Returns:
    
    String
    
    See Also:
    
    Operations overview and related methods
  - setRemoveOperation
```
public void setRemoveOperation(java.lang.String removeOperation)
```
    Description copied from interface: DataBoundComponent
    
    operationId this component should use when performing remove operations.
    
    Specified by:
    
    setRemoveOperation in interface DataBoundComponent
    
    Parameters:
    
    removeOperation - Default value is null
    
    See Also:
    
    Operations overview and related methods
  - getRemoveOperation
```
public java.lang.String getRemoveOperation()
```
    Description copied from interface: DataBoundComponent
    
    operationId this component should use when performing remove operations.
    
    Specified by:
    
    getRemoveOperation in interface DataBoundComponent
    
    Returns:
    
    String
    
    See Also:
    
    Operations overview and related methods
  - setExportFields
```
public void setExportFields(java.lang.String[] exportFields)
```
    Description copied from interface: DataBoundComponent
    
    The list of field-names to export. If provided, the field-list in the exported output is limited and sorted as per the list.
    If exportFields is not provided, the exported output includes all visible fields from this component, sorted as they appear.
    
    Specified by:
    
    setExportFields in interface DataBoundComponent
    
    Parameters:
    
    exportFields - exportFields Default value is null
  - getExportFields
```
public java.lang.String[] getExportFields()
```
    Description copied from interface: DataBoundComponent
    
    The list of field-names to export. If provided, the field-list in the exported output is limited and sorted as per the list.
    If exportFields is not provided, the exported output includes all visible fields from this component, sorted as they appear.
    
    Specified by:
    
    getExportFields in interface DataBoundComponent
    
    Returns:
    
    the list of field-names to export.
  - setExportAll
```
public void setExportAll(java.lang.Boolean exportAll)
```
    Description copied from interface: DataBoundComponent
    
    Setting exportAll to true prevents the component from passing its list of fields to the export call. The result is the export of all visible fields from fields.
    If exportAll is false, an export operation will first consider exportFields, if it's set, and fall back on all visible fields from fields otherwise.
    
    Specified by:
    
    setExportAll in interface DataBoundComponent
    
    Parameters:
    
    exportAll - exportAll Default value is false
  - getExportAll
```
public java.lang.Boolean getExportAll()
```
    Description copied from interface: DataBoundComponent
    
    Setting exportAll to true prevents the component from passing its list of fields to the export call. The result is the export of all visible fields from fields.
    If exportAll is false, an export operation will first consider exportFields, if it's set, and fall back on all visible fields from fields otherwise.
    
    Specified by:
    
    getExportAll in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setExportIncludeSummaries
```
public void setExportIncludeSummaries(java.lang.Boolean exportIncludeSummaries)
```
    Description copied from interface: DataBoundComponent
    
    If Summary rows exist for this component, whether to include them when exporting client data. Defaults to true if not set
    
    Specified by:
    
    setExportIncludeSummaries in interface DataBoundComponent
    
    Parameters:
    
    exportIncludeSummaries - exportIncludeSummaries Default value is true
  - getExportIncludeSummaries
```
public java.lang.Boolean getExportIncludeSummaries()
```
    Description copied from interface: DataBoundComponent
    
    If Summary rows exist for this component, whether to include them when exporting client data. Defaults to true if not set
    
    Specified by:
    
    getExportIncludeSummaries in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setPreventDuplicates
```
public void setPreventDuplicates(java.lang.Boolean preventDuplicates)
                          throws java.lang.IllegalStateException
```
    Description copied from interface: DataBoundComponent
    
    If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). When a duplicate transfer is detected, a dialog will appear showing the duplicateDragMessage.
    If the component either does not have a DataSource or has a DataSource with no primaryKey declared, duplicate checking is off by default. If duplicate checking is enabled, it looks for an existing record in the dataset that has all of the properties of the dragged record, and considers that a duplicate.
    For DragDataAction:"copy" where the target DataSource is related to the source DataSource by foreignKey, a duplicate means that the target list, as filtered by the current criteria, already has a record whose value for the foreignKey field matches the primaryKey of the record being transferred.
    For example, consider dragging "employees" to "teams", where "teams" has a field "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target grid has search criteria causing it to show all the members of one team. A duplicate - adding an employee to the same team twice - is when the target grid's dataset contains an record with "employeeId" matching the "id" field of the dropped employee.
    
    Specified by:
    
    setPreventDuplicates in interface DataBoundComponent
    
    Parameters:
    
    preventDuplicates - preventDuplicates Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getPreventDuplicates
```
public java.lang.Boolean getPreventDuplicates()
```
    Description copied from interface: DataBoundComponent
    
    If set, detect and prevent duplicate records from being transferred to this component, either via drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent). When a duplicate transfer is detected, a dialog will appear showing the duplicateDragMessage.
    If the component either does not have a DataSource or has a DataSource with no primaryKey declared, duplicate checking is off by default. If duplicate checking is enabled, it looks for an existing record in the dataset that has all of the properties of the dragged record, and considers that a duplicate.
    For DragDataAction:"copy" where the target DataSource is related to the source DataSource by foreignKey, a duplicate means that the target list, as filtered by the current criteria, already has a record whose value for the foreignKey field matches the primaryKey of the record being transferred.
    For example, consider dragging "employees" to "teams", where "teams" has a field "teams.employeeId" which is a foreignKey pointing to "employees.id", and the target grid has search criteria causing it to show all the members of one team. A duplicate - adding an employee to the same team twice - is when the target grid's dataset contains an record with "employeeId" matching the "id" field of the dropped employee.
    
    Specified by:
    
    getPreventDuplicates in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setDuplicateDragMessage
```
public void setDuplicateDragMessage(java.lang.String duplicateDragMessage)
                             throws java.lang.IllegalStateException
```
    Description copied from interface: DataBoundComponent
    
    Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.
    
    Specified by:
    
    setDuplicateDragMessage in interface DataBoundComponent
    
    Parameters:
    
    duplicateDragMessage - duplicateDragMessage Default value is "Duplicates not allowed"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getDuplicateDragMessage
```
public java.lang.String getDuplicateDragMessage()
```
    Description copied from interface: DataBoundComponent
    
    Message to show when a user attempts to transfer duplicate records into this component, and preventDuplicates is enabled. If set to null, duplicates will not be reported and the dragged duplicates will not be saved.
    
    Specified by:
    
    getDuplicateDragMessage in interface DataBoundComponent
    
    Returns:
    
    String
  - setAddDropValues
```
public void setAddDropValues(java.lang.Boolean addDropValues)
```
    Description copied from interface: DataBoundComponent
    
    Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key. "Drop values" are properties of the dropped item that you wish to change (and persist) as a result of the item being dropped on this grid.
    If this value is true and this component is databound, DataBoundComponent.getDropValues() will be called for every databound item dropped on this grid, and an update performed on the item
    
    Specified by:
    
    setAddDropValues in interface DataBoundComponent
    
    Parameters:
    
    addDropValues - addDropValues Default value is true
  - getAddDropValues
```
public java.lang.Boolean getAddDropValues()
```
    Description copied from interface: DataBoundComponent
    
    Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key. "Drop values" are properties of the dropped item that you wish to change (and persist) as a result of the item being dropped on this grid.
    If this value is true and this component is databound, DataBoundComponent.getDropValues() will be called for every databound item dropped on this grid, and an update performed on the item
    
    Specified by:
    
    getAddDropValues in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setDropValues
```
public void setDropValues(java.util.Map dropValues)
```
    Description copied from interface: DataBoundComponent
    
    When an item is dropped on this component, and addDropValues is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.
    If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
    Note : This is an advanced setting
    
    Specified by:
    
    setDropValues in interface DataBoundComponent
    
    Parameters:
    
    dropValues - dropValues Default value is null
  - getDropValues
```
public java.util.Map getDropValues()
```
    Description copied from interface: DataBoundComponent
    
    When an item is dropped on this component, and addDropValues is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.
    If this property is not defined, Smart GWT defaults to returning the selection criteria currently in place for this component. Thus, any databound items (for example, rows from other grids bound to the same DataSource) dropped on the grid will, by default, be subjected to an update that makes them conform to the grid's current filter criteria.
    Note : This is an advanced setting
    Specified by:
    
    getDropValues in interface DataBoundComponent
    
    Returns:
    Returns the "drop values" to apply to a record dropped on this component prior to update. Only applicable to databound components - see dropValues for more details. If multiple records are being dropped, this method is called for each of them in turn.
    This method returns the following:
    
    Nothing, if addDropValues is false
    
    dropValues, if that property is set. If the component's criteria object is applicable (as explained in the next item), it is merged into dropValues, with properties in dropValues taking precedence.
    
    The component's criteria object, if the most recent textMatchStyle for the component was "exact" and it is simple criteria (ie, not an AdvancedCriteria object)
    
    Otherwise nothing
    
    You can override this method if you need more complex setting of drop values than can be provided by simply supplying a dropValues object.
  - setProgressiveLoading
```
public void setProgressiveLoading(java.lang.Boolean progressiveLoading)
```
    Indicates whether or not this component will load its data progressively
    
    Parameters:
    
    progressiveLoading -
    
    See Also:
    
    ProgressiveLoading, DataSource.setProgressiveLoading(java.lang.Boolean)
  - getProgressiveLoading
```
public java.lang.Boolean getProgressiveLoading()
```
    Indicates whether or not this component will load its data progressively
    
    Returns:
    
    See Also:
    
    ProgressiveLoading, DataSource.getProgressiveLoading()
  - setUseFlatFields
```
public void setUseFlatFields(java.lang.Boolean useFlatFields)
                      throws java.lang.IllegalStateException
```
    Description copied from interface: DataBoundComponent
    The useFlatFields flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.
    useFlatFields is typically used with imported metadata, such as XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback) from a XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML nesting that aren't meaningful in a user interface, without the cumbersome and fragile process of mapping form fields to XML structures.
    For example, having called WebService.getInputDS(java.lang.String) to retrieve the input message schema for a web service operation whose input message looks like this:
```
 <FindServices>
     <searchFor>search text</searchFor>
     <Options>
         <caseSensitive>false</caseSensitive>
     </Options>
     <IncludeInSearch>
         <serviceName>true</serviceName>
         <documentation>true</documentation>
         <keywords>true</keywords>
     </IncludeInSearch>
 </FindServices>
 
```
    Setting useFlatFields on a DynamicForm that is bound to this input message schema would result in 5 FormItem reflecting the 5 simple type fields in the message.
    For this form, the result of DynamicForm.getValues() might look like:
```
{
    searchFor: "search text",
    caseSensitive: false,
    serviceName: true,
    documentation : true,
    keywords : true
 }
```
    When contacting a WebService, these values can be automatically mapped to the structure of the input message for a web service operation by setting useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting useFlatFields (for use with a DataSource that is 'bound to a WSDL web service' via wsOperation).
    Using these two facilities in conjunction (component.useFlatFields and request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user presentation and when providing the data for XML messages.
    You can also set useFlatFields to automatically enable "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a particular operationType.
    Note that useFlatFields is not generally recommended for use with structures where multiple simple type fields exist with the same name, however if used with such a structure, the first field to use a given name wins. "first" means the first field encountered in a depth first search. "wins" means only the first field will be present as a field when data binding.
    Specified by:
    
    setUseFlatFields in interface DataBoundComponent
    
    Parameters:
    
    useFlatFields - useFlatFields Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getUseFlatFields
```
public java.lang.Boolean getUseFlatFields()
```
    Description copied from interface: DataBoundComponent
    The useFlatFields flag causes all simple type fields anywhere in a nested set of DataSources to be exposed as a flat list for form binding.
    useFlatFields is typically used with imported metadata, such as XMLTools.loadXMLSchema(java.lang.String, com.smartgwt.client.data.XSDLoadCallback) from a XMLTools.loadWSDL(java.lang.String, com.smartgwt.client.data.WSDLLoadCallback), as a means of eliminating levels of XML nesting that aren't meaningful in a user interface, without the cumbersome and fragile process of mapping form fields to XML structures.
    For example, having called WebService.getInputDS(java.lang.String) to retrieve the input message schema for a web service operation whose input message looks like this:
```
 <FindServices>
     <searchFor>search text</searchFor>
     <Options>
         <caseSensitive>false</caseSensitive>
     </Options>
     <IncludeInSearch>
         <serviceName>true</serviceName>
         <documentation>true</documentation>
         <keywords>true</keywords>
     </IncludeInSearch>
 </FindServices>
 
```
    Setting useFlatFields on a DynamicForm that is bound to this input message schema would result in 5 FormItem reflecting the 5 simple type fields in the message.
    For this form, the result of DynamicForm.getValues() might look like:
```
{
    searchFor: "search text",
    caseSensitive: false,
    serviceName: true,
    documentation : true,
    keywords : true
 }
```
    When contacting a WebService, these values can be automatically mapped to the structure of the input message for a web service operation by setting useFlatFields (for use with WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback)) or by setting useFlatFields (for use with a DataSource that is 'bound to a WSDL web service' via wsOperation).
    Using these two facilities in conjunction (component.useFlatFields and request.useFlatFields) allows gratuitous nesting to be consistently bypassed in both the user presentation and when providing the data for XML messages.
    You can also set useFlatFields to automatically enable "flattened" XML serialization (request.useFlatFields) for all DataSource requests of a particular operationType.
    Note that useFlatFields is not generally recommended for use with structures where multiple simple type fields exist with the same name, however if used with such a structure, the first field to use a given name wins. "first" means the first field encountered in a depth first search. "wins" means only the first field will be present as a field when data binding.
    Specified by:
    
    getUseFlatFields in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setHiliteProperty
```
public void setHiliteProperty(java.lang.String hiliteProperty)
```
    Description copied from interface: DataBoundComponent
    
    Marker that can be set on a record to flag that record as hilited. Should be set to a value that matches id for a hilite defined on this component.
    
    Specified by:
    
    setHiliteProperty in interface DataBoundComponent
    
    Parameters:
    
    hiliteProperty - hiliteProperty Default value is "_hilite"
  - getHiliteProperty
```
public java.lang.String getHiliteProperty()
```
    Description copied from interface: DataBoundComponent
    
    Marker that can be set on a record to flag that record as hilited. Should be set to a value that matches id for a hilite defined on this component.
    
    Specified by:
    
    getHiliteProperty in interface DataBoundComponent
    
    Returns:
    
    String
  - editFields
```
public void editFields()
```
    Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent.
  - editHilites
```
public void editHilites()
```
    Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.
    
    Specified by:
    
    editHilites in interface DataBoundComponent
  - getHiliteState
```
public java.lang.String getHiliteState()
```
    Get the current hilites encoded as a String, for saving.
    
    Specified by:
    
    getHiliteState in interface DataBoundComponent
    
    Returns:
    
    the hilite state
  - setHiliteState
```
public void setHiliteState(java.lang.String hiliteState)
```
    Set the current hilites based on a hiliteState String previously returned from getHilitesState.
    
    Specified by:
    
    setHiliteState in interface DataBoundComponent
    
    Parameters:
    
    hiliteState - hilites state encoded as a String
  - setHilites
```
public void setHilites(Hilite[] hilites)
```
    Accepts an array of hilite objects and applies them to this DataBoundComponent. See also getHilites for a method of retrieving the hilite array for storage, including hilites manually added by the user.
    
    Specified by:
    
    setHilites in interface DataBoundComponent
    
    Parameters:
    
    hilites - array of hilite objects
  - getHilites
```
public Hilite[] getHilites()
```
    Return the set of hilite-objects currently applied to this DataBoundComponent. These can be saved for storage and then restored to a component later via setHilites().
    
    Specified by:
    
    getHilites in interface DataBoundComponent
    
    Returns:
    
    array of hilite objects
  - setDragDataAction
```
public void setDragDataAction(DragDataAction dragDataAction)
```
    Description copied from interface: DataBoundComponent
    
    Indicates what to do with data dragged into another DataBoundComponent. See DragDataAction type for details.
    
    Specified by:
    
    setDragDataAction in interface DataBoundComponent
    
    Parameters:
    
    dragDataAction - dragDataAction Default value is Canvas.MOVE
  - getDragDataAction
```
public DragDataAction getDragDataAction()
```
    Description copied from interface: DataBoundComponent
    
    Indicates what to do with data dragged into another DataBoundComponent. See DragDataAction type for details.
    
    Specified by:
    
    getDragDataAction in interface DataBoundComponent
    
    Returns:
    
    DragDataAction
  - setDragTrackerStyle
```
public void setDragTrackerStyle(java.lang.String dragTrackerStyle)
```
    Description copied from interface: DataBoundComponent
    
    CSS Style to apply to the drag tracker when dragging occurs on this component.
    
    Specified by:
    
    setDragTrackerStyle in interface DataBoundComponent
    
    Parameters:
    
    dragTrackerStyle - dragTrackerStyle Default value is "gridDragTracker"
  - getDragTrackerStyle
```
public java.lang.String getDragTrackerStyle()
```
    Description copied from interface: DataBoundComponent
    
    CSS Style to apply to the drag tracker when dragging occurs on this component.
    
    Specified by:
    
    getDragTrackerStyle in interface DataBoundComponent
    
    Returns:
    
    String
  - setCanAddFormulaFields
```
public void setCanAddFormulaFields(java.lang.Boolean canAddFormulaFields)
```
    Description copied from interface: DataBoundComponent
    
    Adds an item to the header context menu allowing users to launch a dialog to define a new field based on values present in other fields, using the com.smartgwt.client..FormulaBuilder.
    User-added formula fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).
    
    Specified by:
    
    setCanAddFormulaFields in interface DataBoundComponent
    
    Parameters:
    
    canAddFormulaFields - canAddFormulaFields Default value is false
  - addSummaryField
```
public void addSummaryField()
```
    Description copied from interface: DataBoundComponent
    
    Convenience method to display a com.smartgwt.client..SummaryBuilder to create a new Summary Field. This is equivalent to calling DataBoundComponentGen#editSummaryField with no parameter.
    
    Specified by:
    
    addSummaryField in interface DataBoundComponent
  - addFormulaField
```
public void addFormulaField()
```
    Description copied from interface: DataBoundComponent
    
    Convenience method to display a com.smartgwt.client..FormulaBuilder to create a new Formula Field. This is equivalent to calling DataBoundComponentGen#editFormulaField with no parameter.
    
    Specified by:
    
    addFormulaField in interface DataBoundComponent
  - getCanAddFormulaFields
```
public java.lang.Boolean getCanAddFormulaFields()
```
    Description copied from interface: DataBoundComponent
    
    Adds an item to the header context menu allowing users to launch a dialog to define a new field based on values present in other fields, using the com.smartgwt.client..FormulaBuilder.
    User-added formula fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).
    
    Specified by:
    
    getCanAddFormulaFields in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setAddFormulaFieldText
```
public void setAddFormulaFieldText(java.lang.String addFormulaFieldText)
```
    Description copied from interface: DataBoundComponent
    
    Text for a menu item allowing users to add a formula field
    
    Specified by:
    
    setAddFormulaFieldText in interface DataBoundComponent
    
    Parameters:
    
    addFormulaFieldText - addFormulaFieldText Default value is "Add formula column..."
  - getAddFormulaFieldText
```
public java.lang.String getAddFormulaFieldText()
```
    Description copied from interface: DataBoundComponent
    
    Text for a menu item allowing users to add a formula field
    
    Specified by:
    
    getAddFormulaFieldText in interface DataBoundComponent
    
    Returns:
    
    String
  - setEditFormulaFieldText
```
public void setEditFormulaFieldText(java.lang.String editFormulaFieldText)
```
    Description copied from interface: DataBoundComponent
    
    Text for a menu item allowing users to edit a formula field
    
    Specified by:
    
    setEditFormulaFieldText in interface DataBoundComponent
    
    Parameters:
    
    editFormulaFieldText - editFormulaFieldText Default value is "Edit formula..."
  - getEditFormulaFieldText
```
public java.lang.String getEditFormulaFieldText()
```
    Description copied from interface: DataBoundComponent
    
    Text for a menu item allowing users to edit a formula field
    
    Specified by:
    
    getEditFormulaFieldText in interface DataBoundComponent
    
    Returns:
    
    String
  - setCanAddSummaryFields
```
public void setCanAddSummaryFields(java.lang.Boolean canAddSummaryFields)
```
    Description copied from interface: DataBoundComponent
    
    Adds an item to the header context menu allowing users to launch a dialog to define a new text field that can contain both user-defined text and the formatted values present in other fields, using the com.smartgwt.client..SummaryBuilder.
    User-added summary fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).
    
    Specified by:
    
    setCanAddSummaryFields in interface DataBoundComponent
    
    Parameters:
    
    canAddSummaryFields - canAddSummaryFields Default value is false
  - getCanAddSummaryFields
```
public java.lang.Boolean getCanAddSummaryFields()
```
    Description copied from interface: DataBoundComponent
    
    Adds an item to the header context menu allowing users to launch a dialog to define a new text field that can contain both user-defined text and the formatted values present in other fields, using the com.smartgwt.client..SummaryBuilder.
    User-added summary fields can be persisted via ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String).
    
    Specified by:
    
    getCanAddSummaryFields in interface DataBoundComponent
    
    Returns:
    
    Boolean
  - setAddSummaryFieldText
```
public void setAddSummaryFieldText(java.lang.String addSummaryFieldText)
```
    Description copied from interface: DataBoundComponent
    
    Text for a menu item allowing users to add a formula field
    
    Specified by:
    
    setAddSummaryFieldText in interface DataBoundComponent
    
    Parameters:
    
    addSummaryFieldText - addSummaryFieldText Default value is "Add summary column..."
  - getAddSummaryFieldText
```
public java.lang.String getAddSummaryFieldText()
```
    Description copied from interface: DataBoundComponent
    
    Text for a menu item allowing users to add a formula field
    
    Specified by:
    
    getAddSummaryFieldText in interface DataBoundComponent
    
    Returns:
    
    String
  - setEditSummaryFieldText
```
public void setEditSummaryFieldText(java.lang.String editSummaryFieldText)
```
    Description copied from interface: DataBoundComponent
    
    Text for a menu item allowing users to edit the formatter for a field
    
    Specified by:
    
    setEditSummaryFieldText in interface DataBoundComponent
    
    Parameters:
    
    editSummaryFieldText - editSummaryFieldText Default value is "Edit summary format..."
  - getEditSummaryFieldText
```
public java.lang.String getEditSummaryFieldText()
```
    Description copied from interface: DataBoundComponent
    
    Text for a menu item allowing users to edit the formatter for a field
    
    Specified by:
    
    getEditSummaryFieldText in interface DataBoundComponent
    
    Returns:
    
    String
  - findAll
```
public Record[] findAll(AdvancedCriteria adCriteria)
```
    Filters all objects according to the AdvancedCriteria passed
    
    Parameters:
    
    adCriteria - AdvancedCriteria to use to filter results
    
    Returns:
    
    all matching Objects or null if none found
  - find
```
public Record find(AdvancedCriteria adCriteria)
```
    Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not found
    
    Parameters:
    
    adCriteria - AdvancedCriteria to use to filter results
    
    Returns:
    
    first matching object or null if not found
  - findIndex
```
public int findIndex(AdvancedCriteria adCriteria)
```
    Finds the index of the first Record that matches with the AdvacendCriteria passed.
    
    Parameters:
    
    adCriteria - AdvancedCriteria to use to filter results
    
    Returns:
    
    index of the first matching Record or -1 if not found
  - findNextIndex
```
public int findNextIndex(int startIndex,
                         AdvancedCriteria adCriteria,
                         int endIndex)
```
    Like RecordList.findIndex(java.util.Map), but considering the startIndex and endIndex parameters.
    
    Parameters:
    
    startIndex - first index to consider
    
    adCriteria - AdvancedCriteria to use to filter results
    
    endIndex - last index to consider
    
    Returns:
    
    index of the first matching Record or -1 if not found
  - findNextIndex
```
public int findNextIndex(int startIndex,
                         AdvancedCriteria adCriteria)
```
    Like RecordList.findIndex(java.util.Map), but considering the startIndex parameter.
    
    Parameters:
    
    startIndex - first index to consider
    
    adCriteria - AdvancedCriteria to use to filter results
    
    Returns:
    
    index of the first matching Record or -1 if not found
  - selectRecord
```
public void selectRecord(Record record)
```
    Description copied from interface: DataBoundComponent
    
    Select/deselect a Record passed in explicitly, or by index.
    
    Specified by:
    
    selectRecord in interface DataBoundComponent
    
    Parameters:
    
    record - record (or row number) to select
  - selectRecord
```
public void selectRecord(int record)
```
    Description copied from interface: DataBoundComponent
    
    Select/deselect a Record passed in explicitly, or by index.
    
    Specified by:
    
    selectRecord in interface DataBoundComponent
    
    Parameters:
    
    record - record (or row number) to select
  - selectRecord
```
public void selectRecord(int record,
                         boolean newState)
```
    Description copied from interface: DataBoundComponent
    
    Select/deselect a Record passed in explicitly, or by index.
    
    Specified by:
    
    selectRecord in interface DataBoundComponent
    
    Parameters:
    
    record - record (or row number) to select
    
    newState - new selection state (if null, defaults to true)
  - selectRecord
```
public void selectRecord(Record record,
                         boolean newState)
```
    Description copied from interface: DataBoundComponent
    
    Select/deselect a Record passed in explicitly, or by index.
    
    Specified by:
    
    selectRecord in interface DataBoundComponent
    
    Parameters:
    
    record - record (or row number) to select
    
    newState - new selection state (if null, defaults to true)
  - selectRecords
```
public void selectRecords(int[] records)
```
    Description copied from interface: DataBoundComponent
    
    Select/deselect a list of Records passed in explicitly, or by index.
    
    Specified by:
    
    selectRecords in interface DataBoundComponent
    
    Parameters:
    
    records - records (or row numbers) to select
  - selectRecords
```
public void selectRecords(int[] records,
                          boolean newState)
```
    Description copied from interface: DataBoundComponent
    
    Select/deselect a list of Records passed in explicitly, or by index.
    
    Specified by:
    
    selectRecords in interface DataBoundComponent
    
    Parameters:
    
    records - records (or row numbers) to select
    
    newState - new selection state
  - selectRecords
```
public void selectRecords(Record[] records)
```
    Description copied from interface: DataBoundComponent
    
    Select/deselect a list of Records passed in explicitly, or by index.
    
    Specified by:
    
    selectRecords in interface DataBoundComponent
    
    Parameters:
    
    records - records (or row numbers) to select
  - selectRecords
```
public void selectRecords(Record[] records,
                          boolean newState)
```
    Description copied from interface: DataBoundComponent
    
    Select/deselect a list of Records passed in explicitly, or by index.
    
    Specified by:
    
    selectRecords in interface DataBoundComponent
    
    Parameters:
    
    records - records (or row numbers) to select
    
    newState - new selection state (if null, defaults to true)
  - deselectRecord
```
public void deselectRecord(Record record)
```
    Description copied from interface: DataBoundComponent
    
    Deselect a Record passed in explicitly, or by index.
    Synonym for selectRecord(record, false)
    
    Specified by:
    
    deselectRecord in interface DataBoundComponent
    
    Parameters:
    
    record - record (or row number) to deselect
  - deselectRecord
```
public void deselectRecord(int record)
```
    Description copied from interface: DataBoundComponent
    
    Deselect a Record passed in explicitly, or by index.
    Synonym for selectRecord(record, false)
    
    Specified by:
    
    deselectRecord in interface DataBoundComponent
    
    Parameters:
    
    record - record (or row number) to deselect
  - deselectRecords
```
public void deselectRecords(int[] records)
```
    Description copied from interface: DataBoundComponent
    
    Deselect a list of Records passed in explicitly, or by index.
    Synonym for selectRecords(records, false)
    
    Specified by:
    
    deselectRecords in interface DataBoundComponent
    
    Parameters:
    
    records - records (or row numbers) to deselect
  - deselectRecords
```
public void deselectRecords(Record[] records)
```
    Description copied from interface: DataBoundComponent
    
    Deselect a list of Records passed in explicitly, or by index.
    Synonym for selectRecords(records, false)
    
    Specified by:
    
    deselectRecords in interface DataBoundComponent
    
    Parameters:
    
    records - records (or row numbers) to deselect
  - selectAllRecords
```
public void selectAllRecords()
```
    Description copied from interface: DataBoundComponent
    
    Select all records
    
    Specified by:
    
    selectAllRecords in interface DataBoundComponent
  - deselectAllRecords
```
public void deselectAllRecords()
```
    Description copied from interface: DataBoundComponent
    
    Deselect all records
    
    Specified by:
    
    deselectAllRecords in interface DataBoundComponent
  - anySelected
```
public java.lang.Boolean anySelected()
```
    Description copied from interface: DataBoundComponent
    
    Whether at least one item is selected
    
    Specified by:
    
    anySelected in interface DataBoundComponent
    
    Returns:
    
    true == at least one item is selected false == nothing at all is selected
  - enableHilite
```
public void enableHilite(java.lang.String hiliteID)
```
    Description copied from interface: DataBoundComponent
    
    Enable / disable a hilites
    
    Specified by:
    
    enableHilite in interface DataBoundComponent
    
    Parameters:
    
    hiliteID - ID of hilite to enable
  - enableHilite
```
public void enableHilite(java.lang.String hiliteID,
                         boolean enable)
```
    Description copied from interface: DataBoundComponent
    
    Enable / disable a hilites
    
    Specified by:
    
    enableHilite in interface DataBoundComponent
    
    Parameters:
    
    hiliteID - ID of hilite to enable
    
    enable - new enabled state to apply - if null, defaults to true
  - disableHilite
```
public void disableHilite(java.lang.String hiliteID)
```
    Description copied from interface: DataBoundComponent
    
    Disable a hilite
    
    Specified by:
    
    disableHilite in interface DataBoundComponent
    
    Parameters:
    
    hiliteID - ID of hilite to disable
  - enableHiliting
```
public void enableHiliting()
```
    Description copied from interface: DataBoundComponent
    
    Enable all hilites.
    
    Specified by:
    
    enableHiliting in interface DataBoundComponent
  - enableHiliting
```
public void enableHiliting(boolean enable)
```
    Description copied from interface: DataBoundComponent
    
    Enable all hilites.
    
    Specified by:
    
    enableHiliting in interface DataBoundComponent
    
    Parameters:
    
    enable - new enabled state to apply - if null, defaults to true
  - disableHiliting
```
public void disableHiliting()
```
    Description copied from interface: DataBoundComponent
    
    Disable all hilites.
    
    Specified by:
    
    disableHiliting in interface DataBoundComponent
  - getDragData
```
public Record[] getDragData()
```
    Description copied from interface: DataBoundComponent
    
    During a drag-and-drop interaction, this method returns the set of records being dragged out of the component. In the default implementation, this is the list of currently selected records.
    This method is consulted by ListGrid.willAcceptDrop().
    
    Specified by:
    
    getDragData in interface DataBoundComponent
    
    Returns:
    
    Array of Records that are currently selected.
  - transferSelectedData
```
public void transferSelectedData(DataBoundComponent source)
```
    Description copied from interface: DataBoundComponent
    
    Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction. This method acts on the dropped records exactly as if they had been dropped in an actual drag / drop interaction, including any special databound behavior invoked by calling DataBoundComponent.getDropValues() for each dropped record.
    To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.
    Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether dropped records already exist in the target component. Therefore, it is possible to issue a call to transferSelectedData() and/or the drop() method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs them one after the other. If you want to be notified when a transfer process has actually completed, use addDropCompleteHandler. See the Dragging documentation for an overview of list grid drag/drop data transfer.
    
    Specified by:
    
    transferSelectedData in interface DataBoundComponent
    
    Parameters:
    
    source - source component from which the records will be tranferred
  - transferSelectedData
```
public void transferSelectedData(DataBoundComponent source,
                                 int index)
```
    Description copied from interface: DataBoundComponent
    
    Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction. This method acts on the dropped records exactly as if they had been dropped in an actual drag / drop interaction, including any special databound behavior invoked by calling DataBoundComponent.getDropValues() for each dropped record.
    To transfer all data in, for example, a ListGrid, call grid.selection.selectAll() first.
    Note that drag/drop type transfers of records between components are asynchronous operations: Smart GWT may need to perform server turnarounds to establish whether dropped records already exist in the target component. Therefore, it is possible to issue a call to transferSelectedData() and/or the drop() method of a databound component whilst a transfer is still active. When this happens, Smart GWT adds the second and subsequent transfer requests to a queue and runs them one after the other. If you want to be notified when a transfer process has actually completed, use addDropCompleteHandler. See the Dragging documentation for an overview of list grid drag/drop data transfer.
    
    Specified by:
    
    transferSelectedData in interface DataBoundComponent
    
    Parameters:
    
    source - source component from which the records will be transferred
    
    index - target index (drop position) of the rows within this grid.
  - getRecordIndex
```
public int getRecordIndex(Record record)
```
    Description copied from interface: DataBoundComponent
    
    Get the index of the provided record.
    Override in subclasses to provide more specific behaviour, for instance, when data holds a large number of records
    
    Specified by:
    
    getRecordIndex in interface DataBoundComponent
    
    Parameters:
    
    record - the record whose index is to be retrieved
    
    Returns:
    
    indexindex of the record, or -1 if not found
  - getTitleFieldValue
```
public java.lang.String getTitleFieldValue(Record record)
```
    Description copied from interface: DataBoundComponent
    
    Get the value of the titleField for the passed record
    Override in subclasses
    
    Specified by:
    
    getTitleFieldValue in interface DataBoundComponent
    
    Parameters:
    
    record - the record whose index is to be retrieved
    
    Returns:
    
    valuethe value of the titleField for the passed record
  - setTitleField
```
public void setTitleField(java.lang.String titleField)
```
    Description copied from interface: DataBoundComponent
    
    Sets the best field to use for a user-visible title for an individual record from this component.
    
    Specified by:
    
    setTitleField in interface DataBoundComponent
  - getTitleField
```
public java.lang.String getTitleField()
```
    Description copied from interface: DataBoundComponent
    
    Method to return the fieldName which represents the "title" for records in this Component.
    If this.titleField is explicitly specified it will always be used. Otherwise, default implementation will check titleField for databound components.
    For non databound components returns the first defined field name of "title", "name", or "id". If we dont find any field-names that match these titles, the first field in the component will be used instead.
    
    Specified by:
    
    getTitleField in interface DataBoundComponent
    
    Returns:
    
    fieldName the title field for this component.
  - getDataSource
```
public DataSource getDataSource()
```
    Description copied from interface: DataBoundComponent
    
    The DataSource that this component should bind to for default fields and for performing DataSource requests.
    
    Specified by:
    
    getDataSource in interface DataBoundComponent
    
    Returns:
    
    DataSource
  - setAutoFetchData
```
public void setAutoFetchData(java.lang.Boolean autoFetchData)
                      throws java.lang.IllegalStateException
```
    Description copied from interface: DataBoundComponent
    
    If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria and textMatchStyle may be specified via DataBoundComponent.getAutoFetchTextMatchStyle().
    NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only initialCriteria and not any other criteria or settings from the first request. Generally, turn off autoFetchData if you are going to manually call fetchData() at any time.
    
    Specified by:
    
    setAutoFetchData in interface DataBoundComponent
    
    Parameters:
    
    autoFetchData - autoFetchData
    
    Throws:
    
    java.lang.IllegalStateException
  - getAutoFetchData
```
public java.lang.Boolean getAutoFetchData()
```
    Description copied from interface: DataBoundComponent
    
    If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() . Criteria for this fetch may be picked up from initialCriteria and textMatchStyle may be specified via DataBoundComponent.getAutoFetchTextMatchStyle().
    NOTE: If autoFetchData is set, calling ListGrid.fetchData() before draw will cause two requests to be issued, one from the manual call to fetchData() and one from the autoFetchData setting. The second request will use only initialCriteria and not any other criteria or settings from the first request. Generally, turn off autoFetchData if you are going to manually call fetchData() at any time.
    
    Specified by:
    
    getAutoFetchData in interface DataBoundComponent
    
    Returns:
    
    autoFetchData autoFetchData
  - setAutoFetchTextMatchStyle
```
public void setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
                                throws java.lang.IllegalStateException
```
    Description copied from interface: DataBoundComponent
    
    If autoFetchData is true, this attribute allows the developer to specify a textMatchStyle for the initial DataBoundComponent.fetchData() call.
    
    Specified by:
    
    setAutoFetchTextMatchStyle in interface DataBoundComponent
    
    Throws:
    
    java.lang.IllegalStateException
  - getAutoFetchTextMatchStyle
```
public TextMatchStyle getAutoFetchTextMatchStyle()
```
    Description copied from interface: DataBoundComponent
    
    If autoFetchData is true, this attribute allows the developer to specify a textMatchStyle for the initial DataBoundComponent.fetchData() call.
    
    Specified by:
    
    getAutoFetchTextMatchStyle in interface DataBoundComponent
    
    Returns:
    
    autoFetchTextMatchStyle autoFetchTextMatchStyle
  - setAutoFetchAsFilter
```
public void setAutoFetchAsFilter(java.lang.Boolean autoFetchAsFilter)
                          throws java.lang.IllegalStateException
```
    Description copied from interface: DataBoundComponent
    
    If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()
    
    Specified by:
    
    setAutoFetchAsFilter in interface DataBoundComponent
    
    Parameters:
    
    autoFetchAsFilter - autoFetchAsFilter
    
    Throws:
    
    java.lang.IllegalStateException
  - getAutoFetchAsFilter
```
public java.lang.Boolean getAutoFetchAsFilter()
```
    Description copied from interface: DataBoundComponent
    
    If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()
    
    Specified by:
    
    getAutoFetchAsFilter in interface DataBoundComponent
    
    Returns:
    
    auto fetch as filter
  - setInitialCriteria
```
public void setInitialCriteria(Criteria initialCriteria)
                        throws java.lang.IllegalStateException
```
    Description copied from interface: DataBoundComponent
    
    Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.
    
    Specified by:
    
    setInitialCriteria in interface DataBoundComponent
    
    Parameters:
    
    initialCriteria - the initial criteria
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getInitialCriteria
```
public Criteria getInitialCriteria()
```
    Description copied from interface: DataBoundComponent
    
    Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.
    
    Specified by:
    
    getInitialCriteria in interface DataBoundComponent
    
    Returns:
    
    the criteria
  - setImplicitCriteria
```
public void setImplicitCriteria(Criteria implicitCriteria)
```
    Description copied from interface: DataBoundComponent
    
    Criteria that are never shown to or edited by the user and are cumulative with any criteria provided via DataBoundComponent.initialCriteria, DataBoundComponent.setCriteria() etc.
    
    Specified by:
    
    setImplicitCriteria in interface DataBoundComponent
    
    Parameters:
    
    implicitCriteria - New implicitCriteria value. Default value is null
  - getImplicitCriteria
```
public Criteria getImplicitCriteria()
```
    Description copied from interface: DataBoundComponent
    
    Criteria that are never shown to or edited by the user and are cumulative with any criteria provided via DataBoundComponent.initialCriteria, DataBoundComponent.setCriteria() etc.
    
    Specified by:
    
    getImplicitCriteria in interface DataBoundComponent
    
    Returns:
    
    Current implicitCriteria value. Default value is null
  - fetchData
```
public void fetchData()
```
    Description copied from interface: DataBoundComponent
    
    Retrieves data from the DataSource that matches the specified criteria.
    When fetchData() is first called, if data has not already been provided via setData(), this method will create a ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.
    NOTE: do not use both autoFetchData and a call to fetchData() - this may result in two DSRequests to fetch data. Use either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData() passing criteria.
    Whether a ResultSet was automatically created or provided via setData(), subsequent calls to fetchData() will simply call resultSet.setCriteria().
    Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call willFetchData(criteria) to determine if new criteria will result in a server fetch.
    If you need to force data to be re-fetched, you can call invalidateCache() and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when using invalidateCache() there is no need to also call fetchData() and in fact this could produce unexpected results.
    This method takes an optional callback parameter (set to a DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can use resultSet.willFetchData() to determine whether or not a server fetch will occur when fetchData() is called with new criteria.
    In addition to the callback parameter for this method, developers can use resultSet.addDataArrivedHandler to be notified every time data is loaded.
    
    Specified by:
    
    fetchData in interface DataBoundComponent
  - fetchData
```
public void fetchData(Criteria criteria)
```
    Description copied from interface: DataBoundComponent
    
    Retrieves data from the DataSource that matches the specified criteria.
    When fetchData() is first called, if data has not already been provided via setData(), this method will create a ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.
    NOTE: do not use both autoFetchData and a call to fetchData() - this may result in two DSRequests to fetch data. Use either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData() passing criteria.
    Whether a ResultSet was automatically created or provided via setData(), subsequent calls to fetchData() will simply call resultSet.setCriteria().
    Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call willFetchData(criteria) to determine if new criteria will result in a server fetch.
    If you need to force data to be re-fetched, you can call invalidateCache() and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when using invalidateCache() there is no need to also call fetchData() and in fact this could produce unexpected results.
    This method takes an optional callback parameter (set to a DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can use resultSet.willFetchData() to determine whether or not a server fetch will occur when fetchData() is called with new criteria.
    In addition to the callback parameter for this method, developers can use resultSet.addDataArrivedHandler to be notified every time data is loaded.
    
    Specified by:
    
    fetchData in interface DataBoundComponent
    
    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)
```
    Description copied from interface: DataBoundComponent
    
    Retrieves data from the DataSource that matches the specified criteria.
    When fetchData() is first called, if data has not already been provided via setData(), this method will create a ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.
    NOTE: do not use both autoFetchData and a call to fetchData() - this may result in two DSRequests to fetch data. Use either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData() passing criteria.
    Whether a ResultSet was automatically created or provided via setData(), subsequent calls to fetchData() will simply call resultSet.setCriteria().
    Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call willFetchData(criteria) to determine if new criteria will result in a server fetch.
    If you need to force data to be re-fetched, you can call invalidateCache() and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when using invalidateCache() there is no need to also call fetchData() and in fact this could produce unexpected results.
    This method takes an optional callback parameter (set to a DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can use resultSet.willFetchData() to determine whether or not a server fetch will occur when fetchData() is called with new criteria.
    In addition to the callback parameter for this method, developers can use resultSet.addDataArrivedHandler to be notified every time data is loaded.
    
    Specified by:
    
    fetchData in interface DataBoundComponent
    
    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)
```
    Description copied from interface: DataBoundComponent
    
    Retrieves data from the DataSource that matches the specified criteria.
    When fetchData() is first called, if data has not already been provided via setData(), this method will create a ResultSet, which will be configured based on component settings such as fetchOperation and dataPageSize, as well as the general purpose dataProperties. The created ResultSet will automatically send a DSRequest to retrieve data from the dataSource, and from then on will automatically manage paging through large datasets, as well as performing filtering and sorting operations inside the browser when possible - see the ResultSet docs for details.
    NOTE: do not use both autoFetchData and a call to fetchData() - this may result in two DSRequests to fetch data. Use either autoFetchData and setAutoFetchCriteria() or a manual call to fetchData() passing criteria.
    Whether a ResultSet was automatically created or provided via setData(), subsequent calls to fetchData() will simply call resultSet.setCriteria().
    Changes to criteria may or may not result in a DSRequest to the server due to client-side filtering. You can call willFetchData(criteria) to determine if new criteria will result in a server fetch.
    If you need to force data to be re-fetched, you can call invalidateCache() and new data will automatically be fetched from the server using the current criteria and sort direction. NOTE: when using invalidateCache() there is no need to also call fetchData() and in fact this could produce unexpected results.
    This method takes an optional callback parameter (set to a DSCallback) to fire when the fetch completes. Note that this callback will not fire if no server fetch is performed. In this case the data is updated synchronously, so as soon as this method completes you can interact with the new data. If necessary, you can use resultSet.willFetchData() to determine whether or not a server fetch will occur when fetchData() is called with new criteria.
    In addition to the callback parameter for this method, developers can use resultSet.addDataArrivedHandler to be notified every time data is loaded.
    
    Specified by:
    
    fetchData in interface DataBoundComponent
    
    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()
```
    Description copied from interface: DataBoundComponent
    
    Retrieves data that matches the provided criteria and displays the matching data in this component.
    This method behaves exactly like ListGrid.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
  - filterData
```
public void filterData(Criteria criteria)
```
    Description copied from interface: DataBoundComponent
    
    Retrieves data that matches the provided criteria and displays the matching data in this component.
    This method behaves exactly like ListGrid.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
    
    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)
```
    Description copied from interface: DataBoundComponent
    
    Retrieves data that matches the provided criteria and displays the matching data in this component.
    This method behaves exactly like ListGrid.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
    
    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)
```
    Description copied from interface: DataBoundComponent
    
    Retrieves data that matches the provided criteria and displays the matching data in this component.
    This method behaves exactly like ListGrid.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
    
    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
  - invalidateCache
```
public void invalidateCache()
```
    Description copied from interface: DataBoundComponent
    
    Invalidate the current data cache for this databound component via a call to the dataset's invalidateCache() method, for example, ResultSet.invalidateCache().
    NOTE: there is no need to call invalidateCache() when a save operation is performed on a DataSource. Automatic cache synchronization features will automatically update caches - see ResultSet for details. If automatic cache synchronization isn't working, troubleshoot the problem using the steps suggested in the FAQ rather than just calling invalidateCache(). Calling invalidateCache() unnecessarily causes extra server load and added code complexity.
    Calling invalidateCache() will automatically cause a new fetch to be performed with the current set of criteria if data had been previously fetched and the component is currently drawn with data visible - there is no need to manually call fetchData() after invalidateCache() and this could result in duplicate fetches.
    While data is being re-loaded after a call to invalidateCache(), the widget is in a state similar to initial data load - it doesn't know the total length of the dataset and any APIs that act on records or row indices will necessarily fail and should not be called. To detect that the widget is in this state, call ResultSet.lengthIsKnown().
    invalidateCache() only has an effect if this component's dataset is a data manager class that manages a cache (eg ResultSet or ResultTree). If data was provided as a simple Array or List, invalidateCache() does nothing.
    
    Specified by:
    
    invalidateCache in interface DataBoundComponent
    
    See Also:
    
    ListGrid.refreshData(), DataBoundComponentMethods overview and related methods
  - getResultSet
```
public ResultSet getResultSet()
```
    Description copied from interface: DataBoundComponent
    
    Return the underlying data of this DataBoundComponent as a ResultSet.
    Note that this method should only be called after initial data has been fetched by this DataBoundComponent.
    
    Specified by:
    
    getResultSet in interface DataBoundComponent
    
    Returns:
    
    ResultSet, or null if the underlying data is not a ResultSet
    
    See Also:
    
    DataBoundComponent.fetchData()
  - getRecordList
```
public RecordList getRecordList()
```
    Description copied from interface: DataBoundComponent
    Return the underlying data of this DataBoundComponent as a RecordList.
    Depending on the component configuration, the actual JavaScript instance of the returned RecordList may be one of several types:
    - If the component is not bound to a DataSource, the instance is generally an Array of Record.
    - If the component is bound to a DataSource, the instance is a ResultSet.
    - If the component is a grouped ListGrid, the instance is a Tree. To access the ungrouped record list regardless of grouping status, use
      isGrouped() ? getOriginalRecordList() : getRecordList()
    - If the component is a TreeGrid, the instance is a ResultTree.
    The underlying type determines the structure of the returned data. An Array or ResultSet represents a list of records, but a Tree or ResultTree represents a list of open rows in the tree, including groups or other nodes which contain no records.
    Specified by:
    
    getRecordList in interface DataBoundComponent
    
    Returns:
    
    the RecordList
  - getDataAsJSList
```
public com.google.gwt.core.client.JavaScriptObject getDataAsJSList()
```
    Specified by:
    
    getDataAsJSList in interface DataBoundComponent
  - exportData
```
public void exportData()
```
    Description copied from interface: DataBoundComponent
    
    Uses a "fetch" operation on the current DataSource to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.
    A variety of DSRequest settings, such as exportAs and exportFilename, affect the exporting process: see exportResults for further detail.
    Note that data exported via this method does not include any client-side formatting and relies on both the Smart GWT server and server-side DataSources. To export client-data with formatters applied, see exportClientData, which still requires the Smart GWT server but does not rely on server-side DataSources.
    For more information on exporting data, see DataSource.exportData.
    
    Specified by:
    
    exportData in interface DataBoundComponent
    
    See Also:
    
    DataBoundComponentMethods overview and related methods
  - exportData
```
public void exportData(DSRequest requestProperties)
```
    Description copied from interface: DataBoundComponent
    
    Uses a "fetch" operation on the current DataSource to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.
    A variety of DSRequest settings, such as exportAs and exportFilename, affect the exporting process: see exportResults for further detail.
    Note that data exported via this method does not include any client-side formatting and relies on both the Smart GWT server and server-side DataSources. To export client-data with formatters applied, see exportClientData, which still requires the Smart GWT server but does not rely on server-side DataSources.
    For more information on exporting data, see DataSource.exportData.
    
    Specified by:
    
    exportData in interface DataBoundComponent
    
    Parameters:
    
    requestProperties - additional properties to set on the DSRequest that will be issued
    
    See Also:
    
    DataBoundComponentMethods overview and related methods
  - addFetchDataHandler
```
public com.google.gwt.event.shared.HandlerRegistration addFetchDataHandler(FetchDataHandler handler)
```
    Add a fetchData handler.
    Notification function fired on fetchData() or filterData()
    
    Specified by:
    
    addFetchDataHandler in interface HasFetchDataHandlers
    
    Parameters:
    
    handler - the filterData handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDropCompleteHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDropCompleteHandler(DropCompleteHandler handler)
```
    Add a com.smartgwt.client.widgets.DropCompleteHandler. See that class's documentation for a definition of "drop complete", and how it differs from "drag complete" (com.smartgwt.client.widgets.DragCompleteHandler).
    
    Specified by:
    
    addDropCompleteHandler in interface HasDropCompleteHandlers
    
    Parameters:
    
    handler - the DropCompleteHandler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addDragCompleteHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragCompleteHandler(DragCompleteHandler handler)
```
    Add a com.smartgwt.client.widgets.DragCompleteHandler. See that class's documentation for a definition of "drag complete", and how it differs from "drop complete" (com.smartgwt.client.widgets.DropCompleteHandler).
    
    Specified by:
    
    addDragCompleteHandler in interface HasDragCompleteHandlers
    
    Parameters:
    
    handler - the DropCompleteHandler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - getFieldAlignments
```
public Alignment[] getFieldAlignments()
```
    Description copied from interface: DataBoundComponent
    
    Returna an array of field alignments for this grid
    
    Specified by:
    
    getFieldAlignments in interface DataBoundComponent
    
    Returns:
    
    array of Alignments
  - getDeepCloneOnEdit
```
public java.lang.Boolean getDeepCloneOnEdit()
```
    Description copied from interface: DataBoundComponent
    
    Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values. See DataSource.getDeepCloneOnEdit() for details of what this means.
    If this value is not explicitly set, it defaults to the DataSource deepCloneOnEdit value. This value can also be overridden per-field with DataSourceField.setDeepCloneOnEdit(java.lang.Boolean).
    Like the other deepCloneOnEdit settings, this flag only has an effect if you are editing a values object that contains nested objects or arrays, using Canvas.setDataPath(java.lang.String)
    
    Specified by:
    
    getDeepCloneOnEdit in interface DataBoundComponent
  - setDeepCloneOnEdit
```
public void setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
```
    Description copied from interface: DataBoundComponent
    
    Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values. See DataSource.getDeepCloneOnEdit() for details of what this means.
    If this value is not explicitly set, it defaults to the DataSource deepCloneOnEdit value. This value can also be overridden per-field with DataSourceField.setDeepCloneOnEdit(java.lang.Boolean).
    Like the other deepCloneOnEdit settings, this flag only has an effect if you are editing a values object that contains nested objects or arrays, using Canvas.setDataPath(java.lang.String)
    
    Specified by:
    
    setDeepCloneOnEdit in interface DataBoundComponent
  - setFields
```
public void setFields(com.google.gwt.core.client.JavaScriptObject... fields)
```
    Description copied from interface: DataBoundComponent
    
    Field setter variant (alternative to setFields(FormItem...), setFields(ListGridField...), etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT Java wrappers of the field class type (e.g. FormItem, ListGridField, etc.) This is an advanced method and only for cases where you have the JavaScriptObject for each field but want to avoid having to create each associated SmartGWT Java wrapper.
    Note: use toArray() to create a Java array of JavaScriptObject if you only have the array itself as a single JavaScriptObject.
    
    Specified by:
    
    setFields in interface DataBoundComponent
    
    Parameters:
    
    fields - the component fields
  - getFieldsAsJavaScriptObjects
```
public com.google.gwt.core.client.JavaScriptObject[] getFieldsAsJavaScriptObjects()
```
    Description copied from interface: DataBoundComponent
    
    Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g. FormItem, ListGridField, etc.) This avoids building the SmartGWT Java wrappers for the fields in situations where they aren't needed - and for FormItems in particular - where there may not be enough information to determine the correct subclass, such as before the SmartClient instance underlying the DynamicForm has been created.
    
    Specified by:
    
    getFieldsAsJavaScriptObjects in interface DataBoundComponent
    
    Returns:
    
    the component fields
  - getFieldCount
```
public int getFieldCount()
```
    Description copied from interface: DataBoundComponent
    
    Return the number of fields.
    
    Specified by:
    
    getFieldCount in interface DataBoundComponent
    
    Returns:
    
    the number of fields
  - setDragDataCustomizer
```
public void setDragDataCustomizer(DragDataCustomizer customizer)
```
    During a drag-and-drop interaction, this method returns the set of records being dragged out of the component. In the default implementation, this is the list of currently selected records.
    This method is consulted by willAcceptDrop().
    
    Parameters:
    
    DragDataCustomizer - customizer
  - setLogicalStructure
```
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.grid.ColumnTreeLogicalStructure s)
```
    Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
  - getLogicalStructure
```
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
```
    Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
    
    Specified by:
    
    getLogicalStructure in interface LogicalStructure
    
    Overrides:
    
    getLogicalStructure in class Layout

Class ColumnTree

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.widgets.layout.Layout

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

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

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

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

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

Constructor Detail

ColumnTree

ColumnTree

Method Detail

getOrCreateRef

changeAutoChildDefaults

changeAutoChildDefaults

create

getBackButton

setBackButtonTitle

getBackButtonTitle

setClosedIconSuffix

getClosedIconSuffix

getColumn

setCustomIconOpenProperty

getCustomIconOpenProperty

setCustomIconProperty

getCustomIconProperty

setData

getData

setDataFetchMode

getDataFetchMode

getDataProperties

setDataSource

setDataSource

setFields

setFirstColumnTitle

getFirstColumnTitle

setFolderIcon

getFolderIcon

setLoadDataOnDemand

getLoadDataOnDemand

setNodeIcon

getNodeIcon

setOpenIconSuffix

getOpenIconSuffix

setShowCustomIconOpen

getShowCustomIconOpen

setShowDetailFields

getShowDetailFields

setShowHeaders

getShowHeaders

setShowMultipleColumns

getShowMultipleColumns

setShowNodeCount

getShowNodeCount

setShowOpenIcons

getShowOpenIcons

getColumnTitle

getIcon

getRecord

getRecord

getSelectedRecord

navigateBack

shouldShowHeader

setDefaultProperties

onInit

onInit_ColumnTree

setDropIconSuffix

getDropIconSuffix

setShowDropIcons

getShowDropIcons

deselectRecord

deselectRecord