Start page
Start page

Start page / Template development / Forms / Design elements / GROUP

CMS_GROUP

CMS_GROUP - Frame

This component is a special case as it is not used for including editorial contents but for the graphical grouping of further input components. The required input components can be collated together to form a group.

There are two ways of grouping the input components:

  • The input components (like all other components too) are displayed under each other and are identified as a group by a surrounding frame.
  • Each input component is displayed in its own, separate tab.

Contents
for example

CMS_GROUP - Tab

height
PositiveInteger
Optional parameter
name
Designator
Optional parameter
scrollable
GroupScrollMode
Optional parameter
tabs
TabMode
Optional parameter
lang
LanguageAbbreviation
Mandatory
description
String
Optional parameter
label
String
Optional parameter

Parameter

The CMS_GROUP component has three optional parameters:

  • name: technical identifier of a grouping, e.g. for use in a BeanShell script
  • scrollable: defines whether a grouping has scroll bars or not
  • tab: display of input components as tabs

ParameterMandatorySinceTypeDefault value
heightNo4.0.28PositiveIntegerNone
nameNo4.2DesignatorNone
scrollableNo4.0GroupScrollModeNone
tabsNo4.0TabModeNONE

height

The height parameter is used to define the display height of the group in pixel.

The parameter expects an integer value, greater than 200. If the parameter is not specified, the height of the group will depend on the input components which are contained in the group.

If more than one tab is defined (parameter tabs) the height depends on the height of the input components of the depending tab.

ParameterMandatorySinceTypeDefault value
heightNo4.0.28PositiveIntegerNone

name

The optional parameter name can be used to assign an identifier to a grouping.

This identifier is used to enable programming access to a grouping, z.B. in a BeanShell script.

ParameterMandatorySinceTypeDefault value
nameNo4.2DesignatorNone

scrollable

The optional parameter scrollable can be used to specify whether a grouping is to be capable of displaying scroll bars or not.

ParameterMandatorySinceTypeDefault value
scrollableNo4.0GroupScrollModeNone

tabs

The optional parameter tabs can be used to display input components in a grouping as tabs.

The orientation of the tabs can be specified.

It is possible to choose between left and right as well as top and bottom for the alignment of the tabs in JAVAclient.

If the parameter is not given, no tabs are displayed.

Note: WEBedit can only display tabs at the top!

ParameterMandatorySinceTypeDefault value
tabsNo4.0TabModeNONE

LANGINFOSAvailable from FirstSpirit Version 3.1

Using the tag LANGINFOS language-dependent information can be defined for each input component, e.g. which title is to be used for the input component in the different project languages (parameter label), which tooltip is to be displayed (parameter description) etc. For reasons of clarity, definitions which are identical in multiple languages will be merged. For example,

<LANGINFOS> 
<LANGINFO lang="*" label="Datum"/>
<LANGINFO lang="DE" label="Datum"/>
<LANGINFO lang="EN" label="Datum"/>
</LANGINFOS>

will be merged to

 <LANGINFOS> 
<LANGINFO lang="*" label="Datum"/>
</LANGINFOS>

after saving.

Available from FirstSpirit Version 4.2R2 Up to and including FirstSpirit version 4.2R2 language definitions will be deleted only in the case if the values are identical in all languages (as in example above). Furthermore, only the parameters lang, description and label are taken into account when merging.

Available from FirstSpirit Version 4.2R4 Since FirstSpirit version 4.2R4 all parameters are taken into account (e.g. format and length). Furthermore, language definitions are also merged within LANGINFOS tags, if they are identical in at least two languages. For example,

<LANGINFOS> 
<LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
<LANGINFO lang="DE" label="Date" format="dd.MM.yy"/>
<LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

will become

 <LANGINFOS> 
<LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
<LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

after saving.

The definition for the fallback value (*) will not be deleted in any case. If there are two or more language definitions with identical values the first one will be maintained, the other will be deleted.

Available from FirstSpirit Version 4.2R2 IMPORTANT: Up to and including FirstSpirit version 4.2R2 at least one definition for the fallback labelling ("*") must be given:

<LANGINFOS>
<LANGINFO lang="*" label="TEXT"/>
</LANGINFOS>

Available from FirstSpirit Version 4.2R4 From FirstSpirit version 4.2R4 the fallback definition can be omitted. In this case, the language which is defined first will be used automatically as fallback value. For example,

<LANGINFOS>
<LANGINFO lang="EN" label="Date"/>
<LANGINFO lang="DE" label="Datum"/>
</LANGINFOS>

will become

 <LANGINFOS> 
<LANGINFO lang="*" label="Date"/>
<LANGINFO lang="DE" label="Datum"/>
</LANGINFOS>

after saving.

LANGINFOAvailable from FirstSpirit Version 3.1

The LANGINFO tag is used to give values or attributes for a language as well for use as fallback values.

In order to state values or attributes for a language it is necessary to give the abbreviation of the project language in the lang parameter:

...
<LANGINFO lang="DE".../>
...

Fallback values are given with the special language abbreviation * ("for all languages"):

...
<LANGINFO lang="*".../>
...

The lang parameter is a mandatory parameter.

ParameterMandatorySinceTypeDefault value
lang*Yes3.1LanguageAbbreviationNone
descriptionNo3.1StringNone
labelNo3.1StringNone

lang

The lang parameter is used to give the language abbreviation which is entered in the server properties see View document FirstSpirit Manual for Administrators, Chapter "Language templates") to specify for which project languages the definitions are to apply, e.g. DE for German, EN for English, FR for French etc. The following characters can be used as often as required: -, _, 0-9 and A-Z. Lower case letters are transformed automatically into upper case letters after having saved the template. In addition * can be used for fallback values.

ParameterMandatorySinceTypeDefault value
lang*Yes3.1LanguageAbbreviationNone

description

The description parameter can be used to give a description which is used to display a tool tip (mouse-over).

ParameterMandatorySinceTypeDefault value
descriptionNo3.1StringNone

label

The label parameter is used to give the surface labelling for input and visualisation components.

ParameterMandatorySinceTypeDefault value
labelNo3.1StringNone
Key

LanguageAbbreviation

Language abbreviation, e.g. DE, EN, FR or * for return values

TabMode

Orientation mode of the tabs

NONEAvailable from FirstSpirit Version 4.0

No display of tabs

TOPAvailable from FirstSpirit Version 4.0

Display tab at the top

LEFTAvailable from FirstSpirit Version 4.0

Display tab on the left

BOTTOMAvailable from FirstSpirit Version 4.0

Display tab at the bottom

RIGHTAvailable from FirstSpirit Version 4.0

Display tab on the right

GroupScrollMode

Display setting for scroll bars

FIXEDAvailable from FirstSpirit Version 4.0

Do not use scroll bars

VERTICALAvailable from FirstSpirit Version 4.0

Use vertical scroll bars

HORIZONTALAvailable from FirstSpirit Version 4.0

Use horizontal scroll bars

BOTHAvailable from FirstSpirit Version 4.0

Use horizontal and vertical scroll bars

PositiveInteger

Positive integer

String

A random character string

Designator

Unique identifier of variable length; must start with a letter or underscore and may only contain the characters "A-Z", "a-z", "0-9" and "_", e.g. "fr_st_varName"

Example

An example of the form component "CMS_GROUP":

<CMS_GROUP tabs="TOP">
<LANGINFOS>
<LANGINFO lang="*" label="TEXT"/>
<LANGINFO lang="DE" label="TEXT"/>
<LANGINFO lang="EN" label="TEXT"/>
</LANGINFOS>
...
</CMS_GROUP>

© 2005 - 2014 e-Spirit AG | All rights reserved. | Last change: 2011-05-18