jsx3.gui.Matrix.ColumnAPI
| Object |
|---|
| Object Type | The JSX foundation class that this object is an instance of. |
| ID | The unique, system-assigned ID for this object. |
| Name | Sets the name assigned by the developer to identify this object. |
| CDF Mapping |
|---|
| Att Name | Sets the named attribute on the CDF record to which this column will map. |
| Att Type | Sets the data type for the named attribute to which this column is mapped. |
| Sort Att Name | Sets the named attribute on the CDF record which this column will sort on. |
| Sort Att Type | Sets the data type for the named sort attribute if one is used. |
| Triggers | Comma separated list of named attributes that when modified by another column will trigger this column's related cell to repaint. |
| Interaction |
|---|
| Sortable | Sets whether or not this column is sortable |
| Resizable | Sets whether or not this column is resizable. |
| Data Display |
|---|
| Width | Sets the width of the control as implied pixels or a percentage. |
| Value Template | The XSL template to generate the cell content. |
| Format Handler | Sets the reformatting method to use on the cell data after it has been painted on-screen. |
| Display | Sets the CSS display property. |
| Header Props |
|---|
| Caption | Sets the label for the column header. |
| Word Wrap | The word wrapping for this object's caption text. |
| Font Name | Sets the name of the font family. |
| Font Size | Sets the point size of the font. |
| Font Weight | Sets the weight of the font, such as bold or normal. |
| Color | Sets the color of the font. |
| BG Color | Sets the background color. |
| Background | Sets the CSS background definition, such as background-image:url(abc.gif);background-repeat:repeat-x;. |
| Padding | Sets the white-space gap between the outer edge/border of this object to its inner content. |
| Border | Sets the CSS border definition. |
| Text Align | Sets the alignment of any contained object or text. |
| V-Align | Sets the vertical-align CSS |
| Cursor | Sets the CSS cursor definition, such as default, wait, or col-resize. |
| Bound Menu | Sets the jsxname property for the context menu instance to display on a right-click. |
| Tooltip | Sets the text displayed when hovered over this object (text only). |
| Data Cell Props |
|---|
| Word Wrap | The word wrapping for this object's data cells. |
| Font Name | Sets the name of the font family. |
| Font Size | Sets the point size of the font. |
| Font Weight | Sets the weight of the font, such as bold or normal. |
| Color | Sets the color of the font. |
| BG Color | Sets the background color. |
| Padding | Sets the white-space gap between the outer edge/border of this object to its inner content. |
| Border | Sets the valid CSS border definition. |
| Text Align | Sets the alignment of any contained object or text. |
| Cursor | Sets the valid CSS cursor definition. |
| V-Align | Sets the vertical-align CSS |
| Metadata |
|---|
| Load Type | Sets the load type of this DOM branch. |
| Annotation | The annotation comment visible in the Component Hierarchy palette. |
| Help ID | A unique ID for use with context-sensitive help. |
Read-Only. The JSX foundation class that this object is an instance of.
Read-Only. The unique, system-assigned ID for this object.
Getter: getId()
Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname
Sets the named attribute on the CDF record to which this column will map. For example, jsxtext.
Getter: getPath()
Setter: setPath()
Property: jsxpath
Sets the data type for the named attribute to which this column is mapped.
Default Value: Text (jsx3.gui.Column.TYPETEXT)
Getter: getDataType()
Setter: setDataType()
Property: jsxdatatype
Allowed Values: - Text (
jsx3.gui.Matrix.Column.TYPE_TEXT) - Numerical (
jsx3.gui.Matrix.Column.TYPE_NUMBER)
Sets the named attribute on the CDF record which this column will sort on. For example, jsxtext.
Getter: getSortPath()
Setter: setSortPath()
Property: jsxsortpath
Sets the data type for the named sort attribute if one is used.
Default Value: Text (jsx3.gui.Column.TYPETEXT)
Getter: getSortType()
Setter: setSortType()
Property: jsxsortdatatype
Allowed Values: - Text (
jsx3.gui.Matrix.Column.TYPE_TEXT) - Numerical (
jsx3.gui.Matrix.Column.TYPE_NUMBER)
Comma separated list of named attributes that when modified by another column will trigger this column's related cell to repaint.
Default Value: Empty
Getter: getTriggers()
Setter: setTriggers()
Property: jsxtriggers
Sets whether or not this column is sortable
Getter: getCanSort()
Setter: setCanSort()
Property: jsxsort
Allowed Values: - True (
jsx3.Boolean.TRUE) - False (
jsx3.Boolean.FALSE)
Sets whether or not this column is resizable.
Getter: getResizable()
Setter: setResizable()
Property: jsxresize
Allowed Values: - True (
jsx3.Boolean.TRUE) - False (
jsx3.Boolean.FALSE)
Sets the width of the control as implied pixels or a percentage. Also supports wildcards(*). Note: Integer values take precedence over percentages.
Default Value: Empty
Getter: getWidth()
Setter: setWidth()
Property: jsxwidth
The XSL template to generate the cell content. Must be a valid XSL Template or a system-defined template identified by one of: @image (jsximg), @unescape, @empty, or @default.
Default Value: jsx3.gui.Matrix.TEMPLATES["default"]
Getter: getValueTemplate()
Setter: setValueTemplate()
Property: jsxvaluetemplate
Sets the reformatting method to use on the cell data after it has been painted on-screen. Can also point to a named reformatter, including @unescape, @lookup, @message, @datetime, @date, @time, and @number.
Default Value: Empty
Getter: getFormatHandler()
Setter: setFormatHandler()
Property: jsxformathandler
Sets the CSS display property. When set to None, this column will not be rendered in the view.
Default Value: Block (jsx3.gui.Block.DISPLAYBLOCK)
Getter: getDisplay()
Setter: setDisplay()
Property: jsxdisplay
Allowed Values: - Block (
jsx3.gui.Block.DISPLAYBLOCK) - None (
jsx3.gui.Block.DISPLAYNONE)
Sets the label for the column header.
Default Value: Empty
Getter: getText()
Setter: setText()
Property: jsxtext
The word wrapping for this object's caption text. If set to True, text wraps.
Default Value: false (jsx3.Boolean.FALSE)
Getter: getWrap()
Setter: setWrap()
Property: jsxwrap
Allowed Values: - True (
jsx3.Boolean.TRUE) - False (
jsx3.Boolean.FALSE)
Sets the name of the font family.
Default Value: jsx3.gui.Block.DEFAULTFONTNAME
Getter: getFontName()
Setter: setFontName()
Property: jsxfontname
Sets the point size of the font.
Default Value: jsx3.gui.Block.DEFAULTFONTSIZE
Getter: getFontSize()
Setter: setFontSize()
Property: jsxfontsize
Sets the weight of the font, such as bold or normal.
Default Value: Normal (jsx3.gui.Block.FONTNORMAL)
Getter: getFontWeight()
Setter: setFontWeight()
Property: jsxfontweight
Allowed Values: - Bold (
jsx3.gui.Block.FONTBOLD) - Normal (
jsx3.gui.Block.FONTNORMAL)
Sets the color of the font. Accepts CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: jsx3.gui.Block.DEFAULTCOLOR
Getter: getColor()
Setter: setColor()
Property: jsxcolor
Sets the background color. Accepts CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: The default background color specified in the static field, DEFAULTBACKGROUNDCOLOR, of the component class. For example, the default background color for a list is #f3f2f4 and is specified in jsx3.gui.List.DEFAULTBACKGROUNDCOLOR. See the API documentation for the component. For some components, this property is empty.
Getter: getBackgroundColor()
Setter: setBackgroundColor()
Property: jsxbgcolor
Sets the CSS background definition, such as background-image:url(abc.gif);background-repeat:repeat-x;.
Default Value: Empty
Getter: getBackground()
Setter: setBackground()
Property: jsxbg
Sets the white-space gap between the outer edge/border of this object to its inner content. Specified as one or four pixel values (top, right, bottom, and left). For example, 5 or 8 4 8 4.
Default Value: Empty
Getter: getPadding()
Setter: setPadding()
Property: jsxpadding
Sets 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;.
Default Value: Empty
Getter: getBorder()
Setter: setBorder()
Property: jsxborder
Sets the alignment of any contained object or text.
Default Value: Left (jsx3.gui.Block.ALIGNLEFT)
Getter: <code>getTextAlign</code>()
Setter: setTextAlign()
Property: jsxtextalign
Allowed Values: - Left (
jsx3.gui.Block.ALIGNLEFT) - Center (
jsx3.gui.Block.ALIGNCENTER) - Right (
jsx3.gui.Block.ALIGNRIGHT)
Sets the vertical-align CSS
Default Value: Empty
Getter: getVAlign()
Setter: setVAlign()
Property: jsxvalign
Sets the CSS cursor definition, such as default, wait, or col-resize.
Default Value: Empty
Getter: getCursor()
Setter: setCursor()
Property: jsxcursor
Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu
Sets the text displayed when hovered over this object (text only).
Default Value: Empty
Getter: getTip()
Setter: setTip()
Property: jsxtip
The word wrapping for this object's data cells. If set to True, text wraps.
Default Value: false (jsx3.Boolean.FALSE)
Getter: getCellWrap()
Setter: setCellWrap()
Property: jsxcellwrap
Allowed Values: - True (
jsx3.Boolean.TRUE) - False (
jsx3.Boolean.FALSE)
Sets the name of the font family.
Default Value: jsx3.gui.Block.DEFAULTFONTNAME
Getter: getCellFontName()
Setter: setCellFontName()
Property: jsxcellfontname
Sets the point size of the font.
Default Value: jsx3.gui.Block.DEFAULTFONTSIZE
Getter: getCellFontSize()
Setter: setCellFontSize()
Property: jsxcellfontsize
Sets the weight of the font, such as bold or normal.
Default Value: Normal (jsx3.gui.Block.FONTNORMAL)
Getter: getCellFontWeight()
Setter: setCellFontWeight()
Property: jsxcellfontweight
Allowed Values: - Bold (
jsx3.gui.Block.FONTBOLD) - Normal (
jsx3.gui.Block.FONTNORMAL)
Sets the color of the font. Accepts valid CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: jsx3.gui.Block.DEFAULTCOLOR
Getter: getCellColor()
Setter: setCellColor()
Property: jsxcellcolor
Sets the background color. Accepts valid CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Default Value: The default background color specified in the static field, DEFAULTBACKGROUNDCOLOR, of the component class. For example, the default background color for a list is #f3f2f4 and is specified in jsx3.gui.List.DEFAULTBACKGROUNDCOLOR. See the API documentation for the component. For some components, this property is empty.
Getter: getCellBackgroundColor()
Setter: setCellBackgroundColor()
Property: jsxcellbgcolor
Sets the white-space gap between the outer edge/border of this object to its inner content. Specified as one or four pixel values (top, right, bottom, and left). For example, 5 or 8 4 8 4.
Default Value: Empty
Getter: getCellPadding()
Setter: setCellPadding()
Property: jsxcellpadding
Sets the valid 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;.
Default Value: Empty
Getter: getCellBorder()
Setter: setCellBorder()
Property: jsxcellborder
Sets the alignment of any contained object or text.
Default Value: Left (jsx3.gui.Block.ALIGNLEFT)
Getter: <code>getTextAlign</code>()
Setter: setCellTextAlign()
Property: jsxcelltextalign
Allowed Values: - Left (
jsx3.gui.Block.ALIGNLEFT) - Center (
jsx3.gui.Block.ALIGNCENTER) - Right (
jsx3.gui.Block.ALIGNRIGHT)
Sets the valid CSS cursor definition.
Default Value: Empty
Getter: getCellCursor()
Setter: setCellCursor()
Property: jsxcellcursor
Sets the vertical-align CSS
Default Value: Empty
Getter: getCellVAlign()
Setter: setCellVAlign()
Property: jsxcellvalign
Sets the load type of this DOM branch.
Default Value: Normal (jsx3.app.Model.LT_NORMAL)
Getter: getLoadType()
Setter: setLoadType()
Property: jsxloadtype
Allowed Values: - Normal (
jsx3.app.Model.LT_NORMAL) - Paint Async. (
jsx3.app.Model.LT_SLEEP_PAINT) - Deserialize Async. (
jsx3.app.Model.LT_SLEEP_DESER) - Paint & Deser. Async. (
jsx3.app.Model.LT_SLEEP_PD) - Paint on Show (
jsx3.app.Model.LT_SHOW_PAINT) - Deserialize on Show (
jsx3.app.Model.LT_SHOW_DESER)
The annotation comment visible in the Component Hierarchy palette.
Property: jsxannotation
A unique ID for use with context-sensitive help.
Getter: getHelpId()
Setter: setHelpId()
Property: jsxhelpid
Copyright © 2001-2007, TIBCO Software Inc.