com.whitestein.lsps.vaadin

Class CustomUIWithContextScreen

java.lang.Object

com.whitestein.lsps.vaadin.AbstractScreen

com.whitestein.lsps.vaadin.CustomUIWithContextScreen

All Implemented Interfaces:

LspsScreen, Serializable

public class CustomUIWithContextScreen
extends AbstractScreen

Custom ui screen.

Author:

bhl

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomUIWithContextScreen(LspsAppConnector appConnector, LspsFormConnector formConnector, LspsContextHolder contextHolder) Creates new instance.

Method Summary

Modifier and Type	Method and Description
void	addComponentToRefresh(UIComponent component) Schedules a component to be refreshed during next call to LspsScreen.triggerEventProcessing(com.whitestein.lsps.vaadin.ui.events.UIEvent).
void	addUploadedBinaryData(long binaryDataId) Adds a temporary file to the list of files to be deleted once the screen is closed.
void	cleanup() Called after the screen content is removed from the Vaadin UI or submitted.
UIComponent	createUIComponent(UIComponent parent, RecordHolder componentDefinition, UIComponentScope scope) Creates a Vaadin component based on the provided component definition.
void	fireApplicationEvent(UIApplicationEvent appEvent) Schedules given application event to be fired on all registered components that have an application event listener.
void	fireBrowserWindowResizeEvent(Dimension dimension) A browser window resize has been detected.
LspsContextHolder	getContextHolder() Returns the the LSPS context which produced this screen.
UIComponentScope	getRootScope() Returns the root scope.
ContextWrapper	getScreenContext() Returns the "0:1" execution context for the screen.
UIComponent	getTopmostComponent() Returns the topmost component.
Set<ValueHolder>	getValuesToRetain() Returns the set of value holders that should not be garbage collected even if they are not referenced from any variables in the model.
boolean	isInvalid(UIComponent component) Checks whether given component is marked as invalid, by calling LspsScreen.markComponentAsInvalid(com.whitestein.lsps.vaadin.ui.components.UIComponent).
void	markComponentAsInvalid(UIComponent component) Marks the component as invalid.
void	markComponentAsValid(UIComponent component) Marks the component as valid again.
void	registerUIComponent(UIComponent component) Register the given UI component and its children in this screen.
void	registerValueToRetain(Handle handle) Registers the value for the given handle as one to be kept during garbage collection.
com.vaadin.ui.Component	render() Called when the screen content should be added to the Vaadin UI.
void	resume() Called after the screen component has been added to Vaadin UI.
boolean	triggerEventProcessing(UIEvent triggeringEvent) Process all events in the queue - invokes standard LSPS ui lifecycle
void	unregisterUIComponent(UIComponent component) Unregister the given UI component and its children from this screen.
void	unregisterValueToRetain(Handle handle) Unregisters the value for the given handle as one to be kept during garbage collection.
void	updateContextFor(UIComponentData componentData) Updates context dependent variables for the given componentData.

Methods inherited from class com.whitestein.lsps.vaadin.AbstractScreen

getAllComponents, getComponentsForDefinition

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomUIWithContextScreen

public CustomUIWithContextScreen(LspsAppConnector appConnector,
                                 LspsFormConnector formConnector,
                                 LspsContextHolder contextHolder)

Creates new instance.

Parameters:

appConnector -

formConnector -

contextHolder -

Method Detail

render

public com.vaadin.ui.Component render()

Description copied from interface: LspsScreen

Called when the screen content should be added to the Vaadin UI. Typically will be called shortly after the screen is created.

This method only creates the Vaadin UI component graph and returns it - it should not attempt to show the component in some Vaadin UI.

The LspsScreen.resume() method is called after this method.

This method must be called exactly once.

Returns:

the root component to show, never null. Returns Vaadin component instead of UIComponent because custom screens may use components other than UIComponent.

addUploadedBinaryData

public void addUploadedBinaryData(long binaryDataId)

Adds a temporary file to the list of files to be deleted once the screen is closed.

Parameters:

binaryDataId -

resume

public void resume()

Description copied from interface: LspsScreen

Called after the screen component has been added to Vaadin UI. Called when the screen content is shown:

• either it is shown for the first time: in such case the LspsScreen.render() method has already been called
• or it is re-shown, e.g. when the user navigates back to a previously-shown screen from which he navigated away without submitting

cleanup

public void cleanup()

Description copied from interface: LspsScreen

Called after the screen content is removed from the Vaadin UI or submitted.

After this method is called, no other methods may be called.

registerValueToRetain

public void registerValueToRetain(Handle handle)

Description copied from interface: LspsScreen

Registers the value for the given handle as one to be kept during garbage collection. See LspsScreen.getValuesToRetain().

Parameters:

handle - a handle to the model object, not null.

unregisterValueToRetain

public void unregisterValueToRetain(Handle handle)

Description copied from interface: LspsScreen

Unregisters the value for the given handle as one to be kept during garbage collection. See LspsScreen.getValuesToRetain().

Parameters:

handle - a handle to the model object, not null.

getValuesToRetain

public Set<ValueHolder> getValuesToRetain()

Description copied from interface: LspsScreen

Returns the set of value holders that should not be garbage collected even if they are not referenced from any variables in the model. Typically this should contain the UI definition (as defined in the model, either as a task or document attribute).

Returns:

values to retain during garbage collection

fireBrowserWindowResizeEvent

public void fireBrowserWindowResizeEvent(Dimension dimension)

Description copied from interface: LspsScreen

A browser window resize has been detected. Application event is fired, with name of internal_windowresize, having payload of type hu::Dimension which holds new window dimension. The event originator component is set to ROOT.

Warning: browsers on Android return value in DPs instead of pixels. From Android documentation: Density-independent Pixels - an abstract unit that is based on the physical density of the screen. These units are relative to a 160 dpi screen, so one dp is one pixel on a 160 dpi screen. The ratio of dp-to-pixel will change with the screen density, but not necessarily in direct proportion. Example: a screen width of 720 on a 320 DPI screen will be reported as 360 DPs.

Therefore, to render special page for small devices, compare screen width to the value of 400. If equal or smaller, provide small screen version.

Parameters:

dimension - the new dimension, in pixels (on desktop OS) or DPs (on Android phones).

getScreenContext

public ContextWrapper getScreenContext()

Description copied from interface: LspsScreen

Returns the "0:1" execution context for the screen. The screen runs in this context until submitted or persisted - then it is merged to the main "0" execution context.

Returns:

the context wrapper, never null.

getContextHolder

public LspsContextHolder getContextHolder()

Description copied from interface: LspsScreen

Returns the the LSPS context which produced this screen.

Returns:

context holder, never null.

createUIComponent

public UIComponent createUIComponent(UIComponent parent,
                                     RecordHolder componentDefinition,
                                     UIComponentScope scope)

Description copied from interface: LspsScreen

Creates a Vaadin component based on the provided component definition. Shortcut to UIComponentFactory.createComponent(LspsScreen, com.whitestein.lsps.vaadin.ui.components.UIComponent, com.whitestein.lsps.lang.exec.RecordHolder, com.whitestein.lsps.vaadin.ui.UIComponentScope) .

Parameters:

parent - parent of the component in the LSPS component hierarchy

componentDefinition - definition of the component to create

scope - component scope; if null, same scope as parent will be used

Returns:

created component

triggerEventProcessing

public boolean triggerEventProcessing(UIEvent triggeringEvent)

Description copied from interface: LspsScreen

Process all events in the queue - invokes standard LSPS ui lifecycle

Parameters:

triggeringEvent - the event that triggered this round of processing; can be null if there is no such event.

Returns:

false if processing could not be started, either because the event processing is already in progress, or any of the components to process is marked as invalid (via LspsScreen.markComponentAsInvalid(com.whitestein.lsps.vaadin.ui.components.UIComponent).

markComponentAsInvalid

public void markComponentAsInvalid(UIComponent component)

Description copied from interface: LspsScreen

Marks the component as invalid. This will cause LspsScreen.triggerEventProcessing(com.whitestein.lsps.vaadin.ui.events.UIEvent) to return false for events which processes given component.

Note that this will not cause the component to show an error icon.

Parameters:

component - the component, not null.

markComponentAsValid

public void markComponentAsValid(UIComponent component)

Description copied from interface: LspsScreen

Marks the component as valid again.

Note that this will not cause the component to hide an error icon.

Parameters:

component - the component, not null.

registerUIComponent

public void registerUIComponent(UIComponent component)

Description copied from interface: LspsScreen

Register the given UI component and its children in this screen. Registration of components is needed, so that the application is able to use references between lsps objects and vaadin components for various reasons (such as refresh functionality).

Parameters:

component - not null. The component parent must already be registered.

unregisterUIComponent

public void unregisterUIComponent(UIComponent component)

Description copied from interface: LspsScreen

Unregister the given UI component and its children from this screen.

Parameters:

component - not null. The component parent must already be registered.

addComponentToRefresh

public void addComponentToRefresh(UIComponent component)

Description copied from interface: LspsScreen

Schedules a component to be refreshed during next call to LspsScreen.triggerEventProcessing(com.whitestein.lsps.vaadin.ui.events.UIEvent).

Parameters:

component - the component, not null. The component must be initialized.

updateContextFor

public void updateContextFor(UIComponentData componentData)

Description copied from interface: LspsScreen

Updates context dependent variables for the given componentData. See UIComponentScope.updateContext().

Parameters:

componentData - a component data, may not be null

getRootScope

public UIComponentScope getRootScope()

Description copied from interface: LspsScreen

Returns the root scope.

Returns:

the root scope, never null.

isInvalid

public boolean isInvalid(UIComponent component)

Description copied from interface: LspsScreen

Checks whether given component is marked as invalid, by calling LspsScreen.markComponentAsInvalid(com.whitestein.lsps.vaadin.ui.components.UIComponent).

Parameters:

component - the component, not null.

Returns:

true if the component is marked invalid, false if it has not yet been marked as invalid or has been marked as valid, by calling LspsScreen.markComponentAsValid(com.whitestein.lsps.vaadin.ui.components.UIComponent).

getTopmostComponent

public UIComponent getTopmostComponent()

Description copied from interface: LspsScreen

Returns the topmost component.

Returns:

the topmost component, never null.

fireApplicationEvent

public void fireApplicationEvent(UIApplicationEvent appEvent)

Description copied from interface: LspsScreen

Schedules given application event to be fired on all registered components that have an application event listener.

The event is not fired until LspsScreen.triggerEventProcessing(com.whitestein.lsps.vaadin.ui.events.UIEvent) is called.

Parameters:

appEvent - the event, not null.