The Dojo Border Container builder adds a Dojo BorderContainer widget to a page location that you specify.
This builder requires Dojo Version 1.2 or later.
For more information about the Dojo BorderContainer widget, refer to http://docs.dojocampus.org/dijit/layout/BorderContainer
The Dojo BorderContainer widget is a Dijit layout component that contains up to four optional regions (left/leading, right/trailing, top and bottom) and a required center region, with optional splitter user interface (UI) controls to manually resize a region in the browser.
This builder is intended to create the region layout area in an empty, named page location on the page, where you can apply other builders (for example, the Inserted Page, Model Container and Data Page builders), within each of the regions. It is not intended to be applied to an existing page location that is already populated with other content and layout elements.
The builder creates <div>
elements within each region to which you can add your content. The element names use the name of the builder call (the name you enter in the Name
builder input) as a prefix and the following strings as the suffix.
Apply your content to those created page locations to populate the content area of those regions.
You can use the Region Settings
input to disable one or more of the optional regions (top, leading, trailing, or bottom). Any disabled regions are not rendered within the border container and thus are not displayed in the browser. The center region must always exist within a border container and automatically fills in any space not used by the other four optional regions. For example, if you apply a Dojo Border Container to an empty element on the page named namedTag3
, and specify myLayout
in the Name
input, the builder generates HTML code like the following output.
<div name="namedTag3" gutters="true" design="headline" style="width:700px;height:500px;padding:2px" dojoType="dijit.layout.BorderContainer">
<DIV dojotype="dijit.layout.ContentPane" splitter="true" region="top" style="">
<DIV dojotype="dijit.layout.ContentPane" splitter="true" region="leading" style="">
<DIV dojotype="dijit.layout.ContentPane" splitter="true" region="center" style="">
<DIV dojotype="dijit.layout.ContentPane" splitter="true" region="trailing" style="">
<DIV dojotype="dijit.layout.ContentPane" splitter="true" region="bottom" style="">
The code is placed on the named page location before other content related builders are applied to the generated regions.
If the Dojo Border Container is not within a fixed size (pixel-based size) HTML body element, it may not render correctly unless you specify the size of the border container itself in pixels. Because your page may be embedded within other pages (for example, a portal page), you often cannot guarantee that you are within a fixed size area. It is a best practice that you specify the absolute size of your border container in pixels in the Border Container Height
and Border Container Width
inputs. (For example, specify 700px instead of 75%.)
With a fixed size border container, you can specify a relative size (for example, 25%) that you wish a particular region to occupy within the container. You can also leave the individual region sizes blank and let the Dojo Border Container widget automatically determine the size based on the actual content of each region.
Parent topic: Builder help
About using the builder call editor
Locating control builder calls on pages