Page History

{div:style=}

Wiki Markup

Div

style	display:none

DO

NOT

EDIT

THE

CONTENT

OF

THIS

PAGE

DIRECTLY

(EXCEPT

INSIDE

THE

DIV

BELOW

WITH

ID=DESCRIPTION),

UNLESS

YOU

KNOW

WHAT

YOU'RE

DOING.

THE

STRUCTURE

OF

THE

CONTENT

IS

VITAL

IN

BEING

ABLE

TO

AUTO

UPDATE

THE

CONTENT

THROUGH

THE

DOC

GENERATOR.

\\ \\ Enter additional information related to this

Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#sticky] Flag to set a set the header sticky so it will not scroll out of view.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#styleClass] The Cascading Style Sheet (CSS) class name applied to the part.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[JSTitle]{td}{td}[#getHeaderText]\() Returns the header text label on the form header if present.{td}{tr}{tbody}{tbody}{tr}{td}[JSButton]{td}{td}[#getLeftButton]\() Returns the left\-button on the form header if present.{td}{tr}{tbody}{tbody}{tr}{td}[JSButton]{td}{td}[#getRightButton]\() Returns the right\-button on the form header if present.{td}{tr}{tbody}{tbody}{tr}{td}[JSTitle]{td}{td}[#newHeaderText]\(text) Creates a new header text label on the form header.{td}{tr}{tbody}{tbody}{tr}{td}[JSButton]{td}{td}[#newLeftButton]\(text, jsmethod) Creates a new left\-button on the form header.{td}{tr}{tbody}{tbody}{tr}{td}[JSButton]{td}{td}[#newRightButton]\(text, jsmethod) Creates a new right\-button on the form header.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeHeaderText]\() Remove the header text label on the form header if present.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeLeftButton]\() Remove the left\-button on the form header if present.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#removeRightButton]\() Remove the right\-button on the form header if present.{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=sticky}{tr:id=name}{td}h6.sticky{td}{tr}{tr:id=des}{td}{div:class=sIndent}Flag to set a set the header sticky so it will not scroll out of view.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Div

id	description

HTML Table

id
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)
Boolean

Table Cell (td)
#sticky Flag to set a set the header sticky so it will not scroll out of view.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#styleClass The Cascading Style Sheet (CSS) class name applied to the part.

HTML Table

id
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)
JSTitle

Table Cell (td)
#getHeaderText() Returns the header text label on the form header if present.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSButton

Table Cell (td)
#getLeftButton() Returns the left-button on the form header if present.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSButton

Table Cell (td)
#getRightButton() Returns the right-button on the form header if present.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSTitle

Table Cell (td)
#newHeaderText(text) Creates a new header text label on the form header.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSButton

Table Cell (td)
#newLeftButton(text, jsmethod) Creates a new left-button on the form header.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSButton

Table Cell (td)
#newRightButton(text, jsmethod) Creates a new right-button on the form header.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#removeHeaderText() Remove the header text label on the form header if present.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#removeLeftButton() Remove the left-button on the form header if present.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#removeRightButton() Remove the right-button on the form header if present.

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	sticky

Table Row (tr)

id	name

Table Cell (td)
sticky

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag to set a set the header sticky so it will not scroll out of view.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
header.sticky = false // default: true

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The Cascading Style Sheet (CSS) class name applied to the part.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var body = form.newPart(JSPart.BODY, 320);
body.styleClass = 'myBody';

...

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	getHeaderText

Table Row (tr)

id	name

Table Cell (td)
getHeaderText

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTitle

Span

style	font-weight: bold;

getHeaderText

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the header text label on the form header if present.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTitle – a JSTitle object if the header text exists, null otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.getForm('myform');
var header = form.getHeader()
var title = header.getHeaderText()
title.text = 'Customers'

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLeftButton}{tr:id=name}{td}h6.getLeftButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSButton]{span}{span:style=font-weight: bold;}getLeftButton{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the left\-button on the form header if present.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSButton] -- a JSButton object if the left-button exists, null otherwise{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLeftButton

Table Row (tr)

id	name

Table Cell (td)
getLeftButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton

Span

style	font-weight: bold;

getLeftButton

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the left-button on the form header if present.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton – a JSButton object if the left-button exists, null otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.getForm('myform');
var header = form.getHeader()
var button = header.getLeftButton()
button.iconType = JSButton.ICON_HOME

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getRightButton}{tr:id=name}{td}h6.getRightButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSButton]{span}{span:style=font-weight: bold;}getRightButton{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the right\-button on the form header if present.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSButton] -- a JSButton object if the right-button exists, null otherwise{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRightButton

Table Row (tr)

id	name

Table Cell (td)
getRightButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton

Span

style	font-weight: bold;

getRightButton

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the right-button on the form header if present.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton – a JSButton object if the right-button exists, null otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.getForm('myform');
var header = form.getHeader()
var button = header.getRightButton()
button.iconType = JSButton.ICON_GEARS

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=newHeaderText-}{tr:id=name}{td}h6.newHeaderText{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSTitle]{span}{span:style=font-weight: bold;}newHeaderText{span}{span}\(text){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Creates a new header text label on the form header.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}text -- the text on the header {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSTitle] -- a new JSTitle object{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newHeaderText-

Table Row (tr)

id	name

Table Cell (td)
newHeaderText

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTitle

Span

style	font-weight: bold;

newHeaderText

Span
(text)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new header text label on the form header.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

text – the text on the header

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTitle – a new JSTitle object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var title = header.newHeaderText('Contacts')

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newLeftButton-String_JSMethod

}{

Table Row (tr)

:

id

=

	name

}{td}h6.newLeftButton{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
newLeftButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}[

JSButton

]{span}{span:style=

Span

style	font-weight:

bold;

}

newLeftButton

{span}{span}\

Span
(text,

jsmethod)

{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Creates a new left\-button on the form header.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text -- the text on the button \{[JSMethod]} jsmethod -- the method assigned to handle an onAction event {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSButton] -- a new JSButton object{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new left-button on the form header.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text – the text on the button
{JSMethod} jsmethod – the method assigned to handle an onAction event

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton – a new JSButton object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var button = header.newLeftButton('back', form.getMethod('goBack'))

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRightButton-String_JSMethod

}{

Table Row (tr)

:

id

=

	name

}{td}h6.newRightButton{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
newRightButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}[

JSButton

]{span}{span:style=

Span

style	font-weight:

bold;

}

newRightButton

{span}{span}\

Span
(text,

jsmethod)

{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Creates a new right\-button on the form header.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text -- the text on the button \{[JSMethod]} jsmethod -- the method assigned to handle an onAction event {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSButton] -- a new JSButton object{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new right-button on the form header.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} text – the text on the button
{JSMethod} jsmethod – the method assigned to handle an onAction event

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton – a new JSButton object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var button = header.newRightButton('save', form.getMethod('doSave'))

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeHeaderText}{tr:id=name}{td}h6.removeHeaderText{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}removeHeaderText{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Remove the header text label on the form header if present.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if header text existed and was removed{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeHeaderText

Table Row (tr)

id	name

Table Cell (td)
removeHeaderText

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeHeaderText

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Remove the header text label on the form header if present.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – true if header text existed and was removed

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeHeaderText()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeLeftButton}{tr:id=name}{td}h6.removeLeftButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}removeLeftButton{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Remove the left\-button on the form header if present.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if button existed and was removed{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeLeftButton

Table Row (tr)

id	name

Table Cell (td)
removeLeftButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeLeftButton

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Remove the left-button on the form header if present.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – true if button existed and was removed

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeLeftButton()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeRightButton}{tr:id=name}{td}h6.removeRightButton{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}removeRightButton{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Remove the right\-button on the form header if present.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if button existed and was removed{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeRightButton

Table Row (tr)

id	name

Table Cell (td)
removeRightButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeRightButton

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Remove the right-button on the form header if present.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – true if button existed and was removed

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeRightButton()

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 7

New Version 8

Key

sticky

styleClass

getHeaderText

getLeftButton

getRightButton

newHeaderText

newLeftButton

newRightButton

removeHeaderText

removeLeftButton

removeRightButton