OverviewSingleDeprecatedPropertiesEventsXSL Parameters

jsx3.gui

class Table

Object
->jsx3.lang.Object
  ->jsx3.app.Model
    ->jsx3.gui.Painted
      ->jsx3.gui.Block
        ->jsx3.gui.Table

All Implemented Interfaces:

jsx3.gui.Form, jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable
class Table
extends jsx3.gui.Block
A lightweight control that displays CDF data in an HTML table. Supports both single- and multi-selection modes. Data can be sorted by clicking on column labels. Output and output formatting can be customized using a combination of XSLT, inline CSS properties, or named CSS rules. The columns for this control are defined within the object model and are not defined in the DOM as child objects.

The Table class by default supports the following CDF attributes: This class publishes the following model events:

Since:

3.5
Field Summary
static String
DEFAULTXSLURL
static jsx3.xml.Document
DEFAULT_CELL_VALUE_TEMPLATE
Default XSL template for rendering the cell value for all cells.
static int
DEFAULT_HEADER_HEIGHT
20
static String
SELECTION_BG
jsx:///images/table/select.gif
static int
SELECTION_MULTI_ROW
Enum value for the multiSelect property indicating a single-select table.
static int
SELECTION_ROW
Enum value for the multiSelect property indicating a multi-select table.
static int
SELECTION_UNSELECTABLE
Enum value for the multiSelect property indicating an unselectable table.
static String
SORT_ASCENDING
ascending
static String
SORT_ASCENDING_IMG
jsx:///images/table/sort_asc.gif (default)
static String
SORT_DESCENDING
descending
static String
SORT_DESCENDING_IMG
jsx:///images/table/sort_desc.gif (default)
static String
TYPE_NUMBER
number
static String
TYPE_TEXT
text (default)
Constructor Summary
void
init(strName : String)
instance initializer
Method Summary
void
deselectAllRecords()
Deselects all selected CDF records.
void
deselectRecord(strRecordId : String)
Deselects a CDF record within the Table.
void
doSort(intSortDir : String)
Sorts according to the current sort path.
int
doValidate()
validates the Table; if the Table is set to 'required', a selection must be made to pass validation.
void
focusRowById(strCdfId : String)
Applies focus to the on-screen row indentified by the CDF record id that generated it
String
getAlternateRowClass(strDefault : String)
Returns the CSS rule for the HTML row element(s) containing the alternating table data rows.
String
getAlternateRowStyle(strDefault : String)
Returns the CSS properties for the HTML row element(s) containing the alternating table data rows.
int
getCanSort()
Returns whether the table is sortable.
String
getCellClass()
Returns the CSS rule that will be applied to every HTML cell in the body of the table.
String
getCellStyle()
Returns the CSS properties that will be inlined on every HTML cell in the body of the table.
String
getColumnProfile()
Returns the string of XML in CDF format representing the Column Profile Document.
jsx3.xml.CDF.Document
getColumnProfileDocument()
Returns a clone of the CDF document used internally to define the Columns (text, order, mapped attributes, etc).
HTMLElement
getContentElement(strCdfId : String, strAttName : String)
Returns the on-screen cell that represents the intersection of the row identified by strCdfId and the first cell mapped to the named CDF attribute, strAttName.
String
getHeaderClass(strDefault : String)
Returns the CSS rule for the HTML row containing the column headers.
int
getHeaderHeight(strDefault : String)
Returns the height of the header row in pixels.
String
getHeaderStyle(strDefault : String)
Returns the CSS style for the HTML row containing the column headers.
String
getNoDataMessage()
Returns the text/HTML to display on-screen when the xml/xsl transformation for this object results in a null or empty result set
String
getRenderingContext(strDefault : String)
Returns the jsxid of the CDF record that will serve as the origin when rendering the data on-screen.
String
getRowClass()
Returns the CSS rule for the HTML row element(s) containing the table data.
String
getRowStyle()
Returns the CSS properties for the HTML row elements(s) containing the table data.
Array<String>
getSelectedIds()
Returns the jsxid(s) for the selected record(s).
jsx3.util.List<jsx3.xml.Entity>
getSelectedNodes()
Returns the collection of selected records.
String
getSelectionBG(strDefault : String)
Returns the CSS string to apply to a Row/Cell when it has focus
int
getSelectionModel(strDefault : String)
Returns the selection model.
String
getSortDirection()
Returns the direction (jsx3.gui.Table.SORT_ASCENDING or jsx3.gui.Table.SORT_DESCENDING) for the sorted column; if no direction specified, ascending is returned
String
getSortPath()
Returns the name of the CDF attribute to sort on.
String
getSortType()
Returns the data type to be used for sorting this list.
String | Array<String>
getValue()
Returns an array of selected values (or empty array) if the selection model is Table.SELECTION_MULTI_ROW.
String
getValueTemplate(strDefault : String)
Gets the user-defined XSL template (xsl:template) that will override the defualt template defined by Table.DEFAULT_CELL_VALUE_TEMPLATE.
int
getWrap(strDefault : String)
Returns whether or not the table's data cells support text-wrapping and expand vertically to display their wrapped content.
jsx3.xml.Document
getXSL()
Returns XSLT for the Table, prioritizing the acquisition in the following order: 1) check cache; 2) check jsxxsl; 3) check jsxxslurl; 4) use default
String
paint()
Returns the DHTML, used for this object's on-screen VIEW
jsx3.gui.Table
redrawRecord(strRecordId : ?, ACTION : ?)
This method implements redraw support by repainting the entire control.
void
repaintData()
Paints only the data rows.
void
repaintHead()
Paints only the header row.
void
selectRecord(strRecordId : String)
Selects a CDF record of this list.
void
setAlternateRowClass(strRuleName : String)
Sets the CSS rule for the HTML row element(s) containing the alternating table data rows.
void
setAlternateRowStyle(strCSS : String)
Sets the CSS properties for the HTML row element(s) containing the alternating table data rows.
void
setCanSort(SORT : int)
Sets whether the table is sortable.
void
setCellClass(strRuleName : String)
Sets the CSS rule that will be applied to every HTML cell in the body of the table.
void
setCellStyle(strCSS : String)
Sets the CSS properties that will be inlined on every HTML cell in the body of the table.
void
setColumnProfile(objCDF : String | jsx3.xml.CDF.Document)
Sets a string of XML (in CDF format) or an actual jsx3.xml.CDF.Document instance representing the Column Profile Document.
void
setHeaderClass(strRuleName : String)
Sets the CSS rule for the HTML row containing the column headers.
void
setHeaderHeight(intHeight : int, bSuppressRepaint : boolean)
Sets the height of the header row in pixels.
void
setHeaderStyle(strCSS : String)
Sets the CSS style properties for the HTML row containing the column headers.
void
setRenderingContext(strJsxId : String, bSuppressRepaint : boolean)
Sets the jsxid of the CDF record that will serve as the origin when rendering the data on-screen.
void
setRowClass(strRuleName : String)
Sets the CSS rule for the HTML row element(s) containing the table data.
void
setRowStyle(strCSS : String)
Sets the CSS properties for the HTML row element(s) containing the table data.
void
setSelectionBG(strURL : String)
Sets the URL for the image to use (as the repeating background image) to denote selection.
void
setSelectionModel(intType : int)
Sets the selection model
void
setSortDirection(intSortDir : String)
Sets the direction (ascending or descending) for the sorted column.
void
setSortPath(strAttr : String)
Sets the name of the CDF attribute to sort on.
void
setSortType(DATATYPE : String)
Sets the data type for the list.
jsx3.gui.Table
setValue(strId : String | Array<String>)
Sets the value of this table.
void
setValueTemplate(TEMPLATE : String)
Sets the user-defined XSL template that will override the defualt template defined by Table.DEFAULT_CELL_VALUE_TEMPLATE.
void
setWrap(WRAP : int)
Sets whether or not the table's data cells support text-wrapping and expand vertically to display their wrapped content.
Methods Inherited From jsx3.gui.Form
doKeyBinding, doReset, getDisabledBackgroundColor, getDisabledColor, getEnabled, getKeyBinding, getRequired, getValidationState, setDisabledBackgroundColor, setDisabledColor, setEnabled, setKeyBinding, setRequired, setValidationState
Methods Inherited From jsx3.xml.Cacheable
clearXmlData, getNodeSet, getShareResources, getXML, getXMLId, getXMLString, getXMLTransformers, getXMLURL, getXSLId, getXSLParams, getXSLString, getXSLURL, getXmlAsync, getXmlBind, onXmlBinding, removeXSLParam, removeXSLParams, resetCacheData, resetData, resetXmlCacheData, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLId, setXMLString, setXMLTransformers, setXMLURL, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind
Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecord, deleteRecordProperty, getRecord, getRecordIds, getRecordNode, getSchema, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource, setSchema
Methods Inherited From jsx3.gui.Block
getBackground, getBackgroundColor, getBorder, getCDFAttribute, getCDFId, getCSSOverride, getClassName, getColor, getCursor, getDimensions, getDisplay, getFontName, getFontSize, getFontWeight, getHeight, getIndex, getLeft, getMargin, getOverflow, getPadding, getRelativePosition, getTagName, getText, getTextAlign, getTip, getTop, getVisibility, getWidth, getZIndex, hideMask, setBackground, setBackgroundColor, setBorder, setCDFAttribute, setCDFId, setCSSOverride, setClassName, setColor, setCursor, setDimensions, setDisplay, setFontName, setFontSize, setFontWeight, setHeight, setIndex, setLeft, setMargin, setOverflow, setPadding, setRelativePosition, setTagName, setText, setTextAlign, setTip, setTop, setVisibility, setWidth, setZIndex, showMask
Methods Inherited From jsx3.gui.Interactive
doEvent, getCanDrag, getCanDrop, getCanMove, getCanSpy, getEvent, getEvents, getMenu, hasEvent, registerHotKey, removeEvent, removeEvents, setCanDrag, setCanDrop, setCanMove, setCanSpy, setEvent, setMenu, setSpyStyles, showSpy
Methods Inherited From jsx3.gui.Painted
focus, getAbsolutePosition, getAttribute, getAttributes, getRendered, insertHTML, onAfterPaint, onAfterRestoreView, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute
Methods Inherited From jsx3.app.Model
adoptChild, assembleFromXML, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getDynamicProperty, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onChildAdded, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, selectDescendants, setChild, setDynamicProperty, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc, toXMLElm
Methods Inherited From jsx3.util.EventDispatcher
publish, subscribe, unsubscribe, unsubscribeAll
Methods Inherited From jsx3.lang.Object
clone, equals, eval, getClass, getInstanceOf, getInstanceOfClass, getInstanceOfPackage, instanceOf, isInstanceOf, isSubclassOf, jsxmix, jsxsuper, jsxsupermix, setInstanceOf
Field Detail

DEFAULTXSLURL

static String DEFAULTXSLURL

DEFAULT_CELL_VALUE_TEMPLATE

static jsx3.xml.Document DEFAULT_CELL_VALUE_TEMPLATE
Default XSL template for rendering the cell value for all cells. This template can be replaced with a custom XSL template. The template should match on a record element (match="record") and will be used for all data cells in the body of the table. This template will be passed one named parameter (xsl:param) named attname, the name of the attribute to which the column is mapped.

DEFAULT_HEADER_HEIGHT

static int DEFAULT_HEADER_HEIGHT
20

SELECTION_BG

static String SELECTION_BG
jsx:///images/table/select.gif

SELECTION_MULTI_ROW

static final int SELECTION_MULTI_ROW
Enum value for the multiSelect property indicating a single-select table.

SELECTION_ROW

static final int SELECTION_ROW
Enum value for the multiSelect property indicating a multi-select table.

SELECTION_UNSELECTABLE

static final int SELECTION_UNSELECTABLE
Enum value for the multiSelect property indicating an unselectable table.

SORT_ASCENDING

static final String SORT_ASCENDING
ascending

SORT_ASCENDING_IMG

static String SORT_ASCENDING_IMG
jsx:///images/table/sort_asc.gif (default)

SORT_DESCENDING

static final String SORT_DESCENDING
descending

SORT_DESCENDING_IMG

static String SORT_DESCENDING_IMG
jsx:///images/table/sort_desc.gif (default)

TYPE_NUMBER

static final String TYPE_NUMBER
number

TYPE_TEXT

static final String TYPE_TEXT
text (default)
Constructor Detail

init

void init(strName : String)
instance initializer

Parameters:

strName – unique name distinguishing this object from all other JSX GUI objects in the JSX application
Method Detail

deselectAllRecords

void deselectAllRecords()
Deselects all selected CDF records.

deselectRecord

void deselectRecord(strRecordId : String)
Deselects a CDF record within the Table. Both the view and the data model (CDF) will be updated

Parameters:

strRecordId – the jsxid of the record to deselect.

doSort

void doSort(intSortDir : String)
Sorts according to the current sort path. If no sort direction is specified, the sort direction will be toggled.

Parameters:

intSortDir – jsx3.gui.Table.SORT_ASCENDING or jsx3.gui.Table.SORT_DESCENDING.

See Also:

SORT_ASCENDING, SORT_DESCENDING

doValidate

int doValidate()
validates the Table; if the Table is set to 'required', a selection must be made to pass validation. Otherwise, a Table will always pass validation

Returns:

one of: jsx3.gui.Form.STATEINVALID or jsx3.gui.Form.STATEVALID  

Overrides:

doValidate in jsx3.gui.Form

focusRowById

void focusRowById(strCdfId : String)
Applies focus to the on-screen row indentified by the CDF record id that generated it

Parameters:

strCdfId – jsxid property for the corresponding CDF record

getAlternateRowClass

String getAlternateRowClass(strDefault : String)
Returns the CSS rule for the HTML row element(s) containing the alternating table data rows.

Parameters:

strDefault –

Returns:

 

getAlternateRowStyle

String getAlternateRowStyle(strDefault : String)
Returns the CSS properties for the HTML row element(s) containing the alternating table data rows.

Parameters:

strDefault –

Returns:

 

getCanSort

int getCanSort()
Returns whether the table is sortable. If null or jsx3.Boolean.TRUE, the instance is sortable.

Returns:

 

getCellClass

String getCellClass()
Returns the CSS rule that will be applied to every HTML cell in the body of the table.

Returns:

 

getCellStyle

String getCellStyle()
Returns the CSS properties that will be inlined on every HTML cell in the body of the table.

Returns:

 

getColumnProfile

String getColumnProfile()
Returns the string of XML in CDF format representing the Column Profile Document.

Returns:

 

getColumnProfileDocument

jsx3.xml.CDF.Document getColumnProfileDocument()
Returns a clone of the CDF document used internally to define the Columns (text, order, mapped attributes, etc). The order of the records in this document reflects the order of the columns in the Table. If the column profile document defined by getColumnProfile is not a valid XML document, an empty CDF Document will be returned instead. Note that if you make changes to the Document returned by this method, those changes will only be reflected by calling setColumnProfile (to update the model), followed by a call to repaint (to update the view).

Returns:

 

See Also:

setColumnProfile

getContentElement

HTMLElement getContentElement(strCdfId : String, strAttName : String)
Returns the on-screen cell that represents the intersection of the row identified by strCdfId and the first cell mapped to the named CDF attribute, strAttName.

Parameters:

strCdfId – jsxid property for CDF record
strAttName – attribute name on the CDF record. For example, jsxtext

Returns:

 

getHeaderClass

String getHeaderClass(strDefault : String)
Returns the CSS rule for the HTML row containing the column headers.

Parameters:

strDefault –

Returns:

 

getHeaderHeight

int getHeaderHeight(strDefault : String)
Returns the height of the header row in pixels. If this value is not set (null), the list will render with the default value of jsx3.gui.Table.DEFAULT_HEADER_HEIGHT.

Parameters:

strDefault – The default value to use if null

Returns:

 

getHeaderStyle

String getHeaderStyle(strDefault : String)
Returns the CSS style for the HTML row containing the column headers.

Parameters:

strDefault –

Returns:

 

getNoDataMessage

String getNoDataMessage()
Returns the text/HTML to display on-screen when the xml/xsl transformation for this object results in a null or empty result set

Returns:

text/HTML  

getRenderingContext

String getRenderingContext(strDefault : String)
Returns the jsxid of the CDF record that will serve as the origin when rendering the data on-screen. If not set, the id, jsxroot, (which is the id for the root node, <data>) will be used.

Parameters:

strDefault – The default value to use if null

Returns:

 

getRowClass

String getRowClass()
Returns the CSS rule for the HTML row element(s) containing the table data.

Returns:

 

getRowStyle

String getRowStyle()
Returns the CSS properties for the HTML row elements(s) containing the table data.

Returns:

 

getSelectedIds

Array<String> getSelectedIds()
Returns the jsxid(s) for the selected record(s). Equivalent to this.getValue() except that the return value is always an Array.

Returns:

JavaScript array of stings  

getSelectedNodes

jsx3.util.List<jsx3.xml.Entity> getSelectedNodes()
Returns the collection of selected records.

Returns:

 

getSelectionBG

String getSelectionBG(strDefault : String)
Returns the CSS string to apply to a Row/Cell when it has focus

Parameters:

strDefault – The default value to use if null (Table.SELECTION_BG)

Returns:

 

getSelectionModel

int getSelectionModel(strDefault : String)
Returns the selection model. If no selection type is specified, the instance will employ single row selection (SELECTION_ROW)

Parameters:

strDefault – The default value to use if null

Returns:

 

getSortDirection

String getSortDirection()
Returns the direction (jsx3.gui.Table.SORT_ASCENDING or jsx3.gui.Table.SORT_DESCENDING) for the sorted column; if no direction specified, ascending is returned

Returns:

one of: jsx3.gui.Table.SORT_ASCENDING or jsx3.gui.Table.SORT_DESCENDING  

getSortPath

String getSortPath()
Returns the name of the CDF attribute to sort on. If no value is set an empty string is returned by default.

Returns:

 

getSortType

String getSortType()
Returns the data type to be used for sorting this list.

Returns:

jsx3.gui.Table.TYPE_TEXT or jsx3.gui.Table.TYPE_NUMBER  

getValue

String | Array<String> getValue()
Returns an array of selected values (or empty array) if the selection model is Table.SELECTION_MULTI_ROW. Returns a string (or null) for the other selection models

Returns:

 

Overrides:

getValue in jsx3.gui.Form

getValueTemplate

String getValueTemplate(strDefault : String)
Gets the user-defined XSL template (xsl:template) that will override the defualt template defined by Table.DEFAULT_CELL_VALUE_TEMPLATE.

Parameters:

strDefault – xsl:template

Returns:

 

getWrap

int getWrap(strDefault : String)
Returns whether or not the table's data cells support text-wrapping and expand vertically to display their wrapped content. If this property is not set, the cell content will not wrap.

Parameters:

strDefault –

Returns:

jsx3.Boolean.TRUE or jsx3.Boolean.FALSE  

getXSL

jsx3.xml.Document getXSL()
Returns XSLT for the Table, prioritizing the acquisition in the following order: 1) check cache; 2) check jsxxsl; 3) check jsxxslurl; 4) use default

Returns:

jsx3.xml.Document instance containing valid XSL stylesheet  

Overrides:

getXSL in jsx3.xml.Cacheable

paint

String paint()
Returns the DHTML, used for this object's on-screen VIEW

Returns:

DHTML  

Overrides:

paint in jsx3.gui.Block

redrawRecord

jsx3.gui.Table redrawRecord(strRecordId : ?, ACTION : ?)
This method implements redraw support by repainting the entire control.

Parameters:

strRecordId –
ACTION –

Returns:

this object  

Overrides:

redrawRecord in jsx3.xml.CDF

repaintData

void repaintData()
Paints only the data rows. Call for quick repainting of the data rows when only the source data has changed. Does not recalculate and reprofile the box profile and resulting XSLT. Retains scroll position when possible.

repaintHead

void repaintHead()
Paints only the header row. Call for quick repainting of the header row and not the data rows.

selectRecord

void selectRecord(strRecordId : String)
Selects a CDF record of this list. The item will be highlighted in the view and the CDF data will be updated accordingly. If this list is a multi-select list then this selection will be added to any previous selection.

Parameters:

strRecordId – the jsxid of the record to select.

setAlternateRowClass

void setAlternateRowClass(strRuleName : String)
Sets the CSS rule for the HTML row element(s) containing the alternating table data rows. Multiple rules are supported. For example: bodyText, normalText.

Parameters:

strRuleName –

setAlternateRowStyle

void setAlternateRowStyle(strCSS : String)
Sets the CSS properties for the HTML row element(s) containing the alternating table data rows. Multiple properties are supported. For example: background-color:red;font-family:Arial;.

Parameters:

strCSS –

setCanSort

void setCanSort(SORT : int)
Sets whether the table is sortable.

Parameters:

SORT – one of jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

setCellClass

void setCellClass(strRuleName : String)
Sets the CSS rule that will be applied to every HTML cell in the body of the table. Multiple rules are supported. For example: boldText titleText.

Parameters:

strRuleName –

setCellStyle

void setCellStyle(strCSS : String)
Sets the CSS properties that will be inlined on every HTML cell in the body of the table. Multiple properties are supported. For example: text-align:right;background-color:#eeeeee;border-bottom:solid 1px #aeaeae;.

Parameters:

strCSS –

setColumnProfile

void setColumnProfile(objCDF : String | jsx3.xml.CDF.Document)
Sets a string of XML (in CDF format) or an actual jsx3.xml.CDF.Document instance representing the Column Profile Document. Each record in this document defines the profile for a column in the Table. The following attributes are supported on each record:


For example:
  <data jsxid="jsxroot">
    <record jsxid="a1" jsxtext="&lt;b&gt;Column 1&lt;/b&gt;" jsxpath="jsxtext"/>
    <record jsxid="a2" jsxtext="Column 2" jsxwidth="100" jsxpath="value" jsxpathtype="number"/>
  </data>

Parameters:

objCDF –

setHeaderClass

void setHeaderClass(strRuleName : String)
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.

Parameters:

strRuleName –

setHeaderHeight

void setHeaderHeight(intHeight : int, bSuppressRepaint : boolean)
Sets the height of the header row in pixels. Set to zero (0) to hide the header row and only render the body rows.

Parameters:

intHeight –
bSuppressRepaint – Pass true to stop the default repaint from occurring. Typically property updates that affect the browser-specific box model (such as height) are repainted immediately to keep the box model abstraction in sync with the native view. However, the repaint can be suppressed to avoid unnecessary reparsing of the XSLT during repeated property updates.

setHeaderStyle

void setHeaderStyle(strCSS : String)
Sets the CSS style properties for the HTML row containing the column headers. Multiple properties are supported. For example: background-image:url(JSXAPPS/myproject/images/bg.gif);font-family:Arial;. The following CSS properties (those affecting layout and position) are not allowed: width, height, left, top, position, overflow, border, padding, margin.

Parameters:

strCSS –

setRenderingContext

void setRenderingContext(strJsxId : String, bSuppressRepaint : boolean)
Sets the jsxid of the CDF record that will serve as the origin when rendering the data on-screen.

Parameters:

strJsxId – jsxid property for the CDF record to use as the contextual root when rendering data on-screen.
bSuppressRepaint – Pass true to stop the default repaint from occurring.

setRowClass

void setRowClass(strRuleName : String)
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.

Parameters:

strRuleName –

See Also:

setAlternateRowClass

setRowStyle

void setRowStyle(strCSS : String)
Sets the CSS 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;.

Parameters:

strCSS –

See Also:

setAlternateRowStyle

setSelectionBG

void setSelectionBG(strURL : String)
Sets the URL for the image to use (as the repeating background image) to denote selection.

Parameters:

strURL –

setSelectionModel

void setSelectionModel(intType : int)
Sets the selection model

Parameters:

intType – one of Table: .SELECTION_UNSELECTABLE, .SELECTION_ROW, .SELECTION_MULTI_ROW

setSortDirection

void setSortDirection(intSortDir : String)
Sets the direction (ascending or descending) for the sorted column.

Parameters:

intSortDir – one of: jsx3.gui.Table.SORT_ASCENDING or jsx3.gui.Table.SORT_DESCENDING

setSortPath

void setSortPath(strAttr : String)
Sets the name of the CDF attribute to sort on. The records in the data source of this table are sorted on this attribute before being painted to screen.

Parameters:

strAttr –

setSortType

void setSortType(DATATYPE : String)
Sets the data type for the list.

Parameters:

DATATYPE – data type for this column's data. Valid types include: jsx3.gui.Table.TYPE_TEXT and jsx3.gui.Table.TYPE_NUMBER

setValue

jsx3.gui.Table setValue(strId : String | Array<String>)
Sets the value of this table. Deselects all existing selections. Scrolls the first record into view.

Parameters:

strId – jsxid attribute for the CDF record(s) to select

Returns:

this object.  

Overrides:

setValue in jsx3.gui.Form

setValueTemplate

void setValueTemplate(TEMPLATE : String)
Sets the user-defined XSL template that will override the defualt template defined by Table.DEFAULT_CELL_VALUE_TEMPLATE. The template must resolve to a valid XSL Template when parsed. The template should match on a record (match="record"). The template will be passed a single XSL param (xsl:param) named attname.

Parameters:

TEMPLATE – valid xsl:template

setWrap

void setWrap(WRAP : int)
Sets whether or not the table's data cells support text-wrapping and expand vertically to display their wrapped content.

Parameters:

WRAP – jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
Copyright © 2001-2011, TIBCO Software Inc.