treeNodes - Child Nodes

Provides selection data for a value picker.

Category

basics

Syntax

<xe:this.treeNodes>
	<xe:basicContainerNode attributes>content</xe:basicContainerNode> |
	<xe:basicLeafNode attributes>content</xe:basicLeafNode> |
	<xe:beanTreeNode attributes>content</xe:beanTreeNode> |
	<xe:dominoViewEntriesTreeNode attributes>content</xe:dominoViewEntriesTreeNode> |
	<xe:dominoViewListTreeNode attributes>content</xe:dominoViewListTreeNode> |
	<xe:loginTreeNode attributes>content</xe:loginTreeNode> |
	<xe:pageTreeNode attributes>content</xe:pageTreeNode> |
	<xe:repeatTreeNode attributes>content</xe:repeatTreeNode> |
	<xe:separatorTreeNode attributes>content</xe:separatorTreeNode> |
	<xe:userTreeNode attributes>content</xe:userTreeNode>
	...
</xe:this.treeNodes>
Table 1. Properties for xe:basicContainerNode
Property Description
<xe:this.children>nodes</xe:this.children> Child nodes with content the same as <xe:this.treeNodes>.
enabled="true|false" Whether the node is enabled. Defaults to true. For example, displays a node as text instead of a link, or a button is grayed out.
href="href" Relative or absolute URL to which can be used as a link.
image="name" Name of image displayed by the node.
imageAlt="text" Alternate text if the image cannot be viewed.
imageHeight="50%|30px|10em|2cm|auto|inherit" Image height.
imageWidth="50%|30px|10em|2cm|auto|inherit" Image width.
label="text" Text displayed by the node.
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
onClick="script" A script that executes if the node is clicked and href is empty.
rendered="true|false" Whether the node is visible on the rendered page.
role="text" Text that can be used by assistive technologies to determine the purpose of the node.
selected="true|false" Whether the node appears as selected when it is loaded.
submitValue="text" Value submitted by the parent control if this node is selected. Use context.getSubmittedValue in an events.action area or XSP.getSubmitValue() in an events.script area to refer to the submitted value.
transparent="true|false" Whether the node shows its children as nodes.
title="text" Advisory title for assistive technologies.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.
Table 2. Properties for xe:basicLeafNode
Property Description
enabled="true|false" Whether the node is enabled. Defaults to true. For example, displays a node as text instead of a link, or a button is grayed out.
href="href" Relative or absolute URL to which can be used as a link.
image="name" Name of image displayed by the node.
imageAlt="text" Alternate text if the image cannot be viewed.
imageHeight="50%|30px|10em|2cm|auto|inherit" Image height.
imageWidth="50%|30px|10em|2cm|auto|inherit" Image width.
label="text" Text displayed by the node.
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
onClick="script" A script that executes if the node is clicked and href is empty.
rendered="true|false" Whether the node is visible on the rendered page.
role="text" Text that can be used by assistive technologies to determine the purpose of the node.
selected="true|false" Whether the node appears as selected when it is loaded.
submitValue="text" Value submitted by the parent control if this node is selected. Use context.getSubmittedValue in an events.action area or XSP.getSubmitValue() in an events.script area to refer to the submitted value.
transparent="true|false" Whether the node shows its children as nodes.
title="text" Advisory title for assistive technologies.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.
Table 3. Properties for xe:beanTreeNode
Property Description
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
nodeBean="name" Name of class or managed bean that provides the node or node list. Should implement the ITreeNode interface.
Table 4. Properties for xe:dominoViewEntriesTreeNode
Property Description
databaseName="name" Name of a Domino database..
enabled="true|false" Whether the node is enabled. Defaults to true. For example, displays a node as text instead of a link, or a button is grayed out.
href="href" Relative or absolute URL to which can be used as a link.
image="name" Name of image displayed by the node.
imageAlt="text" Alternate text if the image cannot be viewed.
imageHeight="50%|30px|10em|2cm|auto|inherit" Image height.
imageWidth="50%|30px|10em|2cm|auto|inherit" Image width.
keys="keys" Key or array of keys that filter a view based on sorted column values as in getAllDocumentsByKey.
keysExactMatch="true|false" Whether keys require an exact match. Defaults to a partial match.
label="text" Text displayed by the node.
labelColumn="name" Name of a view column to display as the node label.
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
onClick="script" A script that executes if the node is clicked and href is empty.
rendered="true|false" Whether the node is visible on the rendered page.
role="text" Text that can be used by assistive technologies to determine the purpose of the node.
selected="true|false" Whether the node appears as selected when it is loaded.
submitValue="text" Value submitted by the parent control if this node is selected. Use context.getSubmittedValue in an events.action area or XSP.getSubmitValue() in an events.script area to refer to the submitted value.
title="text" Advisory title for assistive technologies.
var="name" Name of a request scope variable where the view entry object is made available.
viewName="name" Name of a Domino view.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.
Table 5. Properties for xe:dominoViewListTreeNode
Property Description
databaseName="name" Name of a Domino database..
enabled="true|false" Whether the node is enabled. Defaults to true. For example, displays a node as text instead of a link, or a button is grayed out.
filter="regexp" Regular expression to filter the view or folder names to be displayed.
folders="true|false" Whether folders are processed. Defaults to true.
href="href" Relative or absolute URL to which can be used as a link.
image="name" Name of image displayed by the node.
imageAlt="text" Alternate text if the image cannot be viewed.
imageHeight="50%|30px|10em|2cm|auto|inherit" Image height.
imageWidth="50%|30px|10em|2cm|auto|inherit" Image width.
label="text" Text displayed by the node.
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
onClick="script" A script that executes if the node is clicked and href is empty.
rendered="true|false" Whether the node is visible on the rendered page.
role="text" Text that can be used by assistive technologies to determine the purpose of the node.
selected="true|false" Whether the node appears as selected when it is loaded.
submitValue="text" Value submitted by the parent control if this node is selected. Use context.getSubmittedValue in an events.action area or XSP.getSubmitValue() in an events.script area to refer to the submitted value.
title="text" Advisory title for assistive technologies.
var="name" Name of a request scope variable where the view entry object is made available.
views="true|false" Whether views are processed. Defaults to true.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.
Table 6. Properties for xe:loginTreeNode
Property Description
enabled="true|false" Whether the node is enabled. Defaults to true. For example, displays a node as text instead of a link, or a button is grayed out.
image="name" Name of image displayed by the node.
imageAlt="text" Alternate text if the image cannot be viewed.
imageHeight="50%|30px|10em|2cm|auto|inherit" Image height.
imageWidth="50%|30px|10em|2cm|auto|inherit" Image width.
label="text" Text displayed by the node.
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
rendered="true|false" Whether the node is visible on the rendered page.
role="text" Text that can be used by assistive technologies to determine the purpose of the node.
selected="true|false" Whether the node appears as selected when it is loaded.
title="text" Advisory title for assistive technologies.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.
Table 7. Properties for xe:pageTreeNode
Property Description
<xe:this.children>nodes</xe:this.children> Child nodes with content the same as <xe:this.treeNodes>.
enabled="true|false" Whether the node is enabled. Defaults to true. For example, displays a node as text instead of a link, or a button is grayed out.
image="name" Name of image displayed by the node.
imageAlt="text" Alternate text if the image cannot be viewed.
imageHeight="50%|30px|10em|2cm|auto|inherit" Image height.
imageWidth="50%|30px|10em|2cm|auto|inherit" Image width.
label="text" Text displayed by the node.
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
pageName="name" Name of XPage. Generates a link and sets the selection flag if no selection formula is present.
queryString="text" Query string appended to the URL.
rendered="true|false" Whether the node is visible on the rendered page.
role="text" Text that can be used by assistive technologies to determine the purpose of the node.
selected="true|false" Whether the node appears as selected when it is loaded.
selection="regexp" Regular expression for selecting the item.
title="text" Advisory title for assistive technologies.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.
Table 8. Properties for xe:repeatTreeNode
Property Description
<xe:this.children>nodes</xe:this.children> Child nodes with content the same as <xe:this.treeNodes>.
indexVar="name" Request scope variable name where the current repeat index is made available.
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
value="text" Value up to which items are repeated.
var="name" Request scope variable name under which the current object is made available.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.
Table 9. Properties for xe:separatorTreeNode
Property Description
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
rendered="true|false" Whether the node is visible on the rendered page.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.
Table 10. Properties for xe:userTreeNode
Property Description
enabled="true|false" Whether the node is enabled. Defaults to true. For example, displays a node as text instead of a link, or a button is grayed out.
image="name" Name of image displayed by the node.
imageAlt="text" Alternate text if the image cannot be viewed.
imageHeight="50%|30px|10em|2cm|auto|inherit" Image height.
imageWidth="50%|30px|10em|2cm|auto|inherit" Image width.
label="text" Text displayed by the node.
loaded="true|false" Whether the tag instance should be created when the page is loading. Defaults to true.
rendered="true|false" Whether the node is visible on the rendered page.
role="text" Text that can be used by assistive technologies to determine the purpose of the node.
selected="true|false" Whether the node appears as selected when it is loaded.
title="text" Advisory title for assistive technologies.
userField="name" Name of field for displaying the user data. Depends on the data provider. Defaults to displayName. For Domino, you can use commonName, abbreviatedName, canonicalName, and so on.
style="style(s)" CSS styles to be applied.
styleClass="class(es)" CSS style classes to be applied.

Usage

In Design mode, click All Properties and look for treeNodes under basics.

Examples

Here an Accordion control has three container nodes, each of which has three leaf nodes. The user expands a container node by clicking it. Clicking a leaf node displays its submitted value in a computed field.
<xp:label value="Submitted value: " id="label1"></xp:label>
<xp:text escape="true" id="computedField1"
	value="#{requestScope.svalue}" style="font-weight:bold">
</xp:text>
<xe:accordion id="accordion1" style="width:400px; height:144px;">
	<xe:this.treeNodes>
		<xe:basicContainerNode label="Container one">
			<xe:this.children>
				<xe:basicLeafNode
					submitValue="Container one, choice one" label="Choice one">
				</xe:basicLeafNode>
				<xe:basicLeafNode
					submitValue="Container one, choice two" label="Choice two">
				</xe:basicLeafNode>
				<xe:basicLeafNode
					submitValue="Container one, choice three" label="Choice three">
				</xe:basicLeafNode>
			</xe:this.children>
		</xe:basicContainerNode>
		<xe:basicContainerNode label="Container two">
			<xe:this.children>
				<xe:basicLeafNode
					submitValue="Container two, choice one" label="Choice one">
				</xe:basicLeafNode>
				<xe:basicLeafNode
					submitValue="Container two, choice two" label="Choice two">
				</xe:basicLeafNode>
				<xe:basicLeafNode
					submitValue="Container two, choice three" label="Choice three">
				</xe:basicLeafNode>
			</xe:this.children>
		</xe:basicContainerNode>
		<xe:basicContainerNode label="Container three">
			<xe:this.children>
				<xe:basicLeafNode
					submitValue="Container three, choice one" label="Choice one">
				</xe:basicLeafNode>
				<xe:basicLeafNode
					submitValue="Container three, choice two" label="Choice two">
				</xe:basicLeafNode>
				<xe:basicLeafNode
					submitValue="Container three, choice three" label="Choice three">
				</xe:basicLeafNode>
			</xe:this.children>
		</xe:basicContainerNode>
	</xe:this.treeNodes>
	<xp:eventHandler event="onItemClick" submit="true"
		refreshMode="partial" refreshId="computedField1">
		<xe:this.action>
			<![CDATA[#{javascript:requestScope.svalue = context.getSubmittedValue()}]]>
		</xe:this.action>
	</xp:eventHandler>
</xe:accordion>