|
|
|
The Model-Driven System Builder
|
|
JeeWiz Architect's Guide
|
|
|
|
Contents >
15. 'Screen' Reference
|
|
|
15.5 Field Object
| Used on |
|
| Superclass | businessObject:field |
| Description | A field not directly related to a business object or view placed on a panel/grid or other UI object.
|
Contained
Lists |
|
Inherited
properties |
|
15.5.1 Property 'dontDisplay'
|
| Description | Set this property to prevent the field appearing on a page.
By default this value is false - so the field will appear on the page.
However, the standard patterns set this value true if the type is not displayable.
|
| Type | boolean |
15.5.2 Property 'externalName'
|
| Description | This is the basis for the external name used for the field.
For example, users may think of 'Order Number', whereas the field itself is ord_num (following local variable naming conventions possibly).
For input fields (i.e. one with no related attribute) the external-name defaults to the name (with spaces and capitals added to separate words).
For fields with a related attribute, the external-name defaults to
- the data-view's name if there is one, otherwise to
- the related-attribute's external-name if there is one, otherwise to
- the related-attribute's name.
This can be further mapped to the actual name presented by particular interfaces. This can be done automatically in the component.properties file for the data-view-field.
For example, variants of the name are available through helper methods - getExternal[XML/JavaClass/CapsAndSpaces]Name formats, which may be useful in XML or screen representations of the name.
|
| Type | String |
15.5.3 Property 'summaryName'
|
| Description | A field holding a short name used in grid headers, etc
|
| Type | String |
15.5.4 Property 'useOnSummary'
|
| Description | Use-on-summary tells the standard patterns whether to use this view field on a summary list.
A summary list is shown when the view is the subject of a search (e.g. find all orders for a particular customer) which returns multiple rows.
Rather than bring back all information in an entity or data-view, the summary (based on the summary fields/attributes) is displayed.
The group of all summary fields should be distinctive enough to allow the user to identify a particular record.
There is a related 'use-on-summary' property on the entity's attribute; the relationship between these two is described below.
The standard patterns construct the 'summary' of a view automatically, using the first of the following approaches that succeed:
- One or more fields on the view are explicitly marked 'use-on-summary'.
In this case, the summary is the list of all such fields.
- Failing that, for data-views, the data-view-field may have a related-attribute on the initial entity that is explicitly marked as 'use-on-summary'.
If there are any such data-view-fields, the summary is the list of all such fields.
- Failing that, for data-views, the data-view-field may have a related-attribute on the initial entity that is part of the primary key for the entity.
If there are any such data-view-fields, the summary is the list of all such fields.
- Finally, when all else fails, all fields on the data-view are used. This may result in an interesting rendering!
|
| Type | boolean |
| Default | false |
15.5.5 Property 'useOnSearch'
|
| Description | Use-on-search tells the patterns whether to use this field on a search screen.
|
| Type | boolean |
| Default | false |
15.5.6 Property 'textEvent'
|
| Description | If an event is entered here, when the summary text is printed in a gridline, it will form a URL that fires the event.
|
| Type | String |
15.5.7 Property 'screenPosition'
|
| Description | A numeric value indicating the position of this page or control 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. The value of '-1' indicates that the this field should not placed on the ScreenPositionList (determined by the DataView). This would be used when the specific renderer would want to handle the placing of the field rather than via the automatic rendering which is based on the ScreenPositionList. 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 |
15.5.8 Property 'uiControl'
|
| Description | Specifies the ui control to use for this field. If specified, this field must correctly name a UI control - see your local standards for a complete list.
The standard JeeWiz options are:
TBD
If there is no value for the ui-control property, a suitable UI control for the type will be chosen.
See also ui-style, which can guide the selection process if ui-control is not specified.
|
| Type | String |
15.5.9 Property 'format'
|
| Description | The format works together with the display style at the presentation layer. It might override the date format for
a textbox date or numeric, or it might override the height and width of a textarea. It is up to the UiControl
as to how, or whether this property is processed.
|
| Type | String |
15.5.10 Property 'presentationStyle'
|
| Description | This is hint to the renderer to set a 'class' type style for the children components of this component - The rendering will probably
(but not necessarily) be done using cascading style sheets, where this will translate into the css class attribute.
|
| Type | String |
15.5.11 Property 'border'
|
| Description | This is a hint for the renderer to indicate the style of the border for this component.
|
| Type | String |
15.5.12 Property 'childBorder'
|
| Description | This is a hint for the renderer to indicate the style of the border for the child components of this component.
|
| Type | String |
15.5.13 Property 'margin'
|
| Description | This is a hint for the render to indicate the margin required for this object (and, optionally, the spacing
inbetween child components). The margin value can be a comma separated value using the convention of the first
value = Top, second = Right, third = Bottom, fourth = Left, fifth = Spacing between child components.
Specifiying the fifth element is a convenience to allow spacing between
for example
2,3,4,5,2 would mean a margin of 2 on the Top, 3 on the Right, 4 on the Bottom, 5 on the left and 2 inbetween child components.
2,3,4,5 would mean a margin of 2 on the Top, 3 on the Right, 4 on the Bottom and 5 on the left.
- would mean a margin of 4 on all borders.
4,0,0,0 would mean a margin of 4 on the Top, 0 on all other edges.
|
| Type | String |
15.5.14 Property 'childMargin'
|
| Description | This is a hint for the render to indicate the margin required for the child components of this object. The child margin value can be a comma separated value
using the convention of the first value = Top, second = Right, third = Bottom, fourth = Left.
for example
2,3,4,5 would mean a margin of 2 on the Top, 3 on the Right, 4 on the Bottom and 5 on the left.
- would mean a margin of 4 on all borders.
4,0,0,0 would mean a margin of 4 on the Top, 0 on all other edges.
|
| Type | String |
15.5.15 Property 'padding'
|
| Description | This is a hint for the render to indicate the padding required for this object. The margin value can be a comma separated value
using the convention of the first value = Top, second = Right, third = Bottom, fourth = Left.
for example
2,3,4,5 would mean a padding of 2 on the Top, 3 on the Right, 4 on the Bottom and 5 on the left.
- would mean a pagging of 4 on all borders.
4,0,0,0 would mean a padding of 4 on the Top, 0 on all the other edges
|
| Type | String |
15.5.16 Property 'childPadding'
|
| Description | This is a hint for the render to indicate the padding required for the child components of this object. The child padding value can be a comma separated value
using the convention of the first value = Top, second = Right, third = Bottom, fourth = Left.
for example
2,3,4,5 would mean padding of 2 on the Top, 3 on the Right, 4 on the Bottom and 5 on the left.
- would mean padding of 4 on all borders.
4,0,0,0 would mean padding of 4 on the Top, 0 on all other edges.
|
| Type | String |
15.5.17 Property 'color'
|
| Description | This is hint to the renderer to inidicate the color to use on this component.
|
| Type | String |
15.5.18 Property 'childColor'
|
| Description | This is hint to the renderer to inidicate the color to use on this component's child components.
|
| Type | String |
15.5.19 Property 'backgroundColor'
|
| Description | This is a hint for the renderer to indicate the background color.
|
| Type | String |
15.5.20 Property 'childBackgroundColor'
|
| Description | This is a hint for the renderer to indicate the background color for the child components of this panel.
|
| Type | String |
15.5.21 Property 'extraStyle'
|
| Description | This is mechanism for the modeller to add any additional rendering (look) details into the component.
How this is added will depend on the rendering itself, but for example in the JSF rendering this will be appended to
the 'inlineStyle' attribute (which itself uses css style notation) of the JSF components.
|
| Type | String |
15.5.22 Property 'height'
|
| Description | This is a hint for the render to indicate the height required for this object.
|
| Type | String |
Copyright (c) 2001-2008 New Technology/enterprise Ltd.
| |
