vco:ListPane Component

The vco:ListPane component displays a list of objects in a Web view, and displays an object's details when the user selects the object in the list.

Properties

The vco:ListPane component defines the following properties.

Name	Type	Description
`attribute`	String	A Web view attribute that references an array of objects that you define in the Orchestrator client. The array of objects appears in the vco:ListPane component in the Web view.
`action`	String	A Web view attribute that references an action. The action must return an array of objects.
`actionParameters`	Array of objects	Array of parameters that an action requires. If the parameter is a Web view attribute, use the syntax `attribute:myAttribute`.
`url`	String	The URL of the content of the list. Returns a JavaScript Object Notation (JSON) string.
`detailUrl`	String	The URL of the HTML page in which to display the details of an object in the list. The HTML page that `detailUrl` refers to must include a reference to a Web view component that implements the WebObjectComponent class.
`detailParameterName`	String	Name of the parameter that stores the ID of the item. Default is `itemId`.
`updateFrequency`	Integer	Time in milliseconds before the list of objects refreshes. Default is 0. If you do not set the property, the list never refreshes.
`showHeader`	Boolean	Displays the filtering table header. Default is `false`.
`jsonIdKey`	String	Name of the JSON ID key.
`jsonStateKey`	String	Name of the JSON state key. Default is `state`.
`jsonNameKey`	String	Name of the JSON name key. Default is `name`.
`jsonTypeKey`	String	Name of the JSON type key. Default is `type`.
`sizerWidth`	Integer	Width of the sizer method. Default is 9.
`sizeShare`	Integer	Width or height of a child of a SplitContainer. The value is relative to the `sizeShare` properties of other children. Default is 6, with the other columns set to 10.
`showState`	Boolean	Shows a state column if set to `true`. Default is `false`.

You must set at least one and only one of the attribute, url, or actions properties. If you do not set an attribute, url, or actions property, or if you set more than one of these properties together, the Web view returns an error.

Example: vco:ListPane Component

The following example displays a list of virtual machines in a pane of a Web view.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" 
	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" 
	version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en"> 

<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> 
	<title>
		<span jwcid="@Insert" value="ognl:webview.name">Page Title</span>
		 | Home
	</title> 
</head> 

<body> 
	<div jwcid="@Border"> 
		<h1>Virtual Machine List</h1>
	<div jwcid="vmList@vco:ListPane" 
			action="getVirtualMachineList"
			actionParameters="attribute:vmFolder"
			detailUrl="system/partials/virtual_machine.html" > 
				Select a virtual machine on the left to display it. 
	</div>
	</div> 
</body> 
</html>