Package org.opencms.ui.apps.userdata

Class CmsUserDataAppPanel

java.lang.Object
com.vaadin.server.AbstractClientConnector
com.vaadin.ui.AbstractComponent
com.vaadin.ui.AbstractComponentContainer
com.vaadin.ui.AbstractLayout
com.vaadin.ui.AbstractOrderedLayout
com.vaadin.ui.VerticalLayout
org.opencms.ui.apps.userdata.CmsUserDataAppPanel
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, Serializable, Iterable<com.vaadin.ui.Component>
public class CmsUserDataAppPanel extends com.vaadin.ui.VerticalLayout
The GUI form for the user data app.

Generates a user data report either for a selected OpenCms user, or for an email address. The report is constructed by the I_CmsUserDataDomain plugins configured in opencms-system.xml.

See Also:

  • Nested Class Summary

    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
    protected com.vaadin.ui.Button
    m_download
    The button used to download the report.
    protected com.vaadin.ui.TextField
    m_email
    The field for entering the email address.
    protected CmsEditableGroup
    m_filterGroup
    Manages the dynamic text filter fields.
    protected com.vaadin.ui.FormLayout
    m_filters
    Contains the (dynamic) additional text filter fields.
    protected com.vaadin.ui.Button
    m_pickUserButton
    The button used to select an OpenCms user for whom to generate the report.
    protected AtomicReference<CmsReportOverlay>
    m_reportOverlay
    The m report overlay.
    protected String
    m_result
    The report as a string (the content of the download).
    protected com.vaadin.ui.VerticalLayout
    m_resultsContainer
    The widget containing the report/results.
    protected com.vaadin.ui.Label
    m_resultsLabel
    The label for the results.
    protected com.vaadin.ui.Button
    m_searchByEmail
    The button for generating the report based on the email address.
    protected com.vaadin.ui.Button
    m_searchByUser
    The button which generates the report for the selected OpenCms user.
    protected com.vaadin.ui.TextField
    m_user
    The field containing the name of the user for whom to generate the report.
    static final String
    O_USERDATA_CONTAINER
    CSS class for the container for the user data HTML.

    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
    CmsUserDataAppPanel()
    Creates a new instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected CmsObject
    getCmsObjectForReport()
    Prepares the CmsObject to use for the report.
    protected String
    getResult()
    Gets the report for the download.

    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 Details

    • O_USERDATA_CONTAINER

      public static final String O_USERDATA_CONTAINER
      CSS class for the container for the user data HTML.
      See Also:

    • m_email

      protected com.vaadin.ui.TextField m_email
      The field for entering the email address.

    • m_filters

      protected com.vaadin.ui.FormLayout m_filters
      Contains the (dynamic) additional text filter fields.

    • m_searchByEmail

      protected com.vaadin.ui.Button m_searchByEmail
      The button for generating the report based on the email address.

    • m_filterGroup

      protected CmsEditableGroup m_filterGroup
      Manages the dynamic text filter fields.

    • m_resultsContainer

      protected com.vaadin.ui.VerticalLayout m_resultsContainer
      The widget containing the report/results.

    • m_resultsLabel

      protected com.vaadin.ui.Label m_resultsLabel
      The label for the results.

    • m_download

      protected com.vaadin.ui.Button m_download
      The button used to download the report.

    • m_pickUserButton

      protected com.vaadin.ui.Button m_pickUserButton
      The button used to select an OpenCms user for whom to generate the report.

    • m_user

      protected com.vaadin.ui.TextField m_user
      The field containing the name of the user for whom to generate the report.

    • m_searchByUser

      protected com.vaadin.ui.Button m_searchByUser
      The button which generates the report for the selected OpenCms user.

    • m_result

      protected String m_result
      The report as a string (the content of the download).

    • m_reportOverlay

      protected AtomicReference<CmsReportOverlay> m_reportOverlay
      The m report overlay.

  • Constructor Details

  • Method Details

    • getCmsObjectForReport

      protected CmsObject getCmsObjectForReport()
      Prepares the CmsObject to use for the report.

      The CmsObject's locale needs to be set to the current locale, because the plugins used to generate the report do not use a separate locale parameter.

      Returns:
      the CmsObject to use for generating the report

    • getResult

      protected String getResult()
      Gets the report for the download.
      Returns:
      the report as HTML text