Package org.opencms.ui.report
Class CmsReportWidget
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.ui.AbstractComponent
-
- org.opencms.ui.report.CmsReportWidget
-
- All Implemented Interfaces:
com.vaadin.event.ContextClickEvent.ContextClickNotifier
,com.vaadin.event.MethodEventSource
,com.vaadin.server.ClientConnector
,com.vaadin.server.Sizeable
,com.vaadin.shared.communication.ServerRpc
,com.vaadin.shared.Connector
,com.vaadin.ui.Component
,java.io.Serializable
,I_CmsReportServerRpc
- Direct Known Subclasses:
CmsStreamReportWidget
public class CmsReportWidget extends com.vaadin.ui.AbstractComponent implements I_CmsReportServerRpc
A widget used to display an OpenCms report.- See Also:
- Serialized Form
-
-
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
-
-
Constructor Summary
Constructors Constructor Description CmsReportWidget()
Creates a new instance.CmsReportWidget(A_CmsReportThread thread)
Creates a new instance.CmsReportWidget(CmsWorkplaceReport report)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.gwt.event.shared.HandlerRegistration
addReportFinishedHandler(java.lang.Runnable handler)
Adds an action that should be executed if the report is finished.protected CmsReportWidgetState
getState()
void
requestReportUpdate()
Requests a report update from the server.protected void
runReportFinishedHandlers()
Runs the 'report finished' handlers.void
setReportThread(A_CmsReportThread thread)
Sets the report thread.-
Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined, writeDesign
-
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, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler
-
-
-
-
Constructor Detail
-
CmsReportWidget
public CmsReportWidget()
Creates a new instance.Use in declarative layouts, remember to call .
This does not start the report thread.
-
CmsReportWidget
public CmsReportWidget(A_CmsReportThread thread)
Creates a new instance.This does not start the report thread.
- Parameters:
thread
- the report thread
-
CmsReportWidget
public CmsReportWidget(CmsWorkplaceReport report)
Creates a new instance.Use this constructor in case no report thread is available.
- Parameters:
report
- the report to display
-
-
Method Detail
-
addReportFinishedHandler
public com.google.gwt.event.shared.HandlerRegistration addReportFinishedHandler(java.lang.Runnable handler)
Adds an action that should be executed if the report is finished.Note that this action will only be called if the report is finished while the report widget is actually displayed. For example, if the user closes the browser window before the report is finished, this will not be executed.
- Parameters:
handler
- the handler- Returns:
- the handler registration
-
requestReportUpdate
public void requestReportUpdate()
Description copied from interface:I_CmsReportServerRpc
Requests a report update from the server.- Specified by:
requestReportUpdate
in interfaceI_CmsReportServerRpc
- See Also:
I_CmsReportServerRpc.requestReportUpdate()
-
setReportThread
public void setReportThread(A_CmsReportThread thread)
Sets the report thread.- Parameters:
thread
- the report thread
-
getState
protected CmsReportWidgetState getState()
- Overrides:
getState
in classcom.vaadin.ui.AbstractComponent
- See Also:
AbstractComponent.getState()
-
runReportFinishedHandlers
protected void runReportFinishedHandlers()
Runs the 'report finished' handlers.
-
-