JSResponsiveLayoutContainer
Properties Summarized
CSS position is a replacement for anchoring system making it more intuitive to place a component.
Methods Summarized
Returns a JSResponsiveLayoutContainer that has the given name of this container.
Returns all JSResponsiveLayoutContainer objects of this container
Returns a JSWebComponent that has the given name that is a child of this form, layout container or responsive layout container.
Create a new responsive layout container.
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE container(form , layout container or responsive layout container).
Properties Detailed
cssClasses
The css classes to be output for html tag.
Type String A space-separated string of CSS classes applied to the layout container.
Sample
cssPosition
CSS position is a replacement for anchoring system making it more intuitive to place a component. CSS position should be set on form, an absolute position form can either work with anchoring or with css position. This is only working in NGClient.
Type CSSPosition The CSS position of the component.
Sample
Methods Detailed
getAttribute(name)
Parameters
String name the attributes name
Returns: String The value of the specified attribute, or null if the attribute is not set.
Sample
getComment()
Returns the comment of this component.
Returns: String the comment associated with this component.
Sample
getResponsiveLayoutContainer(name)
Returns a JSResponsiveLayoutContainer that has the given name of this container.
Parameters
String name the specified name of the container
Returns: JSResponsiveLayoutContainer a JSResponsiveLayoutContainer object
Sample
getResponsiveLayoutContainers(returnInheritedElements)
Returns all JSResponsiveLayoutContainer objects of this container
Parameters
Boolean returnInheritedElements true to also return the elements from parent form
Returns: Array all JSResponsiveLayoutContainer objects of this container
Sample
getUUID()
Returns the UUID of this component.
Returns: UUID the UUID of this component.
Sample
getWebComponent(name)
Returns a JSWebComponent that has the given name that is a child of this form, layout container or responsive layout container. Use findWebComponent() to find a webcomponent through the hierarchy
Parameters
String name the specified name of the web component
Returns: JSComponent a JSWebComponent object
Sample
getWebComponents(returnInheritedElements)
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.
Parameters
Boolean returnInheritedElements true to also return the elements from parent form
Returns: Array the list of all JSWebComponents on this forms
Sample
newResponsiveLayoutContainer(position)
Create a new responsive layout container. The position is used to determine the generated order in html markup.
Parameters
Number position the position of responsive layout container object in its parent container
Returns: JSResponsiveLayoutContainer the new responsive layout container
Sample
newWebComponent(name, type, position)
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE container(form , layout container or responsive layout container).
Parameters
String name the specified name of the JSWebComponent object
String type the webcomponent name as it appears in the spec
Number position the position of JSWebComponent object in its parent container
Returns: JSComponent a JSWebComponent object
Sample
putAttribute(key, value)
Parameters
Returns: void
Sample
remove()
Remove a layout container (with all its children) from hierarchy.
Returns: void
Sample
removeWebComponent(name)
Removes a JSWebComponent that has the specified name. Returns true if removal was successful, false otherwise.
Parameters
String name the specified name of the JSWebComponent to be removed
Returns: Boolean true if the JSWebComponent has been removed; false otherwise
Sample
Last updated
Was this helpful?