jsxid
jsxselected
jsxstyle
jsxclass
jsximg
jsxtip
jsxunselectable
jsxexecute
EXECUTE –MENU –CHANGE –SPYGLASS –| Field Summary | |
|---|---|
| static String | |
| static jsx3.xml.Document | Default XSL template for rendering the cell value for all cells. |
| static int | 20
|
| static String | jsx:///images/table/select.gif
|
| static int | Enum value for the multiSelect property indicating a single-select table. |
| static int | Enum value for the multiSelect property indicating a multi-select table. |
| static int | Enum value for the multiSelect property indicating an unselectable table. |
| static String | ascending |
| static String | jsx:///images/table/sort_asc.gif (default)
|
| static String | descending |
| static String | jsx:///images/table/sort_desc.gif (default)
|
| static String | number |
| static String | text (default) |
| Constructor Summary | |
|---|---|
| void | instance initializer |
| Method Summary | |
|---|---|
| void | Deselects all selected CDF records. |
| void | deselectRecord(strRecordId : String) Deselects a CDF record within the Table. |
| void | Sorts according to the current sort path. |
| int | 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 | Returns whether the table is sortable. |
| String | Returns the CSS rule that will be applied to every HTML cell in the body of the table. |
| String | Returns the CSS properties that will be inlined on every HTML cell in the body of the table. |
| String | Returns the string of XML in CDF format representing the Column Profile Document. |
| jsx3.xml.CDF.Document | Returns a clone of the CDF document used internally to define the Columns (text, order, mapped attributes, etc). |
| HTMLElement | 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 | 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 | Returns the CSS rule for the HTML row element(s) containing the table data. |
| String | Returns the CSS properties for the HTML row elements(s) containing the table data. |
| Array<String> | Returns the jsxid(s) for the selected record(s). |
| jsx3.util.List<jsx3.xml.Entity> | 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 | 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 | Returns the name of the CDF attribute to sort on. |
| String | 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 | 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 | This method implements redraw support by repainting the entire control. |
| void | Paints only the data rows. |
| void | 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 | 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 | 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 | 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 | 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, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, insertRecordProperty, reloadFromSource |
| Methods Inherited From jsx3.gui.Block |
|---|
| getBackground, getBackgroundColor, getBorder, 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, 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, getDynamicProperty, getRendered, insertHTML, onAfterPaint, paintChild, paintChildren, recalcBox, removeAttribute, removeAttributes, repaint, setAttribute, setDynamicProperty |
| 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 |
|---|
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.multiSelect property indicating a single-select table.multiSelect property indicating a multi-select table.multiSelect property indicating an unselectable table.| Constructor Detail |
|---|
| Method Detail |
|---|
jsx3.gui.Table.SORT_ASCENDING or jsx3.gui.Table.SORT_DESCENDING.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 updatedParameters:
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:
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 validationReturns:
one of: jsx3.gui.Form.STATEINVALID or jsx3.gui.Form.STATEVALID
Overrides:
focusRowById
void focusRowById(strCdfId : String)Applies focus to the on-screen row indentified by the CDF record id that generated itParameters:
strCdfId – jsxid property for the corresponding CDF record
getAlternateRowClass
Returns the CSS rule for the HTML row element(s) containing the alternating table data rows.Parameters:
strDefault – Returns:
getAlternateRowStyle
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:
getContentElement
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 recordstrAttName – attribute name on the CDF record. For example, jsxtextReturns:
getHeaderClass
Returns the CSS rule for the HTML row containing the column headers.Parameters:
strDefault – Returns:
getHeaderHeight
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 nullReturns:
getHeaderStyle
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 setReturns:
text/HTML
getRenderingContext
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 nullReturns:
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
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
Returns the CSS string to apply to a Row/Cell when it has focusParameters:
strDefault – The default value to use if null (Table.SELECTION_BG)Returns:
getSelectionModel
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 nullReturns:
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 returnedReturns:
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
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 modelsReturns:
Overrides:
getValueTemplate
Gets the user-defined XSL template (xsl:template) that will override the defualt template defined by Table.DEFAULT_CELL_VALUE_TEMPLATE.Parameters:
strDefault – xsl:templateReturns:
getWrap
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 defaultReturns:
jsx3.xml.Document instance containing valid XSL stylesheet
Overrides:
paint
String paint()Returns the DHTML, used for this object's on-screen VIEWReturns:
DHTML
Overrides:
redrawRecord
This method implements redraw support by repainting the entire control.Parameters:
strRecordId – ACTION – Returns:
this object
Overrides:
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 –
int
)jsx3.Boolean.TRUE or jsx3.Boolean.FALSE
boldText titleText.text-align:right;background-color:#eeeeee;border-bottom:solid 1px #aeaeae;.300, or 25%.text (default) or number.
<data jsxid="jsxroot">
<record jsxid="a1" jsxtext="<b>Column 1</b>" jsxpath="jsxtext"/>
<record jsxid="a2" jsxtext="Column 2" jsxwidth="100" jsxpath="value" jsxpathtype="number"/>
</data>
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.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.
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.true to stop the default repaint from occurring.
setAlternateRowClass. Multiple rules are supported.
For example: bodyText normalText.setAlternateRowStyle. Multiple properties are supported.
For example: background-color:white;font-family:Arial;.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.jsx3.Boolean.TRUE or jsx3.Boolean.FALSE