NetUI Tag Library Documentation (Version 1.0.2)

netui-data
netui-data:declarePageInput Tag

The DeclarePageInput tag is used to declare variables that are passed as outputs of Page Flow actions to a JSP.

Syntax

<netui-data:declarePageInput
    name="string_name"
    [required="string_name"]
    type="string_type" >
    ... JSP content ...
</netui-data:declarePageInput>

Description

The DeclarePageInput tag is used to declare variables that are passed as outputs of Page Flow actions to a JSP. This allows pages to declare a data contract that invoking actions must satisfy in order to successfully render a page; in essence, this is a simple method signature for the JSP.

Page inputs are added to a Page Flow's org.apache.beehive.netui.pageflow.Forward class via the org.apache.beehive.netui.pageflow.Forward method. From the page's perspective, the action outputs are known as page inputs and are available via the JSP EL implicit object pageInput using the name given them on the org.apache.beehive.netui.pageflow.Forward and set on this tag via <netui-data:declarePageInput>.

A page input can be declared to be required; if required, the page input must be available in the map of action outputs passed to the page.

For example, to add an actiout output called profile to a org.apache.beehive.netui.pageflow.Forward an action would contain code like:

     forward.addActionOutput("profile", yourProfile);
 
In order to declare this as a page input in a JSP, the page would contain a tag as:
     <netui-data:declarePageInput name="profile" type="org.someprofile.ProfileBean"/>
 
and the profile object could be referenced in the JSP as:
     ${pageInput.profile}
 

Attributes
name
Required: Yes  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: No

The name of the variable to reference.
required
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: No

Set a flag that declares whether this page intput is required or optiona. If a Page Input is required, the tag will report an error if the page input key does not appear in the set of page inputs for a page.
type
Required: Yes  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: No

Set the String classname variable that represents the expected type of the page input.


Tag Information
Tag Classorg.apache.beehive.netui.tags.databinding.pageinput.DeclarePageInput
TagExtraInfo ClassNone
Body Contentscriptless
Display NameNone