Package com.vaadin.client.ui

Class VTreeTable

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.FlowPanel

com.vaadin.client.ui.VScrollTable

com.vaadin.client.ui.VTreeTable

All Implemented Interfaces:

com.google.gwt.event.dom.client.BlurHandler, com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.ScrollHandler, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, DeferredWorker, Focusable, ActionOwner, VHasDropHandler, SubPartAware, Iterable<com.google.gwt.user.client.ui.Widget>

public class VTreeTable
extends VScrollTable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VTreeTable.PendingNavigationEvent	For internal use only.
class	VTreeTable.VTreeTableScrollBody

Nested classes/interfaces inherited from class com.vaadin.client.ui.VScrollTable

VScrollTable.ContextMenuDetails, VScrollTable.FocusableScrollContextPanel, VScrollTable.FooterCell, VScrollTable.HeaderCell, VScrollTable.RowHeadersFooterCell, VScrollTable.RowHeadersHeaderCell, VScrollTable.RowRequestHandler, VScrollTable.SelectMode, VScrollTable.TableFooter, VScrollTable.TableHead, VScrollTable.VScrollTableBody, VScrollTable.VScrollTableDropHandler

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Field Summary

Fields

Modifier and Type	Field	Description
boolean	animationsEnabled	For internal use only.
int	colIndexOfHierarchy	For internal use only.
String	collapsedRowKey	For internal use only.
boolean	collapseRequest	For internal use only.
boolean	focusParentResponsePending	For internal use only.
LinkedList<VTreeTable.PendingNavigationEvent>	pendingNavigationEvents	For internal use only.
VTreeTable.VTreeTableScrollBody	scrollBody	For internal use only.

Fields inherited from class com.vaadin.client.ui.VScrollTable

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, bodyActionKeys, client, collapsibleMenuContent, contextMenu, dropHandler, enabled, focusedRow, focusFirstItemInNextRender, focusLastItemInNextRender, headerChangedDuringUpdate, immediate, initializedAndAttached, lastRenderedHeight, multiselectPending, paintableId, postponeSanityCheckForLastRendered, recalcWidths, rendering, rowRequestHandler, scrollBodyPanel, selectedRowKeys, selectFirstItemInNextRender, selectionChanged, selectionRangeStart, selectLastItemInNextRender, serverCacheFirst, serverCacheLast, showColFooters, showColHeaders, showRowHeaders, sizeNeedsInit, STYLENAME, tabIndex, tFoot, tHead, totalRows

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
VTreeTable()

Method Summary

Modifier and Type	Method	Description
void	addAndRemoveRows(UIDL partialRowAdditions)	Inserts rows in the table body or removes them from the table body based on the commands in the UIDL.
protected String	buildCaptionHtmlSnippet(UIDL uidl)	Icons rendered into first actual column in TreeTable, not to row header cell
protected VScrollTable.VScrollTableBody	createScrollBody()
protected int	getHierarchyColumnIndex()	This method exists for the needs of VTreeTable only.
boolean	handleNavigation(int keycode, boolean ctrl, boolean shift)	For internal use only.
void	onBrowserEvent(com.google.gwt.user.client.Event event)
protected void	reOrderColumn(String columnKey, int newIndex)
protected void	sendSelectedRows(boolean immediately)	Sends the selection to the server if it has been changed since the last update/visit.
void	setStyleName(String style)
void	updateTotalRows(UIDL uidl)	For internal use only.

Methods inherited from class com.vaadin.client.ui.VScrollTable

calcFirstRowInViewPort, cancelScrollingVelocityTimer, deselectAll, discardRowsOutsideCacheWindow, focus, focusRowFromBody, getActionCaption, getActionIcon, getActions, getChildMeasurementHint, getClient, getDropHandler, getFocusedRow, getNavigationDownKey, getNavigationEndKey, getNavigationLeftKey, getNavigationPageDownKey, getNavigationPageUpKey, getNavigationRightKey, getNavigationSelectKey, getNavigationStartKey, getNavigationUpKey, getPaintableId, getRenderedRowByKey, getSubPartElement, getSubPartName, getTotalRows, getWidgetForPaintable, hideScrollPositionAnnotation, init, initializeRows, isFocusable, isScrollPositionVisible, isSelectable, isWorkPending, lazyRevertFocusToRow, measureRowHeightOffset, onAttach, onBlur, onDetach, onFocus, onScroll, onUnregister, resizeSortedColumnForSortIndicator, selectFirstRenderedRowInViewPort, selectLastRenderedRowInViewPort, selectSelectedRows, sendSelectedRows, setCacheRateFromUIDL, setChildMeasurementHint, setColWidth, setHeight, setProperTabIndex, setRowFocus, setStylePrimaryName, setTotalRows, setVisible, sizeInit, startScrollingVelocityTimer, triggerLazyColumnAdjustment, updateActionMap, updateBody, updateColumnProperties, updateDragMode, updateFirstVisibleAndScrollIfNeeded, updateHeight, updateMaxIndent, updatePageLength, updatePageLength, updateRowsInBody, updateSelectionProperties, updateSortingProperties, updateWidth, willHaveScrollbars

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

add, clear, insert, insert

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

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, adopt, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.user.client.ui.HasWidgets

add, clear, iterator, remove

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Field Detail

collapseRequest

public boolean collapseRequest

For internal use only. May be removed or replaced in the future.

colIndexOfHierarchy

public int colIndexOfHierarchy

For internal use only. May be removed or replaced in the future.

collapsedRowKey

public String collapsedRowKey

For internal use only. May be removed or replaced in the future.

scrollBody

public VTreeTable.VTreeTableScrollBody scrollBody

For internal use only. May be removed or replaced in the future.

animationsEnabled

public boolean animationsEnabled

For internal use only. May be removed or replaced in the future.

pendingNavigationEvents

public LinkedList<VTreeTable.PendingNavigationEvent> pendingNavigationEvents

For internal use only. May be removed or replaced in the future.

focusParentResponsePending

public boolean focusParentResponsePending

For internal use only. May be removed or replaced in the future.

Constructor Detail

VTreeTable

public VTreeTable()

Method Detail

createScrollBody

protected VScrollTable.VScrollTableBody createScrollBody()

Overrides:

createScrollBody in class VScrollTable

addAndRemoveRows

public void addAndRemoveRows(UIDL partialRowAdditions)

Description copied from class: VScrollTable

Inserts rows in the table body or removes them from the table body based on the commands in the UIDL.

For internal use only. May be removed or replaced in the future.

Overrides:

addAndRemoveRows in class VScrollTable

Parameters:

partialRowAdditions - the UIDL containing row updates.

getHierarchyColumnIndex

protected int getHierarchyColumnIndex()

Description copied from class: VScrollTable

This method exists for the needs of VTreeTable only. Not part of the official API, extend at your own risk. May be removed or replaced in the future.

Overrides:

getHierarchyColumnIndex in class VScrollTable

Returns:

index of TreeTable's hierarchy column, or -1 if not applicable

buildCaptionHtmlSnippet

protected String buildCaptionHtmlSnippet(UIDL uidl)

Icons rendered into first actual column in TreeTable, not to row header cell

Overrides:

buildCaptionHtmlSnippet in class VScrollTable

Parameters:

uidl - possibly with values caption and icon

Returns:

html snippet containing possibly an icon + caption text

handleNavigation

public boolean handleNavigation(int keycode,
                                boolean ctrl,
                                boolean shift)

For internal use only. May be removed or replaced in the future.

Overrides:

handleNavigation in class VScrollTable

Returns:

true iff the navigation event was handled

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

sendSelectedRows

protected void sendSelectedRows(boolean immediately)

Description copied from class: VScrollTable

Sends the selection to the server if it has been changed since the last update/visit.

Overrides:

sendSelectedRows in class VScrollTable

Parameters:

immediately - set to true to immediately send the rows

reOrderColumn

protected void reOrderColumn(String columnKey,
                             int newIndex)

Overrides:

reOrderColumn in class VScrollTable

setStyleName

public void setStyleName(String style)

Overrides:

setStyleName in class VScrollTable

updateTotalRows

public void updateTotalRows(UIDL uidl)

Description copied from class: VScrollTable

For internal use only. May be removed or replaced in the future.

Overrides:

updateTotalRows in class VScrollTable