Page History

...

Type

Description

string

Plain string property

tagstring

String property that can contain %%tags%%, i18n keys or <html>. It can also be a simple static string.
Will be pre-processed before being provided to web component depending on configuration options below.

Examples:

Code Block

title	Example

Hello %%name%%, welcome to %%i18n:com.mycompany.mykey%% ...
    or
i18n:com.mycompany.mykey
    or
<html>...some html that can also contain JS callbacks and media...</html>
    or
just some static string

Here is how this type of property can be configured in the component's .spec file:

Code Block

title	Example

myTextProperty : {
	"type" : "tagstring",
	"displayTagsPropertyName" : "myDisplaysTagsProp", // default is null. If specified then the
              // property will initially read the boolean value of the property with given
              // name; If that property is true, tags (%%x%%) will be replaced, otherwise
              // they will be ignored (in which case it will just replace i18n and html);
              // if null, tags will be replaced or not based on config option "displayTags"
    "displayTags" : false, // default is true. If displayTagsPropertyName is non-null it
              // will be ignored. Otherwise, only if true this property will parse tags
              // (%%x%%)
    "useParsedValueInRhino" : true, // default is false. Server side scripting read/modify
              // will work with: if false the parsed (with tags/i18n already replaced, so
              // static) value, if true the non-parsed (value containing %%x%% or i18n:...,
              // which will be after modify parsed) value
    "forFoundset" : "myFoundsetPropertyName" // optional; if specified then on the client
              // instead of one value you will get an array of values one for each record
              // in the viewport of given foundset property (see also 'foundset' property type)
},
displaysTags : { "type" : "boolean", "scope" : "design" } // needed only if
              // "displayTagsPropertyName" is used as above

or simply (to use default config values):

Code Block

title	Example

myTextProperty: "tagstring"

color

String color value

Code Block

title	Example

#FFFFFF

point

Point representation

Code Block

title	Example

{
	x: 10, 
	y: 20
}

dimension

Dimension representation

Code Block

title	Example

{
	width: 100, 
	height: 20
}

insets

font

CSS font string

border

CSS border string

boolean

Boolean value, either true or false

styleclass

String with space separated CSS classnames.Possible values supported by the component can be specified as hint for the developer

Code Block

title	Example specifying special classnames supported by the component as hint for the developer

{
	type:'styleclass', 
	values:[
		'btn',
		'btn-default',
		'btn-lg',
		'btn-sm',
		'btn-xs'
	]
}

double

A floating point number

float

A floating point number

int

An integer number

long

A number, size is twice an integer

short

A number, 16 bit

byte

A number, 8 bit unsigned

dataprovider

Reference to a dataprovider, either a record or scope variable. Can be a complex object for supporting onDataChange

Code Block

title	Example

{ 
    	"type": "dataprovider",
    	"ondatachange": { 
		        "onchange": "onDataChangeMethodID", 
		
        "callback": "onDataChangeCallback"
	    }
    "forFoundset" : "myFoundsetPropertyName" // optional; if specified then on the client
              // instead of one value you will get an array of values one for each record
              // in the viewport of given foundset property (see also 'foundset' property type)
}

valuelist

Reference to a ValueList

form

URL string pointing to a form (like tab in tabpanel)

format

Format string. Requires to be specified as object to specify which dataprovider property to map this format property on

Code Block

title	Example

{
	for: 'dataProviderID',
	type: 'format'
}

relation

Reference to a Relation

media

Reference to a Media entry

date

Date value

scrollbars

..

tabSeq

..

protected

boolean security property, can be used to protect the entire component or specific properties or handlers in the component.

Configuration:

setting

description

example

for

list of properties to protect,

when not specified the entire component is protected

"for": ["streetname", "updateInfoFunc"]

blockingOn

when the property is set to this value, protection is active, default: true

"blockingOn": true

Code Block

language	js
title	Example

 "enabled" : { "type": "protected", "blockingOn": false, "default": true }

visible

boolean security property, when set to false the component is protected from client data changes and function calls, data changes from the server are not sent to the client

setting	description	example
for	list of properties to protect, when not specified the entire component is protected	"for": ["streetname", "updateInfoFunc"]

...

Child pages

Versions Compared

Old Version 11

New Version 12

Key