Package io.jmix.ui.widget.client.grid

Class JmixGridWidget

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>
io.jmix.ui.widget.client.grid.JmixGridWidget
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, com.vaadin.client.DeferredWorker, com.vaadin.client.Focusable, com.vaadin.client.ui.SubPartAware, com.vaadin.client.widget.grid.selection.HasSelectionHandlers<elemental.json.JsonObject>, Iterable<com.google.gwt.user.client.ui.Widget>
public class JmixGridWidget extends com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected class 
    JmixGridWidget.JmixAutoColumnWidthsRecalculator
     
    static class 
    JmixGridWidget.JmixAutoScroller
     
    protected class 
    JmixGridWidget.JmixColumnHider
     
    static class 
    JmixGridWidget.JmixEscalator
     
    protected class 
    JmixGridWidget.JmixSelectionColumn
     
    protected static class 
    JmixGridWidget.JmixSidebar
     
    protected class 
    JmixGridWidget.JmixStaticSectionUpdater
     
    protected class 
    JmixGridWidget.JmixUserSorter
     

    Nested classes/interfaces inherited from class com.vaadin.client.widgets.Grid

    com.vaadin.client.widgets.Grid.AbstractGridKeyEvent<HANDLER extends com.vaadin.client.widget.grid.events.AbstractGridKeyEventHandler>, com.vaadin.client.widgets.Grid.AbstractGridMouseEvent<HANDLER extends com.vaadin.client.widget.grid.events.AbstractGridMouseEventHandler>, com.vaadin.client.widgets.Grid.AutoColumnWidthsRecalculator, com.vaadin.client.widgets.Grid.BodyUpdater, com.vaadin.client.widgets.Grid.Column<C extends Object,T extends Object>, com.vaadin.client.widgets.Grid.ColumnHider, com.vaadin.client.widgets.Grid.Editor<T extends Object>, com.vaadin.client.widgets.Grid.EditorDomEvent<T extends Object>, com.vaadin.client.widgets.Grid.Footer, com.vaadin.client.widgets.Grid.FooterCell, com.vaadin.client.widgets.Grid.FooterRow, com.vaadin.client.widgets.Grid.GridEvent<T extends Object>, com.vaadin.client.widgets.Grid.Header, com.vaadin.client.widgets.Grid.HeaderCell, com.vaadin.client.widgets.Grid.HeaderRow, com.vaadin.client.widgets.Grid.SelectionColumn, com.vaadin.client.widgets.Grid.Sidebar, com.vaadin.client.widgets.Grid.StaticSection<ROWTYPE extends com.vaadin.client.widgets.Grid.StaticSection.StaticRow<?>>, com.vaadin.client.widgets.Grid.StaticSectionUpdater, com.vaadin.client.widgets.Grid.UserSorter

    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COLUMN_HIDING_TOGGLE_STYLENAME
     
    protected Map<com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject>,String>
    columnIds
     
    protected String
    deselectAllLabel
     
    protected JmixGridEmptyState
    emptyState
     
    protected Runnable
    emptyStateLinkClickHandler
     
    static final String
    JMIX_ID_COLUMN_HIDING_TOGGLE_PREFIX
     
    static final String
    JMIX_ID_COLUMN_PREFIX
     
    static final String
    MULTI_CHECK_STYLENAME
     
    protected String
    selectAllLabel
     
    static final String
    SORT_LAST_STYLENAME
     

    Fields inherited from class com.vaadin.client.widgets.Grid

    cellFocusHandler

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

    DEBUG_ID_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    JmixGridWidget()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addColumnId(com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject> column, String id)
     
    protected com.vaadin.client.widgets.Grid<elemental.json.JsonObject>.com.vaadin.client.widgets.Grid.AutoColumnWidthsRecalculator
    createAutoColumnWidthsRecalculator()
     
    protected com.vaadin.client.widget.grid.AutoScroller
    createAutoScroller()
     
    protected com.vaadin.client.widgets.Grid<elemental.json.JsonObject>.com.vaadin.client.widgets.Grid.ColumnHider
    createColumnHider()
     
    protected com.vaadin.client.widgets.Grid.Editor<elemental.json.JsonObject>
    createEditor()
     
    protected com.vaadin.client.widgets.Escalator
    createEscalator()
     
    protected com.vaadin.client.widget.escalator.EscalatorUpdater
    createFooterUpdater()
     
    protected com.vaadin.client.widget.escalator.EscalatorUpdater
    createHeaderUpdater()
     
    protected com.vaadin.client.widgets.Grid<elemental.json.JsonObject>.com.vaadin.client.widgets.Grid.SelectionColumn
    createSelectionColumn(com.vaadin.client.renderers.Renderer<Boolean> selectColumnRenderer)
     
    protected com.vaadin.client.widgets.Grid.Sidebar
    createSidebar()
     
    protected com.vaadin.client.widgets.Grid<elemental.json.JsonObject>.com.vaadin.client.widgets.Grid.UserSorter
    createUserSorter()
     
    Map<com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject>,String>
    getColumnIds()
     
    String
    getDeselectAllLabel()
     
    JmixGridEmptyState
    getEmptyState()
     
    String
    getSelectAllLabel()
     
    protected boolean
    hasSelectionColumn(com.vaadin.client.widget.grid.selection.SelectionModel<elemental.json.JsonObject> selectionModel)
     
    protected boolean
    isClickThroughEnabled(com.google.gwt.dom.client.Element e)
     
    protected boolean
    isEventHandlerShouldHandleEvent(com.google.gwt.dom.client.Element targetElement, com.vaadin.client.widgets.Grid.GridEvent<elemental.json.JsonObject> event)
     
    protected boolean
    isWidgetAllowsClickHandling(com.google.gwt.dom.client.Element targetElement, com.google.gwt.dom.client.NativeEvent nativeEvent)
     
    protected boolean
    isWidgetFocusable(com.google.gwt.user.client.ui.Widget widget)
     
    protected boolean
    isWidgetOrParentFocusable(com.google.gwt.user.client.ui.Widget widget)
     
    void
    removeColumnId(com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject> column)
     
    void
    setColumnIds(Map<com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject>,String> columnProperties)
     
    void
    setDeselectAllLabel(String deselectAllLabel)
     
    void
    setSelectAllLabel(String selectAllLabel)
     
    void
    setSelectionModel(com.vaadin.client.widget.grid.selection.SelectionModel<elemental.json.JsonObject> selectionModel)
     
    void
    setStylePrimaryName(String style)
     
    void
    showEmptyState(boolean show)
     
    void
    updateFooterVisibility()
     

    Methods inherited from class com.vaadin.client.widgets.Grid

    add, addBodyClickHandler, addBodyDoubleClickHandler, 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, createBodyUpdater, 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, getSidebar, getSidebarMenu, getSortOrder, getSubPartElement, getSubPartName, getTabIndex, getVisibleColumns, isColumnReorderingAllowed, isDetailsVisible, isEditorActive, isEditorBuffered, isEditorEnabled, isEnabled, isFooterVisible, isHeaderVisible, isSelected, isSidebarOpen, isWorkPending, iterator, onAttach, onBrowserEvent, onDetach, onResize, prependFooterRow, prependHeaderRow, recalculateColumnWidths, remove, removeColumn, removeFooterRow, removeFooterRow, removeHeaderRow, removeHeaderRow, requestRefreshBody, resetSizesFromDom, resetVisibleDetails, saveEditor, 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, setRowStyleGenerator, setScrollLeft, setScrollTop, setSidebarOpen, setSortOrder, setTabIndex, setWidth, sort, sort, sort

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

    initWidget

    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

  • Field Details

  • Constructor Details

    • JmixGridWidget

      public JmixGridWidget()

  • Method Details

    • setSelectionModel

      public void setSelectionModel(com.vaadin.client.widget.grid.selection.SelectionModel<elemental.json.JsonObject> selectionModel)
      Overrides:
      setSelectionModel in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • getColumnIds

      public Map<com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject>,String> getColumnIds()

    • setColumnIds

      public void setColumnIds(Map<com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject>,String> columnProperties)

    • addColumnId

      public void addColumnId(com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject> column, String id)

    • removeColumnId

      public void removeColumnId(com.vaadin.client.widgets.Grid.Column<?,elemental.json.JsonObject> column)

    • getSelectAllLabel

      public String getSelectAllLabel()

    • setSelectAllLabel

      public void setSelectAllLabel(String selectAllLabel)

    • getDeselectAllLabel

      public String getDeselectAllLabel()

    • setDeselectAllLabel

      public void setDeselectAllLabel(String deselectAllLabel)

    • updateFooterVisibility

      public void updateFooterVisibility()

    • showEmptyState

      public void showEmptyState(boolean show)

    • getEmptyState

      public JmixGridEmptyState getEmptyState()

    • createEditor

      protected com.vaadin.client.widgets.Grid.Editor<elemental.json.JsonObject> createEditor()
      Overrides:
      createEditor in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • setStylePrimaryName

      public void setStylePrimaryName(String style)
      Overrides:
      setStylePrimaryName in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • isWidgetAllowsClickHandling

      protected boolean isWidgetAllowsClickHandling(com.google.gwt.dom.client.Element targetElement, com.google.gwt.dom.client.NativeEvent nativeEvent)
      Overrides:
      isWidgetAllowsClickHandling in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • isWidgetOrParentFocusable

      protected boolean isWidgetOrParentFocusable(com.google.gwt.user.client.ui.Widget widget)

    • isWidgetFocusable

      protected boolean isWidgetFocusable(com.google.gwt.user.client.ui.Widget widget)

    • isEventHandlerShouldHandleEvent

      protected boolean isEventHandlerShouldHandleEvent(com.google.gwt.dom.client.Element targetElement, com.vaadin.client.widgets.Grid.GridEvent<elemental.json.JsonObject> event)
      Overrides:
      isEventHandlerShouldHandleEvent in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • isClickThroughEnabled

      protected boolean isClickThroughEnabled(com.google.gwt.dom.client.Element e)

    • createHeaderUpdater

      protected com.vaadin.client.widget.escalator.EscalatorUpdater createHeaderUpdater()
      Overrides:
      createHeaderUpdater in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • createFooterUpdater

      protected com.vaadin.client.widget.escalator.EscalatorUpdater createFooterUpdater()
      Overrides:
      createFooterUpdater in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • createUserSorter

      protected com.vaadin.client.widgets.Grid<elemental.json.JsonObject>.com.vaadin.client.widgets.Grid.UserSorter createUserSorter()
      Overrides:
      createUserSorter in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • createSidebar

      protected com.vaadin.client.widgets.Grid.Sidebar createSidebar()
      Overrides:
      createSidebar in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • createEscalator

      protected com.vaadin.client.widgets.Escalator createEscalator()
      Overrides:
      createEscalator in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • createColumnHider

      protected com.vaadin.client.widgets.Grid<elemental.json.JsonObject>.com.vaadin.client.widgets.Grid.ColumnHider createColumnHider()
      Overrides:
      createColumnHider in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • createSelectionColumn

      protected com.vaadin.client.widgets.Grid<elemental.json.JsonObject>.com.vaadin.client.widgets.Grid.SelectionColumn createSelectionColumn(com.vaadin.client.renderers.Renderer<Boolean> selectColumnRenderer)
      Overrides:
      createSelectionColumn in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • hasSelectionColumn

      protected boolean hasSelectionColumn(com.vaadin.client.widget.grid.selection.SelectionModel<elemental.json.JsonObject> selectionModel)
      Overrides:
      hasSelectionColumn in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • createAutoScroller

      protected com.vaadin.client.widget.grid.AutoScroller createAutoScroller()
      Overrides:
      createAutoScroller in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>

    • createAutoColumnWidthsRecalculator

      protected com.vaadin.client.widgets.Grid<elemental.json.JsonObject>.com.vaadin.client.widgets.Grid.AutoColumnWidthsRecalculator createAutoColumnWidthsRecalculator()
      Overrides:
      createAutoColumnWidthsRecalculator in class com.vaadin.client.widgets.Grid<elemental.json.JsonObject>