com.vaadin.client.widget.treegrid.
Class TreeGrid
- java.lang.Object
-
- com.google.gwt.user.client.ui.UIObject
-
- com.google.gwt.user.client.ui.Widget
-
- com.google.gwt.user.client.ui.Composite
-
- com.google.gwt.user.client.ui.ResizeComposite
-
- com.vaadin.client.widgets.Grid<elemental.json.JsonObject>
-
- com.vaadin.client.widget.treegrid.TreeGrid
-
All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers
,com.google.gwt.event.shared.HasHandlers
,com.google.gwt.user.client.EventListener
,com.google.gwt.user.client.ui.Focusable
,com.google.gwt.user.client.ui.HasEnabled
,com.google.gwt.user.client.ui.HasVisibility
,com.google.gwt.user.client.ui.HasWidgets
,com.google.gwt.user.client.ui.IsRenderable
,com.google.gwt.user.client.ui.IsWidget
,com.google.gwt.user.client.ui.RequiresResize
,DeferredWorker
,Focusable
,SubPartAware
,HasSelectionHandlers<elemental.json.JsonObject>
,Iterable<com.google.gwt.user.client.ui.Widget>
public class TreeGrid extends Grid<elemental.json.JsonObject>
An extension of the Grid widget, which supports displaying of hierarchical data.
Since:
8.1
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
TreeGrid.BodyUpdater
Body updater that adds additional style to each row containing depth information inside the hierarchy.
-
Nested classes/interfaces inherited from class com.vaadin.client.widgets.Grid
Grid.AbstractGridKeyEvent<HANDLER extends AbstractGridKeyEventHandler>, Grid.AbstractGridMouseEvent<HANDLER extends AbstractGridMouseEventHandler>, Grid.Column<C,T>, Grid.Editor<T>, Grid.EditorDomEvent<T>, Grid.FocusStack, Grid.Footer, Grid.FooterCell, Grid.FooterRow, Grid.GridEvent<T>, Grid.Header, Grid.HeaderCell, Grid.HeaderRow, Grid.SelectionColumn, Grid.StaticSection<ROWTYPE extends Grid.StaticSection.StaticRow<?>>, Grid.StaticSectionUpdater
-
-
Field Summary
-
Fields inherited from class com.vaadin.client.widgets.Grid
cellFocusHandler
-
-
Constructor Summary
Constructors Constructor Description TreeGrid()
Creates a new instance.
-
Method Summary
All Methods Modifier and Type Method Description com.google.gwt.event.shared.HandlerRegistration
addBodyClickHandler(BodyClickHandler handler)
Register a BodyClickHandler to this Grid.
com.google.gwt.event.shared.HandlerRegistration
addBodyDoubleClickHandler(BodyDoubleClickHandler handler)
Register a BodyDoubleClickHandler to this Grid.
protected EscalatorUpdater
createBodyUpdater()
Creates the escalator updater used to update the body rows in this grid.
void
focusCell(int rowIndex, int columnIndex)
Method for accessing the private
Grid.focusCell(int, int)
method from this package.boolean
isElementInChildWidget(com.google.gwt.dom.client.Element e)
Method for accessing the private
Grid.isElementInChildWidget(Element)
method from this package.void
setStylePrimaryName(String style)
-
Methods inherited from class com.vaadin.client.widgets.Grid
add, addBodyKeyDownHandler, addBodyKeyPressHandler, addBodyKeyUpHandler, addBrowserEventHandler, addColumn, addColumn, addColumnReorderHandler, addColumnResizeHandler, addColumns, addColumnVisibilityChangeHandler, addDataAvailableHandler, addEnabledHandler, addFooterClickHandler, addFooterDoubleClickHandler, addFooterKeyDownHandler, addFooterKeyPressHandler, addFooterKeyUpHandler, addFooterRowAt, addHeaderClickHandler, addHeaderDoubleClickHandler, addHeaderKeyDownHandler, addHeaderKeyPressHandler, addHeaderKeyUpHandler, addHeaderRowAt, addRowHeightChangedHandler, addRowVisibilityChangeHandler, addScrollHandler, addSelectAllHandler, addSelectionAllowedHandler, addSelectionHandler, addSortHandler, addSpacerIndexChangedHandler, addSpacerVisibilityChangedHandler, appendFooterRow, appendHeaderRow, cancelEditor, clear, createFooterUpdater, createHeaderUpdater, deselect, deselectAll, doAttachChildren, doDetachChildren, editRow, focus, getCellReference, getCellStyleGenerator, getColumn, getColumnCount, getColumnResizeMode, getColumns, getDataSource, getDefaultHeaderRow, getDetailsGenerator, getEditor, getEditorCancelCaption, getEditorHandler, getEditorSaveCaption, getEditorWidget, getEscalator, getEventCell, getFooter, getFooterRow, getFooterRowCount, getFrozenColumnCount, getHeader, getHeaderRow, getHeaderRowCount, getHeightByRows, getHeightMode, getRowStyleGenerator, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getSelectionColumn, getSelectionModel, getSidebarColumnOrder, getSidebarMenu, getSortOrder, getSubPartElement, getSubPartName, getTabIndex, getVisibleColumns, isColumnReorderingAllowed, isDetailsVisible, isEditorActive, isEditorBuffered, isEditorEnabled, isEnabled, isFooterVisible, isHeaderVisible, isReadOnly, isSelected, isSidebarOpen, isWorkPending, iterator, onAttach, onBrowserEvent, onDetach, onResize, prependFooterRow, prependHeaderRow, recalculateColumnWidths, remove, removeColumn, removeFooterRow, removeFooterRow, removeHeaderRow, removeHeaderRow, requestRefreshBody, resetSizesFromDom, resetVisibleDetails, saveEditor, scrollToColumn, scrollToEnd, scrollToRow, scrollToRow, scrollToRow, scrollToRow, scrollToStart, select, setAccessKey, setAriaRole, setCellStyleGenerator, setColumnOrder, setColumnReorderingAllowed, setColumnResizeMode, setDataSource, setDefaultHeaderRow, setDetailsGenerator, setDetailsHeight, setDetailsVisible, setEditorBuffered, setEditorCancelCaption, setEditorEnabled, setEditorHandler, setEditorSaveCaption, setEnabled, setFocus, setFooterVisible, setFrozenColumnCount, setHeaderVisible, setHeight, setHeightByRows, setHeightMode, setReadOnly, setRowStyleGenerator, setScrollLeft, setScrollTop, setSelectionModel, setSidebarColumnOrder, setSidebarOpen, setSortOrder, setTabIndex, setWidth, sort, sort, sort
-
Methods inherited from class com.google.gwt.user.client.ui.Composite
claimElement, getWidget, initializeClaimedElement, isAttached, render, render, resolvePotentialElement, setWidget
-
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, 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, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
focusCell
public void focusCell(int rowIndex, int columnIndex)
Method for accessing the private
Grid.focusCell(int, int)
method from this package.Parameters:
rowIndex
- index of row to focuscolumnIndex
- index (excluding hidden columns) of cell to focus
-
isElementInChildWidget
public boolean isElementInChildWidget(com.google.gwt.dom.client.Element e)
Method for accessing the private
Grid.isElementInChildWidget(Element)
method from this package.Parameters:
e
- the element to checkReturns:
true
if the element is located within a child widget of this TreeGrid,false
otherwise.
-
addBodyClickHandler
public com.google.gwt.event.shared.HandlerRegistration addBodyClickHandler(BodyClickHandler handler)
Description copied from class:
Grid
Register a BodyClickHandler to this Grid. The event for this handler is fired when a Click event occurs in the Body of this Grid.
Overrides:
addBodyClickHandler
in classGrid<elemental.json.JsonObject>
Parameters:
handler
- the click handler to registerReturns:
the registration for the handler
-
addBodyDoubleClickHandler
public com.google.gwt.event.shared.HandlerRegistration addBodyDoubleClickHandler(BodyDoubleClickHandler handler)
Description copied from class:
Grid
Register a BodyDoubleClickHandler to this Grid. The event for this handler is fired when a double click event occurs in the Body of this Grid.
Overrides:
addBodyDoubleClickHandler
in classGrid<elemental.json.JsonObject>
Parameters:
handler
- the double click handler to registerReturns:
the registration for the handler
-
createBodyUpdater
protected EscalatorUpdater createBodyUpdater()
Description copied from class:
Grid
Creates the escalator updater used to update the body rows in this grid. The updater is invoked when body rows or columns are added or removed, the content of body cells is changed, or the body is scrolled to expose previously hidden content.
Overrides:
createBodyUpdater
in classGrid<elemental.json.JsonObject>
Returns:
the new body updater instance
-
setStylePrimaryName
public void setStylePrimaryName(String style)
Overrides:
setStylePrimaryName
in classGrid<elemental.json.JsonObject>
-
-