Package com.storedobject.vaadin

Class Dashboard

java.lang.Object

com.vaadin.flow.component.Component

com.storedobject.vaadin.CSSGrid

com.storedobject.vaadin.Dashboard

All Implemented Interfaces:

ClickHandler, ExecutableView, HasSize, HasStyle, ValueChangeHandler, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<? extends com.vaadin.flow.component.Component>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasValue.ValueChangeListener, Serializable, Runnable, EventListener

public class Dashboard
extends CSSGrid
implements ExecutableView

Dashboard is a "view" that can show multiple embedded "sub-views". Dashboard divides the display area into rows and columns, and each "sub-view" can span across one or more rows and columns.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.vaadin.CSSGrid

CSSGrid.Position

Nested classes/interfaces inherited from interface com.storedobject.vaadin.ClickHandler

ClickHandler.ModifiedClickEvent<C extends com.vaadin.flow.component.Component>

Constructor Summary

Constructors

Constructor	Description
Dashboard()	Constructor.
Dashboard(boolean boxing)	Constructor.
Dashboard(String caption)	Constructor.
Dashboard(String caption, boolean boxing)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	abort()	Closes the view by aborting if that exists
void	add(View... views)	Add sub-views to the dashboard.
void	add(com.vaadin.flow.component.Component... components)	Add sub-views to the dashboard.
void	align(View view, CSSGrid.Position position)	Align (vertically) a view within its grid cell.
void	center(View view)	Center (horizontally and vertically) a view within its grid cell.
void	clean()	This will be invoked whenever the dashboard is closed or aborted so that any resource cleanup can be run.
void	clicked(com.vaadin.flow.component.Component c)	Default implementation, does nothing.
void	close()	Closes the view if that exists
protected View	createView()	Create a View to display the grid when executed.
String	getCaption()	Caption used when displaying it in a View.
final View	getView(boolean create)	Create a View to display the grid when executed.
boolean	isAutoarrange()	Check the current value of an auto-arrange flag.
void	justify(View view, CSSGrid.Position position)	Horizontally justify a view within its grid cell.
void	remove(View... views)	Remove sub-views from the dashboard.
void	setAutoarrange(boolean autoarrange)	Set the auto-arrange flag.
void	setCaption(String caption)	Set the caption used when displaying the grid in a View.
void	setColumnSpan(View view, int numberOfColumns)	Set the column-span for the particular sub-view.
void	setColumnSpan(com.vaadin.flow.component.Component component, int numberOfColumns)	Set the column-span for the particular sub-view.
void	setMinimumColumnWidth(String width)	Set the minimum width for the column.
void	setRowSpan(View view, int numberOfRows)	Set the row-span for the particular sub-view.

Methods inherited from class com.storedobject.vaadin.CSSGrid

align, center, getColumnSpan, getRowSpan, justify, setColumnGap, setColumnGap, setGap, setGap, setRowGap, setRowGap, setRowSpan, style

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.storedobject.vaadin.ExecutableView

clearAlerts, createMenuItem, error, execute, execute, getApplication, getMenuIconName, getMenuItem, getView, invoke, isCloseable, isFullScreen, isHomeView, log, log, message, returnedFrom, run, setClickable, speak, trackValueChange, tray, valueChanged, warning

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasOrderedComponents

getChildren, getComponentAt, getComponentCount, indexOf, replace

Methods inherited from interface com.storedobject.vaadin.HasSize

setHeight, setWidth

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFull

Methods inherited from interface com.storedobject.vaadin.HasStyle

getClassName, getClassNames, getInternalElement, getStyle, setClassName

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, hasClassName, removeClassName, removeClassNames, setClassName

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

Dashboard

public Dashboard()

Constructor. Sub-views are shown in a box by default.

Dashboard

public Dashboard(boolean boxing)

Constructor.

Parameters:

boxing - Whether the sub-views should be shown inside a box or not

Dashboard

public Dashboard(String caption)

Constructor. Sub-views are shown in a box by default.

Parameters:

caption - Caption

Dashboard

public Dashboard(String caption,
 boolean boxing)

Constructor.

Parameters:

caption - Caption

boxing - Whether the sub-views should be shown inside a box or not

Method Details

setMinimumColumnWidth

public void setMinimumColumnWidth(String width)

Set the minimum width for the column. The default width is 250 pixels.

Parameters:

width - Width

setAutoarrange

public void setAutoarrange(boolean autoarrange)

Set the auto-arrange flag. If set, sub-views are arranged automatically to optimize space used. Default value for this is true.

Parameters:

autoarrange - Whether to auto-arrange sub-views or not

isAutoarrange

public boolean isAutoarrange()

Check the current value of an auto-arrange flag.

Returns:

Current auto-arrange flag

See Also:

• setAutoarrange(boolean)

justify

public void justify(View view,
 CSSGrid.Position position)

Horizontally justify a view within its grid cell.

Parameters:

view - View

position - Position

align

public void align(View view,
 CSSGrid.Position position)

Align (vertically) a view within its grid cell.

Parameters:

view - View

position - Position

center

public void center(View view)

Center (horizontally and vertically) a view within its grid cell.

Parameters:

view - View

setColumnSpan

public void setColumnSpan(com.vaadin.flow.component.Component component,
 int numberOfColumns)

Set the column-span for the particular sub-view. The minimum value is 1 and the maximum allowed is 6.

Overrides:

setColumnSpan in class CSSGrid

Parameters:

component - Sub-view

numberOfColumns - Number of columns to span

setColumnSpan

public void setColumnSpan(View view,
 int numberOfColumns)

Set the column-span for the particular sub-view. The minimum value is 1 and the maximum allowed is 6.

Parameters:

view - Sub-view

numberOfColumns - Number of columns to span

setRowSpan

public void setRowSpan(View view,
 int numberOfRows)

Set the row-span for the particular sub-view. Minimum value is 1.

Parameters:

view - Sub-view

numberOfRows - Number of rows to span

add

public void add(com.vaadin.flow.component.Component... components)

Add sub-views to the dashboard.

Specified by:

add in interface com.vaadin.flow.component.HasComponents

Parameters:

components - Sub-views.

add

public void add(View... views)

Add sub-views to the dashboard.

Parameters:

views - Sub-views.

remove

public void remove(View... views)

Remove sub-views from the dashboard.

Parameters:

views - Sub-views.

clicked

public void clicked(com.vaadin.flow.component.Component c)

Description copied from interface: ExecutableView

Default implementation, does nothing.

Specified by:

clicked in interface ClickHandler

Specified by:

clicked in interface ExecutableView

Parameters:

c - Component

getView

public final View getView(boolean create)

Create a View to display the grid when executed.

Specified by:

getView in interface ExecutableView

Parameters:

create - If true is passed, a view will be created if no current view exists

Returns:

A View with this grid as the component.

createView

protected View createView()

Create a View to display the grid when executed. If this method returns null, a default View will be created.

Returns:

A View with this grid as the component.

getCaption

public String getCaption()

Caption used when displaying it in a View. If no caption was set using the setCaption method, "Dashboard" will be returned.

Specified by:

getCaption in interface ExecutableView

Returns:

Caption

close

public void close()

Closes the view if that exists

Specified by:

close in interface ExecutableView

abort

public void abort()

Closes the view by aborting if that exists

Specified by:

abort in interface ExecutableView

clean

public void clean()

This will be invoked whenever the dashboard is closed or aborted so that any resource cleanup can be run.

Specified by:

clean in interface ExecutableView

setCaption

public void setCaption(String caption)

Set the caption used when displaying the grid in a View.

Specified by:

setCaption in interface ExecutableView

Parameters:

caption - Caption