public class TreeGrid extends ListGrid implements HasDataArrivedHandlers, HasFolderClickHandlers, HasFolderClosedHandlers, HasFolderContextClickHandlers, HasFolderOpenedHandlers, HasLeafClickHandlers, HasLeafContextClickHandlers, HasNodeClickHandlers, HasNodeContextClickHandlers, HasFolderDropHandlers
Tree
class, which manipulates hierarchical data sets
TreeDataBinding
. A TreeGrid works just like a ListGrid
, except one column (specified by treeField
) shows a hierarchical Tree
. A TreeGrid is not limited to displaying just the Tree
column - you can define additional columns (via fields
) which will render just like the columns of a ListGrid
, and support all of the functionality of ListGrid columns, such as formatters
.
Except where explicitly overridden,
ListGrid
methods, callbacks, and properties apply to TreeGrids as well. The
ListGrid
defines some methods as taking/returning ListGridField
and ListGridRecord
. When using
those methods in a TreeGrid, those types will be TreeGridField
and TreeNode
, respectively.
config, configOnly, id, isElementSet, nativeObject, scClassName
Constructor and Description |
---|
TreeGrid() |
TreeGrid(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
com.google.gwt.event.shared.HandlerRegistration |
addDataArrivedHandler(DataArrivedHandler handler)
Add a dataArrived handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFolderClickHandler(FolderClickHandler handler)
Add a folderClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFolderClosedHandler(FolderClosedHandler handler)
Add a folderClosed handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFolderContextClickHandler(FolderContextClickHandler handler)
Add a folderContextClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFolderDropHandler(FolderDropHandler handler)
Add a folderDrop handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addFolderOpenedHandler(FolderOpenedHandler handler)
Add a folderOpened handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addLeafClickHandler(LeafClickHandler handler)
Add a leafClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addLeafContextClickHandler(LeafContextClickHandler handler)
Add a leafContextClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addNodeClickHandler(NodeClickHandler handler)
Add a nodeClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addNodeContextClickHandler(NodeContextClickHandler handler)
Add a nodeContextClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addRecordDropHandler(RecordDropHandler handler)
This ListGrid superclass event does not fire on a TreeGrid, use
addFolderDropHandler(com.smartgwt.client.widgets.tree.events.FolderDropHandler) instead. |
java.lang.Boolean |
canEditCell()
Overridden to disallow editing of the
name field of this
grid's data tree. |
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 . |
void |
closeFolder(TreeNode node)
Closes a folder.
|
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
fetchData()
Uses a "fetch" operation on the current
DataSource to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree. |
void |
fetchData(Criteria criteria)
Uses a "fetch" operation on the current
DataSource to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree. |
void |
fetchData(Criteria criteria,
DSCallback callback)
Uses a "fetch" operation on the current
DataSource to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree. |
void |
fetchData(Criteria criteria,
DSCallback callback,
DSRequest requestProperties)
Uses a "fetch" operation on the current
DataSource to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree. |
void |
filterData(Criteria criteria)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
void |
filterData(Criteria criteria,
DSCallback callback)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
void |
filterData(Criteria criteria,
DSCallback callback,
DSRequest requestProperties)
Retrieves data that matches the provided criteria and displays the matching data in this component.
|
java.lang.Boolean |
getAlwaysShowOpener()
If
showOpener is true, should we display the opener icon
for folders even if they have no children? |
AnimationAcceleration |
getAnimateFolderEffect()
When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
|
java.lang.Integer |
getAnimateFolderMaxRows()
If
animateFolders is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder. |
java.lang.Boolean |
getAnimateFolders()
If true, when folders are opened / closed children will be animated into view.
|
int |
getAnimateFolderSpeed()
When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden)
per second.
|
int |
getAnimateFolderTime()
When animating folder opening / closing, if
animateFolderSpeed is not set, this property designates the duration of the animation in ms. |
TextMatchStyle |
getAutoFetchTextMatchStyle()
With
loadDataOnDemand :true, TreeGrids fetch data
by selecting the child nodes of each parent, which should be exact match, so we default to
autoFetchTextMatchStyle:"exact" . |
PreserveOpenState |
getAutoPreserveOpenState()
For dataBound treeGrids this specifies the
autoPreserveOpenState , governing whether the open state of the tree should be preserved when new data arrives due to
cache invalidation. |
java.lang.Boolean |
getCanAcceptDroppedRecords()
Indicates whether records can be dropped into this listGrid.
|
java.lang.Boolean |
getCanDragRecordsOut()
Indicates whether records can be dragged from this listGrid and dropped elsewhere.
|
java.lang.Boolean |
getCanDropOnLeaves()
Whether drops are allowed on leaf nodes.
|
java.lang.Boolean |
getCanReorderRecords()
Indicates whether records can be reordered by dragging within this listGrid.
|
java.lang.Boolean |
getCanReparentNodes()
If set this property allows the user to reparent nodes by dragging them from their current folder to a new folder.
Backcompat: For backwards compatibility with versions prior to Smart GWT 1.5, if this property is unset, but this.canAcceptDroppedRecords is true, we allow nodes to be dragged to different folders. |
java.lang.String |
getCantDragIntoChildMessage()
Message displayed when user attempts to drop a node into a child of itself.
|
java.lang.String |
getCantDragIntoSelfMessage()
Message displayed when user attempts to drop a dragged node onto itself.
|
java.lang.Boolean |
getCascadeSelection()
Should children be selected when parent is selected? And should parent be selected when any child is selected?
|
Alignment |
getCellAlign(ListGridRecord record,
int rowNum,
int colNum)
Return the horizontal alignment for cell contents.
|
java.lang.String |
getClosedIconSuffix()
This suffix will be appended to the
folderIcon for
closed folders. |
java.lang.String |
getConnectorImage()
The base filename for connector icons shown when
showConnectors is true. |
java.lang.Boolean |
getCreateDefaultTreeField()
If no fields are specified, create a single field with
treeField set to true to show the tree. |
java.lang.String |
getCustomIconDropProperty()
This property allows the developer to rename the
default node.showDropIcon property. |
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 rename the
default
node.icon property. |
Tree |
getData()
|
FetchMode |
getDataFetchMode()
Mode of fetching records from server.
|
DisplayNodeType |
getDisplayNodeType()
Specifies the type of nodes displayed in the treeGrid.
|
TreeNode |
getDropFolder()
When the user is dragging a droppable element over this grid, this method returns the folder
which would contain the item if dropped.
|
java.lang.String |
getDropIconSuffix()
If
showDropIcons is true, this suffix will be
appended to the folderIcon when the user drop-hovers
over some folder. |
int |
getEventRow()
Returns the row number of the most recent mouse event.
|
int |
getEventRow(java.lang.Integer y)
Returns the row number of the most recent mouse event.
|
java.lang.String |
getExtraIcon(TreeNode node)
Get an additional icon to show between the open icon and folder/node icon for a particular node.
|
int |
getExtraIconGap()
The amount of gap (in pixels) between the extraIcon (see
TreeGrid.getExtraIcon ) or checkbox icon and the nodeIcon /
folderIcon or node text. |
java.lang.String |
getFolderIcon()
The URL of the base icon for all folder nodes in this treeGrid.
|
protected java.lang.String |
getIcon(Record node,
boolean defaultState)
Get the appropriate icon for a node.
|
int |
getIconSize()
The standard size (same height and width, in pixels) of node icons in this treeGrid.
|
java.lang.Boolean |
getIndentRecordComponents()
For record components placed "within" the
treeField
column, should the component be indented to the position where a title would normally show? |
int |
getIndentSize()
The amount of indentation (in pixels) to add to a node's icon/title for each level down in this tree's hierarchy.
|
java.lang.Boolean |
getKeepParentsOnFilter()
If set, tree-based filtering is performed such that parent nodes are kept as long as they have children that match the
filter criteria, even if the parents themselves do not match the filter criteria.
|
java.lang.Boolean |
getLeaveSelectionCheckboxGap()
If
selectionAppearance :"checkbox" is set on
the treegrid, and a node can't be selected, should a gap be left where the checkbox icon would normally appear, in order
to make the node's icon and title line up with the content for other nodes in the same parent? |
java.lang.Boolean |
getLoadDataOnDemand()
For databound treeGrid instances, should the entire tree of data be loaded on initial fetch, or should folders load
their children as they are opened.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure() |
java.lang.String |
getManyItemsImage()
The filename of the icon displayed use as the default drag tracker when for multiple files and/or folders are being
dragged.
|
java.lang.String |
getNodeIcon()
The filename of the default icon for all leaf nodes in this grid.
|
protected java.lang.String |
getNodeTitle(Record node,
int recordNum,
ListGridField field)
Returns the title to show for a node in the tree column.
|
java.lang.String |
getOfflineNodeMessage()
For TreeGrids with loadDataOnDemand: true, a message to show the user if an attempt is made to open a folder, and thus
load that node's children, while we are offline and there is no offline cache of that data.
|
java.lang.Integer |
getOpenerIconHeight()
Height in pixels of the opener icons, that is, the icons which show the open or closed state of the node, typically a
[+] or [-] symbol.
|
java.lang.Integer |
getOpenerIconSize()
Default width and height in pixels of the opener icons, that is, the icons which show the open or closed state of the
node, typically a [+] or [-] symbol, if not overridden by
openerIconWidth /openerIconHeight . |
java.lang.Integer |
getOpenerIconWidth()
Width in pixels of the opener icons, that is, the icons which show the open or closed state of the node, typically a [+]
or [-] symbol.
|
java.lang.String |
getOpenerImage()
The base filename of the opener icon for the folder node when 'showConnectors' is false for this TreeGrid.
The opener icon is displayed beside the folder icon in the Tree column for folder nodes. |
java.lang.String |
getOpenIcon(TreeNode node)
Get the appropriate open/close opener icon for a node.
|
java.lang.String |
getOpenIconSuffix()
If
showOpenIcons is true, this suffix will be
appended to the folderIcon for open folders in this
grid. |
java.lang.String |
getOpenState()
Returns a snapshot of the current open state of this grid's data as a TreeGridOpenState object.
This object can be passed to TreeGrid.setOpenState to open the same set of
folders within the treeGrid's data (assuming the nodes are still present in the data). |
static TreeGrid |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getParentAlreadyContainsChildMessage()
Message displayed when user attempts to drag a node into a parent that already contains a child of the same name.
|
TreeNode |
getRecord(int recordNum)
Return the pointer to a particular record by record number.
|
ListGridRecord[] |
getRecords()
Return the tree nodes as a flat array of ListGridRecords.
|
java.lang.String |
getSelectedPaths()
Returns a snapshot of the current selection within this treeGrid as a ListGridSelectedState object.
This object can be passed to TreeGrid.setSelectedPaths to reset this
grid's selection the current state (assuming the same data is present in the grid). |
TreeNode |
getSelectedRecord()
Return the first selected record in this component.
This method is appropriate if is "single" , or if you only care about the first selected record in a multiple-record selection. |
java.lang.String |
getSelectionProperty()
If specified, the selection object for this list will use this property to mark records as selected.
|
java.lang.Boolean |
getSeparateFolders()
If specified, this attribute will override
separateFolders on the data for this treeGrid. |
java.lang.String[] |
getServerFilterFields()
When
keepParentsOnFilter is enabled, this
property lists field names that will be sent to the server if they are present in criteria. |
java.lang.Boolean |
getShowConnectors()
Should this treeGrid show connector lines illustrating the tree's hierarchy?
|
java.lang.Boolean |
getShowCustomIconDrop()
Should folder nodes showing custom icons (set via the
customIconProperty , default icon ), show drop state images when the user is drop-hovering over the
folder. |
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 |
getShowDisabledSelectionCheckbox()
Should tree nodes show a disabled checkbox
selectionAppearance :"checkbox" is set on the treegrid, and a node can't be selected? |
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 |
getShowFullConnectors()
If
showConnectors is true, this property determines
whether we should show vertical continuation lines for each level of indenting within the tree. |
java.lang.Boolean |
getShowOpener()
Should the
opener icon be displayed next to folder
nodes? This is an icon which visually indicates whether the folder is opened or closed (typically via a [+] or [-]
image, or a turn-down arrow) and may be clicked to expand or collapse the folder. |
java.lang.Boolean |
getShowOpenIcons()
If true, show a different icon for
open folders than closed folders. |
java.lang.Boolean |
getShowPartialSelection()
Should partially selected parents be shown with special icon?
|
java.lang.Boolean |
getShowRoot()
Specifies whether the root node should be displayed in the treeGrid.
|
java.lang.Boolean |
getSortFoldersBeforeLeaves()
If specified, this attribute will override
sortFoldersBeforeLeaves on the data for this treeGrid. |
protected TreeGrid |
getTestInstance() |
Tree |
getTree()
Synonym for
getData() |
java.lang.String |
getTreeFieldTitle()
Visible title for the tree column (field).
|
java.lang.String |
getTreeRootValue()
For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.
|
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 |
isOverExtraIcon()
Returns true if the last event occurred over
extra icon
for the current node. |
java.lang.Boolean |
isOverOpenArea()
Returns true if the last event occurred over the indented area or over the open / close icon of a folder node in this
TreeGrid.
|
protected void |
onInit() |
void |
openFolder(TreeNode node)
Opens a folder.
|
void |
recordDoubleClick()
Handle a doubleClick on a tree node - override of ListGrid stringMethod of same name.
|
void |
setAlwaysShowOpener(java.lang.Boolean alwaysShowOpener)
If
showOpener is true, should we display the opener icon
for folders even if they have no children? |
void |
setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)
When animating folder opening / closing, this property can be set to apply an animated acceleration effect.
|
void |
setAnimateFolderMaxRows(java.lang.Integer animateFolderMaxRows)
If
animateFolders is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder. |
void |
setAnimateFolders(java.lang.Boolean animateFolders)
If true, when folders are opened / closed children will be animated into view.
|
void |
setAnimateFolderSpeed(int animateFolderSpeed)
When animating folder opening / closing, this property designates the speed of the animation in pixels shown (or hidden)
per second.
|
void |
setAnimateFolderTime(int animateFolderTime)
When animating folder opening / closing, if
animateFolderSpeed is not set, this property designates the duration of the animation in ms. |
void |
setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)
With
loadDataOnDemand :true, TreeGrids fetch data
by selecting the child nodes of each parent, which should be exact match, so we default to
autoFetchTextMatchStyle:"exact" . |
void |
setAutoPreserveOpenState(PreserveOpenState autoPreserveOpenState)
For dataBound treeGrids this specifies the
autoPreserveOpenState , governing whether the open state of the tree should be preserved when new data arrives due to
cache invalidation. |
void |
setCanAcceptDroppedRecords(java.lang.Boolean canAcceptDroppedRecords)
Indicates whether records can be dropped into this listGrid.
|
void |
setCanDragRecordsOut(java.lang.Boolean canDragRecordsOut)
Indicates whether records can be dragged from this listGrid and dropped elsewhere.
|
void |
setCanDropOnLeaves(java.lang.Boolean canDropOnLeaves)
Whether drops are allowed on leaf nodes.
|
void |
setCanReorderRecords(java.lang.Boolean canReorderRecords)
Indicates whether records can be reordered by dragging within this listGrid.
|
void |
setCanReparentNodes(java.lang.Boolean canReparentNodes)
If set this property allows the user to reparent nodes by dragging them from their current folder to a new folder.
Backcompat: For backwards compatibility with versions prior to Smart GWT 1.5, if this property is unset, but this.canAcceptDroppedRecords is true, we allow nodes to be dragged to different folders. |
void |
setCantDragIntoChildMessage(java.lang.String cantDragIntoChildMessage)
Message displayed when user attempts to drop a node into a child of itself.
|
void |
setCantDragIntoSelfMessage(java.lang.String cantDragIntoSelfMessage)
Message displayed when user attempts to drop a dragged node onto itself.
|
void |
setCascadeSelection(java.lang.Boolean cascadeSelection)
Should children be selected when parent is selected? And should parent be selected when any child is selected?
|
void |
setCellValueHoverFormatter(CellValueHoverFormatter formatter)
Provide a custom implementation of
ListGrid.cellValueHoverHTML(ListGridRecord, int, int, String) . |
void |
setClosedIconSuffix(java.lang.String closedIconSuffix)
This suffix will be appended to the
folderIcon for
closed folders. |
void |
setConnectorImage(java.lang.String connectorImage)
The base filename for connector icons shown when
showConnectors is true. |
void |
setCreateDefaultTreeField(java.lang.Boolean createDefaultTreeField)
If no fields are specified, create a single field with
treeField set to true to show the tree. |
void |
setCustomIconDropProperty(java.lang.String customIconDropProperty)
This property allows the developer to rename the
default node.showDropIcon property. |
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 rename the
default
node.icon property. |
void |
setCustomNodeIcon(Record node,
java.lang.String icon)
Set the icon for a particular TreeNode to a specified URL
|
void |
setData(Tree data)
|
void |
setDataFetchMode(FetchMode dataFetchMode)
Mode of fetching records from server.
|
void |
setDataProperties(Tree resultTreeProperties)
For databound TreeGrids, this attribute can be used to customize the ResultTree object
created for this TreeGrid when data is fetched
|
static void |
setDefaultProperties(TreeGrid treeGridProperties)
Class level method to set the default properties of this class.
|
void |
setDisplayNodeType(DisplayNodeType displayNodeType)
Specifies the type of nodes displayed in the treeGrid.
|
void |
setDropIconSuffix(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 |
setExtraIconGap(int extraIconGap)
The amount of gap (in pixels) between the extraIcon (see
TreeGrid.getExtraIcon ) or checkbox icon and the nodeIcon /
folderIcon or node text. |
void |
setFields(TreeGridField... fields)
An array of field objects, specifying the order, layout, dynamic calculation, and sorting behavior of each field
in the treeGrid object.
|
void |
setFolderIcon(java.lang.String folderIcon)
The URL of the base icon for all folder nodes in this treeGrid.
|
void |
setIconSize(int iconSize)
The standard size (same height and width, in pixels) of node icons in this treeGrid.
|
void |
setIndentRecordComponents(java.lang.Boolean indentRecordComponents)
For record components placed "within" the
treeField
column, should the component be indented to the position where a title would normally show? |
void |
setIndentSize(int indentSize)
The amount of indentation (in pixels) to add to a node's icon/title for each level down in this tree's hierarchy.
|
void |
setInitialData(TreeNode[] initialData)
You can specify the initial set of data for a databound TreeGrid using this property.
|
void |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
void |
setKeepParentsOnFilter(java.lang.Boolean keepParentsOnFilter)
If set, tree-based filtering is performed such that parent nodes are kept as long as they have children that match the
filter criteria, even if the parents themselves do not match the filter criteria.
|
void |
setLeaveSelectionCheckboxGap(java.lang.Boolean leaveSelectionCheckboxGap)
If
selectionAppearance :"checkbox" is set on
the treegrid, and a node can't be selected, should a gap be left where the checkbox icon would normally appear, in order
to make the node's icon and title line up with the content for other nodes in the same parent? |
void |
setLoadDataOnDemand(java.lang.Boolean loadDataOnDemand)
For databound treeGrid instances, should the entire tree of data be loaded on initial fetch, or should folders load
their children as they are opened.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.tree.TreeGridLogicalStructure s) |
void |
setManyItemsImage(java.lang.String manyItemsImage)
The filename of the icon displayed use as the default drag tracker when for multiple files and/or folders are being
dragged.
|
void |
setNodeIcon(java.lang.String nodeIcon)
The filename of the default icon for all leaf nodes in this grid.
|
void |
setOfflineNodeMessage(java.lang.String offlineNodeMessage)
For TreeGrids with loadDataOnDemand: true, a message to show the user if an attempt is made to open a folder, and thus
load that node's children, while we are offline and there is no offline cache of that data.
|
void |
setOpenerIconHeight(java.lang.Integer openerIconHeight)
Height in pixels of the opener icons, that is, the icons which show the open or closed state of the node, typically a
[+] or [-] symbol.
|
void |
setOpenerIconSize(java.lang.Integer openerIconSize)
Default width and height in pixels of the opener icons, that is, the icons which show the open or closed state of the
node, typically a [+] or [-] symbol, if not overridden by
openerIconWidth /openerIconHeight . |
void |
setOpenerIconWidth(java.lang.Integer openerIconWidth)
Width in pixels of the opener icons, that is, the icons which show the open or closed state of the node, typically a [+]
or [-] symbol.
|
void |
setOpenerImage(java.lang.String openerImage)
The base filename of the opener icon for the folder node when 'showConnectors' is false for this TreeGrid.
The opener icon is displayed beside the folder icon in the Tree column for folder nodes. |
void |
setOpenIconSuffix(java.lang.String openIconSuffix)
If
showOpenIcons is true, this suffix will be
appended to the folderIcon for open folders in this
grid. |
void |
setOpenState(java.lang.String openState)
Reset this set of open folders within this grid's data to match the TreeGridOpenState object passed in.
Used to restore previous state retrieved from the grid by a call to TreeGrid.getOpenState . |
void |
setParentAlreadyContainsChildMessage(java.lang.String parentAlreadyContainsChildMessage)
Message displayed when user attempts to drag a node into a parent that already contains a child of the same name.
|
void |
setSelectedPaths(java.lang.String selectedPaths)
Reset this grid's selection to match the ListGridSelectedState object passed in.
Used to restore previous state retrieved from the grid by a call to TreeGrid.getSelectedPaths . |
void |
setSelectionProperty(java.lang.String selectionProperty)
If specified, the selection object for this list will use this property to mark records as selected.
|
void |
setSeparateFolders(java.lang.Boolean separateFolders)
If specified, this attribute will override
separateFolders on the data for this treeGrid. |
void |
setServerFilterFields(java.lang.String... serverFilterFields)
When
keepParentsOnFilter is enabled, this
property lists field names that will be sent to the server if they are present in criteria. |
void |
setShowConnectors(java.lang.Boolean showConnectors)
Should this treeGrid show connector lines illustrating the tree's hierarchy?
|
void |
setShowCustomIconDrop(java.lang.Boolean showCustomIconDrop)
Should folder nodes showing custom icons (set via the
customIconProperty , default icon ), show drop state images when the user is drop-hovering over the
folder. |
void |
setShowCustomIconOpen(java.lang.Boolean showCustomIconOpen)
Should folder nodes showing custom icons (set via the
customIconProperty ), show open state images when the
folder is opened. |
void |
setShowDisabledSelectionCheckbox(java.lang.Boolean showDisabledSelectionCheckbox)
Should tree nodes show a disabled checkbox
selectionAppearance :"checkbox" is set on the treegrid, and a node can't be selected? |
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 |
setShowFullConnectors(java.lang.Boolean showFullConnectors)
If
showConnectors is true, this property determines
whether we should show vertical continuation lines for each level of indenting within the tree. |
void |
setShowOpener(java.lang.Boolean showOpener)
Should the
opener icon be displayed next to folder
nodes? This is an icon which visually indicates whether the folder is opened or closed (typically via a [+] or [-]
image, or a turn-down arrow) and may be clicked to expand or collapse the folder. |
void |
setShowOpenIcons(java.lang.Boolean showOpenIcons)
If true, show a different icon for
open folders than closed folders. |
void |
setShowPartialSelection(java.lang.Boolean showPartialSelection)
Should partially selected parents be shown with special icon?
|
void |
setShowRoot(java.lang.Boolean showRoot)
Specifies whether the root node should be displayed in the treeGrid.
|
void |
setSortFoldersBeforeLeaves(java.lang.Boolean sortFoldersBeforeLeaves)
If specified, this attribute will override
sortFoldersBeforeLeaves on the data for this treeGrid. |
void |
setTreeFieldTitle(java.lang.String treeFieldTitle)
Visible title for the tree column (field).
|
void |
setTreeRootValue(java.lang.Integer treeRootValue)
For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.
|
void |
setTreeRootValue(java.lang.String treeRootValue)
For databound trees, use this attribute to supply a ${isc.DocUtils.linkForRef('ResultTree.rootValue')} for this component's generated data object.
|
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 |
startEditingNew()
This inherited
ListGrid API is not supported by the
TreeGrid since adding a new tree node arbitrarily at the end of the tree is usually not useful. |
void |
toggleFolder(TreeNode node)
Opens the folder specified by node if it's closed, and closes it if it's open.
|
java.lang.Boolean |
willAcceptDrop()
This method overrides
ListGrid.willAcceptDrop() and works as follows: First, ListGrid.willAcceptDrop() (the superclass definition) is consulted. |
addBodyKeyPressHandler, addCellClickHandler, addCellContextClickHandler, addCellDoubleClickHandler, addCellHoverHandler, addCellMouseDownHandler, addCellMouseUpHandler, addCellOutHandler, addCellOverHandler, addCellSavedHandler, addCellSelectionChangedHandler, addCellValueHoverHandler, addData, addData, addData, addDataArrivedHandler, addDragCompleteHandler, addDrawAreaChangedHandler, addDropCompleteHandler, addEditCompleteHandler, addEditFailedHandler, addEditorEnterHandler, addEditorExitHandler, addEmbeddedComponent, addEmbeddedComponent, addEmbeddedComponent, addEmbeddedComponent, addFetchDataHandler, addFieldStateChangedHandler, addFilterEditorSubmitHandler, addFormulaField, addFormulaUpdatedHandler, addGroupByCompleteHandler, addGroupByHandler, addGroupStateChangedHandler, addHeaderClickHandler, addHeaderDoubleClickHandler, addHeaderHoverHandler, addHilitesChangedHandler, addRecordClickHandler, addRecordCollapseHandler, addRecordDoubleClickHandler, addRecordExpandHandler, addRemoveRecordClickHandler, addRowContextClickHandler, addRowEditorEnterHandler, addRowEditorExitHandler, addRowHoverHandler, addRowMouseDownHandler, addRowMouseUpHandler, addRowOutHandler, addRowOverHandler, addSelectionChangedHandler, addSelectionUpdatedHandler, addSort, addSortChangedHandler, addSorterClickHandler, addSorterContextClickHandler, addSummaryField, addViewStateChangedHandler, anySelected, applyCellData, applyRecordData, autoFitField, autoFitFields, cancelEditing, canEditCell, canExpandRecord, canSelectCell, canSelectRecord, cellHasChanges, cellHasErrors, cellHasErrors, cellValueHoverHTML, cellValueIsClipped, chartData, chartData, clearCriteria, clearCriteria, clearCriteria, clearEditValue, clearFieldError, clearFieldError, clearRowErrors, clearSort, closeRecord, collapseRecord, configureGrouping, createRecordComponent, deselectAllRecords, deselectRecord, deselectRecord, deselectRecords, deselectRecords, disableHilite, disableHiliting, discardAllEdits, discardAllEdits, discardEdits, discardEdits, editFields, editHilites, enableHilite, enableHilite, enableHiliting, enableHiliting, endEditing, expandRecord, exportClientData, exportClientData, exportData, exportData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fetchRelatedData, fieldIsVisible, filterByEditor, filterData, find, findAll, findIndex, findNextIndex, findNextIndex, focusInFilterEditor, focusInFilterEditor, freezeField, freezeField, freezeFields, freezeFields, getAddDropValues, getAddFormulaFieldText, getAddOperation, getAddSummaryFieldText, getAdvancedFieldPickerThreshold, getAllEditRows, getAllFields, getAllowFilterExpressions, getAllowRowSpanning, getAlternateBodyStyleName, getAlternateRecordFrequency, getAlternateRecordStyles, getAlwaysShowEditors, getAnimateRemoveRecord, getAnimateRemoveSpeed, getAnimateRemoveTime, getAnimateRollOver, getAnimateRollUnder, getAnimateSelection, getAnimateSelectionUnder, getApplyFormulaAfterSummary, getApplyRowNumberStyle, getArrowKeyAction, getAsynchGroupingPrompt, getAutoFetchAsFilter, getAutoFetchData, getAutoFetchDisplayMap, getAutoFitAllText, getAutoFitClipFields, getAutoFitData, getAutoFitExpandField, getAutoFitExtraRecords, getAutoFitFieldsFillViewport, getAutoFitFieldText, getAutoFitFieldWidths, getAutoFitHeaderHeights, getAutoFitIconFields, getAutoFitMaxColumns, getAutoFitMaxHeight, getAutoFitMaxRecords, getAutoFitMaxWidth, getAutoFitWidthApproach, getAutoSaveEdits, getAutoSizeHeaderSpans, getBackgroundComponent, getBadFormulaResultValue, getBaseStyle, getBaseStyle, getBody, getBodyBackgroundColor, getBodyOverflow, getBodyScrollLeft, getBodyScrollTop, getBodyStyleName, getBooleanBaseStyle, getBooleanFalseImage, getBooleanImageHeight, getBooleanImageWidth, getBooleanPartialImage, getBooleanTrueImage, getCanAddFormulaFields, getCanAddSummaryFields, getCanAutoFitFields, getCancelEditingConfirmationMessage, getCanCollapseGroup, getCanDragSelect, getCanDragSelectText, getCanDropInEmptyArea, getCanEdit, getCanEditFieldAttribute, getCanEditTitles, getCanExpandMultipleRecords, getCanExpandRecordProperty, getCanExpandRecords, getCanFreezeFields, getCanGroupBy, getCanHover, getCanMultiGroup, getCanMultiSort, getCanPickFields, getCanPickOmittedFields, getCanRemoveRecords, getCanReorderFields, getCanResizeFields, getCanSelectAll, getCanSelectCells, getCanSort, getCanTabToHeader, getCellCSSText, getCellErrors, getCellHeight, getCellHoverComponent, getCellPadding, getCellRowSpan, getCellSelection, getCellStartRow, getCellStyle, getChartConstructor, getChartType, getCheckboxFieldFalseImage, getCheckboxFieldImageHeight, getCheckboxFieldImageWidth, getCheckboxFieldPartialImage, getCheckboxFieldTrueImage, getChildExpansionMode, getClearAllSortingText, getClearFilterText, getClearSortFieldText, getClipHeaderTitles, getConfigureGroupingText, getConfigureSortText, getConfirmCancelEditing, getConfirmDiscardEdits, getConfirmDiscardEditsMessage, getCriteria, getCurrentExpansionComponent, getCurrentExpansionComponent, getDataAsJSList, getDataAsRecordList, getDataPageSize, getDataSource, getDateFormatter, getDatetimeFormatter, getDefaultFields, getDefaultFieldWidth, getDefaultFormattedFieldValue, getDefaultFormattedFieldValue, getDefaultFormattedFieldValue, getDefaultFormattedValue, getDeferRemoval, getDetailDS, getDetailField, getDiscardEditsSaveButtonTitle, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDisplayValue, getDragData, getDragDataAction, getDragTrackerMode, getDragTrackerStyle, getDragTrackerTitle, getDrawAheadRatio, getDrawAllMaxCells, getDrawArea, getDrawnRowHeight, getDrawnRows, getDropValues, getDuplicateDragMessage, getEditByCell, getEditCol, getEditedCell, getEditedCell, getEditedCell, getEditedCell, getEditedRecord, getEditEvent, getEditFailedBaseStyle, getEditFailedCSSText, getEditFormItem, getEditFormItem, getEditFormulaFieldText, getEditOnF2Keypress, getEditOnFocus, getEditPendingBaseStyle, getEditPendingCSSText, getEditRow, getEditSummaryFieldText, getEditValue, getEditValueAsBoolean, getEditValueAsDate, getEditValueAsFloat, getEditValueAsInt, getEditValueAsRecord, getEditValueAsRecordArray, getEditValueAsString, getEditValues, getEditValues, getEmptyCellValue, getEmptyMessage, getEmptyMessageStyle, getEnforceVClipping, getEnterKeyEditAction, getEnumCriteriaAsInitialValues, getEscapeKeyEditAction, getEventColumn, getEventColumn, getExpansionCanEdit, getExpansionComponent, getExpansionDetailField, getExpansionDetailRelated, getExpansionDetails, getExpansionEditor, getExpansionEditorCollapseOnSave, getExpansionEditorSaveButton, getExpansionEditorSaveButtonTitle, getExpansionEditorSaveDialogPrompt, getExpansionEditorShowSaveDialog, getExpansionField, getExpansionFieldFalseImage, getExpansionFieldImageHeight, getExpansionFieldImageWidth, getExpansionFieldTrueImage, getExpansionLayout, getExpansionMode, getExpansionRelated, getExportAll, getExportFields, getExportRawValues, getFetchDelay, getFetchOperation, getField, getField, getFieldName, getFieldName, getFieldNum, getFieldPickerFieldProperties, getFieldPickerShowSampleValues, getFieldPickerWindow, getFields, getFieldState, getFieldVisibilitySubmenuTitle, getFieldWidth, getFilterButtonPrompt, getFilterButtonProperties, getFilterByCell, getFilterEditor, getFilterEditorCriteria, getFilterEditorCriteria, getFilterEditorHeight, getFilterLocalData, getFilterOnKeypress, getFixedFieldWidths, getFixedRecordHeights, getFocusRow, getFormulaBuilderSpanTitleSeparator, getFormulaFieldValue, getFreezeFieldText, getFreezeOnLeftText, getFreezeOnRightText, getFrozenBaseStyle, getFrozenHeaderBaseStyle, getFrozenHeaderTitleStyle, getGenerateClickOnEnter, getGenerateClickOnSpace, getGenerateDoubleClickOnEnter, getGenerateDoubleClickOnSpace, getGridComponents, getGridRenderer, getGridSummary, getGridSummaryData, getGridSummaryRecordProperty, getGroupByAsyncThreshold, getGroupByFields, getGroupByFieldSummaries, getGroupByMaxRecords, getGroupByText, getGroupIcon, getGroupIconSize, getGroupIndentSize, getGroupLeadingIndent, getGroupNodeBaseStyle, getGroupNodeStyle, getGroupState, getGroupSummaryRecordProperty, getGroupSummaryStyle, getGroupTitleColumnProperties, getGroupTitleField, getGroupTree, getHeader, getHeaderAutoFitEvent, getHeaderBackgroundColor, getHeaderBarStyle, getHeaderBaseStyle, getHeaderButtonProperties, getHeaderContextMenuItems, getHeaderHeight, getHeaderHoverAlign, getHeaderHoverHeight, getHeaderHoverOpacity, getHeaderHoverStyle, getHeaderHoverVAlign, getHeaderHoverWidth, getHeaderHoverWrap, getHeaderMenuButton, getHeaderMenuButtonHeight, getHeaderMenuButtonIcon, getHeaderMenuButtonIconHeight, getHeaderMenuButtonIconWidth, getHeaderMenuButtonWidth, getHeaderSpan, getHeaderSpanContextMenuItems, getHeaderSpanHeight, getHeaderTitleStyle, getHiliteCanReplaceValue, getHiliteEditorSpanTitleSeparator, getHiliteIconHeight, getHiliteIconLeftPadding, getHiliteIconPosition, getHiliteIconRightPadding, getHiliteIcons, getHiliteIconSize, getHiliteIconWidth, getHiliteProperty, getHiliteReplaceValueFieldTitle, getHilites, getHiliteState, getHoverMode, getHoverStyle, getImageSize, getIncludeHilitesInSummaryFields, getIncludeInSummaryProperty, getInitialCriteria, getInitialSort, getInstantScrollTrackRedraw, getInvalidSummaryValue, getIsGrouped, getIsSeparatorProperty, getLeaveScrollbarGap, getLinkTextProperty, getListEndEditAction, getLoadingDataMessage, getLoadingDataMessageStyle, getLoadingMessage, getLocateColumnsBy, getLocateRowsBy, getLongTextEditorThreshold, getLongTextEditorType, getMaxExpandedRecords, getMaxExpandedRecordsPrompt, getMinFieldWidth, getMissingSummaryFieldValue, getModalEditing, getNeverValidate, getNormalBaseStyle, getNormalCellHeight, getNullGroupTitle, getOfflineMessageStyle, getOriginalRecordList, getOriginalResultSet, getOriginBaseStyle, getPoolComponentsPerColumn, getPreventDuplicates, getPrintAutoFit, getPrintBaseStyle, getPrintHeaderStyle, getPrintMaxRows, getPrintWrapCells, getQuickDrawAheadRatio, getRecordBaseStyleProperty, getRecordCanRemoveProperty, getRecordCanSelectProperty, getRecordComponent, getRecordComponent, getRecordComponentHeight, getRecordComponentPoolingMode, getRecordComponentPosition, getRecordDetailDSProperty, getRecordEditProperty, getRecordEnabledProperty, getRecordIndex, getRecordIndex, getRecordList, getRecordSummaryBaseStyle, getRelatedDataSource, getRemovedCSSText, getRemoveFieldDefaults, getRemoveFieldProperties, getRemoveFieldTitle, getRemoveIcon, getRemoveIconSize, getRemoveOperation, getReselectOnUpdate, getReselectOnUpdateNotifications, getResizeFieldsInRealTime, getResultSet, getReverseRTLAlign, getRollOverCanvas, getRollUnderCanvas, getRowEndEditAction, getRowErrors, getRowHeight, getRowNumberField, getRowNumberStart, getRowNumberStyle, getRowPageTop, getRowSpan, getRowSpanSelectionMode, getRowTop, getSaveByCell, getSaveLocally, getSaveRequestProperties, getScreenReaderCellSeparator, getScreenReaderRowSeparator, getScrollRedrawDelay, getSelectedCellData, getSelectedRecords, getSelectedRecords, getSelectedState, getSelectHeaderOnSort, getSelection, getSelection, getSelectionAppearance, getSelectionType, getSelectOnEdit, getShowAllColumns, getShowAllRecords, getShowAsynchGroupingPrompt, getShowBackgroundComponents, getShowCellContextMenus, getShowClippedHeaderTitlesOnHover, getShowClippedValuesOnHover, getShowCollapsedGroupSummary, getShowComplexFields, getShowDetailFields, getShowEmptyMessage, getShowExpansionEditorSaveButton, getShowFilterEditor, getShowGridSummary, getShowGroupSummary, getShowGroupSummaryInHeader, getShowGroupTitleColumn, getShowHeader, getShowHeaderContextMenu, getShowHeaderMenuButton, getShowHeaderSpanTitlesInFormulaBuilder, getShowHeaderSpanTitlesInHiliteEditor, getShowHeaderSpanTitlesInSortEditor, getShowHiddenFields, getShowHilitesInGroupSummary, getShowHover, getShowHoverComponents, getShowRecordComponents, getShowRecordComponentsByCell, getShowRollOver, getShowRollOverCanvas, getShowRowNumbers, getShowSelectedStyle, getShowSelectionCanvas, getShowSortArrow, getShowSortNumerals, getShowTreeColumnPicker, getShrinkForFreeze, getSingleCellValueProperty, getSkinImgDir, getSort, getSortAscendingImage, getSortDescendingImage, getSortDirection, getSortEditorSpanTitleSeparator, getSorterButtonTitle, getSortField, getSortFieldAscendingText, getSortFieldCount, getSortFieldDescendingText, getSortNumeralHTML, getSortNumeralStyle, getSortSpecifier, getSortState, getStopOnErrors, getStyleName, getSummaryFieldValue, getSummaryRow, getSummaryRowCriteria, getSummaryRowDataSource, getSummaryRowFetchRequestProperties, getSummaryRowHeight, getSummaryRowStyle, getTallBaseStyle, getTitleField, getTitleFieldValue, getToggleFreezeText, getTotalRows, getTrackerImage, getUnfreezeFieldText, getUngroupText, getUnremoveIcon, getUpdateOperation, getUseAdvancedFieldPicker, getUseCellRollOvers, getUseCopyPasteShortcuts, getUseFlatFields, getUseRemoteValidators, getUseRowSpanStyling, getValidateByCell, getValidateOnChange, getValueIcon, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getViewState, getVirtualScrolling, getVisibleRows, getWaitForSave, getWarnOnRemoval, getWarnOnRemovalMessage, getWarnOnUnmappedValueFieldChange, getWrapCells, groupBy, hasChanges, hasErrors, headerHoverHTML, headerTitleClipped, hideField, hideField, hideFields, hideFields, hideFields, hideFields, invalidateCache, invalidateRecordComponents, isCheckboxField, isExpanded, isExpansionField, isGrouped, isGroupNode, isPartiallySelected, isRowNumberField, isSelected, isSortField, markForRedraw, markForRedraw, markRecordRemoved, markSelectionRemoved, onInit_ListGrid, openRecordDetailGrid, openRecordEditor, preloadImages, recalculateGridSummary, recalculateSummaries, recalculateSummaries, recordClick, recordMarkedAsRemoved, refreshCell, refreshCell, refreshCellStyle, refreshFields, refreshRecordComponent, refreshRecordComponent, refreshRow, removeData, removeData, removeData, removeEmbeddedComponent, removeEmbeddedComponent, removeEmbeddedComponent, removeRecordClick, removeSelectedData, removeSelectedData, reorderField, reorderFields, resizeField, resort, rowClick, rowDoubleClick, rowHasChanges, rowHasErrors, saveAllEdits, saveAllEdits, saveAllEdits, scrollBodyTo, scrollToCell, scrollToColumn, scrollToRow, selectAllRecords, selectRecord, selectRecord, selectRecord, selectRecord, selectRecords, selectRecords, selectRecords, selectRecords, selectSingleRecord, selectSingleRecord, setAddDropValues, setAddFormulaFieldText, setAddOperation, setAddSummaryFieldText, setAdvancedFieldPickerThreshold, setAllowFilterExpressions, setAllowRowSpanning, setAlternateBodyStyleName, setAlternateRecordFrequency, setAlternateRecordStyles, setAlwaysShowEditors, setAnimateRemoveRecord, setAnimateRemoveSpeed, setAnimateRemoveTime, setAnimateRollOver, setAnimateRollUnder, setAnimateSelection, setAnimateSelectionUnder, setApplyFormulaAfterSummary, setApplyRowNumberStyle, setArrowKeyAction, setAsynchGroupingPrompt, setAutoFetchAsFilter, setAutoFetchData, setAutoFetchDisplayMap, setAutoFitAllText, setAutoFitClipFields, setAutoFitData, setAutoFitExpandField, setAutoFitExtraRecords, setAutoFitFieldsFillViewport, setAutoFitFieldText, setAutoFitFieldWidths, setAutoFitHeaderHeights, setAutoFitIconFields, setAutoFitMaxColumns, setAutoFitMaxHeight, setAutoFitMaxRecords, setAutoFitMaxWidth, setAutoFitWidth, setAutoFitWidthApproach, setAutoSaveEdits, setAutoSizeHeaderSpans, setBadFormulaResultValue, setBaseStyle, setBodyBackgroundColor, setBodyOverflow, setBodyStyleName, setBooleanBaseStyle, setBooleanFalseImage, setBooleanImageHeight, setBooleanImageWidth, setBooleanPartialImage, setBooleanTrueImage, setCanAddFormulaFields, setCanAddSummaryFields, setCanAutoFitFields, setCancelEditingConfirmationMessage, setCanCollapseGroup, setCanDragSelect, setCanDragSelectText, setCanDropInEmptyArea, setCanEdit, setCanEditFieldAttribute, setCanEditTitles, setCanExpandMultipleRecords, setCanExpandRecordProperty, setCanExpandRecords, setCanFreezeFields, setCanGroupBy, setCanHover, setCanMultiGroup, setCanMultiSort, setCanPickFields, setCanPickOmittedFields, setCanRemoveRecords, setCanReorderFields, setCanResizeFields, setCanSelectAll, setCanSelectCells, setCanSort, setCanTabToHeader, setCellFormatter, setCellHeight, setCellPadding, setChartConstructor, setChartType, setCheckboxFieldFalseImage, setCheckboxFieldImageHeight, setCheckboxFieldImageWidth, setCheckboxFieldPartialImage, setCheckboxFieldProperties, setCheckboxFieldTrueImage, setChildExpansionMode, setClearAllSortingText, setClearFilterText, setClearSortFieldText, setClipHeaderTitles, setConfigureGroupingText, setConfigureSortText, setConfirmCancelEditing, setConfirmDiscardEdits, setConfirmDiscardEditsMessage, setCriteria, setData, setData, setData, setDataPageSize, setDataProperties, setDataSource, setDataSource, setDateFormatter, setDateInputFormat, setDatetimeFormatter, setDefaultFields, setDefaultProperties, setDeferRemoval, setDetailDS, setDetailDS, setDetailField, setDiscardEditsSaveButtonTitle, setDontAutoDestroyComponent, setDragDataAction, setDragTrackerIconCustomizer, setDragTrackerMode, setDragTrackerStyle, setDrawAheadRatio, setDrawAllMaxCells, setDropValues, setDuplicateDragMessage, setEditByCell, setEditEvent, setEditFailedBaseStyle, setEditFailedCSSText, setEditFormulaFieldText, setEditOnF2Keypress, setEditOnFocus, setEditorCustomizer, setEditorValueMap, setEditorValueMap, setEditPendingBaseStyle, setEditPendingCSSText, setEditSummaryFieldText, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValue, setEditValues, setEmptyCellValue, setEmptyMessage, setEmptyMessageStyle, setEnforceVClipping, setEnterKeyEditAction, setEnumCriteriaAsInitialValues, setEscapeKeyEditAction, setExpansionCanEdit, setExpansionEditorSaveDialogPrompt, setExpansionEditorShowSaveDialog, setExpansionFieldFalseImage, setExpansionFieldImageHeight, setExpansionFieldImageWidth, setExpansionFieldTrueImage, setExpansionMode, setExportAll, setExportFields, setExportRawValues, setFastCellUpdates, setFetchDelay, setFetchOperation, setFieldButtonProperties, setFieldCellIcon, setFieldError, setFieldError, setFieldHeaderBaseStyle, setFieldHeaderTitleStyle, setFieldIcon, setFieldPickerFieldProperties, setFieldPickerShowSampleValues, setFields, setFieldState, setFieldTitle, setFieldTitle, setFieldVisibilitySubmenuTitle, setFilterButtonPrompt, setFilterButtonProperties, setFilterByCell, setFilterEditorCriteria, setFilterEditorHeight, setFilterLocalData, setFilterOnKeypress, setFixedFieldWidths, setFixedRecordHeights, setFormulaBuilderSpanTitleSeparator, setFreezeFieldText, setFreezeOnLeftText, setFreezeOnRightText, setFrozenBaseStyle, setFrozenHeaderBaseStyle, setFrozenHeaderTitleStyle, setGenerateClickOnEnter, setGenerateClickOnSpace, setGenerateDoubleClickOnEnter, setGenerateDoubleClickOnSpace, setGridComponents, setGridComponents, setGridSummaryRecordProperty, setGroupByAsyncThreshold, setGroupByField, setGroupByField, setGroupByFieldSummaries, setGroupByMaxRecords, setGroupByText, setGroupIcon, setGroupIconSize, setGroupIndentSize, setGroupLeadingIndent, setGroupNodeBaseStyle, setGroupNodeStyle, setGroupStartOpen, setGroupStartOpen, setGroupState, setGroupSummaryRecordProperty, setGroupSummaryStyle, setGroupTitleColumnProperties, setGroupTitleField, setHeaderAutoFitEvent, setHeaderBackgroundColor, setHeaderBarStyle, setHeaderBaseStyle, setHeaderButtonProperties, setHeaderHeight, setHeaderHoverAlign, setHeaderHoverFormatter, setHeaderHoverHeight, setHeaderHoverOpacity, setHeaderHoverStyle, setHeaderHoverVAlign, setHeaderHoverWidth, setHeaderHoverWrap, setHeaderMenuButtonHeight, setHeaderMenuButtonIcon, setHeaderMenuButtonIconHeight, setHeaderMenuButtonIconWidth, setHeaderMenuButtonWidth, setHeaderSpanBaseStyle, setHeaderSpanButtonProperties, setHeaderSpanHeaderTitle, setHeaderSpanHeight, setHeaderSpans, setHeaderSpanTitle, setHeaderSpanTitleStyle, setHeaderTitleStyle, setHiliteCanReplaceValue, setHiliteEditorSpanTitleSeparator, setHiliteIconHeight, setHiliteIconLeftPadding, setHiliteIconPosition, setHiliteIconRightPadding, setHiliteIcons, setHiliteIconSize, setHiliteIconWidth, setHiliteProperty, setHiliteReplaceValueFieldTitle, setHilites, setHiliteState, setHoverCustomizer, setHoverMode, setHoverStyle, setImageSize, setIncludeHilitesInSummaryFields, setIncludeInSummaryProperty, setInitialCriteria, setInitialSort, setInstantScrollTrackRedraw, setInvalidSummaryValue, setIsSeparatorProperty, setLeaveHeaderMenuButtonSpace, setLeaveScrollbarGap, setLinkTextProperty, setListEndEditAction, setLoadingDataMessage, setLoadingDataMessageStyle, setLoadingMessage, setLocateColumnsBy, setLocateRowsBy, setLogicalStructure, setLongTextEditorThreshold, setLongTextEditorType, setMaxExpandedRecords, setMaxExpandedRecordsPrompt, setMinFieldWidth, setMissingSummaryFieldValue, setModalEditing, setNeverValidate, setNormalBaseStyle, setNormalCellHeight, setNullGroupTitle, setOfflineMessageStyle, setOriginBaseStyle, setPoolComponentsPerColumn, setPreventDuplicates, setPrintAutoFit, setPrintBaseStyle, setPrintHeaderStyle, setPrintMaxRows, setPrintWrapCells, setQuickDrawAheadRatio, setRecordBaseStyleProperty, setRecordCanRemoveProperty, setRecordCanSelectProperty, setRecordComponentHeight, setRecordComponentPoolingMode, setRecordComponentPosition, setRecordDetailDSProperty, setRecordEditProperty, setRecordEnabledProperty, setRecords, setRecordSummaryBaseStyle, setRemovedCSSText, setRemoveFieldProperties, setRemoveFieldTitle, setRemoveIcon, setRemoveIconSize, setRemoveOperation, setReselectOnUpdate, setReselectOnUpdateNotifications, setResizeFieldsInRealTime, setReverseRTLAlign, setRollUnderCanvasProperties, setRowEndEditAction, setRowErrors, setRowNumberFieldProperties, setRowNumberStart, setRowNumberStyle, setRowSpanSelectionMode, setSaveByCell, setSaveLocally, setSaveRequestProperties, setScreenReaderCellSeparator, setScreenReaderRowSeparator, setScrollRedrawDelay, setSelectedState, setSelectHeaderOnSort, setSelectionAppearance, setSelectionCanvasProperties, setSelectionType, setSelectionUnderCanvasProperties, setSelectOnEdit, setShowAllColumns, setShowAllRecords, setShowAsynchGroupingPrompt, setShowBackgroundComponents, setShowCellContextMenus, setShowClippedHeaderTitlesOnHover, setShowClippedValuesOnHover, setShowCollapsedGroupSummary, setShowComplexFields, setShowDetailFields, setShowEmptyMessage, setShowFilterEditor, setShowGridSummary, setShowGroupSummary, setShowGroupSummaryInHeader, setShowGroupTitleColumn, setShowHeader, setShowHeaderContextMenu, setShowHeaderMenuButton, setShowHeaderSpanTitlesInFormulaBuilder, setShowHeaderSpanTitlesInHiliteEditor, setShowHeaderSpanTitlesInSortEditor, setShowHiddenFields, setShowHilitesInGroupSummary, setShowHover, setShowHoverComponents, setShowRecordComponents, setShowRecordComponentsByCell, setShowRollOver, setShowRollOverCanvas, setShowRowNumbers, setShowSelectedStyle, setShowSelectionCanvas, setShowSortArrow, setShowSortNumerals, setShowTreeColumnPicker, setShrinkForFreeze, setSingleCellValueProperty, setSkinImgDir, setSort, setSortAscendingImage, setSortDescendingImage, setSortDirection, setSortEditorSpanTitleSeparator, setSorterButtonTitle, setSortField, setSortField, setSortFieldAscendingText, setSortFieldDescendingText, setSortNumeralStyle, setSortState, setStopOnErrors, setStyleName, setSummaryRowCriteria, setSummaryRowDataSource, setSummaryRowFetchRequestProperties, setSummaryRowHeight, setSummaryRowStyle, setTallBaseStyle, setTitleField, setTrackerImage, setUnfreezeFieldText, setUngroupText, setUnremoveIcon, setUpdateOperation, setUseAdvancedFieldPicker, setUseCellRollOvers, setUseCopyPasteShortcuts, setUseFlatFields, setUseRemoteValidators, setUseRowSpanStyling, setValidateByCell, setValidateOnChange, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setViewState, setVirtualScrolling, setWaitForSave, setWarnOnRemoval, setWarnOnRemovalMessage, setWarnOnUnmappedValueFieldChange, setWrapCells, shouldIncludeHiliteInSummaryField, showField, showField, showFields, showFields, showFields, showFields, showRecordComponent, sort, sort, sort, startEditing, startEditing, startEditing, startEditing, startEditingNew, startEditingNew, stopHover, summaryUpdated, toggleSort, transferSelectedData, transferSelectedData, unfreezeField, unfreezeField, unfreezeFields, unfreezeFields, ungroup, unmarkRecordRemoved, unsort, updateData, updateData, updateData, updateRecordComponent, userSelectAllRecords, validateCell, validateCell, validateRow, willFetchData, willFetchData
setDefaultProperties, setLogicalStructure
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, getAnimateMembers, getAnimateMemberTime, getCanDropComponents, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOffset, getMemberOverlap, getMembers, getMembersMargin, getMinMemberSize, getOverflow, getPaddingAsLayoutMargin, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, membersChanged, onInit_Layout, reflow, reflow, reflowNow, removeMember, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setCanDropComponents, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinMemberSize, setOverflow, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember
addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowResizeBar, getShowShadow, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowResizeBar, setShowShadow, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint
addDrawHandler, 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, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getOrCreateJsObj
public TreeGrid()
public TreeGrid(com.google.gwt.core.client.JavaScriptObject jsObj)
public static TreeGrid getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
protected TreeGrid getTestInstance()
getTestInstance
in class ListGrid
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject
in class ListGrid
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.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.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.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.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public void setAlwaysShowOpener(java.lang.Boolean alwaysShowOpener)
showOpener
is true, should we display the opener icon
for folders even if they have no children? Note that for trees which load data on demand
, we may not know if a folder has any
descendants if it has never been opened. As such we will show the opener icon next to the folder. Once the user opens
the icon and a fetch occurs, if the folder is empty, and this property is false, the opener icon will be hidden.
For
more information on load on demand trees, and how we determine whether a node is a a folder or a leaf, please refer to
the TreeDataBinding
documentation.
alwaysShowOpener
- alwaysShowOpener Default value is falsepublic java.lang.Boolean getAlwaysShowOpener()
showOpener
is true, should we display the opener icon
for folders even if they have no children? Note that for trees which load data on demand
, we may not know if a folder has any
descendants if it has never been opened. As such we will show the opener icon next to the folder. Once the user opens
the icon and a fetch occurs, if the folder is empty, and this property is false, the opener icon will be hidden.
For
more information on load on demand trees, and how we determine whether a node is a a folder or a leaf, please refer to
the TreeDataBinding
documentation.
public void setAnimateFolderEffect(AnimationAcceleration animateFolderEffect)
setAnimateFolderEffect
in class ListGrid
animateFolderEffect
- animateFolderEffect Default value is nullpublic AnimationAcceleration getAnimateFolderEffect()
getAnimateFolderEffect
in class ListGrid
public void setAnimateFolderMaxRows(java.lang.Integer animateFolderMaxRows)
animateFolders
is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.setAnimateFolderMaxRows
in class ListGrid
animateFolderMaxRows
- animateFolderMaxRows Default value is nullgetAnimateFolderMaxRows()
public java.lang.Integer getAnimateFolderMaxRows()
animateFolders
is true for this grid, this number
can be set to designate the maximum number of rows to animate at a time when opening / closing a folder.getAnimateFolderMaxRows
in class ListGrid
animateFolders
is true for this treeGrid, this
method returns the the maximum number of rows to animate at a time when opening / closing a folder. This method will
return animateFolderMaxRows
if set. Otherwise
the value will be calculated as 3x the number of rows required to fill a viewport, capped at a maximum value of 75.getAnimateFolderMaxRows()
public void setAnimateFolders(java.lang.Boolean animateFolders)
setAnimateFolders
in class ListGrid
animateFolders
- animateFolders Default value is truepublic java.lang.Boolean getAnimateFolders()
getAnimateFolders
in class ListGrid
public void setAnimateFolderSpeed(int animateFolderSpeed)
animateFolderTime
property, which allows the developer to specify a duration for the animation rather than a speed.setAnimateFolderSpeed
in class ListGrid
animateFolderSpeed
- animateFolderSpeed Default value is 3000setAnimateFolderTime(int)
,
Tree Folders Examplepublic int getAnimateFolderSpeed()
animateFolderTime
property, which allows the developer to specify a duration for the animation rather than a speed.getAnimateFolderSpeed
in class ListGrid
getAnimateFolderTime()
,
Tree Folders Examplepublic void setAnimateFolderTime(int animateFolderTime)
animateFolderSpeed
is not set, this property designates the duration of the animation in ms.setAnimateFolderTime
in class ListGrid
animateFolderTime
- animateFolderTime Default value is 100setAnimateFolderSpeed(int)
public int getAnimateFolderTime()
animateFolderSpeed
is not set, this property designates the duration of the animation in ms.getAnimateFolderTime
in class ListGrid
getAnimateFolderSpeed()
public void setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle) throws java.lang.IllegalStateException
loadDataOnDemand
:true, TreeGrids fetch data
by selecting the child nodes of each parent, which should be exact match, so we default to
autoFetchTextMatchStyle:"exact"
. See autoFetchTextMatchStyle
for details.setAutoFetchTextMatchStyle
in interface DataBoundComponent
setAutoFetchTextMatchStyle
in class ListGrid
autoFetchTextMatchStyle
- autoFetchTextMatchStyle Default value is "exact"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic TextMatchStyle getAutoFetchTextMatchStyle()
loadDataOnDemand
:true, TreeGrids fetch data
by selecting the child nodes of each parent, which should be exact match, so we default to
autoFetchTextMatchStyle:"exact"
. See autoFetchTextMatchStyle
for details.getAutoFetchTextMatchStyle
in interface DataBoundComponent
getAutoFetchTextMatchStyle
in class ListGrid
public void setAutoPreserveOpenState(PreserveOpenState autoPreserveOpenState) throws java.lang.IllegalStateException
autoPreserveOpenState
, governing whether the open state of the tree should be preserved when new data arrives due to
cache invalidation.autoPreserveOpenState
- autoPreserveOpenState Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic PreserveOpenState getAutoPreserveOpenState()
autoPreserveOpenState
, governing whether the open state of the tree should be preserved when new data arrives due to
cache invalidation.public void setCanAcceptDroppedRecords(java.lang.Boolean canAcceptDroppedRecords)
setCanAcceptDroppedRecords
in class ListGrid
canAcceptDroppedRecords
- canAcceptDroppedRecords Default value is falseTreeNode.setCanDrag(java.lang.Boolean)
,
TreeNode.setCanAcceptDrop(java.lang.Boolean)
,
Dragdrop overview and related methods
,
Tree Reparent Examplepublic java.lang.Boolean getCanAcceptDroppedRecords()
getCanAcceptDroppedRecords
in class ListGrid
TreeNode.getCanDrag()
,
TreeNode.getCanAcceptDrop()
,
Dragdrop overview and related methods
,
Tree Reparent Examplepublic void setCanDragRecordsOut(java.lang.Boolean canDragRecordsOut)
setCanDragRecordsOut
in class ListGrid
canDragRecordsOut
- canDragRecordsOut Default value is falseTreeNode.setCanDrag(java.lang.Boolean)
,
TreeNode.setCanAcceptDrop(java.lang.Boolean)
,
Dragdrop overview and related methods
,
Drop Events Examplepublic java.lang.Boolean getCanDragRecordsOut()
getCanDragRecordsOut
in class ListGrid
TreeNode.getCanDrag()
,
TreeNode.getCanAcceptDrop()
,
Dragdrop overview and related methods
,
Drop Events Examplepublic void setCanDropOnLeaves(java.lang.Boolean canDropOnLeaves)
Dropping is ordinarily not allowed on leaf nodes unless canReorderRecords
is set.
The default action for a
drop on a leaf node is to place the node in that leaf's parent folder. This can be customized by overriding TreeGrid.folderDrop
.
Note that enabling
canDropOnLeaves
is usually only appropriate where you intend to add a custom TreeGrid.folderDrop
implementation that does not add a
child node under the leaf. If you want to add a child nodes to a leaf, instead of enabling canDropOnLeaves, use empty
folders instead - see Tree.isFolder
for how to control whether a
node is considered a folder.
Note : This is an advanced setting
canDropOnLeaves
- canDropOnLeaves Default value is falsepublic java.lang.Boolean getCanDropOnLeaves()
Dropping is ordinarily not allowed on leaf nodes unless canReorderRecords
is set.
The default action for a
drop on a leaf node is to place the node in that leaf's parent folder. This can be customized by overriding TreeGrid.folderDrop
.
Note that enabling
canDropOnLeaves
is usually only appropriate where you intend to add a custom TreeGrid.folderDrop
implementation that does not add a
child node under the leaf. If you want to add a child nodes to a leaf, instead of enabling canDropOnLeaves, use empty
folders instead - see Tree.isFolder
for how to control whether a
node is considered a folder.
public void setCanReorderRecords(java.lang.Boolean canReorderRecords)
Note : This is an advanced setting
setCanReorderRecords
in class ListGrid
canReorderRecords
- canReorderRecords Default value is falseTreeNode.setCanDrag(java.lang.Boolean)
,
TreeNode.setCanAcceptDrop(java.lang.Boolean)
,
Dragdrop overview and related methods
,
Tree Reparent Examplepublic java.lang.Boolean getCanReorderRecords()
getCanReorderRecords
in class ListGrid
TreeNode.getCanDrag()
,
TreeNode.getCanAcceptDrop()
,
Dragdrop overview and related methods
,
Tree Reparent Examplepublic void setCanReparentNodes(java.lang.Boolean canReparentNodes)
this.canAcceptDroppedRecords
is true, we allow nodes to be dragged to different folders.canReparentNodes
- canReparentNodes Default value is nullTreeNode.setCanDrag(java.lang.Boolean)
,
TreeNode.setCanAcceptDrop(java.lang.Boolean)
,
Dragdrop overview and related methods
public java.lang.Boolean getCanReparentNodes()
this.canAcceptDroppedRecords
is true, we allow nodes to be dragged to different folders.TreeNode.getCanDrag()
,
TreeNode.getCanAcceptDrop()
,
Dragdrop overview and related methods
public void setCantDragIntoChildMessage(java.lang.String cantDragIntoChildMessage) throws java.lang.IllegalStateException
cantDragIntoChildMessage
- . See String
. Default value is "You can't drag an item into one of it's children."java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetCanDragRecordsOut(java.lang.Boolean)
,
setCanAcceptDroppedRecords(java.lang.Boolean)
,
setCanReorderRecords(java.lang.Boolean)
public java.lang.String getCantDragIntoChildMessage()
String
getCanDragRecordsOut()
,
getCanAcceptDroppedRecords()
,
getCanReorderRecords()
public void setCantDragIntoSelfMessage(java.lang.String cantDragIntoSelfMessage) throws java.lang.IllegalStateException
cantDragIntoSelfMessage
- . See String
. Default value is "You can't drag an item into itself."java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetCanDragRecordsOut(java.lang.Boolean)
,
setCanAcceptDroppedRecords(java.lang.Boolean)
,
setCanReorderRecords(java.lang.Boolean)
public java.lang.String getCantDragIntoSelfMessage()
String
getCanDragRecordsOut()
,
getCanAcceptDroppedRecords()
,
getCanReorderRecords()
public void setCascadeSelection(java.lang.Boolean cascadeSelection) throws java.lang.IllegalStateException
cascadeSelection
- cascadeSelection Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCascadeSelection()
public void setClosedIconSuffix(java.lang.String closedIconSuffix)
folderIcon
for
closed folders. If showOpenIcons
is set to
false
this suffix will also be appended to open folders' icons.closedIconSuffix
- . See String
. Default value is "closed"public java.lang.String getClosedIconSuffix()
folderIcon
for
closed folders. If showOpenIcons
is set to
false
this suffix will also be appended to open folders' icons.String
public void setConnectorImage(java.lang.String connectorImage) throws java.lang.IllegalStateException
showConnectors
is true. Connector icons are rendered into the title field of each row and show the dotted hierarchy
lines between siblings of the same parent node. For each node, a connector icon may be shown:showFullConnectors
is true).showFullConnectors
governs whether connector
lines will be displayed for all indent levels, or just for the innermost level of the tree. The filenames for these
icons are assembled from this base filename and the state of the node. Assuming the connectorImage is set to
{baseName}.{extension}
, the full set of images to be displayed will be:
{baseName}_ancestor[_rtl].{extension}
if showFullConnectors
is true, this is the URL for the
vertical continuation image to be displayed at the appropriate indent levels for ancestor nodes with subsequent
children.
For nodes with no children:
{baseName}_single[_rtl].{extension}
: Shown when there is
no connector line attached to the parent or previous sibling, and no connector line to the next sibling. For showFullConnectors:true
trees, there will always be a
connector leading to the parent or previous sibling if its present in the tree so this icon can only be displayed for
the first row.{baseName}_start[_rtl].{extension}
: Shown when the there is no connector line
attached to the parent or previous sibling, but there is a connector to the next sibling. As with _single
this will only ever be used for the first row if showFullConnectors
is true{baseName}_end[_rtl].{extension}
: Shown if we are not showing a
connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or
parent).{baseName}_middle[_rtl].{extension}
: Shown where the we have a connector line leading
to both the previous sibling (or parent) and the next sibling. showFullConnectors
is false, open folders will never
show a connector to subsequent siblings: {baseName}_opened_single[_rtl].{extension}
opened folder
node with children when no connector line is shown attaching to either the folder's previous sibling or parent, or to
any subsequent siblings.{baseName}_opened_start[_rtl].{extension}
: opened folder with children
when the there is no connector line attached to the parent or previous sibling, but there is a connector to the next
sibling.{baseName}_opened_end[_rtl].{extension}
: opened folder with children if we are not
showing a connector line attached to the next sibling of this node (but are showing a connection to the previous
sibling or parent).{baseName}_opened_middle[_rtl].{extension}
: opened folder with children
where the we have a connector line leading to both the previous sibling (or parent) and the next sibling. {baseName}_closed_single[_rtl].{extension}
closed folder node with children when no connector line is
shown attaching to either the folder's previous sibling or parent, or to any subsequent siblings.{baseName}_closed_start[_rtl].{extension}
: closed folder with children when the there is no connector
line attached to the parent or previous sibling, but there is a connector to the next sibling.{baseName}_closed_end[_rtl].{extension}
: closed folder with children if we are not showing a
connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or
parent).{baseName}_closed_middle[_rtl].{extension}
: closed folder with children where the we
have a connector line leading to both the previous sibling (or parent) and the next sibling. connectorImage
- . See SCImgURL
. Default value is "[SKIN]connector.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getConnectorImage()
showConnectors
is true. Connector icons are rendered into the title field of each row and show the dotted hierarchy
lines between siblings of the same parent node. For each node, a connector icon may be shown:showFullConnectors
is true).showFullConnectors
governs whether connector
lines will be displayed for all indent levels, or just for the innermost level of the tree. The filenames for these
icons are assembled from this base filename and the state of the node. Assuming the connectorImage is set to
{baseName}.{extension}
, the full set of images to be displayed will be:
{baseName}_ancestor[_rtl].{extension}
if showFullConnectors
is true, this is the URL for the
vertical continuation image to be displayed at the appropriate indent levels for ancestor nodes with subsequent
children.
For nodes with no children:
{baseName}_single[_rtl].{extension}
: Shown when there is
no connector line attached to the parent or previous sibling, and no connector line to the next sibling. For showFullConnectors:true
trees, there will always be a
connector leading to the parent or previous sibling if its present in the tree so this icon can only be displayed for
the first row.{baseName}_start[_rtl].{extension}
: Shown when the there is no connector line
attached to the parent or previous sibling, but there is a connector to the next sibling. As with _single
this will only ever be used for the first row if showFullConnectors
is true{baseName}_end[_rtl].{extension}
: Shown if we are not showing a
connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or
parent).{baseName}_middle[_rtl].{extension}
: Shown where the we have a connector line leading
to both the previous sibling (or parent) and the next sibling. showFullConnectors
is false, open folders will never
show a connector to subsequent siblings: {baseName}_opened_single[_rtl].{extension}
opened folder
node with children when no connector line is shown attaching to either the folder's previous sibling or parent, or to
any subsequent siblings.{baseName}_opened_start[_rtl].{extension}
: opened folder with children
when the there is no connector line attached to the parent or previous sibling, but there is a connector to the next
sibling.{baseName}_opened_end[_rtl].{extension}
: opened folder with children if we are not
showing a connector line attached to the next sibling of this node (but are showing a connection to the previous
sibling or parent).{baseName}_opened_middle[_rtl].{extension}
: opened folder with children
where the we have a connector line leading to both the previous sibling (or parent) and the next sibling. {baseName}_closed_single[_rtl].{extension}
closed folder node with children when no connector line is
shown attaching to either the folder's previous sibling or parent, or to any subsequent siblings.{baseName}_closed_start[_rtl].{extension}
: closed folder with children when the there is no connector
line attached to the parent or previous sibling, but there is a connector to the next sibling.{baseName}_closed_end[_rtl].{extension}
: closed folder with children if we are not showing a
connector line attached to the next sibling of this node (but are showing a connection to the previous sibling or
parent).{baseName}_closed_middle[_rtl].{extension}
: closed folder with children where the we
have a connector line leading to both the previous sibling (or parent) and the next sibling. SCImgURL
public void setCreateDefaultTreeField(java.lang.Boolean createDefaultTreeField) throws java.lang.IllegalStateException
treeField
set to true
to show the tree.
This automatically generated field will display values derived by calling TreeGrid.getNodeTitle
, and have the column title set to the
specified treeFieldTitle
.
Has no effect if fields are explicitly specified.
This is a convenience setting to allow a TreeGrid to be created without specifying
a field list. If fields are specified, refer to the documentation on property autoAssignTreeField
for a way to automatically have
one of the fields be use as the tree field if no fields have treeField
set.
For databound treeGrids, if there is no
explicit fields array specified, developers who wish to pick up all fields from the DataSource definition rather than
displaying this single automatically generated tree field may either set this property to false, or set useAllDataSourceFields
to true
.
createDefaultTreeField
- createDefaultTreeField Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCreateDefaultTreeField()
treeField
set to true
to show the tree.
This automatically generated field will display values derived by calling TreeGrid.getNodeTitle
, and have the column title set to the
specified treeFieldTitle
.
Has no effect if fields are explicitly specified.
This is a convenience setting to allow a TreeGrid to be created without specifying
a field list. If fields are specified, refer to the documentation on property autoAssignTreeField
for a way to automatically have
one of the fields be use as the tree field if no fields have treeField
set.
For databound treeGrids, if there is no
explicit fields array specified, developers who wish to pick up all fields from the DataSource definition rather than
displaying this single automatically generated tree field may either set this property to false, or set useAllDataSourceFields
to true
.
public void setCustomIconDropProperty(java.lang.String customIconDropProperty)
default node.showDropIcon
property.
Note : This is an advanced setting
customIconDropProperty
- . See String
. Default value is "showDropIcon"setCustomIconProperty(java.lang.String)
,
setShowCustomIconDrop(java.lang.Boolean)
public java.lang.String getCustomIconDropProperty()
default node.showDropIcon
property.String
getCustomIconProperty()
,
getShowCustomIconDrop()
public void setCustomIconOpenProperty(java.lang.String customIconOpenProperty)
default node.showOpenIcon
property.
Note : This is an advanced setting
customIconOpenProperty
- . See String
. Default value is "showOpenIcon"setCustomIconProperty(java.lang.String)
,
setShowCustomIconOpen(java.lang.Boolean)
public java.lang.String getCustomIconOpenProperty()
default node.showOpenIcon
property.String
getCustomIconProperty()
,
getShowCustomIconOpen()
public void setCustomIconProperty(java.lang.String customIconProperty)
default
node.icon
property.customIconProperty
- . See String
. Default value is "icon"public java.lang.String getCustomIconProperty()
default
node.icon
property.String
public void setDataFetchMode(FetchMode dataFetchMode) throws java.lang.IllegalStateException
In a ResultTree, "basic" fetchMode implies that if search criteria change, the
entire tree will be discarded and re-fetched from the server. TreeGrid.getOpenState
will be preserved.
fetchMode:"local"
implies that local filtering will be performed. See keepParentsOnFilter
for additional filtering details.
fetchMode:"paged" does not apply to ResultTrees. Instead, loadDataOnDemand
is used for folder-by-folder loading of
tree data. If enough nodes exist that paging is desirable within a folder, a better UI can be obtained by showing an
adjacent ListGrid (similar to Outlook email) to show a large number of child nodes.
setDataFetchMode
in interface DataBoundComponent
setDataFetchMode
in class ListGrid
dataFetchMode
- dataFetchMode Default value is "basic"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdDatabinding overview and related methods
public FetchMode getDataFetchMode()
In a ResultTree, "basic" fetchMode implies that if search criteria change, the
entire tree will be discarded and re-fetched from the server. TreeGrid.getOpenState
will be preserved.
fetchMode:"local"
implies that local filtering will be performed. See keepParentsOnFilter
for additional filtering details.
fetchMode:"paged" does not apply to ResultTrees. Instead, loadDataOnDemand
is used for folder-by-folder loading of
tree data. If enough nodes exist that paging is desirable within a folder, a better UI can be obtained by showing an
adjacent ListGrid (similar to Outlook email) to show a large number of child nodes.
getDataFetchMode
in interface DataBoundComponent
getDataFetchMode
in class ListGrid
Databinding overview and related methods
public void setDisplayNodeType(DisplayNodeType displayNodeType)
displayNodeType
- displayNodeType Default value is Tree.FOLDERS_AND_LEAVESDisplayNodeType
public DisplayNodeType getDisplayNodeType()
DisplayNodeType
public void setDropIconSuffix(java.lang.String dropIconSuffix)
showDropIcons
is true, this suffix will be
appended to the folderIcon
when the user drop-hovers
over some folder.dropIconSuffix
- . See String
. Default value is "drop"public java.lang.String getDropIconSuffix()
showDropIcons
is true, this suffix will be
appended to the folderIcon
when the user drop-hovers
over some folder.String
public void setExtraIconGap(int extraIconGap) throws java.lang.IllegalStateException
TreeGrid.getExtraIcon
) or checkbox icon and the nodeIcon
/
folderIcon
or node text.extraIconGap
- extraIconGap Default value is 2java.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public int getExtraIconGap()
TreeGrid.getExtraIcon
) or checkbox icon and the nodeIcon
/
folderIcon
or node text.Appearance overview and related methods
public void setFolderIcon(java.lang.String folderIcon)
openIconSuffix
, closedIconSuffix
or dropIconSuffix
appended to indicate state changes if
appropriate - see documentation on showOpenIcons
and showDropIcons
.folderIcon
- . See SCImgURL
. Default value is "[SKIN]folder.gif"public java.lang.String getFolderIcon()
openIconSuffix
, closedIconSuffix
or dropIconSuffix
appended to indicate state changes if
appropriate - see documentation on showOpenIcons
and showDropIcons
.SCImgURL
public void setIconSize(int iconSize)
iconSize
- iconSize Default value is 16public int getIconSize()
public void setIndentRecordComponents(java.lang.Boolean indentRecordComponents)
treeField
column, should the component be indented to the position where a title would normally show? For more general
placement of embedded components, see addEmbeddedComponent
.
indentRecordComponents
- indentRecordComponents Default value is truepublic java.lang.Boolean getIndentRecordComponents()
treeField
column, should the component be indented to the position where a title would normally show? For more general
placement of embedded components, see addEmbeddedComponent
.
public void setIndentSize(int indentSize)
This value is ignored when showConnectors
is
true
because fixed-size images are used to render the connectors.
indentSize
- indentSize Default value is 20Appearance overview and related methods
public int getIndentSize()
This value is ignored when showConnectors
is
true
because fixed-size images are used to render the connectors.
Appearance overview and related methods
public void setKeepParentsOnFilter(java.lang.Boolean keepParentsOnFilter) throws java.lang.IllegalStateException
When enabled, fetchMode:"local" is
automatically enabled so that all filtering behavior shifts to the client-side and full criteria are no longer sent to
the server. Instead, server fetches will always load all nodes, or with loadDataOnDemand
:true, will always load all nodes under a
given parent. This means that the server does not need to implement special tree filtering logic.
Optionally,
serverFilterFields
can be set to a list of
field names that will be sent to the server whenever they are present in the criteria.
keepParentsOnFilter
- keepParentsOnFilter Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getKeepParentsOnFilter()
When enabled, fetchMode:"local" is
automatically enabled so that all filtering behavior shifts to the client-side and full criteria are no longer sent to
the server. Instead, server fetches will always load all nodes, or with loadDataOnDemand
:true, will always load all nodes under a
given parent. This means that the server does not need to implement special tree filtering logic.
Optionally,
serverFilterFields
can be set to a list of
field names that will be sent to the server whenever they are present in the criteria.
public void setLeaveSelectionCheckboxGap(java.lang.Boolean leaveSelectionCheckboxGap) throws java.lang.IllegalStateException
selectionAppearance
:"checkbox" is set on
the treegrid, and a node can't be selected, should a gap be left where the checkbox icon would normally appear, in order
to make the node's icon and title line up with the content for other nodes in the same parent? Has no effect if
showDisabledSelectionCheckbox
is
true
leaveSelectionCheckboxGap
- leaveSelectionCheckboxGap Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdListGrid.setRecordCanSelectProperty(java.lang.String)
public java.lang.Boolean getLeaveSelectionCheckboxGap()
selectionAppearance
:"checkbox" is set on
the treegrid, and a node can't be selected, should a gap be left where the checkbox icon would normally appear, in order
to make the node's icon and title line up with the content for other nodes in the same parent? Has no effect if
showDisabledSelectionCheckbox
is
true
ListGrid.getRecordCanSelectProperty()
public void setLoadDataOnDemand(java.lang.Boolean loadDataOnDemand)
If unset, calling TreeGrid.fetchData
will default it to true, otherwise, if a ResultTree is passed to TreeGrid.setData
, the loadDataOnDemand
setting is respected.
Note that
when using loadDataOnDemand
, every node returned by the server is assumed be a folder which may load
further children. See defaultIsFolder
for how to
control this behavior.
loadDataOnDemand
- loadDataOnDemand Default value is nullsetDataFetchMode(com.smartgwt.client.types.FetchMode)
,
Databinding overview and related methods
,
Initial Data & Load on Demand Examplepublic java.lang.Boolean getLoadDataOnDemand()
If unset, calling TreeGrid.fetchData
will default it to true, otherwise, if a ResultTree is passed to TreeGrid.setData
, the loadDataOnDemand
setting is respected.
Note that
when using loadDataOnDemand
, every node returned by the server is assumed be a folder which may load
further children. See defaultIsFolder
for how to
control this behavior.
getDataFetchMode()
,
Databinding overview and related methods
,
Initial Data & Load on Demand Examplepublic void setManyItemsImage(java.lang.String manyItemsImage)
manyItemsImage
- . See SCImgURL
. Default value is "[SKIN]folder_file.gif"Dragdrop overview and related methods
public java.lang.String getManyItemsImage()
SCImgURL
Dragdrop overview and related methods
public void setNodeIcon(java.lang.String nodeIcon)
customIconProperty
directly on the node.
nodeIcon
- tree node. See SCImgURL
. Default value is "[SKIN]file.gif"public java.lang.String getNodeIcon()
customIconProperty
directly on the node.SCImgURL
public void setOfflineNodeMessage(java.lang.String offlineNodeMessage)
offlineNodeMessage
- . See String
. Default value is "This data not available while offline"public java.lang.String getOfflineNodeMessage()
String
public void setOpenerIconHeight(java.lang.Integer openerIconHeight)
If not specified, openerIconSize
is used instead.
openerIconHeight
- openerIconHeight Default value is nullpublic java.lang.Integer getOpenerIconHeight()
If not specified, openerIconSize
is used instead.
public void setOpenerIconSize(java.lang.Integer openerIconSize)
openerIconWidth
/openerIconHeight
. If showConnectors
is true, the opener icon includes the
connector line, and defaults to cellHeight
.
Otherwise, openerIconSize
defaults to iconSize
.
openerIconSize
- openerIconSize Default value is nullpublic java.lang.Integer getOpenerIconSize()
openerIconWidth
/openerIconHeight
. If showConnectors
is true, the opener icon includes the
connector line, and defaults to cellHeight
.
Otherwise, openerIconSize
defaults to iconSize
.
public void setOpenerIconWidth(java.lang.Integer openerIconWidth)
If not specified, openerIconSize
is used instead.
openerIconWidth
- openerIconWidth Default value is nullpublic java.lang.Integer getOpenerIconWidth()
If not specified, openerIconSize
is used instead.
public void setOpenerImage(java.lang.String openerImage) throws java.lang.IllegalStateException
{baseName}.{extension}
,
{baseName}_opened.{extension}
will be displayed next to opened folders, and
{baseName}_closed.{extension}
will be displayed next to closed folders, or if this page is in RTL mode,
{baseName}_opened_rtl.{extension}
and {baseName}_closed_rtl.{extension}
will be used.openerImage
- . See SCImgURL
. Default value is "[SKIN]opener.gif"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getOpenerImage()
{baseName}.{extension}
,
{baseName}_opened.{extension}
will be displayed next to opened folders, and
{baseName}_closed.{extension}
will be displayed next to closed folders, or if this page is in RTL mode,
{baseName}_opened_rtl.{extension}
and {baseName}_closed_rtl.{extension}
will be used.SCImgURL
public void setOpenIconSuffix(java.lang.String openIconSuffix)
showOpenIcons
is true, this suffix will be
appended to the folderIcon
for open folders in this
grid.openIconSuffix
- . See String
. Default value is "open"public java.lang.String getOpenIconSuffix()
showOpenIcons
is true, this suffix will be
appended to the folderIcon
for open folders in this
grid.String
public void setParentAlreadyContainsChildMessage(java.lang.String parentAlreadyContainsChildMessage) throws java.lang.IllegalStateException
parentAlreadyContainsChildMessage
- . See String
. Default value is "This item already contains a child item with that name."java.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetCanDragRecordsOut(java.lang.Boolean)
,
setCanAcceptDroppedRecords(java.lang.Boolean)
,
setCanReorderRecords(java.lang.Boolean)
public java.lang.String getParentAlreadyContainsChildMessage()
String
getCanDragRecordsOut()
,
getCanAcceptDroppedRecords()
,
getCanReorderRecords()
public void setSelectionProperty(java.lang.String selectionProperty) throws java.lang.IllegalStateException
"isSelected"
any records in the listGrid data where "isSelected"
is
true
will show up as selected in the grid. Similarly if records are selected within the grid after the grid
has been created, this property will be set to true on the selected records.
Note : This is an advanced setting
setSelectionProperty
in class ListGrid
selectionProperty
- . See String
. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
public java.lang.String getSelectionProperty()
"isSelected"
any records in the listGrid data where "isSelected"
is
true
will show up as selected in the grid. Similarly if records are selected within the grid after the grid
has been created, this property will be set to true on the selected records.getSelectionProperty
in class ListGrid
String
Appearance overview and related methods
public void setSeparateFolders(java.lang.Boolean separateFolders) throws java.lang.IllegalStateException
separateFolders
on the data for this treeGrid. Specifies whether folders and leaves should be segregated in the
treeGrid display. Use sortFoldersBeforeLeaves
to customize whether folders appear before or after their sibling leaves.
If unset, at the
treeGrid level, the property can be set directly on the tree
data object
or for dataBound TreeGrids on the dataProperties configuration object
.
separateFolders
- separateFolders Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getSeparateFolders()
separateFolders
on the data for this treeGrid. Specifies whether folders and leaves should be segregated in the
treeGrid display. Use sortFoldersBeforeLeaves
to customize whether folders appear before or after their sibling leaves.
If unset, at the
treeGrid level, the property can be set directly on the tree
data object
or for dataBound TreeGrids on the dataProperties configuration object
.
public void setServerFilterFields(java.lang.String... serverFilterFields) throws java.lang.IllegalStateException
keepParentsOnFilter
is enabled, this
property lists field names that will be sent to the server if they are present in criteria.serverFilterFields
- . See String
. Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String[] getServerFilterFields()
keepParentsOnFilter
is enabled, this
property lists field names that will be sent to the server if they are present in criteria.String
public void setShowConnectors(java.lang.Boolean showConnectors)
For the set of images used to show
connectors, see connectorImage
.
Note: in order for connector images to be perfectly connected, all styles for cells must have no top or bottom border or padding. If you see small gaps in connector lines, check your CSS files. See the example below for an example of correct configuration, including example CSS.
showConnectors
- showConnectors Default value is falsepublic java.lang.Boolean getShowConnectors()
For the set of images used to show
connectors, see connectorImage
.
Note: in order for connector images to be perfectly connected, all styles for cells must have no top or bottom border or padding. If you see small gaps in connector lines, check your CSS files. See the example below for an example of correct configuration, including example CSS.
public void setShowCustomIconDrop(java.lang.Boolean showCustomIconDrop)
customIconProperty
, default icon
), show drop state images when the user is drop-hovering over the
folder. If true, the dropIconSuffix
will be appended
to the image URL (so "customFolder.gif"
might be replaced with "customFolder_drop.gif"
).showDropIcon
and that property can be renamed via customIconDropProperty
.
Note : This is an advanced setting
showCustomIconDrop
- showCustomIconDrop Default value is falsepublic java.lang.Boolean getShowCustomIconDrop()
customIconProperty
, default icon
), show drop state images when the user is drop-hovering over the
folder. If true, the dropIconSuffix
will be appended
to the image URL (so "customFolder.gif"
might be replaced with "customFolder_drop.gif"
).showDropIcon
and that property can be renamed via customIconDropProperty
.public void setShowCustomIconOpen(java.lang.Boolean showCustomIconOpen)
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"
).closedIconSuffix
is never appended to custom folder
icons.showOpenIcon
and that property can be renamed via customIconOpenProperty
.
Note : This is an advanced setting
showCustomIconOpen
- showCustomIconOpen Default value is falsepublic java.lang.Boolean getShowCustomIconOpen()
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"
).closedIconSuffix
is never appended to custom folder
icons.showOpenIcon
and that property can be renamed via customIconOpenProperty
.public void setShowDisabledSelectionCheckbox(java.lang.Boolean showDisabledSelectionCheckbox) throws java.lang.IllegalStateException
selectionAppearance
:"checkbox" is set on the treegrid, and a node can't be selected? If set to false
the treeGrid will use leaveSelectionCheckboxGap
to determine whether to leave a blank space where the checkbox would normally appear.
showDisabledSelectionCheckbox
- showDisabledSelectionCheckbox Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdListGrid.setRecordCanSelectProperty(java.lang.String)
public java.lang.Boolean getShowDisabledSelectionCheckbox()
selectionAppearance
:"checkbox" is set on the treegrid, and a node can't be selected? If set to false
the treeGrid will use leaveSelectionCheckboxGap
to determine whether to leave a blank space where the checkbox would normally appear.
ListGrid.getRecordCanSelectProperty()
public void setShowDropIcons(java.lang.Boolean showDropIcons)
dropIconSuffix
onto the
folderIcon
URL (for example
"[SKIN]/folder.gif"
may be replaced by "[SKIN]/folder_drop.gif"
).showDropIcons
- showDropIcons Default value is truepublic java.lang.Boolean getShowDropIcons()
dropIconSuffix
onto the
folderIcon
URL (for example
"[SKIN]/folder.gif"
may be replaced by "[SKIN]/folder_drop.gif"
).public void setShowFullConnectors(java.lang.Boolean showFullConnectors)
showConnectors
is true, this property determines
whether we should show vertical continuation lines for each level of indenting within the tree. Setting to false will
show only the hierarchy lines are only shown for the most indented path ("sparse" connectors).showFullConnectors
- showFullConnectors Default value is truepublic java.lang.Boolean getShowFullConnectors()
showConnectors
is true, this property determines
whether we should show vertical continuation lines for each level of indenting within the tree. Setting to false will
show only the hierarchy lines are only shown for the most indented path ("sparse" connectors).public void setShowOpener(java.lang.Boolean showOpener)
opener icon
be displayed next to folder
nodes? This is an icon which visually indicates whether the folder is opened or closed (typically via a [+] or [-]
image, or a turn-down arrow) and may be clicked to expand or collapse the folder. For folders with no children, this
icon is not shown unless alwaysShowOpener
is
true
. Note that for trees which load
data on demand
, we may not know if a folder has any descendants if it has never been opened. As such we will show the
opener icon next to the folder. Once the user opens the icon and a fetch occurs, if the folder is empty, and alwaysShowOpener
is false, the opener icon will be
hidden.
For more information on load on demand trees, and how we determine whether a node is a a folder or a leaf,
please refer to the TreeDataBinding
documentation.
showOpener
- showOpener Default value is truepublic java.lang.Boolean getShowOpener()
opener icon
be displayed next to folder
nodes? This is an icon which visually indicates whether the folder is opened or closed (typically via a [+] or [-]
image, or a turn-down arrow) and may be clicked to expand or collapse the folder. For folders with no children, this
icon is not shown unless alwaysShowOpener
is
true
. Note that for trees which load
data on demand
, we may not know if a folder has any descendants if it has never been opened. As such we will show the
opener icon next to the folder. Once the user opens the icon and a fetch occurs, if the folder is empty, and alwaysShowOpener
is false, the opener icon will be
hidden.
For more information on load on demand trees, and how we determine whether a node is a a folder or a leaf,
please refer to the TreeDataBinding
documentation.
public void setShowOpenIcons(java.lang.Boolean showOpenIcons)
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"
.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
.showOpenIcons
- showOpenIcons Default value is truepublic java.lang.Boolean getShowOpenIcons()
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"
.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
.public void setShowPartialSelection(java.lang.Boolean showPartialSelection)
showPartialSelection
- showPartialSelection Default value is falsepublic java.lang.Boolean getShowPartialSelection()
public void setShowRoot(java.lang.Boolean showRoot) throws java.lang.IllegalStateException
This property is only available for "children"
modelType trees, hence is not allowed for trees that load data from the server dynamically via TreeGrid.fetchData
.
To get the equivalent of a visible "root"
node in a tree that loads data dynamically, add a singular, top-level parent to the data. However, note that this
top-level parent will technically be the only child of root, and the implicit root object will be returned by this.data.getRoot()
.
showRoot
- showRoot Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowRoot()
This property is only available for "children"
modelType trees, hence is not allowed for trees that load data from the server dynamically via TreeGrid.fetchData
.
To get the equivalent of a visible "root"
node in a tree that loads data dynamically, add a singular, top-level parent to the data. However, note that this
top-level parent will technically be the only child of root, and the implicit root object will be returned by this.data.getRoot()
.
public void setSortFoldersBeforeLeaves(java.lang.Boolean sortFoldersBeforeLeaves) throws java.lang.IllegalStateException
sortFoldersBeforeLeaves
on the data for this treeGrid. Specifies whether when separateFolders
is true, folders should be displayed before or
after their sibling leaves in a sorted tree. If set to true, with sortDirection set to Array.ASCENDING, folders are
displayed before their sibling leaves and with sort direction set to Array.DESCENDING they are displayed after. To
invert this behavior, set this property to false.
sortFoldersBeforeLeaves
- sortFoldersBeforeLeaves Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdsetSeparateFolders(java.lang.Boolean)
public java.lang.Boolean getSortFoldersBeforeLeaves()
sortFoldersBeforeLeaves
on the data for this treeGrid. Specifies whether when separateFolders
is true, folders should be displayed before or
after their sibling leaves in a sorted tree. If set to true, with sortDirection set to Array.ASCENDING, folders are
displayed before their sibling leaves and with sort direction set to Array.DESCENDING they are displayed after. To
invert this behavior, set this property to false.
getSeparateFolders()
public void setTreeFieldTitle(java.lang.String treeFieldTitle) throws java.lang.IllegalStateException
treeFieldTitle
- . See String
. Default value is "Name"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getTreeFieldTitle()
String
public void setUseAllDataSourceFields(java.lang.Boolean useAllDataSourceFields)
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.
This example shows a mixture of component fields and DataSource fields, and how they interact for validation.
setUseAllDataSourceFields
in interface DataBoundComponent
setUseAllDataSourceFields
in class ListGrid
useAllDataSourceFields
- useAllDataSourceFields Default value is nullDatabinding overview and related methods
,
Customized Binding Examplepublic java.lang.Boolean getUseAllDataSourceFields()
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.
This example shows a mixture of component fields and DataSource fields, and how they interact for validation.
getUseAllDataSourceFields
in interface DataBoundComponent
getUseAllDataSourceFields
in class ListGrid
Databinding overview and related methods
,
Customized Binding Examplepublic java.lang.Boolean canEditCell()
name
field of this
grid's data tree. Also disallows editing of the auto-generated tree field, which displays the result of Tree.getTitle
on the node.public void closeFolder(TreeNode node)
node
- node to closeopenFolder(com.smartgwt.client.widgets.tree.TreeNode)
,
FolderClosedEvent
public com.google.gwt.event.shared.HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)
Notification method fired whenever this TreeGrid receives new data nodes from the dataSource. Only applies to databound
TreeGrids where data
is a ResultTree
- either explicitly created and applied via TreeGrid.setData
or automatically generated via a fetchData()
call.
handler
- the dataArrived handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFolderClickHandler(FolderClickHandler handler)
This method is called when a folder record is clicked on.
addFolderClickHandler
in interface HasFolderClickHandlers
handler
- the folderClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFolderClosedHandler(FolderClosedHandler handler)
This method is called when a folder is closed either via the user manipulating the expand/collapse control in the UI or
via TreeGrid.closeFolder
. You can return
false
to cancel the close.
addFolderClosedHandler
in interface HasFolderClosedHandlers
handler
- the folderClosed handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFolderContextClickHandler(FolderContextClickHandler handler)
This method is called when a context click occurs on a folder record.
addFolderContextClickHandler
in interface HasFolderContextClickHandlers
handler
- the folderContextClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFolderOpenedHandler(FolderOpenedHandler handler)
This method is called when a folder is opened either via the user manipulating the expand/collapse control in the UI or
via TreeGrid.openFolder
. You can return false
to cancel the open.
addFolderOpenedHandler
in interface HasFolderOpenedHandlers
handler
- the folderOpened handlerHandlerRegistration
used to remove this handlerpublic int getEventRow()
getEventRow
in class ListGrid
public int getEventRow(java.lang.Integer y)
getEventRow
in class ListGrid
y
- optional y-coordinate to obtain row number, in lieu of the y coordinate of the last mouse eventpublic java.lang.String getOpenIcon(TreeNode node)
showOpener
is set to false.node
- tree node in questionpublic java.lang.String getOpenState()
TreeGrid.setOpenState
to open the same set of
folders within the treeGrid's data (assuming the nodes are still present in the data).setOpenState(java.lang.String)
public java.lang.String getSelectedPaths()
TreeGrid.setSelectedPaths
to reset this
grid's selection the current state (assuming the same data is present in the grid).setSelectedPaths(java.lang.String)
public java.lang.Boolean isOverExtraIcon()
extra icon
for the current node. Returns false if the event did not occur over an extraIcon, or if no extraIcon is showing for the node in question.
public java.lang.Boolean isOverOpenArea()
public com.google.gwt.event.shared.HandlerRegistration addLeafClickHandler(LeafClickHandler handler)
This method is called when a leaf record is clicked on.
addLeafClickHandler
in interface HasLeafClickHandlers
handler
- the leafClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addLeafContextClickHandler(LeafContextClickHandler handler)
This method is called when a context click occurs on a leaf record.
addLeafContextClickHandler
in interface HasLeafContextClickHandlers
handler
- the leafContextClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addNodeClickHandler(NodeClickHandler handler)
This method is called when a leaf or folder record is clicked on. Note that if you set up a callback for
nodeClick()
and e.g. TreeGrid.leafClick
, then both will fire (in that order) if a leaf is clicked on.
addNodeClickHandler
in interface HasNodeClickHandlers
handler
- the nodeClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addNodeContextClickHandler(NodeContextClickHandler handler)
This method is called when a context click occurs on a leaf or folder record. Note that if you set up a callback for
nodeContextClick()
and e.g. TreeGrid.leafContextClick
, then both will fire (in that order) if a leaf is contextclicked - unless
nodeContextClick()
returns false, in which case no further contextClick callbacks will be called.
addNodeContextClickHandler
in interface HasNodeContextClickHandlers
handler
- the nodeContextClick handlerHandlerRegistration
used to remove this handlerpublic com.google.gwt.event.shared.HandlerRegistration addFolderDropHandler(FolderDropHandler handler)
Notification method fired when treeNode(s) are dropped into a folder of this TreeGrid. This method fires before the
standard TreeGrid.folderDrop
processing occurs and
returning false will suppress that default behavior.
addFolderDropHandler
in interface HasFolderDropHandlers
handler
- the folderDrop handlerHandlerRegistration
used to remove this handlerpublic void openFolder(TreeNode node)
Executed when a folder node receives a 'doubleClick' event.
See the ListGrid Widget Class for inherited recordClick and recordDoubleClick events.
node
- node to opencloseFolder(com.smartgwt.client.widgets.tree.TreeNode)
,
FolderOpenedEvent
,
ListGrid
public void recordDoubleClick()
TreeGrid.toggleFolder
on it. If the
node is a leaf, calls TreeGrid.openLeaf
on it.RecordDoubleClickEvent
public void setOpenState(java.lang.String openState)
TreeGrid.getOpenState
.openState
- Object describing the desired set of open folders.. See TreeGridOpenState
getOpenState()
public void setSelectedPaths(java.lang.String selectedPaths)
TreeGrid.getSelectedPaths
.selectedPaths
- Object describing the desired selection state of the grid. See ListGridSelectedState
getSelectedPaths()
public void toggleFolder(TreeNode node)
node
- node to togglepublic static void setDefaultProperties(TreeGrid treeGridProperties)
Note: This method is intended for setting default attributes only and will effect 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.
treeGridProperties
- properties that should be used as new defaults when instances of this class are createdpublic void startEditingNew()
ListGrid API
is not supported by the
TreeGrid since adding a new tree node arbitrarily at the end of the tree is usually not useful. Instead, to add a new
tree node and begin editing it, use either of these two strategies: Tree.add
, then use startEditing
to begin editing this node. Note that if using
a DataSource, when the node is saved, an "update" operation will be used since adding a node directly to the client-side
ResultTree
effectively means a new node has been added server side. DataSource.addData
to immediately save a new node. Automatic cache
sync by the ResultTree
will cause the node to be integrated into the tree.
When the callback to addData() fires, locate the new node by matching primary key and call startEditing
to begin editing it. startEditingNew
in class ListGrid
protected java.lang.String getNodeTitle(Record node, int recordNum, ListGridField field)
name
attribute, then the current node[field.name]
is returned.
Otherwise, the result of calling Tree.getTitle(com.smartgwt.client.widgets.tree.TreeNode)
on the node is called.
node
- The node for which the title is being requested.recordNum
- The index of the node.field
- The field for which the title is being requested.protected java.lang.String getIcon(Record node, boolean defaultState)
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(java.lang.String)
to the
value returned from this method.
Note: This is an override point
node
- tree node in questiondefaultState
- defaultStatepublic void setCustomNodeIcon(Record node, java.lang.String icon)
node
- the tree nodeicon
- path to the resourcepublic java.lang.String getExtraIcon(TreeNode node)
NOTE: If selectionAppearance
is "checkbox"
, this
method will NOT be called. Extra icons cannot be shown for that appearance.
Note: This is an override point
node
- tree node in questionTreeNode
public TreeNode getDropFolder()
public void setFields(TreeGridField... fields)
If dataSource
is also
set, this value acts as a set of overrides as explained in fields
.
fields
- fields Default value is nullpublic void setData(Tree data)
Tree
object containing of nested TreeNode
s to display as rows in this TreeGrid. The data
property will
typically not be explicitly specified for databound TreeGrids, where the data is returned from the server via databound
component methods such as fetchData()
Tree
object this TreeGrid will view and manipulate.data
- Tree to show. Default value is nullpublic Tree getData()
Tree
object containing of nested TreeNode
s to display as rows in this TreeGrid. The data
property will
typically not be explicitly specified for databound TreeGrids, where the data is returned from the server via databound
component methods such as fetchData()
public void setDataProperties(Tree resultTreeProperties)
resultTreeProperties
- the data propertiespublic ListGridRecord[] getRecords()
Tree.getOpenList(TreeNode)
. You should favor working with the underlying Tree
data
structure when working with a TreeGrid.getRecords
in class ListGrid
public void setInitialData(TreeNode[] initialData) throws java.lang.IllegalStateException
parentId
linked ${isc.DocUtils.linkForRef('object:TreeNode')}s in a format
equivalent to that documented on data
.
initialData
- initialData Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic void fetchData()
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree. This method will create a
com.smartgwt.client.data.ResultTree
to manage tree data, which will subsequently be available as
treeGrid.data
. DataSource records returned by the "fetch" operation are linked into a tree
structure according to primaryKey
and foreignKey
declarations on DataSource fields. See the
TreeDataBinding
topic for complete details.
By default, the created ResultTree will use folder-by-folder load on demand, asking the server for the children of each folder as the user opens it.
The com.smartgwt.client.data.ResultTree
created by fetchData()
can be
customized by setting dataProperties
to an
Object containing properties and methods to apply to the created ResultTree. For example, the property that
determines whether a node is a folder (isFolderProperty
) can be customized, or level-by-level loading can be disabled via loadDataOnDemand
.
The callback passed to
fetchData
will fire once, the first time that data is loaded from the server. If using
folder-by-folder load on demand, use the com.smartgwt.client.data.ResultTree#dataArrived
notification to be
notified each time new nodes are loaded.
Note that, if criteria are passed to fetchData()
, they
will be passed every time a new "fetch" operation is sent to the server. This allows you to retrieve multiple
different tree structures from the same DataSource. However note that the server is expected to always respond
with an intact tree - returned nodes which do not have parents are dropped from the dataset and not displayed.
fetchData
in interface DataBoundComponent
fetchData
in class ListGrid
public void fetchData(Criteria criteria)
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree. This method will create a
com.smartgwt.client.data.ResultTree
to manage tree data, which will subsequently be available as
treeGrid.data
. DataSource records returned by the "fetch" operation are linked into a tree
structure according to primaryKey
and foreignKey
declarations on DataSource fields. See the
TreeDataBinding
topic for complete details.
By default, the created ResultTree will use folder-by-folder load on demand, asking the server for the children of each folder as the user opens it.
The com.smartgwt.client.data.ResultTree
created by fetchData()
can be
customized by setting dataProperties
to an
Object containing properties and methods to apply to the created ResultTree. For example, the property that
determines whether a node is a folder (isFolderProperty
) can be customized, or level-by-level loading can be disabled via loadDataOnDemand
.
The callback passed to
fetchData
will fire once, the first time that data is loaded from the server. If using
folder-by-folder load on demand, use the com.smartgwt.client.data.ResultTree#dataArrived
notification to be
notified each time new nodes are loaded.
Note that, if criteria are passed to fetchData()
, they
will be passed every time a new "fetch" operation is sent to the server. This allows you to retrieve multiple
different tree structures from the same DataSource. However note that the server is expected to always respond
with an intact tree - returned nodes which do not have parents are dropped from the dataset and not displayed.
fetchData
in interface DataBoundComponent
fetchData
in class ListGrid
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()
public void fetchData(Criteria criteria, DSCallback callback)
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree. This method will create a
com.smartgwt.client.data.ResultTree
to manage tree data, which will subsequently be available as
treeGrid.data
. DataSource records returned by the "fetch" operation are linked into a tree
structure according to primaryKey
and foreignKey
declarations on DataSource fields. See the
TreeDataBinding
topic for complete details.
By default, the created ResultTree will use folder-by-folder load on demand, asking the server for the children of each folder as the user opens it.
The com.smartgwt.client.data.ResultTree
created by fetchData()
can be
customized by setting dataProperties
to an
Object containing properties and methods to apply to the created ResultTree. For example, the property that
determines whether a node is a folder (isFolderProperty
) can be customized, or level-by-level loading can be disabled via loadDataOnDemand
.
The callback passed to
fetchData
will fire once, the first time that data is loaded from the server. If using
folder-by-folder load on demand, use the com.smartgwt.client.data.ResultTree#dataArrived
notification to be
notified each time new nodes are loaded.
Note that, if criteria are passed to fetchData()
, they
will be passed every time a new "fetch" operation is sent to the server. This allows you to retrieve multiple
different tree structures from the same DataSource. However note that the server is expected to always respond
with an intact tree - returned nodes which do not have parents are dropped from the dataset and not displayed.
fetchData
in interface DataBoundComponent
fetchData
in class ListGrid
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 requiredpublic void fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
DataSource
to retrieve data that matches
the provided criteria, and displays the matching data in this component as a tree. This method will create a
com.smartgwt.client.data.ResultTree
to manage tree data, which will subsequently be available as
treeGrid.data
. DataSource records returned by the "fetch" operation are linked into a tree
structure according to primaryKey
and foreignKey
declarations on DataSource fields. See the
TreeDataBinding
topic for complete details.
By default, the created ResultTree will use folder-by-folder load on demand, asking the server for the children of each folder as the user opens it.
The com.smartgwt.client.data.ResultTree
created by fetchData()
can be
customized by setting dataProperties
to an
Object containing properties and methods to apply to the created ResultTree. For example, the property that
determines whether a node is a folder (isFolderProperty
) can be customized, or level-by-level loading can be disabled via loadDataOnDemand
.
The callback passed to
fetchData
will fire once, the first time that data is loaded from the server. If using
folder-by-folder load on demand, use the com.smartgwt.client.data.ResultTree#dataArrived
notification to be
notified each time new nodes are loaded.
Note that, if criteria are passed to fetchData()
, they
will be passed every time a new "fetch" operation is sent to the server. This allows you to retrieve multiple
different tree structures from the same DataSource. However note that the server is expected to always respond
with an intact tree - returned nodes which do not have parents are dropped from the dataset and not displayed.
fetchData
in interface DataBoundComponent
fetchData
in class ListGrid
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 requiredrequestProperties
- additional properties to set on the DSRequest
that will be issuedpublic void filterData(Criteria criteria)
This
method behaves exactly like fetchData()
except that textMatchStyle
is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData
in interface DataBoundComponent
filterData
in class ListGrid
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()
public void filterData(Criteria criteria, DSCallback callback)
This
method behaves exactly like fetchData()
except that textMatchStyle
is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData
in interface DataBoundComponent
filterData
in class ListGrid
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 detailspublic void filterData(Criteria criteria, DSCallback callback, DSRequest requestProperties)
This
method behaves exactly like fetchData()
except that textMatchStyle
is automatically set to "substring" so that
String-valued fields are matched by case-insensitive substring comparison.
filterData
in interface DataBoundComponent
filterData
in class ListGrid
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 detailsrequestProperties
- for databound components only - optional additional
properties to set on the DSRequest that will be issuedpublic TreeNode getSelectedRecord()
selectionType
is "single"
, or if you only care about the first selected record in a multiple-record selection. To access all selected records, use ListGrid.getSelection()
instead.getSelectedRecord
in class ListGrid
Selection overview and related methods
,
Databound remove Examplepublic TreeNode getRecord(int recordNum)
com.smartgwt.client.widgets.grid.ListGrid#getCellRecord
.getRecord
in class ListGrid
recordNum
- row index of record to return.com.smartgwt.client.widgets.grid.ListGrid#getCellRecord
,
ListGrid.getEditedRecord(int)
public void setTreeRootValue(java.lang.String treeRootValue) throws java.lang.IllegalStateException
This property allows you to have a particular component navigate a tree starting from any given node as the root.
Note : This is an advanced setting
treeRootValue
- treeRootValue Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic void setTreeRootValue(java.lang.Integer treeRootValue) throws java.lang.IllegalStateException
This property allows you to have a particular component navigate a tree starting from any given node as the root.
Note : This is an advanced setting
treeRootValue
- treeRootValue Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getTreeRootValue()
This property allows you to have a particular component navigate a tree starting from any given node as the root.
public Alignment getCellAlign(ListGridRecord record, int rowNum, int colNum)
treeField
[or right-align if the page is in RTL mode] -
otherwise will return cellAlign
if specified,
otherwise align
.record
- this cell's recordrowNum
- row number for the cellcolNum
- column number of the cellpublic void setCellValueHoverFormatter(CellValueHoverFormatter formatter)
ListGrid
ListGrid.cellValueHoverHTML(ListGridRecord, int, int, String)
.
The CellValueHoverFormatter
should return the HTML to display in the hover canvas
that is displayed by default if a registered CellValueHoverHandler
does not cancel a CellValueHoverEvent
.
The formatter can return null or an empty string to cancel the hover.
setCellValueHoverFormatter
in class ListGrid
formatter
- the cell value hover formatterpublic java.lang.Boolean willAcceptDrop()
ListGrid.willAcceptDrop()
and works as follows: ListGrid.willAcceptDrop()
(the superclass definition) is consulted. If it
returns false, then this method returns false immediately.canReorderRecords
is truecanAcceptDroppedRecords
is true and the
dragTarget gives us a valid set of records to drop into place.canAcceptDrop:false
canAcceptDrop
set to false
canReparentNodes
is true, and the user is dragging a node
from one folder to another, this method will return true to allow the change of parent folder.willAcceptDrop
in class ListGrid
public com.google.gwt.event.shared.HandlerRegistration addRecordDropHandler(RecordDropHandler handler) throws java.lang.UnsupportedOperationException
addFolderDropHandler(com.smartgwt.client.widgets.tree.events.FolderDropHandler)
instead.addRecordDropHandler
in interface HasRecordDropHandlers
addRecordDropHandler
in class ListGrid
handler
- the onRecordDrop handlerHandlerRegistration
used to remove this handlerjava.lang.UnsupportedOperationException
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.tree.TreeGridLogicalStructure s)
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
getLogicalStructure
in interface LogicalStructure
getLogicalStructure
in class ListGrid