com.whitestein.lsps.vaadin.forms.dashboard

Class WGridStackDashboard

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.dashboard.WGridStackDashboard

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, Serializable, EventListener

public class WGridStackDashboard
extends FormComponent

Author:

mvy

See Also:

Serialized Form

Field Summary

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WGridStackDashboard()

Method Summary

Modifier and Type	Method and Description
RecordHolder	addWidget(RecordHolder component, RecordHolder position, boolean autoposition) Adds a widget to the dashboard.
protected GridStackDashboard	createWidget() Called once, to create the actual Vaadin component.
String	getCaption(RecordHolder widget) Gets a widget caption.
Decimal	getComponentCount() Gets the component count.
ListHolder	getComponents() Gets a list of components in the grid.
RecordHolder	getPosition(RecordHolder widget) Gets a position of a widget.
EnumerationImpl	getState(RecordHolder dwidget) Gets a widget state.
GridStackDashboard	getWidget() Gets the Vaadin representation of this component.
ListHolder	getWidgets() Gets a list of widgets.
protected void	onUpdate(GridStackDashboardUpdateEvent e)
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
void	removeWidget(RecordHolder dwidget) Removes the widget from the dashboard.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setCaption(RecordHolder widget, String caption) Sets a caption to a widget.
void	setMaximizeWindowTooltip(String maximizeTooltip, String restoreTooltip) Tooltip for maximize widget button.
void	setMinimizeWindowTooltip(String minimizeTooltip, String restoreTooltip) Tooltip for minimize widget button.
void	setPosition(RecordHolder widget, RecordHolder position) Sets the widget position.
void	setState(RecordHolder widget, EnumerationImpl state) Sets a state to a widget.
void	setToolbar(RecordHolder widget, RecordHolder component) Sets a toolbar to a widget.
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidth, hashCode, isEnabled, isReadOnly, isVisible, localize, markAsDirty, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setReadOnly, setStyleName, setTabIndex, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WGridStackDashboard

public WGridStackDashboard()

Method Detail

createWidget

protected GridStackDashboard createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class FormComponent

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

getWidget

public GridStackDashboard getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class FormComponent

Returns:

the Vaadin representation of this form component.

addWidget

public RecordHolder addWidget(RecordHolder component,
                              RecordHolder position,
                              boolean autoposition)

Adds a widget to the dashboard.

Parameters:

component - the component to be set as a widget content.

position - the widget position

autoposition -

Returns:

a record representing forms::GSDashboardWidget

removeWidget

public void removeWidget(RecordHolder dwidget)

Removes the widget from the dashboard.

Parameters:

dwidget - the widget to remove.

getWidgets

public ListHolder getWidgets()

Gets a list of widgets.

Returns:

a list of forms::GSDashboardWidget records.

getComponentCount

public Decimal getComponentCount()

Gets the component count. The count includes all widgets contents and their toolbars.

Returns:

the component count

getComponents

public ListHolder getComponents()

Gets a list of components in the grid. The list contains content of each widget and toolbar. If needed only to access widgets use getWidgets().

Returns:

a list of all form components in the dashboard.

getState

public EnumerationImpl getState(RecordHolder dwidget)

Gets a widget state. This method provides the information whether a widget is minimized, maximized, restored or closed.

Parameters:

dwidget - the widget for which to query the state

Returns:

One of the forms::WidgetState enumeration values.

getCaption

public String getCaption(RecordHolder widget)

Gets a widget caption.

Parameters:

widget - the widghets the caption of which should be returned.

Returns:

the widget's caption

setCaption

public void setCaption(RecordHolder widget,
                       String caption)

Sets a caption to a widget.

Parameters:

widget - the widget

caption - the caption to set

setState

public void setState(RecordHolder widget,
                     EnumerationImpl state)

Sets a state to a widget.

Parameters:

widget - the widget

state - the state value represented by forms::WidgetState enumeration.

setPosition

public void setPosition(RecordHolder widget,
                        RecordHolder position)

Sets the widget position.

Parameters:

widget -

position -

getPosition

public RecordHolder getPosition(RecordHolder widget)

Gets a position of a widget.

Parameters:

widget -

Returns:

the widget's position

setToolbar

public void setToolbar(RecordHolder widget,
                       RecordHolder component)

Sets a toolbar to a widget.

Parameters:

widget -

component - the toolbar component

onUpdate

protected void onUpdate(GridStackDashboardUpdateEvent e)

setMinimizeWindowTooltip

public void setMinimizeWindowTooltip(String minimizeTooltip,
                                     String restoreTooltip)

Tooltip for minimize widget button.

Parameters:

minimizeTooltip - tooltip when the widget has normal size

restoreTooltip - tooltip when the widget is minimized

setMaximizeWindowTooltip

public void setMaximizeWindowTooltip(String maximizeTooltip,
                                     String restoreTooltip)

Tooltip for maximize widget button.

Parameters:

maximizeTooltip - tooltip when the widget has normal size

restoreTooltip - tooltip when the widget is maximized

preventGC

public void preventGC(Set<ValueHolder> set)

Description copied from class: FormComponent

Override for all components which are actively using some record holders, not directly linked to the model. You will need to return those record holders here, otherwise they will be garbage-collected.

For example, WTabSheet maintains a set of opened tabs. These tab records are not referenced directly from forms::TabSheet and will therefore be garbage-collected. We however need those records to not to be GCed as the user may ask for them simply by calling getTab(Integer).

Please note that the component definition records (e.g. forms::Button) are already GC-protected and they do not need to be added to this set. Also, any child components currently attached to the UI are automatically protected and are not required to be registered in the set.

Overrides:

preventGC in class FormComponent

Parameters:

set - a set of records which are to be GC-prevented, never null. The component should add any records here. Default implementation does nothing.

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class FormComponent

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class FormComponent

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)