Package com.cmobilecom.af.model.nav

Class BeanFlowNavigation

java.lang.Object

com.cmobilecom.af.model.nav.BeanFlowNavigation

public class BeanFlowNavigation
extends java.lang.Object

BeanFlowNavigation: Define the way for going to the next or previous step of a bean flow.

The bean flow consists of steps that display a different list of properties of an EntityBackingBean. The properties can be any EntityProperty(s) including custom properties, EntityFormBeanProperty(s) and user-defined properties. Going through bean flow steps, the bean should collect necessary form data to execute a specified action and complete the bean flow. The last step usually is showing the completed message of the bean flow, where users can not go back to any previous step. So the last step with its bean flow completed does not need to have any navigation.

Since:

5.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BeanFlowNavigation.Direction	Navigation direction

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COMMAND_BACK	Command: back to the previous step
static java.lang.String	COMMAND_CONTINUE	Command: continue to the next step

Constructor Summary

Constructors

Constructor	Description
BeanFlowNavigation(BeanFlowNavigation.Direction direction, FormDesign formDesign, java.util.List<java.lang.String> execCommands, I18NName navigationCommandVisibleName)	Constructor

Method Summary

Modifier and Type	Method	Description
BeanFlowNavigation.Direction	getDirection()	Get navigation direction
java.util.List<java.lang.String>	getExecCommands()	Get a list of predefined commands to execute for navigation
FormDesign	getFormDesign()	Get the form design for the previous or next stop.
I18NName	getNavigationCommandVisibleName()	Get the navigation(next/back) command visible name for display.
void	setDirection(BeanFlowNavigation.Direction direction)	Set navigation direction
void	setExecCommands(java.util.List<java.lang.String> execCommands)	Get a list of predefined commands to execute for navigation
void	setFormDesign(FormDesign nextFormDesign)	Set the form design for the previous or next stop.
void	setNavigationCommandVisibleName(I18NName navigationCommandVisibleName)	Set the navigation(next/back) command visible name for display.

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_BACK

public static final java.lang.String COMMAND_BACK

Command: back to the previous step

See Also:

Constant Field Values

COMMAND_CONTINUE

public static final java.lang.String COMMAND_CONTINUE

Command: continue to the next step

See Also:

Constant Field Values

Constructor Detail

BeanFlowNavigation

public BeanFlowNavigation(BeanFlowNavigation.Direction direction,
                          FormDesign formDesign,
                          java.util.List<java.lang.String> execCommands,
                          I18NName navigationCommandVisibleName)

Constructor

Parameters:

direction - navigation direction

formDesign - the form design for the navigation direction.

execCommands - a list of predefined commands to execute for navigation

navigationCommandVisibleName - next/back command visible name for display

Method Detail

getDirection

public BeanFlowNavigation.Direction getDirection()

Get navigation direction

Returns:

the direction of navigation

setDirection

public void setDirection(BeanFlowNavigation.Direction direction)

Set navigation direction

Parameters:

direction - the direction of navigation

getFormDesign

public FormDesign getFormDesign()

Get the form design for the previous or next stop. Null for the last step.

Returns:

FormDesign instance

setFormDesign

public void setFormDesign(FormDesign nextFormDesign)

Set the form design for the previous or next stop. Null for the last step.

Parameters:

nextFormDesign - FormDesign instance

getExecCommands

public java.util.List<java.lang.String> getExecCommands()

Get a list of predefined commands to execute for navigation

Returns:

a list of command names

setExecCommands

public void setExecCommands(java.util.List<java.lang.String> execCommands)

Get a list of predefined commands to execute for navigation

Parameters:

execCommands - a list of command names

getNavigationCommandVisibleName

public I18NName getNavigationCommandVisibleName()

Get the navigation(next/back) command visible name for display. If null, default to the command name (not localized).

Returns:

navigation command visible name

setNavigationCommandVisibleName

public void setNavigationCommandVisibleName(I18NName navigationCommandVisibleName)

Set the navigation(next/back) command visible name for display. If null, default to the command name (not localized).

Parameters:

navigationCommandVisibleName - navigation command visible name