jsx3.gui.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. |
| Width | Sets the width. |
| Column |
|---|
| Text/HTML | Sets the text/HTML content to be displayed on-screen. |
| Mask Name | The jsxname property for the edit mask that this column should use. |
| Path | Sets the selection path for this column of data. |
| Sortable | Sets whether the parent list/grid can be sorted on this column. |
| Sort Path | Sets the CDF attribute to use to sort the data of the list when sorting on this column. |
| Sort Data Type | Sets the assumed data type of this column, which affects the sort order if this column is used for sorting the data. |
| Resizable | Sets whether or not the column can be resized. |
| Vertical Align | Sets the vertical alignment for the header cell text. |
| Word Wrap | Sets the word wrapping for the header cell text. |
| Font |
|---|
| 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. |
| Box |
|---|
| BG Color | Sets the background color. |
| Text Align | Sets the alignment of any contained object or text. |
| CSS Override | Convenience method for extending this object. |
| Display | Sets the CSS display property. |
| Interaction |
|---|
| 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. |
| Accessibility |
|---|
| Tooltip | Sets the text displayed when hovered over this object (text only). |
| Data Row |
|---|
| XSL Template | Sets the XSLT fragment for any custom template to render the cells for this column. |
| CSS Rule Name | Sets the named CSS rule(s) to use. |
| 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 width. This value is applied as an implied pixel or a percentage. For example, 100 or 25%.
Default Value: jsx3.gui.Column.DEFAULTWIDTH
Getter: getWidth()
Setter: setWidth()
Property: jsxwidth
Sets the text/HTML content to be displayed on-screen.
Default Value: Empty
Getter: getText()
Setter: setText()
Property: jsxtext
The jsxname property for the edit mask that this column should use.
Getter: getEditMask()
Setter: setEditMask()
Property: jsxmask
Sets the selection path for this column of data. Typically this is simply the name of the attribute, such as jsxtext, social, phone.
Default Value: @jsxid
Getter: getPath()
Setter: setPath()
Property: jsxpath
Sets whether the parent list/grid can be sorted on this column. Choose Parent-Specified to have the parent list/grid specify if this column is sortable.
Default Value: Parent-Specified (jsx3.Boolean.TRUE)
Getter: getCanSort()
Setter: setCanSort()
Property: jsxsort
Allowed Values: - Parent-Specified (
jsx3.Boolean.TRUE) - Fixed (
jsx3.Boolean.FALSE)
Sets the CDF attribute to use to sort the data of the list when sorting on this column.
Default Value: @path
Getter: getSortPath()
Setter: setSortPath()
Property: jsxsortpath
Sets the assumed data type of this column, which affects the sort order if this column is used for sorting the data.
Default Value: Text (jsx3.gui.Column.TYPETEXT)
Getter: getDataType()
Setter: setDataType()
Property: jsxdatatype
Allowed Values: - Text (
jsx3.gui.Column.TYPETEXT) - Numerical (
jsx3.gui.Column.TYPENUMBER)
Sets whether or not the column can be resized. Choose Parent-Specified to have the parent list/grid specify if this column is resizable.
Default Value: Parent-Specified (jsx3.Boolean.TRUE)
Getter: getResizable()
Setter: setResizable()
Property: jsxresize
Allowed Values: - Parent-Specified (
jsx3.Boolean.TRUE) - Fixed (
jsx3.Boolean.FALSE)
Sets the vertical alignment for the header cell text.
Default Value: Top (jsx3.gui.Column.VALIGNTOP)
Getter: getVAlign()
Setter: setVAlign()
Property: jsxvalign
Allowed Values: - Top (
jsx3.gui.Column.VALIGNTOP) - Middle (
jsx3.gui.Column.VALIGNMIDDLE)
Sets the word wrapping for the header cell text.
Default Value: Truncate (jsx3.Boolean.FALSE)
Getter: getWrap()
Setter: setWrap()
Property: jsxwrap
Allowed Values: - Wrap (
jsx3.Boolean.TRUE) - Truncate (
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 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)
Convenience method for extending this object. CSS properties affecting layout, including border-width, padding, margin, width, and height are strongly discouraged, as they may interfere with the framework's internal box models. Since some controls are composited from multiple HTML elements, some styles may not cascade to nested elements.
Instance Properties are the preferred method for applying styles.
Getter: getCSSOverride()
Setter: setCSSOverride()
Property: jsxstyleoverride
Sets the CSS display property. When set to None, content is hidden AND the container collapses.
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 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
Sets the XSLT fragment for any custom template to render the cells for this column.
Getter: getXSLString()
Setter: setXSLString()
Property: jsxxsl
Sets the named CSS rule(s) to use. Rules that specify border-width, padding, margin, width, and height are strongly discouraged. Multiple rules may be specified, delimited with a space. For example, label emphasis. Since some controls are composited from multiple HTML elements, some rule styles may not cascade to nested elements.
Dynamic Properties are the preferred method for applying global styles.
Getter: getClassName()
Setter: setClassName()
Property: jsxclassname
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.