Child pages
  • JSLayoutContainer

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListNGClient

servoy sSummary12%30%58%height: 30px;3Property SummaryThe css classes to be output for html tag.The id to be output for html tag.Get/set container height.The name of the component.returns the layouts package namereturns the layouts spec nameThe style definition to be output in html tag.The tag type for html output.Get/set x location.Get/set Y location.

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns a JSLayoutContainer that has the given name throughout the whole form hierarchy.Returns a JSWebComponent that has the given name through the whole hierarchy of JSLayoutContainersReturns the comment of this container.Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean, JSWebComponent or JSTabPanel.Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponents or JSTabPanel.Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponent or JSTabPanel.Returns a JSLayoutContainer that has the given name of this container.Returns all JSLayoutContainers objects of this container.Returns all JSLayoutContainers objects of this containerReturns a JSWebComponent that has the given name that is a child of this layout container.Returns all JSWebComponents of this form/container.Returns all JSWebComponents of this form/container.Create a new layout container as the last child of its parent container.Create a new layout container.Create a new layout container.Create a new layout container as the last child in its parent container.Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form, as the last component in its parent container.Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.Creates a new JSWebComponent (spec based component) object on the form.voidvoidRemove a layout container (with all its children) from hierarchy.Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel, JSWebComponent) that has the given name.Removes a JSWebComponent that has the specified name.

propertyservoy sDetail2100%height:30px2Property DetailscssClassesname

cssClasses

dessIndent
The css classes to be output for html tag.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRowelementIdname

elementId

dessIndent
The id to be output for html tag.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
heightname

height

dessIndent
Get/set container height. This is only used for CSS Position Container.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
namename

name

dessIndent
The name of the component. Through this name it can also accessed in methods.
Must be a valid javascript name. (no - in the name or start with number)
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
packageNamename

packageName

dessIndent
returns the layouts package name
ret

Returns

sIndent String
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
specNamename

specName

dessIndent
returns the layouts spec name
ret

Returns

sIndent String
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
stylename

style

dessIndent
The style definition to be output in html tag.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
tagTypename

tagType

dessIndent
The tag type for html output. Default value is 'div'.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
xname

x

dessIndent
Get/set x location. Location is used for ordering in html output.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
yname

y

dessIndent
Get/set Y location. Location is used for ordering in html output.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsfindLayoutContainername

findLayoutContainer(name)

dessIndent
Returns a JSLayoutContainer that has the given name throughout the whole form hierarchy.
prs

Parameters

sIndentnamethe specified name of the container
ret

Returns

sIndent a JSLayoutContainer object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRowfindWebComponentname

findWebComponent(name)

dessIndent
Returns a JSWebComponent that has the given name through the whole hierarchy of JSLayoutContainers
prs

Parameters

sIndentnamethe specified name of the web component
ret

Returns

sIndent a JSWebComponent object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getAttributename

getAttribute(name)

dessIndentprs

Parameters

sIndentnamethe attributes name
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getCommentname

getComment()

dessIndent
Returns the comment of this container.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getComponentname

getComponent(name)

dessIndent
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean, JSWebComponent or JSTabPanel.
prs

Parameters

sIndentnamethe specified name of the component
ret

Returns

sIndent a JSComponent object (might be a JSField, JSLabel, JSButton, JSPortal, JSBean, JSWebComponent or JSTabPanel)
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getComponentsname

getComponents()

dessIndent
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponents or JSTabPanel.
ret

Returns

sIndent an array of all the JSComponents on the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getComponentsname

getComponents(returnInheritedElements)

dessIndent
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponent or JSTabPanel.
prs

Parameters

sIndentreturnInheritedElementstrue to also return the elements from the parent form
ret

Returns

sIndent an array of all the JSComponents on the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getLayoutContainername

getLayoutContainer(name)

dessIndent
Returns a JSLayoutContainer that has the given name of this container.
Use findLayoutContainer() method to find a JSLayoutContainter through the hierarchy
prs

Parameters

sIndentnamethe specified name of the container
ret

Returns

sIndent a JSLayoutContainer object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getLayoutContainersname

getLayoutContainers()

dessIndent
Returns all JSLayoutContainers objects of this container.
Does not return the inherited containers, use #getLayoutContainers(true) to get the inherited as well.
ret

Returns

sIndent all JSLayoutContainers objects of this container
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getLayoutContainersname

getLayoutContainers(returnInheritedElements)

dessIndent
Returns all JSLayoutContainers objects of this container
prs

Parameters

sIndentreturnInheritedElementstrue to also return the elements from parent form
ret

Returns

sIndent all JSLayoutContainers objects of this container
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getWebComponentname

getWebComponent(name)

dessIndent
Returns a JSWebComponent that has the given name that is a child of this layout container.
Use findWebComponent() to find a webcomponent through the hierarchy
prs

Parameters

sIndentnamethe specified name of the web component
ret

Returns

sIndent a JSWebComponent object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getWebComponentsname

getWebComponents()

dessIndent
Returns all JSWebComponents of this form/container.
If this method is called on a form, then it will return all web components on that form.
If the form is responsive, it will return the web components from all the containers.
It does not return the inherited components, use #getWebComponents(true) to get the inherited as well.
ret

Returns

sIndent the list of all JSWebComponent on this forms
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
getWebComponentsname

getWebComponents(returnInheritedElements)

dessIndent
Returns all JSWebComponents of this form/container.
If this method is called on a form, then it will return all web components on that form.
If the form is responsive, it will return the web components from all the containers.
prs

Parameters

sIndentreturnInheritedElementstrue to also return the elements from parent form
ret

Returns

sIndent the list of all JSWebComponents on this forms
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newLayoutContainername

newLayoutContainer()

dessIndent
Create a new layout container as the last child of its parent container.
This method can only be used in responsive forms.

If you want to use default values and so on from a layout package (like 12grid) or if you use the solution model
to create a form that is saved back into the workspace (servoyDeveloper.save(form)) then you have to set the
packageName and specName properties. So that it works later on in the designer.

If the packageName and specName are not provided, then:
   the packageName is the same as for the parent container
   the specName is the first allowed child defined in the specification of the parent container

If the specification of the parent container does not defined allowed children, then if it is not empty
   the packageName and the specName are copied from the first child layout container.
ret

Returns

sIndent the new layout container
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newLayoutContainername

newLayoutContainer(position)

dessIndent
Create a new layout container. The position is used to determine the generated order in html markup.
This method can only be used in responsive forms.

If you want to use default values and so on from a layout package (like 12grid) or if you use the solution model
to create a form that is saved back into the workspace (servoyDeveloper.save(form)) then you have to set the
packageName and specName properties. So that it works later on in the designer.

If the packageName and specName are not provided, then:
   the packageName is the same as for the parent container
   the specName is the first allowed child defined in the specification of the parent container

If the specification of the parent container does not defined allowed children, then if it is not empty
   the packageName and the specName are copied from the first child layout container.
prs

Parameters

sIndentpositionthe position of JSWebComponent object in its parent container
ret

Returns

sIndent the new layout container
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newLayoutContainername

newLayoutContainer(position, spec)

dessIndent
Create a new layout container. The position is used to determine the generated order in html markup.
This method can only be used in responsive forms.
prs

Parameters

sIndentpositionthe position of JSWebComponent object in its parent containerspeca string of the form 'packageName-layoutName', or 'layoutName'
ret

Returns

sIndent the new layout container
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newLayoutContainername

newLayoutContainer(spec)

dessIndent
Create a new layout container as the last child in its parent container.
This method can only be used in responsive forms.
prs

Parameters

sIndentspeca string of the form 'packageName-layoutName', or 'layoutName'
ret

Returns

sIndent the new layout container
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newWebComponentname

newWebComponent(type)

dessIndent
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.
Will receive a generated name. Will be added as last position in container.
prs

Parameters

sIndenttypethe webcomponent name as it appears in the spec
ret

Returns

sIndent a JSWebComponent object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newWebComponentname

newWebComponent(type, position)

dessIndent
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.
Will receive a generated name.
prs

Parameters

sIndenttypethe webcomponent name as it appears in the specpositionthe position of JSWebComponent object in its parent container
ret

Returns

sIndent a JSWebComponent object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newWebComponentname

newWebComponent(name, type)

dessIndent
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form,
as the last component in its parent container.
prs

Parameters

sIndentnamethe specified name of the JSWebComponent objecttypethe webcomponent name as it appears in the spec
ret

Returns

sIndent a JSWebComponent object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newWebComponentname

newWebComponent(name, type, position)

dessIndent
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.
prs

Parameters

sIndentnamethe specified name of the JSWebComponent objecttypethe webcomponent name as it appears in the specpositionthe position of JSWebComponent object in its parent container
ret

Returns

sIndent a JSWebComponent object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
newWebComponentname

newWebComponent(name, type, x, y, width, height)

dessIndent
Creates a new JSWebComponent (spec based component) object on the form.
prs

Parameters

sIndentnamethe specified name of the JSWebComponent objecttypethe webcomponent name as it appears in the specxthe horizontal "x" position of the JSWebComponent object in pixelsythe vertical "y" position of the JSWebComponent object in pixelswidththe width of the JSWebComponent object in pixelsheightthe height of the JSWebComponent object in pixels
ret

Returns

sIndent a JSWebComponent object
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
putAttributename

putAttribute(key, value)

dessIndentprs

Parameters

sIndentkey ;value ;
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
removename

remove()

dessIndent
Remove a layout container (with all its children) from hierarchy.
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeComponentname

removeComponent(name)

dessIndent
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel, JSWebComponent) that has the given name. It is the same as calling "if(!removeLabel(name) && !removeButton(name) ....)".
Returns true if removal was successful, false otherwise.
prs

Parameters

sIndentnamethe specified name of the component to be deleted
ret

Returns

sIndent true if component has been successfully deleted; false otherwise
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeWebComponentname

removeWebComponent(name)

dessIndent
Removes a JSWebComponent that has the specified name. Returns true if removal was successful, false otherwise.
prs

Parameters

sIndentnamethe specified name of the JSWebComponent to be removed
ret

Returns

sIndent true if the JSWebComponent has been removed; false otherwise
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow