Component CLIENTCONFIG

Overview

The CLIENTCONFIG component is an invisible component which allows to set global client configuration parameters.

The most important parameters are the COUNTRY and the LANGUAGE that is used for the client components. But there are many more parameters.

Attribute summary

Typically used attributes

All attributes are

Positioning

Used inside: BEANPROCESSING, CONTENTPANE, PANE

Attribute details

adapterbinding

Special binding to component adapter object instance on server side. The component adapter must be an instance of IComponentAdapterBinding. For some components (e.g. FIXGRID) there is an extended interface (e.g. IFIXGRIDComponentAdapterBinding).

The attribute value must be an expression.

#{tobedefined}Binding to IComponentAdapter instance

animate

Defines if the client executes animations or not. In certain situations it is useful to switch off all animatiosn - e.g. when using screens via terminal server.

true(default) animations are enabled
falseanimations are disabled

attributemacro

Name of macro that is used for generating certain attributes of this component. Please pay attention: the value of this attribute is read one time for each control and cannot be changed afterwards.

The attribute value must not be changed once the component is created.

beepwhenblocked

When the client communicates then by default the dialog processing is blocked and a beep-sound is output when the user e.g. clicks into the screen. You can override this default behavior by using this attribute.

true(default) Beep-sound
falseNo beep-sound

clientlogactive

If set to true, then the client logging will be activated.

falseNo client logging (default)
trueWith client logging

clientloglevel

Log level on client side.

ALLDebug
INFOInfo (default)
WARNINGWarning
ERRORError

comment

Comment that can be asigned to any component. The comment is not operationally used.

Any textAny text

configinfo

Configuration information that is attached to this component. This information is not functionally used by CaptainCasa, but may be used for any application specific purpose.

confirmexit

If set to true then the browser client will ask the user for confirmation before closing the current page.

falsePage closed without confirmation (default)
trueUser needs to confirm closing of page

connectionproblemmessage

Text that is shown to the user in case of connections problems.

connectionproblempopup

Decision if to explicitly show the user a popup message in case of connection problems. If set to false then no popup is shown but immediately the user receives some error message.

country

Country abbreviation - important for setting date/time/decimal format of output.

DEGermany
FRFrance
USUnited Stated
...Country ISO Codes

doubleclickclearstextselection

By default the client removes the text selection on double click in order to ensure a proper e.g. double click selection in grids. You may override this by setting this attribuet to true.

true(default) Double click clears text selection.
falseDouble click does not clear text selection.

durationglasspaneblocker

Duration until a glass pane is overlayed on top of the screen in order to catch any time of user mouse events after initiating a round trip.

200200ms
250250ms
300300ms
350250ms
450300ms

durationglasspaneblockerphase2

Duration until phase 2 of blocking is started (default: dark overlay)

200200ms
250250ms
300300ms
350250ms
450300ms

durationglasspaneblockerphase3

Duration until phase 3 of blocking is started (default: spinning wheel image)

10001000ms
15001500ms
20002000ms

emptyvalues

Semicolon separated list of string values, that are interpreted on client side as empty string when calculating the BGPAINT for e.g. mandatory attributes. By default an attribute value is treated when it is null or when it is an empty string - here you can add alternatives.

 default - not additional empty values
-- is treated as empty value
[null];[undefined][null] and [undefined] are treated as empty value

falsestring

String representation that is used for the boolean value false

nulldefault value for false
__ is displayed for true

fontfamily

Name of font to be used in client. This is either the name of a specific font, or a semicolon separated sequence of fonts - the first font, that is available on client side, will be selected

ArialArial
Courier NewCourier New
Trebuchet MSTrebuchet MS
...Any other font family name
FontAwesomeIcon font: Awesome font
SAPIconsIcon font: SAP icons
Trebuchet MS;ArialTry Trebuchet, if not available then use Arial

html5dragdrop

Indicates that HTML5 drag drop should be used for all drag drop operations.

falsefalse (default)
truetrue

html5dragdropcrossbrowser

Indicates that HTML5 drag-drop should be used also for cross browser drag drop operations. If set to false then drag-drop is only supported within the same browser instance.

truetrue (default)
falsefalse

inputusedefaultbrowserautofill

Browsers added a certain function to input elements: the management of values. Typical use case: passwords may be stored in the browser. Some browsers to extends this by also keeping other input parameters as well.

 false (default)
trueUse the default input-component configuration without trying to control autofill/complete in any means.
falseUse the default configuration that CaptainCasa applies to an input element in order to avoid autofill/complete.

keyvariantshotkey

Hotkey definition that is used in fields for opening the key variant dialog.

 No keyboard association (default)
ctrl-83Control key + s
alt-83Alt key + s
shift-83Shift key + s
ctrl-shift-83Control key + Shift key + s
10return
32space
37cursor left
38cursor up
39cursor right
40cursor down
33page up
34page down
36Begin
35End
27escape
127Del
65a
66b
67c
68d
69e
70f
71g
72h
73i
74j
75k
76l
77m
78n
79o
80p
81q
82r
83s
84t
85u
86v
87w
88x
89y
90z
480
491
502
513
524
535
546
557
568
579
112F1
113F2
114F3
115F4
116F5
117F6
118F7
119F8
120F9
121F10
122F11
123F12

language

Language abbreviation.

deGerman
frFrench
enEnglish
...Language ISO Codes

loadstylewithsessionreference

By default styles are loaded without reference to the http session. If switching this attribute to true, then the client will automatically add a jsessionid-extension to the URL loading the style (in case of using session management by URL-encoding). You only should use this attribute if building up some own style management, in which the runtime style is updated during a session and in which the loading/building of the style requires a separation of sessions

falseStyle is loaded as normal resource
true>Style is loaded with explicit reference to session

numberofreconnects

If the communication of the client to the page then the client retries to reach the server. This attribute defines the number of retries.

0no reconnects
11 reconnect (default)
22 reconnects

popupmenucopyclipboard

Definition if automatic copy-clipboard popup menu is provided for text components.

truePopup menu is automatically provided.
gridOnlyPopup menu is automatically provided for components inside some grid.
false(default) No automatic popup menu.

popupmenuglobalhotkeys

Definition if all global hotkey definitions are automatically available as popup menu items.

true(default) Global hot key definitions are added to any popup menu.
falseNo adding of global hot key definitions to popup menu.

popupmenupasteclipboard

reference

Reference to an outside object that is the content behind the component. E.g. a field is representing a certain field of a database table: in this case you could define the value table;column. The reference plays a siginficant role within the attributemacro management.

The attribute value must not be changed once the component is created.

refOne reference
ref1;ref2Two references
ref1;ref2;ref3Three references

scale

Scaling of sizes on client side. Float value. If attribute SCALEFONT is not set, then the scale value is taken for fonts scaling, too.

 any float value, well reasonable is something between 1.0 and 2.0 ...
1.0100% (default)
1.25125%
1.5150%

selectioncolor1

Top color of color shading that is applied when a grid row is selected.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

selectioncolor2

Bottom color of color shading that is applied when a grid row is selected.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

sessiontimeouturl

In case of a server side session timeout: navigate the browser to this URL

https://www.captaincasa.comAbsolute URL
/html/sessiontimeoutpage.htmlRelative URL (base is the WebContent)
/abc.def.riscRelative URL (base is the WebContent) directly starting a CC dialog

tabonenter

If enabled then the return-key will switch the focus to the next component.

trueSwitch focus on return-key
falseSwitch focus on tab-key only (default)

timezone

Timezone that is used for transferring the date input into a time stamp. Values need to correspond to TimeZone.getAvailableIDs().

LOCALTo be set if using LocalDate/LocalTime on server side
-------------------------
GMTGMT - Greenwich Mean Time (no daylight saving)
UTCUTC - Coordinated Universal Time (no daylight saving)
-------------------------
CETCET - Central European Time
Europe/ParisEurope/Paris
Africa/HarareAfrica/Harare
Asia/Tel_AvivAsia/Tel_Aviv
......

title

The title of the dialog.

titleimage

Image that is shown in the browser tab of the page as fav-icon.

/images/abc.pngImage /images/abc.png
/images/svg/def.svgImage /images/svg/def.svg

touchsupport

Central swicht to provide touch dialogs for all input componentes.

falseno touch support (default)
trueWith touch support

truestring

String representation that is used for the boolean value true

nulldefault value for true
XX is displayed for true