com.extjs.gxt.ui.client.widget.treetable
Class TreeTableItem

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.tree.TreeItem
                  com.extjs.gxt.ui.client.widget.treetable.TreeTableItem

All Implemented Interfaces:

Observable, com.google.gwt.user.client.EventListener

Direct Known Subclasses:

RootTreeTableItem

public class TreeTableItem
extends TreeItem

A item in a TreeTable. All events are bubbled to the item's parent treetable.

Events:

BeforeAdd : TreeTableEvent(treeTable, item, child, index)

Fires before a item is added or inserted. Listeners can set the doit field to false to cancel the action.

• treeTable : the tree table
• item : this
• child : the item being added
• index : the index at which the item will be added

BeforeRemove : TreeTableEvent(treeTable, item, child)

Fires before a item is removed. Listeners can set the doit field to false to cancel the action.

• treeTable : this
• item : this
• child : the item being removed

BeforeExpand : TreeTableEvent(treeTable, item)

Fires before a item is expanded. Listeners can set the doit field to false to cancel the expand.

• treeTable : this
• item : this

BeforeCollapse : TreeTableEvent(treeTable, item)

Fires before a item is collapsed. Listeners can set the doit field to false to cancel the collapse.

• treeTable : this
• item : this

Add : TreeTableEvent(treeTable, item, index)

Fires after a item has been added or inserted.

• treeTable : the tree table
• item : this
• child : the item that was added
• index : the index at which the item will be added

Remove : TreeEvent(treeTable, item, child)

Fires after a item has been removed.

• treeTable : the tree table
• item : this
• child : the item being removed

Expand : TreeEvent(treeTable, item)

Fires after a item has been expanded.

• item : the item being expanded

Collapse : TreeEvent(treeTable, item)

Fires ater a item is collapsed.

• treeTable : the tree table
• item : this

CheckChange : TreeTableEvent(treeTable, item)

Fires after a check state change.

• treeTable : the tree table
• item : this

CellClick : TreeTableEvent(treeTable, item, columnIndex)

Fires after a cell has been clicked.

• treeTable : the tree table
• item : this
• columnIndex : cell column index

CellDoubleClick : RowDoubleClick(treeTable, item, columnIndex)

Fires after a cell has been double clicked.

• treeTable : the tree table
• item : this
• columnIndex : cell column index

RowClick : (treeTable, item, index)

Fires after a cell has been clicked.

• treeTable : the tree table
• item : this
• columnIndex : cell column index

RowDoubleClick : TreeTableEvent(treeTable, item, columnIndex)

Fires after a cell has been double clicked.

• treeTable : the treet table
• item : this
• columnIndex : cell column index

CSS:

.my-tree-item (the item itself)

.my-tree-item-text span (the tree item text)

Nested Class Summary

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

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

TreeTableItem(java.lang.Object[] values)
Creates a new tree table item.

TreeTableItem(java.lang.String text, java.lang.Object[] values)
Creates a new tree table item.

Method Summary

java.lang.String	getCellStyle(int index) Returns the style for the given cell.
ToolTip	getCellToolTip() Returns the item's cell tooltip.
TreeTable	getTreeTable() Returns the item's tree table.
java.lang.Object	getValue(int index) Returns a cell value.
java.lang.Object[]	getValues() Returns the item's values.
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
void	setCellStyle(int index, java.lang.String style) Sets the style for a table cell.
void	setCellToolTip(int index, java.lang.String text) Sets a cell tooltip.
void	setCellToolTips(java.lang.String[] toolTips) Sets all of the cell tooltips
void	setElement(com.google.gwt.user.client.Element elem)
void	setText(int index, java.lang.String text) Sets a cell value.
void	setValue(int index, java.lang.Object value) Sets a cell value.
void	setValues(java.lang.Object[] values) Sets the item's values.

Methods inherited from class com.extjs.gxt.ui.client.widget.tree.TreeItem

add, add, firstChild, getContainer, getDepth, getIconStyle, getItem, getItemCount, getItems, getParentItem, getPath, getText, getTextStyle, getUI, hasChildren, indexOf, isChecked, isExpanded, isLeaf, isRoot, remove, removeAll, setChecked, setExpanded, setExpanded, setIconStyle, setLeaf, setText, setTextStyle, toggle, toString

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addStyleName, addWidgetListener, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getData, getData, getElement, getId, getItemId, getModel, getState, getToolTip, hide, hideToolTip, isEnabled, isRendered, isVisible, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeWidgetListener, render, render, saveState, setBorders, setData, setData, setEnabled, setEnableState, setHeight, setId, setIntStyleAttribute, setItemId, setPixelSize, setSize, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWidth, show

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

getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TreeTableItem

public TreeTableItem(java.lang.Object[] values)

Creates a new tree table item.

Parameters:

values - the cell values

TreeTableItem

public TreeTableItem(java.lang.String text,
                     java.lang.Object[] values)

Creates a new tree table item.

Parameters:

text - the text

values - the values

Method Detail

getCellToolTip

public ToolTip getCellToolTip()

Returns the item's cell tooltip.

Returns:

the tooltip

getTreeTable

public TreeTable getTreeTable()

Returns the item's tree table.

Returns:

the tree table

getValue

public java.lang.Object getValue(int index)

Returns a cell value.

Parameters:

index - the cell index

Returns:

the value

getValues

public java.lang.Object[] getValues()

Returns the item's values.

Returns:

the values

onComponentEvent

public void onComponentEvent(ComponentEvent ce)

Description copied from class: Component

Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:

onComponentEvent in class TreeItem

Parameters:

ce - the base event

setCellStyle

public void setCellStyle(int index,
                         java.lang.String style)

Sets the style for a table cell.

Parameters:

index - the column index

style - the new style

getCellStyle

public java.lang.String getCellStyle(int index)

Returns the style for the given cell.

Parameters:

index - the column index

Returns:

the style

setCellToolTip

public void setCellToolTip(int index,
                           java.lang.String text)

Sets a cell tooltip.

Parameters:

index - the column index

text - the text of the tool tip

setCellToolTips

public void setCellToolTips(java.lang.String[] toolTips)

Sets all of the cell tooltips

Parameters:

toolTips - the tool tips to use

setText

public void setText(int index,
                    java.lang.String text)

Sets a cell value.

Parameters:

index - the column index

text - the text

setValue

public void setValue(int index,
                     java.lang.Object value)

Sets a cell value.

Parameters:

index - the column index

value - the value

setValues

public void setValues(java.lang.Object[] values)

Sets the item's values.

Parameters:

values - the values

setElement

public void setElement(com.google.gwt.user.client.Element elem)

Overrides:

setElement in class Component