Class CmsDataViewPanel

  • All Implemented Interfaces:
    com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>

    public class CmsDataViewPanel
    extends com.vaadin.v7.ui.VerticalLayout
    Panel containing both the interface elements used to search the data source (query field, filter select boxes) as well as the paged list of search results.

    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  CmsDataViewPanel.PagedTable
      Subclass of Table, which we need because we want to trigger a complete refresh when sorting instead of just sorting the in-memory data.
      • Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

        com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener
      • Nested classes/interfaces inherited from interface com.vaadin.ui.Component

        com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener
      • Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

        com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener
      • Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

        com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler
      • Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

        com.vaadin.server.Sizeable.Unit
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.Object ID_COLUMN
      The ID column name.
      protected boolean m_ascending
      The sort direction.
      protected java.lang.Object m_sortCol
      The sort column.
      • Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

        ALIGNMENT_DEFAULT, components
      • Fields inherited from class com.vaadin.ui.AbstractComponent

        DESIGN_ATTR_PLAIN_TEXT
      • Fields inherited from interface com.vaadin.server.Sizeable

        SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS
    • Constructor Summary

      Constructors 
      Constructor Description
      CmsDataViewPanel​(I_CmsDataView viewInstance, boolean multiselect)
      Creates a new instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void fillItem​(I_CmsDataViewItem item, com.vaadin.v7.data.Item target)
      Fills the given item.
      java.util.List<I_CmsDataViewItem> getSelection()
      Gets the list of selected data items.
      com.vaadin.v7.ui.Table getTable()
      Gets the table.
      void refreshData​(boolean resetPaging, java.lang.String textQuery)
      Updates the data displayed in the table.
      void updateFilter​(java.lang.String id, java.lang.String value)
      Updates the search results after a filter is changed by the user.
      void updateFilters​(java.util.List<CmsDataViewFilter> newFilters)
      Changes the displayed filters to a new set.
      protected void updateRealSelection​(java.util.Set<java.lang.Object> selectionEventIds)
      Updates the real selection, given the item ids from the selection event.
      • Methods inherited from class com.vaadin.ui.VerticalLayout

        addComponentsAndExpand, getState, getState
      • Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

        addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, isSpacing, iterator, readDesign, removeComponent, removeLayoutClickListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign
      • Methods inherited from class com.vaadin.ui.AbstractLayout

        readMargin, writeMargin
      • Methods inherited from class com.vaadin.ui.AbstractComponentContainer

        addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth
      • Methods inherited from class com.vaadin.ui.AbstractComponent

        addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined
      • Methods inherited from class com.vaadin.server.AbstractClientConnector

        addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.vaadin.server.ClientConnector

        addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler
      • Methods inherited from interface com.vaadin.ui.Component

        addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible
      • Methods inherited from interface com.vaadin.ui.ComponentContainer

        addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents
      • Methods inherited from interface com.vaadin.shared.Connector

        getConnectorId
      • Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

        addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
      • Methods inherited from interface com.vaadin.server.Sizeable

        getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined
    • Field Detail

      • ID_COLUMN

        public static final java.lang.Object ID_COLUMN
        The ID column name.
      • m_sortCol

        protected java.lang.Object m_sortCol
        The sort column.
      • m_ascending

        protected boolean m_ascending
        The sort direction.
    • Constructor Detail

      • CmsDataViewPanel

        public CmsDataViewPanel​(I_CmsDataView viewInstance,
                                boolean multiselect)
        Creates a new instance.

        Parameters:
        viewInstance - the data view instance
        multiselect - true if multi-selection should be allowed
    • Method Detail

      • fillItem

        public void fillItem​(I_CmsDataViewItem item,
                             com.vaadin.v7.data.Item target)
        Fills the given item.

        Parameters:
        item - the data view item
        target - the table item
      • getSelection

        public java.util.List<I_CmsDataViewItemgetSelection()
        Gets the list of selected data items.

        If this widget is not in multi-select mode, a list with a single result will be returned.

        Returns:
        the selected results
      • getTable

        public com.vaadin.v7.ui.Table getTable()
        Gets the table.

        Returns:
        the table
      • refreshData

        public void refreshData​(boolean resetPaging,
                                java.lang.String textQuery)
        Updates the data displayed in the table.

        Parameters:
        resetPaging - true if we should go back to page 1
        textQuery - the text query to use
      • updateFilter

        public void updateFilter​(java.lang.String id,
                                 java.lang.String value)
        Updates the search results after a filter is changed by the user.

        Parameters:
        id - the filter id
        value - the filter value
      • updateFilters

        public void updateFilters​(java.util.List<CmsDataViewFilter> newFilters)
        Changes the displayed filters to a new set.

        Parameters:
        newFilters - the new filters
      • updateRealSelection

        protected void updateRealSelection​(java.util.Set<java.lang.Object> selectionEventIds)
        Updates the real selection, given the item ids from the selection event.

        Parameters:
        selectionEventIds - the item ids from the selection event