15.12 Page Object

Used on	uiJar
Superclass	panel
Subclassed By	wizardPage
Description	This is the overall screen page - this is one page shown to a user. It has a required view object, events and state objects. Typically, there will be one named script (e.g. 'myPage.jsp') for each page model object. Within that, the controls on a page should trigger activity at the server by setting a request parameter to a value. The event-handlers pick up the requested activity via the value in the event-request-parameter-factor. The view object, if defined, will be newly created on each request to the page and automatically filled with values from the request. There is a default event handler, which is invoked if none of the other event handlers are triggered. This event handler is indicated by having no name or by having the 'is-default-event' set to true. The 'is-default-event' can have a name, but it is not used (but it is useful for documentation or for migrating existing systems). Constraints are applied to the underlying data before the event handling logic is started. State objects declared here should be page-level. State objects can also be referenced in the "use-state-object" list. This restricts the list of global and session state objects. If the list is omitted, all objects from the enclosing application are made availabe on this page. Note to developers: The standard page rendering lays out a form with input controls and does navigation in a standard way. Variations should be done using the 'template=' mechanism to set up another templating directory. Then override any of the standard scripts as necessary.
Contained Lists	1 Name   panel Type   panel Inherited from   panel   2 Name   forward Type   forward Inherited from   panel   3 Name   constraint Type   constraint Inherited from   panel   4 Name   field Type   field Inherited from   panel   5 Name   tabMenu Type   tabMenu Inherited from   panel   6 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   7 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   8 Name   rolesBlocked Type   String Description   Members of these roles are blocked, whether they are granted permission elsewhere or not. Unique   false   9 Name   section Type   section Indexed property   name   10 Name   include Type   String Description   This defines the field froms the data-view of the page that are to be accessible through this page. Unique   false   11 Name   pageVars Type   String Unique   false   12 Name   import Type   String Description   List of classes or packages to import. The imports get put into 'import' statements in the *.java files (and could be put in a 'using' statement in C#). In XML, you can use one or more <import> nested elements as an alternative to the 'import=' property. See also the import list on the Business Object Model jar, which provides additional facilities. Unique   false
Inherited properties	jwpattern (base property) displayTitle from panel.displayTitle layout from panel.layout view from panel.view masterView from panel.masterView instanceId from panel.instanceId form from panel.form viewDetail from panel.viewDetail editDetail from panel.editDetail role from panel.role banding from panel.banding bandingInterval from panel.bandingInterval presentationStyle from panel.presentationStyle border from panel.border childBorder from panel.childBorder margin from panel.margin childMargin from panel.childMargin padding from panel.padding childPadding from panel.childPadding color from panel.color childColor from panel.childColor backgroundColor from panel.backgroundColor childBackgroundColor from panel.childBackgroundColor extraStyle from panel.extraStyle height from panel.height

15.12.1  Property 'name'

15.12.2  Property 'title'

15.12.3  Property 'container'

15.12.4  Property 'pageInitialisationCode'

15.12.5  Property 'generatePage'

15.12.6  Property 'keepstash'

15.12.7  Property 'menuEntryEvent'

15.12.8  Property 'entryEvent'

15.12.9  Property 'processName'

15.12.10  Property 'loopName'

15.12.11  Property 'autoPersist'

15.12.12  Property 'format'

15.12.13  Property 'package'

15.12.14  Property 'eventRequestParameter'

15.12.15  Property 'group'

15.12.16  Property 'screenPosition'

15.12.17  Property 'template'

15.12.18  Property 'description'

15.12.19  Property 'uid'

15.12.20  Property 'failureForwardPage'

15.12.21  Property 'failureForwardRequestString'

15.12.22  Property 'linkCaption'

15.12.23  Property 'text'

15.12.24  Property 'hideWhenBlocked'

Copyright (c) 2001-2008 New Technology/enterprise Ltd.