org.apache.beehive.netui.pageflow.annotations
Annotation Type Jpf.Forward

@Target(value=ANNOTATION_TYPE)
@Retention(value=RUNTIME)
public static @interface Jpf.Forward

A destination that is used by actions (Jpf.Action, Jpf.SimpleAction) and exception handlers Jpf.ExceptionHandler.

name

public abstract String name

The forward name. An action method (Jpf.Action) or an exception handler method (Jpf.ExceptionHandler) can use this forward by returning a Forward object that is initialized with this name.

action

public abstract String action

The name of an action to forward to. Mutually-exclusive with path(), navigateTo(), returnAction(), and tilesDefinition().

Default:

""

actionOutputs

public abstract Jpf.ActionOutput[] actionOutputs

Array of action output declarations to be associated with this Forward. An actual action output is passed on a Forward object. An action output supplies a "page input" in a page, where it is accessed by databinding to ${pageInput.action-output-name}.

Default:

{}

externalRedirect

public abstract boolean externalRedirect

When set to true, then this Forward will redirect to a path that is external to the current webapp; for example, the following path would redirect to /dir/mypage.jsp in webapp "/myapp":

path="/myapp/dir/mypage.jsp", externalRedirect=true

With externalRedirect set to false, the path above would forward to /myapp/dir/mypage.jsp under the current webapp. Note that externalRedirect=true implies that redirect=true.

Default:

false

navigateTo

public abstract Jpf.NavigateTo navigateTo

A symbolic name for the page/action to which to navigate. Mutually-exclusive with path(), returnAction(), action(), and tilesDefinition().

See Also:

Jpf.NavigateTo

Default:

currentPage

outputFormBeanType

public abstract Class outputFormBeanType

The type of form bean that will be passed along (to a page or to another action) with this forward. The actual form bean instance is provided on the Forward object that is returned from the action method (Jpf.Action) or the exception handler method (Jpf.ExceptionHandler). If that object has no output form bean, then a new instance of the given type will be created.

Default:

java.lang.Void.class

outputFormBean

public abstract String outputFormBean

The name of a member variable whose value will be passed along (to a page or to another action) with this forward.

Default:

""

path

public abstract String path

The forward path. Mutually-exclusive with navigateTo(), returnAction(), action(), and tilesDefinition().

Default:

""

redirect

public abstract boolean redirect

If true, there will be a browser redirect (not a server forward) to the destination path.

Default:

false

restoreQueryString

public abstract boolean restoreQueryString

If true, the original URL query string will be restored when the previous page or action is run. Only valid when the navigateTo attribute is used.

Default:

false

returnAction

public abstract String returnAction

The action to be invoked on the calling page flow. Mutually-exclusive with path(), navigateTo(), action(), and tilesDefinition(), and only valid in a nested page flow (Jpf.Controller.nested() must be true).

Default:

""

tilesDefinition

public abstract String tilesDefinition

A Tiles definition to forward to. The Tiles definition is found in one of the config files specified with Jpf.Controller.tilesDefinitionsConfigs(). Mutually-exclusive with path(), navigateTo(), returnAction(), and action().

Default:

""