jsx3.gui.GridAPI
| 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. |
| List |
|---|
| Header Height | Sets the height of the header row in implied pixels. |
| BG Color Head | Sets the CSS color for the header row. |
| Background Head | Sets the CSS background definition for the header row, such as background-image:url(abc.gif);background-repeat:repeat-x;. |
| Box | |
| Column Interactions | |
| Spyglass | |
| Grow By | Sets whether or not a new row is appended to the view when a new record is added to the CDF document for the list. |
| Word Wrap | The word wrapping for this object. |
| Sort Path | Sets the attribute path to sort on, such as @jsxtext. |
| Sort Column Index | Overrides sortpath. |
| Sort Data Type | Sets the default data type for columns in this list/grid. |
| Sort Direction | Sets whether the Grid is sorted ascending (a-z) or descending (z-a). |
| Can Drag From | If true (1) (Enabled), this object supports drag events and allows any contained item to be dragged and dropped on another container supporting drop. |
| Can Drop On | If true (1) (Enabled), this object can be the target of drop events. |
| 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. |
| XSL Cache Id | Deprecated. |
| XSL String | Deprecated. |
| XSL URL | Deprecated. |
| Font Name | Sets the name of the font family. |
| Font Size | Sets the point size of the font. |
| CSS Rule Name | Sets the named CSS rule(s) to use. |
| Display | Sets the CSS display property. |
| Visibility | Sets the CSS visibility property. |
| Bound Menu | Sets the jsxname property for the context menu instance to display on a right-click. |
| Tab Index | Sets the tab index. |
| 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 height of the header row in implied pixels. Only positive integers are allowed. Set to 0 if the list does not use a header.
Default Value: The default height for the header row specified in the static field, DEFAULTHEADERHEIGHT, of the component class (jsx3.gui.List.DEFAULTHEADERHEIGHT). See the API documentation.
Getter: getHeaderHeight()
Setter: setHeaderHeight()
Property: jsxheaderheight
Sets the CSS color for the header row. For example, red, rgb(255,0,0), or #ff0000.
Default Value: The default background color for the header row specified in the static field, DEFAULTBACKGROUNDCOLORHEAD, of the component class (jsx3.gui.List.DEFAULTBACKGROUNDCOLORHEAD). See the API documentation.
Getter: getBackgroundColorHead()
Setter: setBackgroundColorHead()
Property: jsxbgcolorhead
Sets the CSS background definition for the header row, such as background-image:url(abc.gif);background-repeat:repeat-x;.
Default Value: The default background for the header row specified in the static field, DEFAULTBACKGROUNDHEAD, of the component class (jsx3.gui.List.DEFAULTBACKGROUNDHEAD). See the API documentation.
Getter: getBackgroundHead()
Setter: setBackgroundHead()
Property: jsxbghead
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
If Sortable, the list/grid can be sorted when a column header is clicked.
Default Value: Sortable (jsx3.Boolean.TRUE)
Getter: getCanSort()
Setter: setCanSort()
Property: jsxsort
Allowed Values: - Sortable (
jsx3.Boolean.TRUE) - Fixed (
jsx3.Boolean.FALSE)
If Reorderable, the columns in the list/grid can be reordered by the user at runtime.
Default Value: Reorderable (jsx3.Boolean.TRUE)
Getter: getCanReorder()
Setter: setCanReorder()
Property: jsxreorder
Allowed Values: - Reorderable (
jsx3.Boolean.TRUE) - Fixed (
jsx3.Boolean.FALSE)
Sets whether the columns in the list/grid can be resized by the user at runtime.
Default Value: Resizable (jsx3.Boolean.TRUE)
Getter: getResizable()
Setter: setResizable()
Property: jsxresize
Allowed Values: - Resizable (
jsx3.Boolean.TRUE) - Fixed (
jsx3.Boolean.FALSE)
If true (1), this object can be spyglassed. A spyglass displays HTML returned from the jsxspy event when a spyglassed object is hovered over.
Default Value: false (jsx3.Boolean.FALSE)
Getter: getCanSpy()
Setter: setCanSpy()
Property: jsxspy
Allowed Values: - True (
jsx3.Boolean.TRUE) - False (
jsx3.Boolean.FALSE)
Sets whether or not a new row is appended to the view when a new record is added to the CDF document for the list. In the case of a grid, a new row is also appended when the last row in the grid gets cursor focus.
Default Value: true (jsx3.Boolean.TRUE)
Getter: getGrowBy()
Setter: setGrowBy()
Property: jsxgrowby
Allowed Values: - True (
jsx3.Boolean.TRUE) - False (
jsx3.Boolean.FALSE)
The word wrapping for this object. If set to True, text wraps.
Default Value: true (jsx3.Boolean.TRUE)
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
Overrides sortpath. Specifies the zero-based index for the child column to sort on.
Getter: getSortColumn()
Setter: setSortColumn()
Property: jsxsortcolumn
Sets the default data type for columns in this list/grid.
Default Value: Text (jsx3.gui.Column.TYPETEXT)
Getter: getSortType()
Setter: setSortType()
Property: jsxsorttype
Allowed Values: - Text (
jsx3.gui.Column.TYPETEXT) - Numerical (
jsx3.gui.Column.TYPENUMBER)
Sets whether the Grid is sorted ascending (a-z) or descending (z-a).
Default Value: Ascending (jsx3.gui.List.SORTASCENDING)
Getter: getSortDirection()
Setter: setSortDirection()
Property: jsxsortdirection
Allowed Values: - Ascending (a-z) (
jsx3.gui.List.SORTASCENDING) - Descending (z-a) (
jsx3.gui.List.SORTDESCENDING)
If true (1) (Enabled), this object supports drag events and allows any contained item to be dragged and dropped on another container supporting drop.
Default Value: Disabled (jsx3.Boolean.FALSE)
Getter: getCanDrag()
Setter: setCanDrag()
Property: jsxdrag
Allowed Values: - Enabled (
jsx3.Boolean.TRUE) - Disabled (
jsx3.Boolean.FALSE)
If true (1) (Enabled), this object can be the target of drop events.
Default Value: Disabled (jsx3.Boolean.FALSE)
Getter: getCanDrop()
Setter: getCanDrop()
Property: jsxdrop
Allowed Values: - Enabled (
jsx3.Boolean.TRUE) - Disabled (
jsx3.Boolean.FALSE)
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)
Deprecated.
Sets the cache ID for the XSL document this object is mapped to.
Default Value: Unique ID assigned by the system
Getter: getXSLId()
Setter: setXSLId()
Property: jsxxslid
Deprecated.
Sets the XSL document as a string.
Getter: getXSLString()
Setter: setXSLString()
Property: jsxxsl
Deprecated.
Sets the URL for the resource. This resource is synchronously loaded when this object is painted on-screen.
Getter: getXSLURL()
Setter: setXSLURL()
Property: jsxxslurl
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 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 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 visibility property. When set to Hidden, content is hidden.
Default Value: Visible (jsx3.gui.Block.VISIBILITYVISIBLE)
Getter: getVisibility()
Setter: setVisibility()
Property: jsxvisibility
Allowed Values: - Visible (
jsx3.gui.Block.VISIBILITYVISIBLE) - Hidden (
jsx3.gui.Block.VISIBILITYHIDDEN)
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
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.