com.whitestein.lsps.vaadin

Class VaadinUtils

java.lang.Object

com.whitestein.lsps.vaadin.VaadinUtils

public class VaadinUtils
extends Object

Author:

mvy

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadLocal<LspsContextHolder>	CONTEXT_HOLDER PRIVATE API, DO NOT USE.
static ThreadLocal<UIComponent>	LISTENER_SCOPE PRIVATE API, DO NOT USE.

Constructor Summary

Constructors

Constructor and Description
VaadinUtils()

Method Summary

Modifier and Type	Method and Description
RecordHolder	addColumn(ExecutionContext ctx, RecordHolder wwhat, RecordHolder wwhere)
void	addTab(ExecutionContext ctx, RecordHolder tabbedLayout, RecordHolder tab) Adds tab to tabbed layout.
void	clear(ExecutionContext ctx, CollectionHolder viewModels)
RecordHolder	createAndAdd(ExecutionContext ctx, Object wwhat, RecordHolder wwhere)
RecordHolder	createAndShow(ExecutionContext ctx, RecordHolder def) Only popup is supported.
ListHolder	findTopmostComponents(ExecutionContext ctx, Type type, RecordHolder root)
RecordHolder	getBrowserWindowSize(ExecutionContext ctx)
ListHolder	getChildren(ExecutionContext ctx, RecordHolder def)
ListHolder	getColumns(ExecutionContext ctx, RecordHolder def)
ListHolder	getColumnStates(ExecutionContext ctx, RecordHolder def) Gets a list of table column states of the given Table or TreeTable2
ListHolder	getTabs(ExecutionContext ctx, RecordHolder tabbedLayout)
void	hideAndDestroy(ExecutionContext ctx, RecordHolder def) Hide pop-up.
void	invoke(ExecutionContext ctx, CollectionHolder targets, String methodName, ListHolder parameters) Invoke method on each target container.
boolean	isDescendantOrSelf(ExecutionContext ctx, RecordHolder parent, RecordHolder child)
void	merge(ExecutionContext ctx, CollectionHolder viewModels)
void	notify(ExecutionContext ctx, String caption, String description, EnumerationImpl type, EnumerationImpl alignment, Decimal delayMillis, String cssStyle, Boolean htmlContentAllowed) Shows notification.
void	persist(ExecutionContext ctx) Persist execution contexts.
void	refresh(ExecutionContext ctx, CollectionHolder components) Refresh components
void	removeAll(ExecutionContext ctx, RecordHolder wwhere) Remove all childs of VerticalLayout, HorizontalLayout or FormLayout
void	removeAndDestroy(ExecutionContext ctx, RecordHolder wwhat, RecordHolder wwhere) Remove and destroy what component.
void	removeTab(ExecutionContext ctx, RecordHolder tabbedLayout, RecordHolder tab) Remove the tab.
void	requestSubmit(ExecutionContext ctx) Marks the screen for submission.
void	requestSubmitAndNavigate(ExecutionContext ctx, RecordHolder navigateTo) Marks the screen for submission and navigate away.
void	restoreColumnStates(ExecutionContext ctx, RecordHolder def, ListHolder columnStates) Restores the column states to the Table or TreeTable2
void	selectTab(ExecutionContext ctx, RecordHolder tabbedLayout, RecordHolder tab) Open the tab.
void	showConstraintViolations(ExecutionContext ctx, ListHolder constraintViolations) Map constraint violations to visible components.
void	showNotification(com.vaadin.ui.Notification notification) Show notification.

Methods inherited from class java.lang.Object

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

Field Detail

LISTENER_SCOPE

public static final ThreadLocal<UIComponent> LISTENER_SCOPE

PRIVATE API, DO NOT USE.

The scope of the listener currently being executed.

CONTEXT_HOLDER

public static final ThreadLocal<LspsContextHolder> CONTEXT_HOLDER

PRIVATE API, DO NOT USE.

Only filled in when a screen is being constructed.

Constructor Detail

VaadinUtils

public VaadinUtils()

Method Detail

getBrowserWindowSize

public RecordHolder getBrowserWindowSize(ExecutionContext ctx)

Parameters:

ctx -

Returns:

current browser window size as reported by Vaadin

notify

public void notify(ExecutionContext ctx,
                   String caption,
                   String description,
                   EnumerationImpl type,
                   EnumerationImpl alignment,
                   Decimal delayMillis,
                   String cssStyle,
                   Boolean htmlContentAllowed)

Shows notification.

Parameters:

ctx -

caption -

description -

type -

alignment -

delayMillis -

cssStyle -

htmlContentAllowed -

showNotification

public void showNotification(com.vaadin.ui.Notification notification)

Show notification.

Parameters:

notification -

isDescendantOrSelf

public boolean isDescendantOrSelf(ExecutionContext ctx,
                                  RecordHolder parent,
                                  RecordHolder child)

Parameters:

ctx -

parent -

child -

Returns:

true if the parent is direct or indirect parent of the child record.

getChildren

public ListHolder getChildren(ExecutionContext ctx,
                              RecordHolder def)

Parameters:

ctx -

def - - ui::VerticalLayout, ui::HorizontalLayout or ui::FormLayout record

Returns:

all children of the layout record

getColumns

public ListHolder getColumns(ExecutionContext ctx,
                             RecordHolder def)

Parameters:

ctx -

def - - either ui::Table or ui::TreeTable2 record

Returns:

list of columns

getColumnStates

public ListHolder getColumnStates(ExecutionContext ctx,
                                  RecordHolder def)

Gets a list of table column states of the given Table or TreeTable2

Parameters:

ctx -

def - the definition record of Table or TreeTable2

Returns:

a list of ui::TableColumnState records

See Also:

restoreColumnStates(ExecutionContext, RecordHolder, ListHolder)

restoreColumnStates

public void restoreColumnStates(ExecutionContext ctx,
                                RecordHolder def,
                                ListHolder columnStates)

Restores the column states to the Table or TreeTable2

Parameters:

ctx -

def - the table or the tree table

columnStates - the state of columns which should be restored to the columns of the given table (tree table)

See Also:

getColumnStates(ExecutionContext, RecordHolder)

getTabs

public ListHolder getTabs(ExecutionContext ctx,
                          RecordHolder tabbedLayout)

Parameters:

ctx -

tabbedLayout - - ui::TabbedLayout record

Returns:

all tabs

addTab

public void addTab(ExecutionContext ctx,
                   RecordHolder tabbedLayout,
                   RecordHolder tab)

Adds tab to tabbed layout.

Parameters:

ctx -

tabbedLayout -

tab -

removeTab

public void removeTab(ExecutionContext ctx,
                      RecordHolder tabbedLayout,
                      RecordHolder tab)

Remove the tab.

Parameters:

ctx -

tabbedLayout -

tab -

selectTab

public void selectTab(ExecutionContext ctx,
                      RecordHolder tabbedLayout,
                      RecordHolder tab)

Open the tab.

Parameters:

ctx -

tabbedLayout -

tab -

invoke

public void invoke(ExecutionContext ctx,
                   CollectionHolder targets,
                   String methodName,
                   ListHolder parameters)

Invoke method on each target container.

Parameters:

ctx -

targets - - a list of ui::Container records

methodName -

parameters -

findTopmostComponents

public ListHolder findTopmostComponents(ExecutionContext ctx,
                                        Type type,
                                        RecordHolder root)

Parameters:

ctx -

type -

root -

Returns:

depth-first search for closest descendants of the root that is of the type type.

refresh

public void refresh(ExecutionContext ctx,
                    CollectionHolder components)

Refresh components

Parameters:

ctx -

components -

persist

public void persist(ExecutionContext ctx)
             throws LspsException

Persist execution contexts.

Parameters:

ctx -

Throws:

LspsException

requestSubmit

public void requestSubmit(ExecutionContext ctx)
                   throws LspsException

Marks the screen for submission. The submission will occur immediately after all events are processed and before actual refresh and init events processing.

Parameters:

ctx -

Throws:

LspsException

requestSubmitAndNavigate

public void requestSubmitAndNavigate(ExecutionContext ctx,
                                     RecordHolder navigateTo)
                              throws LspsException

Marks the screen for submission and navigate away.

Parameters:

ctx -

navigateTo -

Throws:

LspsException

merge

public void merge(ExecutionContext ctx,
                  CollectionHolder viewModels)

Parameters:

ctx -

viewModels -

clear

public void clear(ExecutionContext ctx,
                  CollectionHolder viewModels)

Parameters:

ctx -

viewModels -

showConstraintViolations

public void showConstraintViolations(ExecutionContext ctx,
                                     ListHolder constraintViolations)

Map constraint violations to visible components.

Parameters:

ctx -

constraintViolations -

createAndShow

public RecordHolder createAndShow(ExecutionContext ctx,
                                  RecordHolder def)

Only popup is supported.

Parameters:

ctx -

def -

Returns:

record

hideAndDestroy

public void hideAndDestroy(ExecutionContext ctx,
                           RecordHolder def)

Hide pop-up.

Parameters:

ctx -

def -

createAndAdd

public RecordHolder createAndAdd(ExecutionContext ctx,
                                 Object wwhat,
                                 RecordHolder wwhere)

Parameters:

ctx -

wwhat - - ui component

wwhere - ui::VerticalLayout, ui::HorizontalLayout or ui::FormLayout component

Returns:

record

removeAndDestroy

public void removeAndDestroy(ExecutionContext ctx,
                             RecordHolder wwhat,
                             RecordHolder wwhere)

Remove and destroy what component.

Parameters:

ctx -

wwhat -

wwhere -

removeAll

public void removeAll(ExecutionContext ctx,
                      RecordHolder wwhere)

Remove all childs of VerticalLayout, HorizontalLayout or FormLayout

Parameters:

ctx -

wwhere -

addColumn

public RecordHolder addColumn(ExecutionContext ctx,
                              RecordHolder wwhat,
                              RecordHolder wwhere)

Parameters:

ctx -

wwhat - - ui::TableColumn record

wwhere - - ui::Table or ui::TreeTable2 record

Returns:

wwhat record type