JeeWiz Architect's Guide - Forward Object


	The Model-Driven System Builder

JeeWiz Architect's Guide

Contents > 15. 'Screen' Reference

15.6 Forward Object

Used on

panel

Subclassed By

eventHandler

Description The forward mechanism allows you to define an event that links directly to another page without going to the server

Contained
Lists

1

Name   style

Type   String

Description   You can specify one or more styles to give information to the code generation scripts. The meaning of the styles is up to the script writer.

The styles can be used as flags by the script calling $styleList.contains( "styleOfInterest" )

[ Currently, there is no built-in support for style="styleType=value" type semantics. This would have to be defined by each script writer. ]

Examples of the use of styles:

characteristics of a web page (e.g. should it be included in one of the menus)
whether an entity should be automatically mapped to a data-view (the 'maintain' style).
Note that styles and the 'group' property are different concepts, and therefore complimentary. Many modelling objects - such as data-views and their fields, or business methods - can be put into groups as a hint as to where to render the UI pages. Typically groups are used to define 'where' to place the meta class, whereas styles indicate how to render the object.

Unique   false

2

Name   rolesAllowed

Type   String

Description   If no roles are specified all roles are allowed that are not explicitly prohibited, otherwise only the specified roles are allowed.

Unique   false

3

Name   rolesBlocked

Type   String

Description   Members of these roles are blocked, whether they are granted permission elsewhere or not.

Unique   false

Inherited
properties

description (base property)

template (base property)

text (base property)

jwpattern (base property)

15.6.1	Property 'name'
15.6.2	Property 'isDefaultEvent'
15.6.3	Property 'isDisabled'
15.6.4	Property 'successForwardPage'
15.6.5	Property 'successForwardAction'
15.6.6	Property 'forwardId'
15.6.7	Property 'package'
15.6.8	Property 'uid'
15.6.9	Property 'linkCaption'
15.6.10	Property 'screenPosition'
15.6.11	Property 'group'
15.6.12	Property 'hideWhenBlocked'

15.6.1 Property 'name'

*Description*	The name of the event-handler. It defaults to 'default' but only one event-handler should have this name. This will be used in J2EE to construct the command string to trigger the action (e.g. '?action=myCommand' ).
*Type*	String
*Default*	default

15.6.2 Property 'isDefaultEvent'

*Description*	This marks a forward or event handler as the default to use. After initialisation, this will automatically be set for an event if there is only one event. Therefore in a single-event page there is no need to set this flag.
*Type*	boolean
*Default*	false

15.6.3 Property 'isDisabled'

*Description*	This marks an event-handler as being disabled - that is the rendering of it will still occur but it cannot be activated.
*Type*	boolean
*Default*	false

15.6.4 Property 'successForwardPage'

*Description*	Defines the default page (as in, the name of a JeeWiz 'page' object) to go to in a success situation This must be the name of a page in the current application.
*Type*	String

15.6.5 Property 'successForwardAction'

*Description*	Defines the action to execute in a success situation. Default is just to display the page. The name should be the name of the event-handler in the target page.
*Type*	String

15.6.6 Property 'forwardId'

*Description*	A single screen event can result in multiple paths being taken from a page. The foward-id allows you to say 'this forward is not the default for this event, but may be returned by a business method.' The name identifies the forward or event action the default event triggers the forward. The name of the forward-id should match an existing forward or event within the page.
*Type*	String

15.6.7 Property 'package'

*Alias*	namespace
*Description*	This is the package attribute: it declares the name of the package that this interface (or class, or entity, etc.) belongs to. It can be used on reference types (interfaces and classes) and all their derivatives associations assemblies of model-objects containers of same, like jars. It uses delegation of responsibility to search its parent chain. For example, in the J2EE realm, this means that the package can be specified on (working up the containment chain): an entity, or its ejb-jar, or the application, or in the assembly or in the build properties '.jwp' file. If none of these is specified the package will be null. Null packages are not recommended but legal for simple Java builds. For larger systems, null packages are not allowed. The combination of the package and class name (i.e. the fully-qualified Java classname) must be unique across all reference types and their derivatives in a build.
*Type*	String
*Delegates*	true

15.6.8 Property 'uid'

*Description*	The 'uid' is a Unique IDentifier for a methods in the business object model (and derivatives like J2EE). The 'uid' uniquely identifies the method, even if the name or signature of the method changes. This will normally be generated by the modelling tool; if not, it can be entered manually (but make sure it is unique!).
*Type*	String

15.6.9 Property 'linkCaption'

*Description*	This is the caption that goes on links, buttons or other controls. It should be a short, one- or two-word name that will fit on a small button.
*Type*	String

15.6.10 Property 'screenPosition'

*Description*	A numeric value indicating the position of this page or field within a group. This affects the position of the item's display on the screen, relative to other members of the group. The value is a string of 1-6 digits; the order is calculated numerically rather than alphabetically - so 25 is higher than 5. Lower-valued positions appear first. If this is not specified, then the order of controls within a group is determined by the order in the XML specification file. The order within the specification can be set if the XML is being specified directly and this field need not be specified. However, for specifications from UML design tools this may not be possible and it will be necessary to set this field to control screen order.
*Type*	String
*Delegates*	true

15.6.11 Property 'group'

Description

A group is a hint to generation scripts as to where to place this object.

It provides an alternative, more flexbile way of grouping business-methods, objects, data-views and pages.

For example, pages for data-maintenance might be in the "DataMaintenance" group, while specially-designed sessions might be in the "BusinessFunctions" group. (Expressing this grouping cannot be derived from the hierarchy: all pages are children of a single application.)

Another usage could be to group fields for presentation based on their group name.

The 'group' property should be used to guide presentation to the user, whereas 'style' should be used to guide further pattern generation.

The 'default' group is the null value (script writers must use '#if( !$group )' to identify the default group.

Type

String

15.6.12 Property 'hideWhenBlocked'

*Description*	Whether a blocked principal should be prohibited from seeing links they can not use.
*Type*	boolean
*Default*	true