Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#anchors Enables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#background The background color of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#borderType The type, color and style of border of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#dataProviderID The dataprovider of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#displaysTags Flag that enables or disables merging of data inside components using tags (placeholders).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#enabled The enable state of the component, default true.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#fontType The font type of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#foreground The foreground color of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#formIndex The Z index of this component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#groupID A String representing a group ID for this component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#height The height in pixels of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#horizontalAlignment Horizontal alignment of the text inside the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMedia

Table Cell (td)
#imageMedia The image Media object that should be displayed inside the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#labelFor Some components can be set to be labels of other components.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#margin The margins of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#mediaOptions Options to scale the image Media object that is displayed inside the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#mnemonic The keyboard shortcut that activates this component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#name The name of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
#onAction The method that is executed when the component is clicked.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
#onDoubleClick The method that is executed when the component is double clicked.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
#onRender The method that is executed when the component is rendered.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
#onRightClick The method that is executed when the component is right clicked.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#printSliding Enables an element to resize based on its content and/or move when printing.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#printable Flag that tells if the component should be printed or not when the form is printed.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#rolloverCursor The cursor that is shown as the mouse is rolled over the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSMedia

Table Cell (td)
#rolloverImageMedia The roll over image Media object used.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#rotation The rotation of the element.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#showClick When set, the element will show the clicked state when selected.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#showFocus When set the text of an element will showfocus when selected.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#styleClass The name of the style class that should be applied to this component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#tabSeq An index that specifies the position of the component in the tab sequence.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#text The text that is displayed inside the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#toolTipText The text displayed when hovering over the component with a mouse cursor.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#transparent Flag that tells if the component is transparent or not.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#verticalAlignment The vertical alignment of the text inside the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#visible The visible property of the component, default true.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#width The width in pixels of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#x The x coordinate of the component on the form.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#y The y coordinate of the component on the form.

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
UUID

Table Cell (td)
#getUUID() Returns the UUID of this component.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

Table Body (tbody)

id	anchors
class	node

Table Row (tr)

id	name

Table Cell (td)
anchors

Table Row (tr)

id	des

Table Cell (td)

Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.

If opposite anchors are activated then the component with grow or
shrink with the window. For example if Top and Bottom are activated,
then the component will grow/shrink when the window is vertically
resized. If Left and Right are activated then the component
will grow/shrink when the window is horizontally resized.

If opposite anchors are not activated, then the component will
keep a constant distance from the sides of the window which
correspond to the activated anchors.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('mediaForm', 'example_data', 'parent_table', 'null', false, 400, 300);
var strechAllDirectionsLabel = form.newLabel('Strech all directions', 10, 10, 380, 280);
strechAllDirectionsLabel.background = 'red';
strechAllDirectionsLabel.anchors = SM_ANCHOR.ALL;	
var strechVerticallyLabel = form.newLabel('Strech vertically', 10, 10, 190, 280);
strechVerticallyLabel.background = 'green';
strechVerticallyLabel.anchors = SM_ANCHOR.WEST | SM_ANCHOR.NORTH | SM_ANCHOR.SOUTH;
var strechHorizontallyLabel = form.newLabel('Strech horizontally', 10, 10, 380, 140);
strechHorizontallyLabel.background = 'blue';
strechHorizontallyLabel.anchors = SM_ANCHOR.NORTH | SM_ANCHOR.WEST | SM_ANCHOR.EAST;
var stickToTopLeftCornerLabel = form.newLabel('Stick to top-left corner', 10, 10, 200, 100);
stickToTopLeftCornerLabel.background = 'orange';
stickToTopLeftCornerLabel.anchors = SM_ANCHOR.NORTH | SM_ANCHOR.WEST; // This is equivalent to SM_ANCHOR.DEFAULT 
var stickToBottomRightCornerLabel = form.newLabel('Stick to bottom-right corner', 190, 190, 200, 100);
stickToBottomRightCornerLabel.background = 'pink';
stickToBottomRightCornerLabel.anchors = SM_ANCHOR.SOUTH | SM_ANCHOR.EAST;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	background
class	node

Table Row (tr)

id	name

Table Cell (td)
background

Table Row (tr)

id	des

Table Cell (td)
The background color of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This property can be used on all types of components.
// Here it is illustrated only for labels and fields.
var greenLabel = form.newLabel('Green',10,10,100,50);
greenLabel.background = 'green'; // Use generic names for colors.	
var redField = form.newField('parent_table_text',JSField.TEXT_FIELD,10,110,100,30);
redField.background = '#FF0000'; // Use RGB codes for colors.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	borderType
class	node

Table Row (tr)

id	name

Table Cell (td)
borderType

Table Row (tr)

id	des

Table Cell (td)
The type, color and style of border of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//HINT: To know exactly the notation of this property set it in the designer and then read it once out through the solution model.
var field = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.borderType = solutionModel.createBorder(1,'#ff0000');;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	dataProviderID
class	node

Table Row (tr)

id	name

Table Cell (td)
dataProviderID

Table Row (tr)

id	des

Table Cell (td)
The dataprovider of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Normally the dataprovider is specified when a component is created.
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20);
// But it can be modified later if needed.
field.dataProviderID = 'parent_table_id';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	displaysTags
class	node

Table Row (tr)

id	name

Table Cell (td)
displaysTags

Table Row (tr)

id	des

Table Cell (td)

Flag that enables or disables merging of data inside components using tags (placeholders).
Tags (or placeholders) are words surrounded by %%on each side. There are data tags and
standard tags. Data tags consist in names of dataproviders surrounded by%%. Standard tags
are a set of predefined tags that are made available by the system.

See the "Merging data" section for more details about tags.

The default value of this flag is "false", that is merging of data is disabled by default.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var label = form.newLabel('You are viewing record no. %%parent_table_id%%. You are running on server %%serverURL%%.', 
					10, 10, 600, 100);
label.displaysTags = true;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enabled
class	node

Table Row (tr)

id	name

Table Cell (td)
enabled

Table Row (tr)

id	des

Table Cell (td)
The enable state of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('printForm', 'example_data', 'parent_table', 'null', false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.enabled = false;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	fontType
class	node

Table Row (tr)

id	name

Table Cell (td)
fontType

Table Row (tr)

id	des

Table Cell (td)
The font type of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var label = form.newLabel('Text here', 10, 50, 100, 20);
label.fontType = solutionModel.createFont('Times New Roman',1,14);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	foreground
class	node

Table Row (tr)

id	name

Table Cell (td)
foreground

Table Row (tr)

id	des

Table Cell (td)
The foreground color of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This property can be used on all types of components.
// Here it is illustrated only for labels and fields.
var labelWithBlueText = form.newLabel('Blue text', 10, 10, 100, 30);
labelWithBlueText.foreground = 'blue'; // Use generic names for colors.
var fieldWithYellowText = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 50, 100, 20);
fieldWithYellowText.foreground = '#FFFF00'; // Use RGB codes for colors.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	formIndex
class	node

Table Row (tr)

id	name

Table Cell (td)
formIndex

Table Row (tr)

id	des

Table Cell (td)
The Z index of this component. If two components overlap, then the component with higher Z index is displayed above the component with lower Z index.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var labelBelow = form.newLabel('Green', 10, 10, 100, 50);
labelBelow.background = 'green';	
labelBelow.formIndex = 10;
var fieldAbove = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 30);
fieldAbove.background = '#FF0000';
fieldAbove.formIndex = 20;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	groupID
class	node

Table Row (tr)

id	name

Table Cell (td)
groupID

Table Row (tr)

id	des

Table Cell (td)
A String representing a group ID for this component. If several components have the same group ID then they belong to the same group of components. Using the group itself, all components can be disabled/enabled or made invisible/visible. The group id should be a javascript compatible identifier to allow access of the group in scripting.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('someForm', 'example_data', 'parent_table', 'null', false, 400, 300);
var label = form.newLabel('Green', 10, 10, 100, 20);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20);
label.groupID = 'someGroup';
field.groupID = 'someGroup';	
forms['someForm'].elements.someGroup.enabled = false;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	height
class	node

Table Row (tr)

id	name

Table Cell (td)
height

Table Row (tr)

id	des

Table Cell (td)
The height in pixels of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original width: ' + field.width);
application.output('original height: ' + field.height);
field.width = 200;
field.height = 100;
application.output('modified width: ' + field.width);
application.output('modified height: ' + field.height);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	horizontalAlignment
class	node

Table Row (tr)

id	name

Table Cell (td)
horizontalAlignment

Table Row (tr)

id	des

Table Cell (td)

Horizontal alignment of the text inside the component. Can be one of
LEFT, CENTER or RIGHT.

Note that this property does not refer to the horizontal alignment
of the component inside the form.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var leftAlignedLabel = form.newLabel('LEFT', 10, 10, 300, 20);
leftAlignedLabel.horizontalAlignment = SM_ALIGNMENT.LEFT;
var hCenteredLabel = form.newLabel('CENTER', 10, 40, 300, 20);
hCenteredLabel.horizontalAlignment = SM_ALIGNMENT.CENTER;
var rightAlignedLabel = form.newLabel('RIGHT', 10, 70, 300, 20);
rightAlignedLabel.horizontalAlignment = SM_ALIGNMENT.RIGHT;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	imageMedia
class	node

Table Row (tr)

id	name

Table Cell (td)
imageMedia

Table Row (tr)

id	des

Table Cell (td)
The image Media object that should be displayed inside the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMedia

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var ballBytes = plugins.file.readFile('d:/ball.jpg');
var ballImage = solutionModel.newMedia('ball.jpg', ballBytes);
var label = form.newLabel('', 10, 10, 100, 100);
label.imageMedia = ballImage;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	labelFor
class	node

Table Row (tr)

id	name

Table Cell (td)
labelFor

Table Row (tr)

id	des

Table Cell (td)
Some components can be set to be labels of other components. This is useful in two situations. In table view mode it is used for constructing the header of the table. In record view mode, by setting mnemonics on the label, keyboard shortcuts can be used to set the focus to fields.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var labelOne = form.newLabel('Label One', 10, 10, 100, 20);
var fieldOne = form.newField('parent_table_id', JSField.TEXT_FIELD, 120, 10, 100, 20);
fieldOne.name = 'fieldOne';
labelOne.labelFor = 'fieldOne';
labelOne.mnemonic = 'O';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	margin
class	node

Table Row (tr)

id	name

Table Cell (td)
margin

Table Row (tr)

id	des

Table Cell (td)
The margins of the component. They are specified in this order, separated by commas: top, right, bottom, left.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var label = form.newLabel('Label', 10, 10, 150, 150);
label.background = 'yellow';
label.margin = '10,20,30,40';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mediaOptions
class	node

Table Row (tr)

id	name

Table Cell (td)
mediaOptions

Table Row (tr)

id	des

Table Cell (td)

Options to scale the image Media object that is displayed inside the component.
Can be set to one or a combination of CROP, REDUCE, ENLARGE and KEEPASPECT.

REDUCE will scale down the image if the component is smaller than the image.
REDUCE combined with KEEPASPECT will reduce the image, but keep its aspect ratio.
This is useful when the component has other proportions than the image.

ENLARGE will scale up the image if the component is larger than the image.
ENLARGE combined with KEEPASPECT will scale up the image while keeping its aspect ratio.

CROP will leave the image at its original size. If the component is smaller than
the image this will result in only a part of the image showing up.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Load two images, a big one and a small one.
var bigBytes = plugins.file.readFile('d:/big.jpg');
var bigImage = solutionModel.newMedia('big.jpg', bigBytes);
var smallBytes = plugins.file.readFile('d:/small.jpg');
var smallImage = solutionModel.newMedia('small.jpg', smallBytes);
// Put the big image in several small labels, with different media options.
var smallLabelWithBigImageReduceKeepAspect = form.newLabel('', 10, 10, 50, 50);
smallLabelWithBigImageReduceKeepAspect.imageMedia = bigImage;
smallLabelWithBigImageReduceKeepAspect.background = 'yellow';	
smallLabelWithBigImageReduceKeepAspect.mediaOptions = SM_MEDIAOPTION.REDUCE | SM_MEDIAOPTION.KEEPASPECT;
var smallLabelWithBigImageReduceNoAspect = form.newLabel('', 70, 10, 50, 50);
smallLabelWithBigImageReduceNoAspect.imageMedia = bigImage;
smallLabelWithBigImageReduceNoAspect.background = 'yellow';	
smallLabelWithBigImageReduceNoAspect.mediaOptions = SM_MEDIAOPTION.REDUCE;
var smallLabelWithBigImageCrop = form.newLabel('', 130, 10, 50, 50);
smallLabelWithBigImageCrop.imageMedia = bigImage;
smallLabelWithBigImageCrop.background = 'yellow';	
smallLabelWithBigImageCrop.mediaOptions = SM_MEDIAOPTION.CROP;
// Put the small image in several big labels, with different media options.
var bigLabelWithSmallImageEnlargeKeepAspect = form.newLabel('', 10, 70, 200, 100);
bigLabelWithSmallImageEnlargeKeepAspect.imageMedia = smallImage;
bigLabelWithSmallImageEnlargeKeepAspect.background = 'yellow';
bigLabelWithSmallImageEnlargeKeepAspect.mediaOptions = SM_MEDIAOPTION.ENLARGE | SM_MEDIAOPTION.KEEPASPECT;
var bigLabelWithSmallImageEnlargeNoAspect = form.newLabel('', 10, 180, 200, 100);
bigLabelWithSmallImageEnlargeNoAspect.imageMedia = smallImage;
bigLabelWithSmallImageEnlargeNoAspect.background = 'yellow';
bigLabelWithSmallImageEnlargeNoAspect.mediaOptions = SM_MEDIAOPTION.ENLARGE;
var bigLabelWithSmallImageCrop = form.newLabel('', 10, 290, 200, 100);
bigLabelWithSmallImageCrop.imageMedia = smallImage;
bigLabelWithSmallImageCrop.background = 'yellow';
bigLabelWithSmallImageCrop.mediaOptions = SM_MEDIAOPTION.CROP; // This does not do any cropping actually if the label is larger than the image.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mnemonic
class	node

Table Row (tr)

id	name

Table Cell (td)
mnemonic

Table Row (tr)

id	des

Table Cell (td)

The keyboard shortcut that activates this component. A letter must be specified,
and the actual shortcut will be combination of ALT + the specified letter.

This property can be used in two ways. Normally the keyboard shortcut activates
the onClick event of the component. But if the "labelFor" property is set for the
component, then the keyboard shortcut will move the focus to the component whose
label this component is.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var m = form.newFormMethod('function onClick() { application.output("I was clicked."); }');
var btn = form.newButton('I am a button', 10, 40, 200, 20, m);
btn.mnemonic = 'B'; // When ALT-B is pressed the mouse will respond as if clicked.
var labelOne = form.newLabel('Label One', 10, 10, 100, 20);
var fieldOne = form.newField('parent_table_id', JSField.TEXT_FIELD, 120, 10, 100, 20);
fieldOne.name = 'fieldOne';
labelOne.labelFor = 'fieldOne';
labelOne.mnemonic = 'O'; // When ALT-O is pressed the focus will move to fieldOne.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name
class	node

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)
The name of the component. Through this name it can also accessed in methods.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('someForm', 'example_data', 'parent_table', 'null', false, 620, 300);
var label = form.newLabel('Label', 10, 10, 150, 150);
label.name = 'myLabel'; // Give a name to the component.
forms['someForm'].controller.show()
// Now use the name to access the component.
forms['someForm'].elements['myLabel'].text = 'Updated text';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onAction
class	node

Table Row (tr)

id	name

Table Cell (td)
onAction

Table Row (tr)

id	des

Table Cell (td)
The method that is executed when the component is clicked.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var doNothingMethod = form.newFormMethod('function doNothing() { application.output("Doing nothing."); }');
var onClickMethod = form.newFormMethod('function onClick(event) { application.output("I was clicked at " + event.getTimestamp()); }');
var onDoubleClickMethod = form.newFormMethod('function onDoubleClick(event) { application.output("I was double-clicked at " + event.getTimestamp()); }');
var onRightClickMethod = form.newFormMethod('function onRightClick(event) { application.output("I was right-clicked at " + event.getTimestamp()); }');
// At creation the button has the 'doNothing' method as onClick handler, but we'll change that later.
var btn = form.newButton('I am a button', 10, 40, 200, 20, doNothingMethod);
btn.onAction = onClickMethod;
btn.onDoubleClick = onDoubleClickMethod;
btn.onRightClick = onRightClickMethod;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDoubleClick
class	node

Table Row (tr)

id	name

Table Cell (td)
onDoubleClick

Table Row (tr)

id	des

Table Cell (td)
The method that is executed when the component is double clicked.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var doNothingMethod = form.newFormMethod('function doNothing() { application.output("Doing nothing."); }');
var onClickMethod = form.newFormMethod('function onClick(event) { application.output("I was clicked at " + event.getTimestamp()); }');
var onDoubleClickMethod = form.newFormMethod('function onDoubleClick(event) { application.output("I was double-clicked at " + event.getTimestamp()); }');
var onRightClickMethod = form.newFormMethod('function onRightClick(event) { application.output("I was right-clicked at " + event.getTimestamp()); }');
// At creation the button has the 'doNothing' method as onClick handler, but we'll change that later.
var btn = form.newButton('I am a button', 10, 40, 200, 20, doNothingMethod);
btn.onAction = onClickMethod;
btn.onDoubleClick = onDoubleClickMethod;
btn.onRightClick = onRightClickMethod;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRender
class	node

Table Row (tr)

id	name

Table Cell (td)
onRender

Table Row (tr)

id	des

Table Cell (td)
The method that is executed when the component is rendered.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

label.onRender = form.newFormMethod('function onRender(event) { event.getElement().bgcolor = \'#00ff00\' }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRightClick
class	node

Table Row (tr)

id	name

Table Cell (td)
onRightClick

Table Row (tr)

id	des

Table Cell (td)
The method that is executed when the component is right clicked.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var doNothingMethod = form.newFormMethod('function doNothing() { application.output("Doing nothing."); }');
var onClickMethod = form.newFormMethod('function onClick(event) { application.output("I was clicked at " + event.getTimestamp()); }');
var onDoubleClickMethod = form.newFormMethod('function onDoubleClick(event) { application.output("I was double-clicked at " + event.getTimestamp()); }');
var onRightClickMethod = form.newFormMethod('function onRightClick(event) { application.output("I was right-clicked at " + event.getTimestamp()); }');
// At creation the button has the 'doNothing' method as onClick handler, but we'll change that later.
var btn = form.newButton('I am a button', 10, 40, 200, 20, doNothingMethod);
btn.onAction = onClickMethod;
btn.onDoubleClick = onDoubleClickMethod;
btn.onRightClick = onRightClickMethod;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printSliding
class	node

Table Row (tr)

id	name

Table Cell (td)
printSliding

Table Row (tr)

id	des

Table Cell (td)
Enables an element to resize based on its content and/or move when printing. The component can move horizontally or vertically and can grow or shrink in height and width, based on its content and the content of neighboring components.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('printForm', 'example_data', 'parent_table', 'null', false, 400, 300);
var slidingLabel = form.newLabel('Some long text here', 10, 10, 5, 5);
slidingLabel.printSliding = SM_PRINT_SLIDING.GROW_HEIGHT | SM_PRINT_SLIDING.GROW_WIDTH;
slidingLabel.background = 'gray';
forms['printForm'].controller.showPrintPreview();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printable
class	node

Table Row (tr)

id	name

Table Cell (td)
printable

Table Row (tr)

id	des

Table Cell (td)

Flag that tells if the component should be printed or not when the form is printed.

By default components are printable.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('printForm', 'example_data', 'parent_table', 'null', false, 400, 300);
var printedField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
var notPrintedField = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 40, 100, 20);
notPrintedField.printable = false; // This field won't show up in print preview and won't be printed.
forms['printForm'].controller.showPrintPreview()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rolloverCursor
class	node

Table Row (tr)

id	name

Table Cell (td)
rolloverCursor

Table Row (tr)

id	des

Table Cell (td)
The cursor that is shown as the mouse is rolled over the component. Possible options are DEFAULT and HAND.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var label = form.newLabel('Move the mouse over me', 10, 10, 200, 200);
label.rolloverCursor = SM_CURSOR.HAND_CURSOR;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rolloverImageMedia
class	node

Table Row (tr)

id	name

Table Cell (td)
rolloverImageMedia

Table Row (tr)

id	des

Table Cell (td)
The roll over image Media object used. When the mouse is moved over the component, this image Media will be displayed. When the mouse is moved out of the component, whatever text or image was being initially displayed will be restored.

Table Row (tr)

id	ret

Table Cell (td)
Returns JSMedia

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var ballBytes = plugins.file.readFile('d:/ball.jpg');
var ballImage = solutionModel.newMedia('ball.jpg', ballBytes);
var mapBytes = plugins.file.readFile('d:/map.jpg');
var mapImage = solutionModel.newMedia('map.jpg', mapBytes);
var label = form.newLabel('', 10, 10, 200, 200);
label.imageMedia = mapImage;
label.rolloverImageMedia = ballImage;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rotation
class	node

Table Row (tr)

id	name

Table Cell (td)
rotation

Table Row (tr)

id	des

Table Cell (td)
The rotation of the element. You can choose 0, 90, 180, or 270 and the label is rotated accordingly. This property also applies to buttons and images.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var m = form.newFormMethod('function onClick() { application.output("I was clicked."); }');
var label = form.newLabel('I am a label', 10, 10, 200, 200, m);
label.rotation = 90;
var btn = form.newButton('And I am a button', 10, 220, 200, 20, m);
btn.rotation = 180;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showClick
class	node

Table Row (tr)

id	name

Table Cell (td)
showClick

Table Row (tr)

id	des

Table Cell (td)
When set, the element will show the clicked state when selected. Applies to labels and buttons and images only.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Create a form method.
var m = form.newFormMethod('function onClick() { application.output("I was clicked."); }');
// Create a label with the method attached to its onClick event.
var label = form.newLabel('I am a label', 10, 10, 200, 20, m);
// By default the label does not visually react to clicks, but we can enable this.
// Basically the label will now behave as a button does.
label.showClick = true;
// Create a button with the same method attached to its onClick event.
var btn = form.newButton('And I am a button', 10, 40, 200, 20, m);
// By default the button visually reacts to onClick, but we can disable this.
// Then the button will behave like a label does.
btn.showClick = false;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFocus
class	node

Table Row (tr)

id	name

Table Cell (td)
showFocus

Table Row (tr)

id	des

Table Cell (td)

When set the text of an element will showfocus when selected.
Applies to labels and buttons only.
The text property for the element MUST be filled in first.

NOTE: The TAB key may also be used to select the element, depending
on the operating system being used and the selected LAF.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var m = form.newFormMethod('function onClick() { application.output("I was clicked."); }');
var label = form.newLabel('I am a label', 10, 10, 200, 20, m);
label.showFocus = false;
var btn = form.newButton('And I am a button', 10, 40, 200, 20, m);
btn.showFocus = false;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass
class	node

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

The name of the style class that should be applied to this component.

When defining style classes for specific component types, their names
must be prefixed according to the type of the component. For example
in order to define a class names 'fancy' for fields, in the style
definition the class must be named 'field.fancy'. If it would be
intended for labels, then it would be named 'label.fancy'. When specifying
the class name for a component, the prefix is dropped however. Thus the
field or the label will have its styleClass property set to 'fancy' only.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('printForm', 'example_data', 'parent_table', 'null', false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
var style = solutionModel.newStyle('myStyle','field.fancy { background-color: yellow; }');
form.styleName = 'myStyle'; // First set the style on the form.
field.styleClass = 'fancy'; // Then set the style class on the field.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	tabSeq
class	node

Table Row (tr)

id	name

Table Cell (td)
tabSeq

Table Row (tr)

id	des

Table Cell (td)
An index that specifies the position of the component in the tab sequence. The components are put into the tab sequence in increasing order of this property. A value of 0 means to use the default mechanism of building the tab sequence (based on their location on the form). A value of -2 means to remove the component from the tab sequence.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Create three fields. Based on how they are placed, by default they will come one
// after another in the tab sequence.
var fieldOne = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 10, 100, 20);
var fieldTwo = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 40, 100, 20);
var fieldThree = form.newField('parent_table_id', JSField.TEXT_FIELD, 10, 70, 100, 20);
// Set the third field come before the first in the tab sequence, and remove the 
// second field from the tab sequence.
fieldOne.tabSeq = 2;
fieldTwo.tabSeq = SM_DEFAULTS.IGNORE;
fieldThree.tabSeq = 1;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	text
class	node

Table Row (tr)

id	name

Table Cell (td)
text

Table Row (tr)

id	des

Table Cell (td)
The text that is displayed inside the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// In general the text is specified when creating the component.
var label = form.newLabel('Initial text', 10, 10, 100, 20);
// But it can be changed later if needed.
label.text = 'Changed text';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	toolTipText
class	node

Table Row (tr)

id	name

Table Cell (td)
toolTipText

Table Row (tr)

id	des

Table Cell (td)

The text displayed when hovering over the component with a mouse cursor.

NOTE:
HTML should be used for multi-line tooltips; you can also use any
valid HTML tags to format tooltip text. For example:
<html>This includes<b>bolded text</b> and
<font color='blue'>BLUE</font> text as well.</html>

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var label = form.newLabel('Stop the mouse over me!', 10, 10, 200, 20);
label.toolTipText = 'I\'m the tooltip. Do you see me?';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent
class	node

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (td)

Flag that tells if the component is transparent or not.

The default value is "false", that is the components
are not transparent.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// Load an image from disk an create a Media object based on it.
var imageBytes = plugins.file.readFile('d:/ball.jpg');
var media = solutionModel.newMedia('ball.jpg', imageBytes);
// Put on the form a label with the image.
var image = form.newLabel('', 10, 10, 100, 100);
image.imageMedia = media;
// Put two fields over the image. The second one will be transparent and the
// image will shine through.
var nonTransparentField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 20, 100, 20);
var transparentField = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 50, 100, 20);
transparentField.transparent = true;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	verticalAlignment
class	node

Table Row (tr)

id	name

Table Cell (td)
verticalAlignment

Table Row (tr)

id	des

Table Cell (td)

The vertical alignment of the text inside the component. Can be one of
TOP, CENTER or BOTTOM.

Note that this property does not refer to the vertical alignment of the
component inside the form.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var topAlignedLabel = form.newLabel('TOP', 400, 10, 50, 300);
topAlignedLabel.verticalAlignment = SM_ALIGNMENT.TOP;
var vCenterAlignedLabel = form.newLabel('CENTER', 460, 10, 50, 300);
vCenterAlignedLabel.verticalAlignment = SM_ALIGNMENT.CENTER
var bottomAlignedLabel = form.newLabel('BOTTOM', 520, 10, 50, 300);
bottomAlignedLabel.verticalAlignment = SM_ALIGNMENT.BOTTOM;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	visible
class	node

Table Row (tr)

id	name

Table Cell (td)
visible

Table Row (tr)

id	des

Table Cell (td)
The visible property of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('printForm', 'example_data', 'parent_table', 'null', false, 400, 300);
var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.visible = false;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	width
class	node

Table Row (tr)

id	name

Table Cell (td)
width

Table Row (tr)

id	des

Table Cell (td)
The width in pixels of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original width: ' + field.width);
application.output('original height: ' + field.height);
field.width = 200;
field.height = 100;
application.output('modified width: ' + field.width);
application.output('modified height: ' + field.height);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	x
class	node

Table Row (tr)

id	name

Table Cell (td)
x

Table Row (tr)

id	des

Table Cell (td)
The x coordinate of the component on the form.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original location: ' + field.x + ', ' + field.y);
field.x = 90;
field.y = 90;
application.output('changed location: ' + field.x + ', ' + field.y);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	y
class	node

Table Row (tr)

id	name

Table Cell (td)
y

Table Row (tr)

id	des

Table Cell (td)
The y coordinate of the component on the form.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var field = form.newField('parent_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
application.output('original location: ' + field.x + ', ' + field.y);
field.x = 90;
field.y = 90;
application.output('changed location: ' + field.x + ', ' + field.y);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	getUUID
class	node

Table Row (tr)

id	name

Table Cell (td)
getUUID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

UUID

Span

style	float: left; font-weight: bold;
id	iets

getUUID

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the UUID of this component.

Table Row (tr)

id	ret

Table Cell (td)
Returns UUID

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID();
application.output(button_uuid.toString());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Page History

Versions Compared

Old Version 15

New Version Current

Key

anchors

background

borderType

dataProviderID

displaysTags

enabled

fontType

foreground

formIndex

groupID

height

horizontalAlignment

imageMedia

labelFor

margin

mediaOptions

mnemonic

name

onAction

onDoubleClick

onRender

onRightClick

printSliding

printable

rolloverCursor

rolloverImageMedia

rotation

showClick

showFocus

styleClass

tabSeq

text

toolTipText

transparent

verticalAlignment

visible

width

x

y

getUUID