com.whitestein.lsps.vaadin.forms.dashboard

Class GridStackDashboardWidget

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.CssLayout

com.whitestein.lsps.vaadin.forms.dashboard.GridStackDashboardWidget

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, Serializable, Iterable<com.vaadin.ui.Component>

public class GridStackDashboardWidget
extends com.vaadin.ui.CssLayout

Author:

oko

See Also:

Serialized Form

Nested Class Summary

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.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.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.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.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field and Description
Serializable	tag A serializable representation of the widget definition record.

Fields inherited from class com.vaadin.ui.CssLayout

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 and Description
GridStackDashboardWidget(com.vaadin.ui.Component c, GridStackDashboard.DashboardCommunication comm) Constructor for GridStackDashboard widget representation, creates necessary layout for holding widget content.

Method Summary

Modifier and Type	Method and Description
void	addInternalStateUpdateListener(GridStackDashboardWidgetUpdateListener listener) Adds a state update listener.
String	getCaption()
com.vaadin.ui.Component	getContent() Gets the widget content.
Rectangle	getPosition() Gets currently stored position
com.vaadin.ui.Component	getToolbarComponent() Returns the current toolbar component or null if there is none.
boolean	isClosed()
boolean	isMaximized() Indicates if the widget is maximized.
boolean	isMinimized() Indicates if the widget is minimized.
void	maximize() Maximizes widget.
void	minimize() Minimize widget.
void	restoreMaximized() Restore if maximized.
void	restoreMinimized() Restore if minimized.
void	setCaption(String caption)
void	setClosed(boolean closed) Sets the closed state flag to true.
void	setMaximizeWindowTooltip(String maximizeTooltip, String restoreTooltip) Tooltip for maximize widget button.
void	setMinimizeWindowTooltip(String minimizeTooltip, String restoreTooltip) Tooltip for minimize widget button.
void	setPosition(Rectangle position) Sets stored position and updates the client.
void	setPositionOnServer(Rectangle position) Sets stored position, does not update client.
void	setReadOnly(boolean readOnly)
void	setToolbar(com.vaadin.ui.Component component) Sets component to toolbar
String	toString()

Methods inherited from class com.vaadin.ui.CssLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, addListener, beforeClientResponse, getComponent, getComponentCount, getComponentIndex, getCss, getState, iterator, readDesign, removeComponent, removeLayoutClickListener, removeListener, replaceComponent, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

readMargin, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, removeListener, removeListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, 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, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, addListener, addListener, getComponentIterator, moveComponentsFrom, removeAllComponents, removeListener, removeListener

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Field Detail

tag

public Serializable tag

A serializable representation of the widget definition record.

Constructor Detail

GridStackDashboardWidget

public GridStackDashboardWidget(com.vaadin.ui.Component c,
                                GridStackDashboard.DashboardCommunication comm)

Constructor for GridStackDashboard widget representation, creates necessary layout for holding widget content.

Parameters:

c -

comm -

Method Detail

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

minimize

public void minimize()

Minimize widget. If maximized, it is restored and minimized then.

restoreMinimized

public void restoreMinimized()

Restore if minimized.

isMinimized

public boolean isMinimized()

Indicates if the widget is minimized.

Returns:

true if the widget is minimized.

maximize

public void maximize()

Maximizes widget. If minimized, it is restored and maximized then.

restoreMaximized

public void restoreMaximized()

Restore if maximized.

isMaximized

public boolean isMaximized()

Indicates if the widget is maximized.

Returns:

true if the widget is maximized.

addInternalStateUpdateListener

public void addInternalStateUpdateListener(GridStackDashboardWidgetUpdateListener listener)

Adds a state update listener.

Parameters:

listener -

getPosition

public Rectangle getPosition()

Gets currently stored position

Returns:

the position of this widget

setPosition

public void setPosition(Rectangle position)

Sets stored position and updates the client.

Parameters:

position -

setPositionOnServer

public void setPositionOnServer(Rectangle position)

Sets stored position, does not update client. For position update on client use GridStackDashboardWidget setPosition instead.

Parameters:

position -

getContent

public com.vaadin.ui.Component getContent()

Gets the widget content.

Returns:

the widget content

getCaption

public String getCaption()

Specified by:

getCaption in interface com.vaadin.ui.Component

Overrides:

getCaption in class com.vaadin.ui.AbstractComponent

setCaption

public void setCaption(String caption)

Specified by:

setCaption in interface com.vaadin.ui.Component

Overrides:

setCaption in class com.vaadin.ui.AbstractComponent

setToolbar

public void setToolbar(com.vaadin.ui.Component component)

Sets component to toolbar

Parameters:

component -

getToolbarComponent

public com.vaadin.ui.Component getToolbarComponent()

Returns the current toolbar component or null if there is none.

Returns:

the toolbar component

toString

public String toString()

Overrides:

toString in class Object

isClosed

public boolean isClosed()

Returns:

the value of the closed flag.

setClosed

public void setClosed(boolean closed)

Sets the closed state flag to true.

Parameters:

closed -

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.ui.Component

Overrides:

setReadOnly in class com.vaadin.ui.AbstractComponent