Custom Elements Documentation

Getting Started

jqxDockingLayout is a HTML Element which enables the creation of complex layouts with panels that can be floated, docked, nested, resized, pinned, unpinned and closed.

Every UI element from jQWidgets toolkit needs its JavaScript files to be included in order to work properly.

The first step is to create html page and add links to the javascript files and css dependencies to your project.

The jqxDockingLayout element requires the following files: 

<script type="text/javascript" src="../scripts/webcomponents-lite.min.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxcore.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxcore.elements.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxdata.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxbuttons.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxwindow.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxlayout.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxdockinglayout.js"></script>
<script type="text/javascript" src="../jqwidgets/jqxribbon.js"></script>
The next step is to add the html element within the body of the html page.

<jqx-docking-layout settings="elementSettings"></jqx-docking-layout>
The last step is to initialize the element settings: 
<script type="text/javascript">
    JQXElements.settings["elementSettings"] =
    {
         layout:layout,contextMenu:true, theme:"light"
    }
</script>
To call a function(method), you need to pass the method name and parameters(if any) in the jqxDockingLayout's instance. 
<script>
	window.onload = function () {
		var element = document.querySelector("jqx-docking-layout");
		element.addFloatGroup(200,200,{x:10, y:10},'layoutPanel','Title','Content');
	}
</script>
To get the result of a function after calling it, you can use the following syntax: 
<script>
	window.onload = function () {
		var element = document.querySelector("jqx-docking-layout");
		var result = element.saveLayout();
	}
</script>
To set a property(option), you need to use the property name and value(s) along with the jqxDockingLayout's instance. 
window.onload = function() {
	document.querySelector("jqx-docking-layout").contextMenu = false;
}
You can also set properties of HTML Elements by using Attributes. Traditionally, attributes are used to set the initial state of an element. Properties with camelCase naming have dash-based attributes. For example: A property "dataSource" will have an attribute called "data-source".

To get a property(option), you need to use the property name along with the jqxDockingLayout's instance. 
window.onload = function() {
	var propertyValue = document.querySelector("jqx-docking-layout").contextMenu;
}

Event binding can be defined in the HTML as an attribute. The syntax is: 'on-' and the event's name. Event Names with camelCase naming have dash-based attributes. The attribute's value is the event handler's name. The addEventListener function can also be used for event binding. 

<script>
	window.onload = function () {
		var element = document.querySelector("jqx-docking-layout");
		element.addEventListener("create", function(event){
		// Your code here
		});
	}
</script>

Example

<!DOCTYPE html>
<html lang="en">
<head>
    <title id='Description'>DockingLayout Custom Element</title>
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
    <meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1 minimum-scale=1" />
    <link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" />
    <link rel="stylesheet" href="../../jqwidgets/styles/jqx.light.css" type="text/css" />
    <link rel="stylesheet" href="../../styles/demos.css" type="text/css" />
    <script type="text/javascript" src="../../scripts/webcomponents-lite.min.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxcore.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxcore.elements.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxlayout.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxdockinglayout.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxribbon.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxbuttons.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxwindow.js"></script>
    <script type="text/javascript" src="../../jqwidgets/jqxmenu.js"></script>
    <script>
		var layout = [{
			type: 'layoutGroup',
			orientation: 'horizontal',
			items: [{
				type: 'layoutGroup',
				orientation: 'vertical',
				width: '60%',
				items: [{
					type: 'documentGroup',
					height: '50%',
					minHeight: '25%',
					items: [{
						type: 'documentPanel',
						title: 'Document 1',
						contentContainer: 'Document1Panel'
					}, {
						type: 'documentPanel',
						title: 'Document 2',
						contentContainer: 'Document2Panel'
					}]
				}, {
					type: 'tabbedGroup',
					height: '50%',
					pinnedHeight: '10%',
					items: [{
						type: 'layoutPanel',
						title: 'Error List',
						contentContainer: 'ErrorListPanel'
					}, {
						type: 'layoutPanel',
						title: 'Output',
						contentContainer: 'OutputPanel',
						selected: true
					}]
				}]
			}, {
				type: 'tabbedGroup',
				width: '40%',
				items: [{
					type: 'layoutPanel',
					title: 'Solution Explorer',
					contentContainer: 'SolutionExplorerPanel'
				}, {
					type: 'layoutPanel',
					title: 'Properties',
					contentContainer: 'PropertiesPanel'
				}]
			},
				{
					type: 'floatGroup',
					width: 500,
					height: 300,
					position: {
						x: 350,
						y: 250
					},
					items: [{
						type: 'layoutPanel',
						title: 'Output',
						contentContainer: 'OutputPanel',
						selected: true
					}]
				}
			]
		}];
		JQXElements.settings["layoutSettings"] =
		{
			 layout:layout,contextMenu:true, theme:"light"
		}
    </script>
</head>
<body>
   <jqx-docking-layout settings="layoutSettings">
       <!--The panel content divs can have a flat structure-->
       <!--documentGroup-->
       <div data-container="Document1Panel">
           Document 1 content
       </div>
       <div data-container="Document2Panel">
           Document 2 content
       </div>
       <!--bottom tabbedGroup-->
       <div data-container="ErrorListPanel">
           List of errors
       </div>
       <div data-container="OutputPanel">
           Output
       </div>
       <!--right tabbedGroup-->
       <div data-container="SolutionExplorerPanel">
           Solution structure
       </div>
       <div data-container="PropertiesPanel">
           List of properties
       </div>
   </jqx-docking-layout>
</body>
</html>

The result of the above code is: