com.whitestein.lsps.vaadin.ui.events

Class UINavigateAction

java.lang.Object

com.whitestein.lsps.vaadin.ui.events.UINavigateAction

All Implemented Interfaces:

UIListenerAction, Serializable

public class UINavigateAction
extends Object
implements UIListenerAction

Standard listener action for "ui::NavigationAction". When invoked, it will perform navigation based on the returned value from the navigation closure.

Author:

mhi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UINavigateAction(UIComponent scope, Variant.RecordVariant definition, UIListener owner) Full constructor.

Method Summary

Modifier and Type	Method and Description
Variant.RecordVariant	getDefinition() Returns action definition.
Variant.RecordVariant	getNavigationTarget() Evaluates a navigation closure.
void	processAction(UIScreen screen) Invokes the action on the screen.

Methods inherited from class java.lang.Object

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

Constructor Detail

UINavigateAction

public UINavigateAction(UIComponent scope,
                        Variant.RecordVariant definition,
                        UIListener owner)

Full constructor.

Parameters:

scope - not null.

definition -

owner -

Method Detail

processAction

public void processAction(UIScreen screen)

Description copied from interface: UIListenerAction

Invokes the action on the screen.

Specified by:

processAction in interface UIListenerAction

Parameters:

screen - the screen reference, not null.

getDefinition

public Variant.RecordVariant getDefinition()

Returns action definition.

Returns:

action definition, never null, always present.

getNavigationTarget

public Variant.RecordVariant getNavigationTarget()

Evaluates a navigation closure.

Returns:

the navigation target, never null, may be absent. Subtype of ui::Navigation.