This section discusses properties that can be configured for the Matrix and Matrix Column components.
Matrix Properties
The following properties can be configured for Matrix components.
| Property |
Description |
| Name |
The name of the matrix in the Component Hierarchy palette. |
| Rendering Model |
The rendering model of the matrix, such as shallow, deep, and hierarchical. Shallow and deep are flat models, the hierarchical model is rendered as a tree. Shallow only paints direct children of the context node. Deep paints all descendants. Hierarchical paints all children but can also be performance-tuned to paint a given number of generations at a time. Because this allows nodes to be fetched only when a user expands a given branch, application performance is faster. For more information, see Rendering Models. |
| Rendering Ctx |
The rendering context (jsxid) of the parent record whose children or descendants will be painted. The context node, the reference or starting point to begin rendering, isn't rendered. |
| Selection Model |
The selection model, such as single row, multiple rows, and not selectable. |
| Paging Model |
The paging model for how and when objects are rendered on-screen, such as No Paging, 2-pass, Chunked, Paged, and Stepped (Hierarchical). For more information, see Paging Models. |
| Panel Pool Size |
The maximum allowed number of pooled panels when the rendering model is Paged. |
| Rows Per Panel |
The number of rows in a panel when the rendering model is Paged. |
| Panel Queue Size |
The maximum allowed number of panels in the paint queue when the rendering model is Paged. |
| Scroll Info |
The info label to display when scrolling a paged instance. |
| Header Height |
The height of the header in implied pixels. Set to 0 if the column doesn't use a header. |
| Row Height |
The height of the data rows. The paging model, Paged, supports only fixed row height. All other paging models support fixed and flexible heights. If a row height isn't specified (null), the default height (Matrix.DEFAULT_ROW_HEIGHT) is used. If the specified row height is 0, flexible height is used. For a fixed row height, specify a positive integer in implied pixels, such as 14. |
| Header Border |
The border for the header row. |
| Body Border |
The border for the body. To set the border for an individual column, update the APIs for the given column. |
| Scale Width |
Whether or not the column width should be scaled to fit in the visible region or if a horizontal scrollbar should be used. The Matrix automatically provides a horizontal scrollbar when the aggregate width of its columns is greater than the overall Matrix width. A scale width flag can also be set to reduce column widths until the content fits exactly within the view port constraints. When rendering with a scaled width, it's often useful to include a wild card width (*) on those columns whose width should be flexible. Percentage and pixel values are also supported. Note that the unit identifier for pixels is implied and should not be specified as px. |
| Hide H-Scroller |
Whether or not to hide the horizontal scrollbar. Set to true to hide it. |
| Hide V-Scroller |
Whether or not to hide the vertical scrollbar. Set to true to hide it. |
| Render Nav |
In a hierarchical tree view, whether or not to render the navigation controls on the first column. |
| Close Icon |
In a hierarchical tree view, the 16x16 transparent GIF used to signal that clicking the item collapses its contents. |
| Open Icon |
In a hierarchical tree view, the 16x16 transparent GIF used to signal that clicking the item expands its contents. |
| Icon |
The icon to display in a hierarchical tree view. |
| Sort Path |
The attribute path to sort on, such as @jsxtext. |
| Sort Data Type |
The type of data for columns in this list or grid, such as text or a number. |
| Sort Direction |
Whether to sort in ascending (a-z) or descending (z-a) order. |
| Sortable |
Whether or not the Matrix will sort when a column header is clicked. |
| Resizable |
Whether or not the columns are resizable. |
| Reorderable |
Whether or not the columns can be reordered. |
| Fixed Columns |
The index (zero-based) of the first column that can be reordered. All columns of a lesser index can't be reordered. |
| Can Drag From |
If Enabled, this object supports drag events and allows any contained record to be dragged and dropped onto another container supporting drop. |
| Can Drag On |
If Enabled, this object can be the target of drop events. |
| Can Spy |
If true, this object can be spyglassed. A spyglass displays HTML returned from the jsxspy event when a row in the Matrix is hovered over. |
| Bound Menu |
A menu to display when a user right-clicks on a row in the Matrix. Specify the jsxname, the name of the menu component as displayed in the Component Hierarchy palette. |
| Tab Index |
Sets the tab index. When tabbing between controls, the index group that this component belongs to. |
| Focus Style |
The CSS styles to apply to a cell when it has cursor focus. For example, color:red. |
| Selection BG |
The URL of the background image to apply to the background of the selected cell or row to show that it's selected. For example, jsx:///images/matrix/select.gif. |
| Spy Styles |
The CSS styles to apply to a cell when the mouse hovers over the cell and a spyglass is applied. |
| XML Cache Id |
The string identifier of the cached CDF document with data. This string, which is the XML document name, displays in the Local Data Cache palette. |
| XML String |
The XML string (CDF) with data. |
| XML URL |
The URL of the CDF document with data. The file can be local or remote. Paths can be relative or absolute. |
| XML Transformers |
A comma-separated list of XSLT transformers. The source XML is transformed in a series by each of the transformers listed here before being placed in the XML cache. Specify each transformer as a URI to an XSLT file or the XML cache ID of an XSLT document. |
| Share Resources |
Whether to delete the associated CDF document when the component is recycled in the Component Hierarchy palette. If Share is specified, the document remains in cache after the component is recycled. The default value is Cleanup. |
| Annotation |
The annotation comment visible in a spyglass when you hover the mouse over the component in the Component Hierarchy palette. |
Matrix Column Properties
The following properties can be configured for Matrix Column components:
| Property |
Description |
| Att Name |
The named attribute whose content will be displayed on-screen, such as jsxtext. |
| Att Type |
The data type for the attribute, such as text or number. |
| Sort Att Name |
The attribute path to sort on, such as jsxtext. |
| Sort Att Type |
The data type for the attribute, such as text or number. |
| Triggers |
A comma-separated list of named attributes that when modified by another column will trigger this column's related cell to repaint. |
| Sortable |
Whether or not this column is sortable. |
| Resizable |
Whether or not this column is resizable. |
| Width |
The width of the column as implied pixels or a percentage. Wildcards(*)
are also supported. Note: Integer values take precedence over percentages. |
| Value Template |
The XSL template to generate the cell content. It must be a valid XSL template or a system-defined template identified by one of these — @image (jsximg), @unescape, @empty, or @default. For more information, see Content Formatting and Localization. |
| Format Handler |
The reformatting method to use on the cell data after it has been painted on-screen. You can also point to a named reformatter, including @unescape, @lookup, @message, @datetime, @date, @time, and @number. For more information, see Content Formatting and Localization. |
| Display |
Sets the CSS display property. When set to None, the column isn't rendered. |
| Caption |
The label for the column header. |
| Word Wrap |
Whether the text wraps or not. Setting to true, wraps the text. |
| Font Name |
The name of the font for rendering the label. |
| Font Size |
The pixel size of the font for rendering the label. |
| Font Weight |
The weight of the font for rendering the label, either bold or normal. The default value is Normal. |
| Color |
The color of the font for rendering the text. Specify as a predefined color name, RGB, or hexadecimal value. For example, red, rgb(255,0,0), or #ff0000. |
| BG Color |
The RGB value of the background fill. Specify the value as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000. |
| Background |
The CSS background definition. For example, background-image:url(abc.gif);background-repeat:repeat-x. |
| Padding |
The CSS padding value between the border and the contents of the cell. Specify a single value to use on all sides, such as 5, or a set of values separated by spaces for top, right, bottom, and left, such as 5 0 5 0. |
| Border |
The CSS border definition. Specified as one or four value sets (top, right, bottom, and left). Specified as: style width color. For example, solid 1px red;dashed 2px red;double 3px black; solid 1px red;. |
| Text Align |
The alignment of any contained object or text, such as Left, Center, and Right. |
| V-Align |
The valid CSS vertical alignment definition. |
| Cursor |
The valid CSS cursor definition, such as default, wait, or col-resize. |
| Bound Menu |
A menu to display when a user right-clicks on the header with the mouse. Specify the jsxname, the name of the menu component as displayed in the Component Hierarchy palette. |
| Tooltip |
The text to display when the mouse hovers over this header. Only text is supported. |
| Annotation |
The annotation comment visible in a spyglass when you hover the mouse over the component in the Component Hierarchy palette. |
|
|
