Elements

element <column>
Namespace:
http://schema.caplin.com/CaplinTrader/gridDefinitions
XML Representation Summary
<column
   
id
 = 
 xs:string
cellRenderer
 = 
 xs:string : "'caplin.element.factory.DefaultRendererType'"
headerRenderer
 = 
 xs:string : "'default'"
fields
 = 
 xs:string : "Value of id attribute"
displayName
 = 
 xs:string : "Value of id attribute"
cssClass
 = 
 xs:string : ""
width
 = 
 xs:integer : "100"
mandatory
 = 
 xs:boolean : "false"
clear
 = 
 xs:boolean : "false"
fixed
 = 
 xs:boolean : "false"
primaryFieldType
 = 
 ("number" | "text" | "tenor") : "number"
resizable
 = 
 xs:boolean : "true"
sortable
 = 
 xs:boolean : "true"
tooltip
 = 
 xs:string : ""
/>
Parent elements (1):
Description
Defines a single column of a grid or grid template.
Attribute Detail
cellRenderer
Type:
xs:string, predefined
Use:
optional
Default:
"'caplin.element.factory.DefaultRendererType'"
Identifies the element renderer that renders data in the cells of this column. This attribute can either be set to the fully qualified name of a JavaScript class or the logical name of an element renderer. The logical name of an element renderer is defined by the <renderer> tag, described in the renderers XML schema.
clear
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Flag to indicate whether a column should clear the values it was displaying when the containing grid is re-shown after being hidden. When a grid is hidden (for example, when the tab for another grid in a panel is selected), the columns of the grid are not updated by the data provider until the grid is re-shown. Valid settings are "true" (clear previous values) and "false" (display previous values until they are updated by the data provider).
cssClass
Type:
xs:string, predefined
Use:
optional
Default:
""
The name of a CSS class that styles the column text. The style will cascade with other CSS styles applied to the column text.
displayName
Type:
xs:string, predefined
Use:
optional
Default:
"Value of id attribute"
The text to be displayed in the column header.
fields
Type:
xs:string, predefined
Use:
optional
Default:
"Value of id attribute"
The names of the fields to be sent to the control renderer for display in this column. This is a comma separated list. The first field in the list is known as the "primary field", and is the field that is used to sort or filter the column (either in the XML configuration or when the end user sorts or filters the column). Also see the 'primaryFieldType' and 'sortOrder' attributes.
fixed
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Flag to indicate whether or not the position of the column is fixed (see <columnReorderingDecorator>). Fixed columns cannot be moved, and other columns cannot be moved to the left of a fixed column. Valid values are "true" (fixed) and "false" (not fixed).
headerRenderer
Type:
xs:string, predefined
Use:
optional
Default:
"'default'"
The logical name of the renderer for the header of the column. This is defined in a separate set of XML configuration for the renderers.
id
Type:
xs:string, predefined
Use:
required
An identifier for this column. This should be unique within the inheritance hierarchy of the grid, with the following exception. A child grid can use an id for one of its columns that is the same as an id used by one of it parents. In this situation, if the parent has defined a attribute of the column that the child has not defined, the child will inherit the attribute value from the parent.
mandatory
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Flag to indicate whether or not a column must be present in a grid. Mandatory columns cannot be removed from a grid. Valid values are "true" (mandatory) and "false" (not mandatory).
primaryFieldType
Type:
anonymous simpleType (restriction of xs:token)
Use:
optional
Default:
"number"
The type of the primary field displayed by this column. A column can display more than one field, and the primary field is the first field in the comma separated list of fields defined by the 'fields' attribute. Valid values are "number", "text" and "tenor". If set to "number", then the column can be sorted by the numerical value of the primary field. If set to "text", then the column can be sorted by the alphabetical value of the primary field. If set to "tenor", then the column can be sorted by tenor (for example "1Y" has the same sort value as "12M"). If set to "tenor" and the primary field is not a tenor, then the column can be sorted numerically if the field value starts with a number, and alphabetically otherwise.
resizable
Type:
xs:boolean, predefined
Use:
optional
Default:
"true"
Flag to indicate whether or not the width of the column is fixed (see <columnResizingDecorator>). Valid values are "true" (fixed) and "false" (not fixed).
sortable
Type:
xs:boolean, predefined
Use:
optional
Default:
"true"
Flag to indicate whether or not the grid can be sorted by this column (see <columnSortDecorator>). Valid values are "true" (can be sorted) and "false" (cannot be sorted).
tooltip
Type:
xs:string, predefined
Use:
optional
Default:
""
The text for the tooltip that is displayed when the mouse pointer hovers over the column header.
width
Type:
xs:integer, predefined
Use:
optional
Default:
"100"
The default width of the column in pixels.