jsx3.gui.TableAPI
| 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. |
| Models |
|---|
| Rendering Ctxt | Sets the jsxid for the parent record whose immediate child records will be painted. |
| Selection Model | Sets the selection model. |
| Column Profile |
|---|
| Columns | The table control defines its columns via an instance property instead of using the General Interface DOM as is common with other controls. |
| Table Box |
|---|
| BG Color | Sets the background color for the table (header and data). |
| Header Height | Sets the height of the header row in implied pixels. |
| Border | Sets the CSS border definition. |
| Table 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. |
| Header CSS |
|---|
| Background | Sets the CSS background property for the HTML row containing the column headers. |
| Style | Sets the CSS style properties for the HTML row containing the column headers. |
| Class | Sets the CSS rule for the HTML row containing the column headers. |
| Row CSS |
|---|
| Style | Sets the CSS style properties for the HTML row element(s) containing the table data. |
| Class | Sets the CSS rule for the HTML row element(s) containing the table data. |
| Style (Alt) | Sets the CSS style properties for the HTML row element(s) containing the alternating table data rows. |
| Class (Alt) | Sets the CSS rule for the HTML row element(s) containing the alternating table data rows. |
| Cell CSS |
|---|
| Style | Sets the CSS style properties that will be inlined on every HTML cell in the body of the table. |
| Class | Sets the CSS rule that will be applied to every HTML cell in the body of the table. |
| Cell Content |
|---|
| Value Template | The XSL template to generate the cell content. |
| Text Wrap | The word wrapping for this object's data cells. |
| Interaction |
|---|
| Sort Path | Sets the attribute path to sort on, such as jsxtext. |
| Sort Data Type | Sets the default data type for columns in this list/grid. |
| Sort Direction | Sets whether the Table is sorted ascending (a-z) or descending (z-a). |
| Sortable | Sets whether or not the Table is sortable. |
| Bound Menu | Sets the jsxname property for the context menu instance to display on a right-click. |
| Tab Index | Sets the tab index. |
| Required | Determines if the form input field is required. |
| Interaction Styles |
|---|
| Selection BG | Sets the URL of the background-image to apply to the cell/row background to designate it as selected. |
| XML/XSL |
|---|
| XML Cache Id | Sets the cache ID for the XML document this object is mapped to. |
| XML String | Sets an XML document as a string. |
| XML URL | Sets the URL for the resource. |
| XML Transformers | A comma-separated list of XSLT transformers. |
| Share Resources | If set to Share, this object does not delete its associated document from the cache when removed from the DOM. |
| XML Async | If set to Asynchronous and the XML data source of this control is loaded from a URL, then the data is loaded asynchronously and a loading message is displayed in this control until the data loads. |
| XML Bind | If set to Bound this control automatically repaints every time its XML cache document changes. |
| 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 jsxid for the parent record whose immediate child records will be painted.
Default Value: jsxroot (this is the ID used by the <data> node)
Getter: getRenderingContext()
Setter: setRenderingContext()
Property: jsxrenderingcontext
Sets the selection model.
Default Value: Single Row (jsx3.gui.Table.SELECTION_ROW)
Getter: getSelectionModel()
Setter: setSelectionModel()
Property: jsxselectionmodel
Allowed Values: - Not Selectable (
jsx3.gui.Table.SELECTION_UNSELECTABLE) - Single Row (
jsx3.gui.Table.SELECTION_ROW) - Multi-row (
jsx3.gui.Table.SELECTION_MULTI_ROW)
The table control defines its columns via an instance property instead of using the General Interface DOM as is common with other controls.
Getter: getColumnProfile()
Setter: setColumnProfile()
Property: jsxcolumnprofile
Sets the background color for the table (header and data). Accepts CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.
Getter: getBackgroundColor()
Setter: setBackgroundColor()
Property: jsxbgcolor
Sets the height of the header row in implied pixels. Only positive integers are allowed. Set to 0 if the table does not use a header.
Default Value: jsx3.gui.Table.DEFAULT_HEADER_HEIGHT. See the API documentation for this component.
Getter: getHeaderHeight()
Setter: setHeaderHeight()
Property: jsxheaderheight
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 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 CSS background property for the HTML row containing the column headers. For example, background-image:url(abc.gif);.
Default Value: Empty
Getter: getBackground()
Setter: setBackground()
Property: jsxbg
Sets the CSS style properties for the HTML row containing the column headers. Multiple properties are supported. For example: background-color:gray;. The following CSS properties (those affecting layout and position) are not allowed: width, height, left, top, position, overflow, border, padding, margin.
Getter: getHeaderStyle()
Setter: setHeaderStyle()
Property: jsxheaderstyle
Sets the CSS rule for the HTML row containing the column headers. Multiple rules are supported. For example: boldText titleText. The following CSS properties (those affecting layout and position) are not allowed for the rule: width, height, left, top, position, overflow, border, padding, margin.
Getter: getHeaderClass()
Setter: setHeaderClass()
Property: jsxheaderclass
Sets the CSS style properties for the HTML row element(s) containing the table data. Every row will apply the properties defined by this value, unless an alternate row style is used, in which case, the properties are alternated between this value and the value applied by setAlternateRowStyle. Multiple properties are supported. For example: background-color:white;font-family:Arial;.
Getter: getRowStyle()
Setter: setRowStyle()
Property: jsxrowstyle
Sets the CSS rule for the HTML row element(s) containing the table data. Every row will apply the rule defined by this value, unless an alternate row rule is used, in which case, the rule (classname) is alternated between this value and the value applied by setAlternateRowClass. Multiple rules are supported. For example: bodyText normalText.
Getter: getRowClass()
Setter: setRowClass()
Property: jsxrowclass
Sets the CSS style properties for the HTML row element(s) containing the alternating table data rows. Multiple properties are supported. For example: background-color:red;.
Getter: getAlternateRowStyle()
Setter: setAlternateRowStyle()
Property: jsxaltrowstyle
Sets the CSS rule for the HTML row element(s) containing the alternating table data rows. Multiple rules are supported. For example: bodyText normalText.
Getter: getAlternateRowClass()
Setter: setAlternateRowClass()
Property: jsxaltrowclass
Sets the CSS style properties that will be inlined on every HTML cell in the body of the table. Multiple properties are supported. For example: border-bottom:solid 1px #aeaeae;.
Getter: getCellStyle()
Setter: setCellStyle()
Property: jsxcellstyle
Sets the CSS rule that will be applied to every HTML cell in the body of the table. Multiple rules are supported. For example: normalText bodyText.
Getter: getCellClass()
Setter: setCellClass()
Property: jsxcellclass
The XSL template to generate the cell content. This template is shared by all columns, so any conditional output must be handled by this single template. This template executes in context of the current CDF record and is passed a single parameter (xsl:param) named attname
Default Value: jsx3.gui.Table.DEFAULT_CELL_VALUE_TEMPLATE
Getter: getValueTemplate()
Setter: setValueTemplate()
Property: jsxvaluetemplate
The word wrapping for this object's data cells. 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 attribute path to sort on, such as jsxtext.
Getter: getSortPath()
Setter: setSortPath()
Property: jsxsortpath
Sets the default data type for columns in this list/grid.
Default Value: Text (jsx3.gui.Table.TYPETEXT)
Getter: getSortType()
Setter: setSortType()
Property: jsxsorttype
Allowed Values: - Text (
jsx3.gui.Table.TYPE_TEXT) - Numerical (
jsx3.gui.Table.TYPE_NUMBER)
Sets whether the Table is sorted ascending (a-z) or descending (z-a).
Default Value: Ascending (jsx3.gui.Table.SORTASCENDING)
Getter: getSortDirection()
Setter: setSortDirection()
Property: jsxsortdirection
Allowed Values: - Ascending (a-z) (
jsx3.gui.Table.SORT_ASCENDING) - Descending (z-a) (
jsx3.gui.Table.SORT_DESCENDING)
Sets whether or not the Table is sortable.
Getter: getCanSort()
Setter: setCanSort()
Property: jsxsort
Allowed Values: - True (
jsx3.Boolean.TRUE) - False (
jsx3.Boolean.FALSE)
Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu
Sets the tab index. When tabbing between controls, the index group this component belongs to.
Default Value: Empty
Getter: getIndex()
Setter: setIndex()
Property: jsxindex
Determines if the form input field is required.
Default Value: Optional (jsx3.gui.Form.OPTIONAL)
Getter: getRequired()
Setter: setRequired()
Property: jsxrequired
Allowed Values: - Required (
jsx3.gui.Form.REQUIRED) - Optional (
jsx3.gui.Form.OPTIONAL)
Sets the URL of the background-image to apply to the cell/row background to designate it as selected. For example, jsx:///images/table/select.gif
Default Value: jsx:///images/table/select.gif (jsx3.gui.Table.SELECTION_BG)
Getter: getSelectionBG()
Setter: setSelectionBG()
Property: jsxselectionbg
Sets the cache ID for the XML document this object is mapped to.
Default Value: Unique ID assigned by the system
Getter: getXMLId()
Setter: setXMLId()
Property: jsxxmlid
Sets an XML document as a string.
Getter: getXMLString()
Setter: setXMLString()
Property: jsxxml
Sets the URL for the resource. This resource is synchronously loaded when this object is painted on-screen.
Getter: getXMLURL()
Setter: setXMLURL()
Property: jsxxmlurl
A comma-separated list of XSLT transformers. The source XML will be transformed in series by each of the transformers listed here before being placed in the XML cache. Each transformer is either a URI to an XSLT file or the XML cache id of an XSLT document.
Getter: getXMLTransformers()
Setter: setXMLTransformers()
Property: jsxxmltrans
If set to Share, this object does not delete its associated document from the cache when removed from the DOM.
Default Value: Cleanup (jsx3.xml.Cacheable.CLEANUPRESOURCES)
Getter: getShareResources()
Setter: setShareResources()
Property: jsxshare
Allowed Values: - Cleanup (
jsx3.xml.Cacheable.CLEANUPRESOURCES) - Share (
jsx3.xml.Cacheable.SHARERESOURCES)
If set to Asynchronous and the XML data source of this control is loaded from a URL, then the data is loaded asynchronously and a loading message is displayed in this control until the data loads.
Default Value: Synchronous (jsx3.Boolean.FALSE)
Getter: getXmlAsync()
Setter: setXmlAsync()
Property: jsxxmlasync
Allowed Values: - Asynchronous (
jsx3.Boolean.TRUE) - Synchronous (
jsx3.Boolean.FALSE)
If set to Bound this control automatically repaints every time its XML cache document changes.
Default Value: Not Bound (jsx3.Boolean.FALSE)
Getter: getXmlBind()
Setter: setXmlBind()
Property: jsxxmlbind
Allowed Values: - Bound (
jsx3.Boolean.TRUE) - Not Bound (
jsx3.Boolean.FALSE)
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.