|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@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
.
Required Element Summary | |
---|---|
String |
name
The forward name. |
Optional Element Summary | |
---|---|
String |
action
The name of an action to forward to. |
Jpf.ActionOutput[] |
actionOutputs
Array of action output declarations to be associated with this Forward. |
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. |
Jpf.NavigateTo |
navigateTo
A symbolic name for the page/action to which to navigate. |
String |
outputFormBean
The name of a member variable whose value will be passed along (to a page or to another action) with this forward. |
Class |
outputFormBeanType
The type of form bean that will be passed along (to a page or to another action) with this forward. |
String |
path
The forward path. |
boolean |
redirect
If true , there will be a browser redirect (not a server forward) to the destination path. |
boolean |
restoreQueryString
If true , the original URL query string will be restored when the previous page or action is
run. |
String |
returnAction
The action to be invoked on the calling page flow. |
String |
tilesDefinition
A Tiles definition to forward to. |
Element Detail |
---|
public abstract String name
Jpf.Action
) or an exception handler method
(Jpf.ExceptionHandler
) can use this forward by returning a
Forward
object that is initialized with this name.
public abstract String action
path()
, navigateTo()
,
returnAction()
, and tilesDefinition()
.
public abstract Jpf.ActionOutput[] actionOutputs
Forward
object. An action output supplies a "page input" in a
page, where it is accessed by databinding to
${pageInput.
action-output-name}
.
public abstract boolean externalRedirect
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
.
public abstract Jpf.NavigateTo navigateTo
path()
,
returnAction()
, action()
, and tilesDefinition()
.
Jpf.NavigateTo
public abstract Class outputFormBeanType
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.
public abstract String outputFormBean
public abstract String path
navigateTo()
, returnAction()
, action()
,
and tilesDefinition()
.
public abstract boolean redirect
true
, there will be a browser redirect (not a server forward) to the destination path.
public abstract boolean restoreQueryString
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.
public abstract String returnAction
path()
,
navigateTo()
, action()
, and tilesDefinition()
, and only valid in a nested page flow
(Jpf.Controller.nested()
must be true
).
public abstract String tilesDefinition
Jpf.Controller.tilesDefinitionsConfigs()
. Mutually-exclusive with path()
, navigateTo()
,
returnAction()
, and action()
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |