org.apertereports.dashboard
Class AbstractDashboardComponent

java.lang.Object
  com.vaadin.ui.AbstractComponent
      com.vaadin.ui.AbstractComponentContainer
          com.vaadin.ui.CustomComponent
              org.apertereports.dashboard.AbstractDashboardComponent

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.terminal.Paintable, com.vaadin.terminal.Sizeable, com.vaadin.terminal.VariableOwner, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, Serializable, EventListener

Direct Known Subclasses:

EditDashboardComponent, EditDashboardComponentNew, ViewDashboardComponent

public abstract class AbstractDashboardComponent
extends com.vaadin.ui.CustomComponent

An abstract class that manages the portlet session and preferences.

The preferences are transformed from an Base64 encoded XML to a list of ReportConfig objects. Extending classes use these configuration objects to either display the dashboard or show an edit form.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponent.ComponentErrorEvent, com.vaadin.ui.AbstractComponent.ComponentErrorHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.ComponentContainer

com.vaadin.ui.ComponentContainer.ComponentAttachEvent, com.vaadin.ui.ComponentContainer.ComponentAttachListener, com.vaadin.ui.ComponentContainer.ComponentDetachEvent, com.vaadin.ui.ComponentContainer.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.ErrorListener, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.terminal.Paintable

com.vaadin.terminal.Paintable.RepaintRequestEvent, com.vaadin.terminal.Paintable.RepaintRequestListener

Field Summary

protected MapCache	cache An instance of a MapCache for general caching purposes.
protected String	portletId
protected javax.portlet.PortletPreferences	preferences
protected List<ReportConfig>	reportConfigs
protected javax.portlet.PortletSession	session
protected String	template

Fields inherited from interface com.vaadin.terminal.Sizeable

SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

AbstractDashboardComponent()

Method Summary

protected abstract void	initComponentData() Init extending class view.
void	initData() Loads preferences and initializes the view.
protected void	prepareData() Loads the dashboard HTML template from preferences with a key specified by DashboardPreferences.PREFERENCE_TEMPLATE_KEY.
protected void	saveData() Stores the dashboard HTML template to preferences.
void	setPortletId(String portletId)
void	setPortletPreferences(javax.portlet.PortletPreferences preferences)
void	setPortletSession(javax.portlet.PortletSession session)

Methods inherited from class com.vaadin.ui.CustomComponent

addComponent, getComponentCount, getComponentIterator, getComponentType, getCompositionRoot, moveComponentsFrom, paintContent, removeAllComponents, removeComponent, replaceComponent, setComponentType, setCompositionRoot

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addListener, addListener, attach, detach, fireComponentAttachEvent, fireComponentDetachEvent, removeListener, removeListener, requestRepaintAll, setEnabled, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addListener, addStyleName, changeVariables, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setErrorHandler, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidth, setWidthUnits

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, childRequestedRepaint, getApplication, getCaption, getIcon, getLocale, getParent, getStyleName, getWindow, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setIcon, setParent, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.terminal.Paintable

addListener, getDebugId, paint, removeListener, requestRepaint, requestRepaintRequests, setDebugId

Methods inherited from interface com.vaadin.terminal.VariableOwner

changeVariables, isImmediate

Methods inherited from interface com.vaadin.terminal.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUnits, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUnits

Field Detail

reportConfigs

protected List<ReportConfig> reportConfigs

template

protected String template

preferences

protected javax.portlet.PortletPreferences preferences

session

protected javax.portlet.PortletSession session

portletId

protected String portletId

cache

protected MapCache cache

An instance of a MapCache for general caching purposes.

See Also:

MapCache

Constructor Detail

AbstractDashboardComponent

public AbstractDashboardComponent()

Method Detail

prepareData

protected void prepareData()

Loads the dashboard HTML template from preferences with a key specified by DashboardPreferences.PREFERENCE_TEMPLATE_KEY.

Also loads an XML containing a list of ReportConfigs which is transformed so that classes extending this class can use it.

saveData

protected void saveData()

Stores the dashboard HTML template to preferences. The template is stored under DashboardPreferences.PREFERENCE_TEMPLATE_KEY key as a Base64 encoded string.

Also stores the list of ReportConfig which is marshaled to a single string using JAXB.

initData

public void initData()

Loads preferences and initializes the view.

initComponentData

protected abstract void initComponentData()

Init extending class view.

setPortletPreferences

public void setPortletPreferences(javax.portlet.PortletPreferences preferences)

setPortletSession

public void setPortletSession(javax.portlet.PortletSession session)

setPortletId

public void setPortletId(String portletId)