jsx3.gui.List Summary

Field Summary
static String	DEFAULTBACKGROUNDCOLOR #F3F2F4
static String	DEFAULTBACKGROUNDCOLORHEAD #c8cfd8
static String	DEFAULTBACKGROUNDHEAD background-image:url(JSX/images/list/header.gif);
static int	DEFAULTHEADERHEIGHT 20
static String	DEFAULTROWCLASS jsx30list_r1
static String	DEFAULTXSLURL Deprecated.
static int	MULTI 1
static int	NOTSELECTABLE 2
static String	RESIZEBARBGCOLOR #2050df
static String	SELECTBGIMAGE url(JSX/images/list/select.gif)
static int	SINGLE 0
static String	SORTASCENDING ascending
static String	SORTDESCENDING descending

Constructor Summary
void	init(strName : String) instance initializer

Method Summary
void	appendRow(objMasterRecord : Object, strID : String) Appends a new row to the end of the list and adds a corresponding record to the CDF source XML.
jsx3.gui.List	clearXSL() Deprecated. use `resetXslCacheData()` instead.
jsx3.gui.List	deselectAllRecords() Deselects all selected CDF records of this list.
jsx3.gui.List	deselectRecord(strRecordId : String) Deselects a CDF record of this list.
void	deselectRecords() Deprecated. use setValue() or `deselectAllRecords()` instead.
void	doClearSelections() Deprecated. use setValue() or `deselectAllRecords()` instead.
jsx3.gui.List	doDeselect(strRecordId : String, bVIEW : boolean) Deprecated. use `setValue()` or `deselectRecord()` instead.
void	doExecute(strRecordId : String) Deprecated. use `executeRecord()` instead.
jsx3.gui.List	doSelect(strRecordId : String, bVIEW : boolean, bNoEvent : boolean, bReveal : ?) Deprecated. use `setValue()` or `selectRecord()` instead.
void	doSort(intSortDir : String) Sorts this list according to the current sort path.
int	doValidate() validates the list; if the list is set to 'required', a selection must be made to pass validation.
void	executeRecord(strRecordId : String) Evaluates the JavaScript code in the jsxexecute attribute of one CDF record of this list.
jsx3.gui.List	focusRecord(strRecordId : String) Gives cursor focus to a row in the list.
HTMLElement	getActiveRow() Returns a handle to the active TR for the list.
int	getAutoExpand() Deprecated. Replaced by `getGrowBy` which returns an integer argument rather than a boolean.
String	getBackgroundColorHead() Returns the CSS color for the header row (for example, "#ffffff").
String	getBackgroundHead() Returns the CSS background property for the header row (for example, "background-image:url(abc.gif)").
int	getCanReorder() Returns whether the columns in the list can be re-ordered via user interaction.
void	getCanResize() Deprecated. Renamed to getResizable.
int	getCanSort() Returns whether the list will render with sortable columns.
int	getGrowBy() Returns whether or not a new row will be appended to the VIEW when a new record is added to the CDF document for the List.
int	getHeaderHeight() Returns the height of the header row in pixels.
int	getMultiSelect() Returns the selection type of this list.
int	getResizable() Returns whether columns in this list can be resized.
void	getResizeable() Deprecated. Renamed to getResizable.
Array<String>	getSelectedIds() Returns the ids of the selected records of this list.
jsx3.util.List<jsx3.xml.Entity>	getSelectedNodes() Returns the collection of selected records.
int	getSortColumn() Returns the zero-based index of column to sort on.
String	getSortDirection() Returns the direction (jsx3.gui.List.SORTASCENDING or jsx3.gui.List.SORTDESCENDING) for the sorted column; if no direction specified, ascending is returned
String	getSortPath() Returns the selection path for XSLT to use when sorting output.
String	getSortType() Returns the data type to be used for sorting this list.
String \| Array<String>	getValue() Returns the jsxid of the selected record if this list is a single-select list or an array of the the jsxids of the selected records if this list is a multi-select list.
static String	getVersion() Deprecated.
int	getWrap() Returns whether or not the rows in the grid will support text-wrapping and expand to display their wrapped content OR be a fixed height.
jsx3.xml.Document	getXSL() Returns xslt for the List, prioritizing the acquisition in the following order: 1) check cache; 2) check jsxxsl; 3) check jsxxslurl; 4) use default
boolean	isSelected(strRecordId : String) Returns whether or not the given record is selected (true/false)
static void	onCheck(strId : String, strPropName : String, objGUI : HTMLElement, bToggle : boolean, objArray : Object) Deprecated.
static void	onDelete(strId : String, objGUI : HTMLElement) Static function that can be called from XSLT-generated content in a list cell to delete a row from the CDF of a list instance.
static void	onRadio(strId : String, strPropName : String, objGUI : HTMLElement, bSelect : boolean, objArray : Object) provides function that can be called from XSLT-generated content in a list cell.
String	paint() Returns the DHTML, used for this object's on-screen VIEW
void	redrawRecord(strRecordId : String, intAction : int) List implementation.
void	repaintBody() Repaints the body portion of the list (the data rows), retaining the scroll position in the list whereas repainting the entire list would reset scroll position.
void	repaintHead() Repaints the head portion of the list (the header row).
void	revealRecord(strRecordId : String, objJSX : jsx3.gui.Block) Reveals a record by scrolling any ancestor blocks as necessary.
jsx3.gui.List	selectRecord(strRecordId : String) Selects a CDF record of this list.
void	setAutoExpand(bExpand : int) Deprecated. Replaced by `setGrowBy` which takes an integer argument rather than a boolean one.
jsx3.gui.List	setBackgroundColorHead(strBGColor : String) Sets the CSS color for the header row (for example, #ffffff)
jsx3.gui.List	setBackgroundHead(strBG : String) Sets the CSS background property (can be a composite of varoius CSS-related bg properties)
jsx3.gui.List	setCanReorder(intReorder : int) Sets whether the columns in the list can be re-ordered via user interaction with the VIEW
void	setCanResize() Deprecated. Renamed to setResizable.
jsx3.gui.List	setCanSort(SORT : int) Sets whether the list will render with sortable columns.
jsx3.gui.List	setGrowBy(intGrow : int) Sets whether or not a new row will be appended to the VIEW when a new record is added to the CDF document for the List.
jsx3.gui.List	setHeaderHeight(intHeight : int) Sets the height of the header row in pixels.
jsx3.gui.List	setMultiSelect(intMulti : int) Sets the selection type of this list.
jsx3.gui.List	setResizable(BOOLEAN : int) Sets whether columns in this list can be resized.
void	setResizeable() Deprecated. Renamed to setResizable.
jsx3.gui.List	setSortColumn(intColumnIndex : int) Sets the zero-based index of column to sort on and executes the sort.
jsx3.gui.List	setSortDirection(intSortDir : String) Sets the direction (ascending or descending) for the sorted column.
jsx3.gui.List	setSortPath(strPath : String) Sets the index for the column that the data will be sorted on; returns a ref to self;
jsx3.gui.List	setSortType(strDataType : String) Sets the data type for the list.
jsx3.gui.List	setValue(strRecordId : String \| Array<String>) Sets the selected records for this list.
jsx3.gui.List	setWrap(WRAP : int) Sets whether or not the rows in the grid will support text-wrapping and expand to display their wrapped content OR be a fixed height.
void	updateRow(strRecordId : String) Updates the DHTML (VIEW) for an existing row within a list, circumventing a full table repaint by updating the row directly.

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.app.Model
adoptChild, doClone, findAncestor, findDescendants, getAncestorOfName, getAncestorOfType, getChild, getChildIndex, getChildren, getDescendantOfName, getDescendantsOfType, getFirstChild, getFirstChildOfType, getHelpId, getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

getId, getLastChild, getLoadType, getMetaValue, getNS, getName, getNextSibling, getParent, getPersistence, getPreviousSibling, getServer, getUriResolver, insertBefore, load, loadAndCache, loadXML, onAfterAssemble, onAfterAttach, onBeforeAssemble, onChangeServer, onDestroy, onRemoveChild, onSetChild, onSetParent, removeChild, removeChildren, setChild, setHelpId, setLoadType, setMetaValue, setName, setPersistence, toString, toXML, toXMLDoc

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

DEFAULTBACKGROUNDCOLOR

static String DEFAULTBACKGROUNDCOLOR

#F3F2F4

DEFAULTBACKGROUNDCOLORHEAD

static String DEFAULTBACKGROUNDCOLORHEAD

#c8cfd8

DEFAULTBACKGROUNDHEAD

static String DEFAULTBACKGROUNDHEAD

background-image:url(JSX/images/list/header.gif);

DEFAULTROWCLASS

static String DEFAULTROWCLASS

jsx30list_r1

DEFAULTXSLURL

static String DEFAULTXSLURL

Deprecated.

JSX/xsl/[?fx]/jsx30list.xsl (default)

SELECTBGIMAGE

static String SELECTBGIMAGE

url(JSX/images/list/select.gif)

SORTASCENDING

static final String SORTASCENDING

ascending

SORTDESCENDING

static final String SORTDESCENDING

descending

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

appendRow

void appendRow(objMasterRecord : Object, strID : String)

Appends a new row to the end of the list and adds a corresponding record to the CDF source XML. This method requires that at least one CDF record already be present to use as a master to clone from if the objMasterRecord parameter is null.

Parameters:

objMasterRecord – JavaScript object containing at least the field jsxid.

strID – if provided this id will be used as the id (jsxid) for objMasterRecord. If null, a unique, system-generated key will be used.

clearXSL

jsx3.gui.List clearXSL()

Deprecated. use resetXslCacheData() instead.

List instances typically start with a baseline, system XSL file which is then extended at run-time to include the output markup specific to the child columns; calling this method will remove the document from the cache, effectively causing the template to reset; returns ref to self

Returns:

this object

deselectAllRecords

jsx3.gui.List deselectAllRecords()

Deselects all selected CDF records of this list.

Returns:

this object

deselectRecord

jsx3.gui.List deselectRecord(strRecordId : String)

Deselects a CDF record of this list. The item will be un-highlighted in the view and the CDF data will be updated accordingly.

Parameters:

strRecordId – the jsxid of the record to deselect.

Returns:

this object

deselectRecords

void deselectRecords()

Deprecated. use setValue() or deselectAllRecords() instead.

Deselects all selected records of this list. This method updates both the model and the view.

doClearSelections

void doClearSelections()

Deprecated. use setValue() or deselectAllRecords() instead.

Deselects all selected records of this list. This method updates both the model and the view.

doDeselect

jsx3.gui.List doDeselect(strRecordId : String, bVIEW : boolean)

Deprecated. use setValue() or deselectRecord() instead.

Deselects a given record for the list. Invokes the SELECT and CHANGE model events only under the deprecated 3.0 model event protocol.

Parameters:

strRecordId – 'jsxid' value for the record node (according to the CDF) to select in the DATA MODEL

bVIEW – true if null; if true, the selection state in the VIEW will be updated to reflect the selection within the MODEL

Returns:

this object

doExecute

void doExecute(strRecordId : String)

Deprecated. use executeRecord() instead.

Executes any bound code for a record of this list specified by the strRecordId parameter. If this parameter is omitted the code of any currently selected records is executed. Invokes the EXECUTE model event only under the deprecated 3.0 model event protocol.

Parameters:

strRecordIdprecated 3.0 model event protocol.

Parameters:

strRecordId – 'jsxid' value for the record node (according to the CDF) to execute

doSelect

jsx3.gui.List doSelect(strRecordId : String, bVIEW : boolean, bNoEvent : boolean, bReveal : ?)

Deprecated. use setValue() or selectRecord() instead.

Selects a given record for the list. Invokes the SELECT and CHANGE model events only under the deprecated 3.0 model event protocol.

Parameters:

strRecordId – 'jsxid' value for the record node (according to the CDF) to select in the DATA MODEL

bVIEW – true if null; if true, the selection state in the VIEW will be updated to reflect the selection within the MODEL

bNoEvent – if true, then don't invoke a selection event

bReveal –

Returns:

this object

doSort

void doSort(intSortDir : String)

Sorts this list according to the current sort path. If no sort direction is specified, the value will be toggled.

Parameters:

intSortDir – SORTASCENDING or SORTDESCENDING.

doValidate

int doValidate()

validates the list; if the list is set to 'required', a selection must be made to pass validation. Otherwise, a list will always pass validation

Returns:

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

Overrides:

doValidate in jsx3.gui.Form

executeRecord

void executeRecord(strRecordId : String)

Evaluates the JavaScript code in the jsxexecute attribute of one CDF record of this list.

Parameters:

strRecordId – the jsxid of the CDF record to execute.

focusRecord

jsx3.gui.List focusRecord(strRecordId : String)

Gives cursor focus to a row in the list.

Parameters:

strRecordId – the jsxid value for the record node (according to the CDF) to give focus to.

Returns:

this object

getActiveRow

HTMLElement getActiveRow()

Returns a handle to the active TR for the list.

Returns:

the JavaScript DOM object or null if no row is active.

getAutoExpand

int getAutoExpand()

Deprecated. Replaced by getGrowBy which returns an integer argument rather than a boolean.

Returns:

jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

getBackgroundColorHead

String getBackgroundColorHead()

Returns the CSS color for the header row (for example, "#ffffff"). If this value is not set (null) the list will render with the default value of jsx3.gui.List.DEFAULTBACKGROUNDCOLORHEAD.

Returns:

CSS color

getBackgroundHead

String getBackgroundHead()

Returns the CSS background property for the header row (for example, "background-image:url(abc.gif)"). If this value is not set (null) the list will render with the default value of jsx3.gui.List.DEFAULTBACKGROUNDHEAD.

Returns:

CSS background property

getCanReorder

int getCanReorder()

Returns whether the columns in the list can be re-ordered via user interaction. The default value is jsx3.Boolean.TRUE.

Returns:

one of: jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

getCanResize

void getCanResize()

Deprecated. Renamed to getResizable.

getCanSort

int getCanSort()

Returns whether the list will render with sortable columns.

Returns:

one of: jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

getGrowBy

int getGrowBy()

Returns whether or not a new row will be 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.

Returns:

jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

getHeaderHeight

int 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.List.DEFAULTHEADERHEIGHT.

Returns:

getMultiSelect

int getMultiSelect()

Returns the selection type of this list.

Returns:

MULTI, SINGLE, or NOTSELECTABLE.

getResizable

int getResizable()

Returns whether columns in this list can be resized. The default value is jsx3.Boolean.TRUE.

Returns:

jsx3.Boolean.TRUE or jsx3.Boolean.TRUE

getResizeable

void getResizeable()

Deprecated. Renamed to getResizable.

getSelectedIds

Array<String> getSelectedIds()

Returns the ids of the selected records of this list.

Returns:

JavaScript array of stings

getSelectedNodes

jsx3.util.List<jsx3.xml.Entity> getSelectedNodes()

Returns the collection of selected records.

Returns:

getSortColumn

int getSortColumn()

Returns the zero-based index of column to sort on.

Returns:

zero-based index of child column

getSortDirection

String getSortDirection()

Returns the direction (jsx3.gui.List.SORTASCENDING or jsx3.gui.List.SORTDESCENDING) for the sorted column; if no direction specified, ascending is returned

Returns:

one of: jsx3.gui.List.SORTASCENDING or jsx3.gui.List.SORTDESCENDING

getSortPath

String getSortPath()

Returns the selection path for XSLT to use when sorting output. Typically this is simply the name of the attribute preceded by '@' (i.e., @jsxtext, @social, @phone, etc); if no value exists (e.g., null), an empty string is returned

Returns:

selection path (xpath / xsl query)

getSortType

String getSortType()

Returns the data type to be used for sorting this list. This value is either the one explicitly set with setSortType() or the data type of the current sort.

Returns:

jsx3.gui.Column.TYPETEXT or jsx3.gui.Column.TYPENUMBER

getValue

String | Array<String> getValue()

Returns the jsxid of the selected record if this list is a single-select list or an array of the the jsxids of the selected records if this list is a multi-select list.

Returns:

Overrides:

getValue in jsx3.gui.Form

getVersion

static String getVersion()

Deprecated.

Returns the release/build for the class (i.e., "2.2.00")

Returns:

getWrap

int getWrap()

Returns whether or not the rows in the grid will support text-wrapping and expand to display their wrapped content OR be a fixed height. The default value is jsx3.Boolean.TRUE.

Returns:

jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

getXSL

jsx3.xml.Document getXSL()

Retur">jsx3.xml.Document getXSL()

Returns xslt for the List, 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

isSelected

boolean isSelected(strRecordId : String)

Returns whether or not the given record is selected (true/false)

Parameters:

strRecordId – jsxid property for the record to check selection state for

Returns:

onCheck

static void onCheck(strId : String, strPropName : String, objGUI : HTMLElement, bToggle : boolean, objArray : Object)

Deprecated.

provides function that can be called from XSLT-generated content in a list cell. Allows update of CDF via persistent mask interface (checkbox)

Parameters:

strId – CDF record id (jsxid)

strPropName – CDF attribute name for attribute that stores the value of the checkbox

objGUI – browser checkbox element (what was checked)

bToggle – if true, the checkbox will be toggled via this function and the result will be persisted. if false, the current state of the checkbox will be persisted.

objArray – 2-element JavaScript array. First element contains the value to insert into the CDF for @strPropName if the checkbox is checked. Second element is for unchecked states.

onDelete

static void onDelete(strId : String, objGUI : HTMLElement)

Static function that can be called from XSLT-generated content in a list cell to delete a row from the CDF of a list instance.

Parameters:

strId – CDF record id (jsxid) for the row to delete.

objGUI – browser element (the hyperlink was clicked) that is contained in the list instance.

onRadio

static void onRadio(strId : String, strPropName : String, objGUI : HTMLElement, bSelect : boolean, objArray : Object)

provides function that can be called from XSLT-generated content in a list cell. Allows update of CDF via persistent mask interface (radio button); assumes that the nodes in the CDF document have jsxgroupname attributes to distinguish the radio groups

Parameters:

strId – CDF record id (jsxid)

strPropName – CDF attribute name for attribute that stores the value of the radio button

objGUI – browser radio button element

bSelect – if true, the radio button will be forced to a 'selected' state and the result will be persisted. if false, the current state of the radio button will be persisted.

objArray – 2-element JavaScript array. First element contains the value to insert into the CDF for @strPropName if the checkbox is checked. Second element is for unchecked states.

paint

String paint()

Returns the DHTML, used for this object's on-screen VIEW

Returns:

DHTML

Overrides:

paint in jsx3.gui.Block

redrawRecord

void redrawRecord(strRecordId : String, intAction : int)

List implementation.

Parameters:

strRecordId – jsxid value for the record node (according to the CDF) to redraw

intAction – jsx3.xml.CDF.INSERT, jsx3.xml.CDF.DELETE, or jsx3.xml.CDF.UPDATE.

Overrides:

redrawRecord in jsx3.xml.CDF

repaintBody

void repaintBody()

Repaints the body portion of the list (the data rows), retaining the scroll position in the list whereas repainting the entire list would reset scroll position.

repaintHead

void repaintHead()

Repaints the head portion of the list (the header row).

Note that this method will not change the rendered height of the header row. Therefore, after the header height is changed programmatically, repaint() must be called for the list to render properly.

revealRecord

void revealRecord(strRecordId : String, objJSX : jsx3.gui.Block)

Reveals a record by scrolling any ancestor blocks as necessary.

Parameters:

strRecordId – the id of the record to reveal

objJSX – if provided, reveal the record up to this visual block; useful if the list is set to overflow:expand and the containing block is set to overflow:scroll

selectRecord

jsx3.gui.List 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.

Returns:

this object

setAutoExpand

void setAutoExpand(bExpand : int)

Deprecated. Replaced by setGrowBy which takes an integer argument rather than a boolean one.

Parameters:

bExpand – jsx3.Boolean.TRUE or jsx3.Boolean.FALSE.

setBackgroundColorHead

jsx3.gui.List setBackgroundColorHead(strBGColor : String)

Sets the CSS color for the header row (for example, #ffffff)

Parameters:

strBGColor – CSS color property

Returns:

this object

setBackgroundHead

jsx3.gui.List setBackgroundHead(strBG : String)

Sets the CSS background property (can be a composite of varoius CSS-related bg properties)

Parameters:

strBG – CSS background property

Returns:

this object

setCanReorder

jsx3.gui.List setCanReorder(intReorder : int)

Sets whether the columns in the list can be re-ordered via user interaction with the VIEW

Parameters:

intReorder – one of: jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

Returns:

this object

setCanResize

void setCanResize()

Deprecated. Renamed to setResizable.

setCanSort

jsx3.gui.List setCanSort(SORT : int)

Sets whether the list will render with sortable columns.

Parameters:

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

Returns:

this object

setGrowBy

jsx3.gui.List setGrowBy(intGrow : int)

Sets whether or not a new row will be 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.

Parameters:

intGrow – jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

Returns:

this object

setHeaderHeight

jsx3.gui.List setHeaderHeight(intHeight : int)

Sets the heiwhen 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.

Parameters:

intGrow – jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

Returns:

this object

setHeaderHeight

jsx3.gui.List setHeaderHeight(intHeight : int)

Sets the height of the header row in pixels. Set to zero (0) to hide the header row and only render the body rows for the list.

Parameters:

intHeight –

Returns:

this object

setMultiSelect

jsx3.gui.List setMultiSelect(intMulti : int)

Sets the selection type of this list.

Parameters:

intMulti – MULTI, SINGLE, or NOTSELECTABLE.

Returns:

this object

setResizable

jsx3.gui.List setResizable(BOOLEAN : int)

Sets whether columns in this list can be resized.

Parameters:

BOOLEAN – jsx3.Boolean.TRUE or jsx3.Boolean.TRUE

Returns:

this object

setResizeable

void setResizeable()

Deprecated. Renamed to setResizable.

setSortColumn

jsx3.gui.List setSortColumn(intColumnIndex : int)

Sets the zero-based index of column to sort on and executes the sort. This method fires the AFTER_SORT only under the deprecated 3.0 model event protocol.

Parameters:

intColumnIndex – zero-based index of child column

Returns:

this object

setSortDirection

jsx3.gui.List setSortDirection(intSortDir : String)

Sets the direction (ascending or descending) for the sorted column.

Parameters:

intSortDir – one of: jsx3.gui.List.SORTASCENDING or jection (ascending or descending) for the sorted column.

Parameters:

intSortDir – one of: jsx3.gui.List.SORTASCENDING or jsx3.gui.List.SORTDESCENDING

Returns:

this object

setSortPath

jsx3.gui.List setSortPath(strPath : String)

Sets the index for the column that the data will be sorted on; returns a ref to self;

Parameters:

strPath – selection path (xpath / xsl query)

Returns:

this object

setSortType

jsx3.gui.List setSortType(strDataType : String)

Sets the data type for the list. This explicit value will override any column data type if set. If it is not set the data type specific to the sort column is used for sorting.

Parameters:

strDataType – jsx3.gui.Column.TYPETEXT or jsx3.gui.Column.TYPENUMBER

Returns:

this object

setValue

jsx3.gui.List setValue(strRecordId : String | Array<String>)

Sets the selected records for this list. This method clears any current selection state and updates both the view and the model. The strRecordId parameter should be a single value for a single-select list or a list of values for a multi-select list.

Parameters:

strRecordId –

Returns:

this object

Overrides:

setValue in jsx3.gui.Form

setWrap

jsx3.gui.List setWrap(WRAP : int)

Sets whether or not the rows in the grid will support text-wrapping and expand to display their wrapped content OR be a fixed height.

Parameters:

WRAP – jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

Returns:

this object

updateRow

void updateRow(strRecordId : String)

Updates the DHTML (VIEW) for an existing row within a list, circumventing a full table repaint by updating the row directly.

Parameters:

strRecordId – id for the CDF record whose associated on-screen TR needs to be updated.

class List

All Implemented Interfaces:

Direct Known Subclasses:

See Also:

Parameters:

Parameters:

Returns:

See Also:

Returns:

Parameters:

Returns:

See Also:

See Also:

Parameters:

Returns:

See Also:

Parameters:

Parameters:

See Also:

Parameters:

Returns:

See Also:

Parameters:

See Also:

Returns:

Overrides:

Parameters:

Parameters:

Returns:

Returns:

Returns:

See Also:

Returns:

Returns:

Returns:

See Also:

Returns:

Returns:

Returns:

Returns:

Returns:

See Also:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Overrides:

Returns:

Returns:

Returns:

Overrides:

Parameters:

Returns:

Parameters:

Parameters:

Parameters:

Returns:

Overrides:

Parameters:

Overrides:

Parameters:

Parameters:

Returns:

Parameters:

See Also:

Parameters:

Returns:

Parameters:

Returns: