jsx3.gui

class Matrix

Object

->jsx3.lang.Object

->jsx3.app.Model

->jsx3.gui.Painted

->jsx3.gui.Block

->jsx3.gui.Matrix

All Implemented Interfaces:

jsx3.gui.Form, jsx3.gui.Interactive, jsx3.util.EventDispatcher, jsx3.xml.CDF, jsx3.xml.Cacheable

class Matrix
extends jsx3.gui.Block

The Matrix control is the standard visual interface for the Common Data Format (CDF), providing grid and tree-grid functionality that mirrors the the record and attribute structures used by the CDF. Instances of this class can be used to create editable grids, selectable lists, trees, tables, etc. In addtion to providing layout, selection, and editing schemes, the Matrix also provides various paging models to help optimize how (and how much) data is rendered on-screen. The Matrix class is always used in conjunction with jsx3.gui.Matrix.Column, which describes how data for a given series should be rendered on-screen. While the Matrix manages data and user interactions, Column manages the on-screen format for how the data is presented.

Since:

3.2

Nested Class Summary
jsx3.gui.Matrix.BlockMask	The interface that defines the methods that affect the behavior of a composite object used as an edit mask of a matrix column.
jsx3.gui.Matrix.Column	Column control for use as a child of a jsx3.gui.Matrix class
jsx3.gui.Matrix.ColumnFormat	A class that defines the methods required for an object to be used by Matrix.Column instances to format cells of data.
jsx3.gui.Matrix.EditMask	The interface defining the methods that affect the behavior of an object used as an edit mask in a matrix column.

Field Summary
static String	APPEND_IMG jsx:///images/matrix/append.gif
static int	AUTOROW_FIRST_ROW 2
static int	AUTOROW_LAST_ROW 1
static int	AUTOROW_NONE 0
static int	AUTO_SCROLL_INTERVAL 50
static String	DEFAULTXSLURL
static int	DEFAULT_HEADER_HEIGHT 20
static String	DEFAULT_INFO_LABEL Deprecated. This value is localized.
static int	DEFAULT_PANEL_POOL_COUNT 18.
static int	DEFAULT_PANEL_QUEUE_SIZE 3.
static int	DEFAULT_REAPER_INTERVAL 250.
static int	DEFAULT_ROWS_PER_PANEL 50.
static int	DEFAULT_ROW_HEIGHT 20
static String	DEFAULT_XSL_URL Deprecated. Renamed to `DEFAULTXSLURL`.
static String	FOCUS_STYLE font-weight:bold
static String	ICON jsx:///images/matrix/file.gif (default)
static String	ICON_MINUS jsx:///images/matrix/minus.gif (default)
static String	ICON_PLUS jsx:///images/matrix/plus.gif (default)
static String	INSERT_BEFORE_IMG jsx:///images/matrix/insert_before.gif
static String	MINIMUM_COLUMN_WIDTH 4.
static String	ON_PAINT_PAGE jsxpaintpage.
static int	PAGING_2PASS The outer container is first painted and then the entirety of the data is painted during a second pass
static int	PAGING_CHUNKED The outer container is first painted.
static int	PAGING_OFF Default.
static int	PAGING_PAGED The outer container is first painted.
static int	PAGING_STEPPED The outer container is painted along with any rows which are immediate children of the rendering context and those descendant rows that have an open path to the context node.
static String	SELECTION_BG jsx:///images/matrix/select.gif
static int	SELECTION_MULTI_ROW 2
static int	SELECTION_ROW 1 (default)
static int	SELECTION_UNSELECTABLE 0
static String	SORT_ASCENDING ascending
static String	SORT_ASCENDING_IMG jsx:///images/matrix/sort_asc.gif (default)
static String	SORT_DESCENDING descending
static String	SORT_DESCENDING_IMG jsx:///images/matrix/sort_desc.gif (default)

Constructor Summary
void	init(strName : String) instance initializer

Method Summary
void	adoptChild(objChild : jsx3.app.Model, bRepaint : boolean, bForce : boolean) Instance override
void	commitAutoRowSession(objEvent : jsx3.gui.Event, intCellIndex : int) Commits any active autorow session.
jsx3.xml.Entity	deleteRecord(strRecordId : String, bRedraw : boolean) Removes a record from the XML data source of this object.
void	deselectAllRecords() Deselects all selected CDF records.
void	deselectRecord(strRecordId : String) Deselects a CDF record within the Matrix.
void	doSort(intSortDir : String) Sorts according to the current sort path.
int	doValidate()
void	executeRecord(strRecordId : String) Evaluates the JavaScript code in the jsxexecute attribute of one CDF record of this list.
void	focusCellById(strCdfId : String, strAttName : String) Applies focus to the on-screen cell that corresponds to the intersection of the element in the CDF source document identified by strCdfId, and the first column mapped to strAttName.
void	focusCellByIndex(strCdfId : String, intCellIndex : int) Applies focus to the on-screen cell that corresponds to the intersection of the element in the CDF source document identified by strCdfId, and the cell at the given index.
void	focusRowById(strCdfId : String) Applies focus to the on-screen row that corresponds to the element in the CDF source document identified by strCdfId.
int	getAutoRow() Returns whether or not an 'auto append' row will be rendered, allowing the user to automatically add new rows to the instance.
Object	getAutoRowSession() Returns an object array of name/value pairs representing the current auto row session.
String	getBodyBorder() Returns CSS property value(s) for a border (border: solid 1px #000000)
int	getCanReorder() Returns whether the column children can be reordered via user interaction.
int	getCanSort() Returns whether the list will render with sortable columns.
HTMLElement	getContentElement(strCdfId : String, strAttName : String) Returns the HTML element that represents the intersection of the row identified by strCdfId and the first column mapped to the named CDF attribute, strAttName.
int	getFixedColumnIndex(strDefault : String) Returns the zero-based index of the on-screen column(s), to the left of which will be fixed and cannot be reordered.
String	getFocusStyle(strDefault : String) Returns the CSS string to apply to a Row/Cell when it has focus
String	getHeaderBorder() Returns CSS property value(s) for a border (border: solid 1px #000000)
int	getHeaderHeight(strDefault : String) Returns the height of the header row in pixels.
String	getIcon(strDefault : String) Returns the icon to use for those CDF records that do not explicitly specify an icon via the jsximg attribute
String	getIconMinus(strDefault : String) Returns the icon to use when the given tree node is in an open state.
String	getIconPlus(strDefault : String) Returns the icon to use when the given tree node is in a closed state.
int	getPagingModel(strDefault : String) Returns how data should be painted on-screen.
int	getPanelPoolSize(strDefault : String) Returns the number panels (a panel contains a collection of rows--getRowsPerPanel()) that should be part of the pool.
int	getPanelQueueSize(strDefault : String) Sets the number of panels that are allowed in the queue waiting to be painted.
int	getReaperInterval(strDefault : String) Returns the the number of milliseconds to wait before checking for inactive panels to garbage collect.
int	getRenderNavigators(strDefault : String) Returns whether or not to render the navigation controls that are applied to the first column when rendering model is hierarchical.
String	getRenderingContext(strDefault : String) Returns the jsxid of the CDF record that will serve as the origin when rendering the data on-screen.
String	getRenderingModel(strDefault : String) Returns the rendering model (how rows will be painted on-screen).
int	getResizable() Returns whether or not this column can be resized by the user.
int	getRowHeight(strDefault : String) Returns the row height
int	getRowsPerPanel(strDefault : String) Returns the number of rows each panel should contain.
int	getScaleWidth() Returns whether or not the column widths should be adjusted (decremented) such that all columns fit within the viewport.
int	getScrollInfoLabel(strDefault : String) Returns the info label to display when scrolling a paged instance, in order to show the scroll position.
int	getScrollLeft() Returns the horizontal scroll position of the list.
int	getScrollTop() Returns the vertical scroll position.
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.Matrix.SORT_ASCENDING or jsx3.gui.Matrix.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.
Array	getSortedIds() Returns an array of all jsxid attributes in the source CDF in the order they would appear if painted on-screen
int	getSuppressHScroller(strDefault : String) Returns whether or not to supress display of the horizontal scrollbar.
int	getSuppressVScroller(strDefault : String) Returns whether or not to supress display of the vertical scrollbar.
String \| Array<String>	getValue() Returns an array of selected values (or empty array) if the selection model is Matrix.SELECTION_MULTI_ROW.
jsx3.xml.Document	getXSL() Deprecated. Per-instance control of the XSL template is deprecated
void	insertBefore(objMoveChild : jsx3.app.Model, objPrecedeChild : jsx3.app.Model, bRepaint : boolean) Assigns objMoveChild as the previousSibling of objPrecedeChild
jsx3.xml.CDF	insertRecordProperty(strRecordId : String, strPropName : String, strPropValue : String, bRedraw : boolean) Inserts a new property into an existing record with jsxid equal to strRecordId.
String	paint() Returns the DHTML, used for this object's on-screen VIEW
void	paintChild(objJSX : jsx3.app.Model, bGroup : ?) inserts DHTML (as string) into IE's on-screen DOM as a child of the object's on-screen VIEW
void	redrawCell(strRecordId : String, objColumn : jsx3.gui.Matrix.Column, bSuppressTriggers : boolean) Updates the on-screen cell to reflect the value in the CDF document to which the cell is mapped.
void	redrawMappedCells(strRecordId : String, strAttName : String) Updates the on-screen cell to reflect the value in the CDF document to which the cell is mapped.
void	redrawRecord(strRecordId : String, intAction : int, bRecurse : boolean) Matrix implementation.
String	repaint() Updates the view of this object by calling paint() and replacing the current view with the returned HTML.
void	repaintData() Paints only the data rows.
void	repaintHead() Repaints the header row for improved runtime efficiency.
void	resetFocusContext(strId : ?) Removes the focus style from whichever cell is designated to have focus context.
void	resetMask() Ends any existing edit session and hides the active mask.
void	resetXmlCacheData(objServer : jsx3.app.Server) Removes the XML source document stored under the XML ID of this object from the server cache.
void	revealRecord(strRecordId : String) Reveals a record by toggling parent nodes open (if rendering hierarcally) and scrolling the record into view.
void	selectRecord(strRecordId : String) Selects a CDF record of this list.
void	setAutoRow(intBoolean : int) Sets whether or not an 'auto append' row will be rendered, allowing the user to automatically add new rows to the instance.
jsx3.gui.Block	setBodyBorder(strCSS : String, bSuppressRepaint : boolean) Sets CSS property value(s) for a border (border: solid 1px #000000).
void	setCanReorder(REORDER : int) Sets whether the columns in the list can be re-ordered via user interaction with the VIEW
void	setCanSort(SORT : int) Sets whether the list will render with sortable columns.
void	setFixedColumnIndex(intIndex : int) Sets the zero-based index of the on-screen column(s), to the left of which will be fixed and cannot be reordered.
void	setFocusStyle(strCSS : String) Sets the CSS string to apply to a Row/Cell when it has focus.
void	setHeaderBorder(strCSS : String) Sets CSS property value(s) for a border on the header row (border: solid 1px #000000).
void	setHeaderHeight(intHeight : int, bSuppressRepaint : boolean) Sets the height of the header row in pixels.
void	setIcon(strURL : String) Sets the icon to use for those CDF records that do not explicitly specify an icon via the jsximg attribute
void	setIconMinus(strURL : String) Sets the icon to use when the given tree node is in an open state.
void	setIconPlus(strURL : String) Sets the icon to use when the given tree node is in a closed state.
void	setPagingModel(intModel : int) Sets how data should be painted on-screen.
void	setPanelPoolSize(intCount : int) Sets the number panels (a panel contains a collection of rows--getRowsPerPanel()) that should be part of the pool.
void	setPanelQueueSize(intCount : int) Sets the number of panels that are allowed in the queue waiting to be painted.
void	setReaperInterval(intInterval : int) Sets the the number of milliseconds to wait before checking for inactive panels to garbage collect.
void	setRenderNavigators(intTrueFalse : int, bSuppressRepaint : boolean) Sets whether or not to render the navigation controls on the first column when being rendered in hierarchical mode.
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	setRenderingModel(MODEL : String, bSuppressRepaint : boolean) Sets the rendering model (how rows will be painted on-screen).
void	setResizable(RESIZE : int) Sets whether or not this column can be resized by the user.
void	setRowHeight(intHeight : int, bSuppressRepaint : boolean) Sets the on-screen row height.
void	setRowsPerPanel(intCount : int, bSuppressRepaint : boolean) Sets the number of rows each panel should contain.
void	setScaleWidth(intBoolean : int) Sets whether or not the column widths should be adjusted such that all columns visually display within the viewport.
void	setScrollInfoLabel(strLabel : String) Sets the standard info label to display when scrolling to show the scroll position.
void	setScrollLeft(intScrollLeft : int) Sets the horizontal scroll position.
void	setScrollTop(intScrollTop : int, objGUI : HTMLElement) Sets the vertical scroll position.
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.
void	setSuppressHScroller(intTrueFalse : int) Sets whether or not to supress display of the horizontal scrollbar.
void	setSuppressVScroller(intTrueFalse : int, bSuppressRepaint : boolean) Sets whether or not to supress display of the vertical scrollbar.
jsx3.gui.Matrix	setValue(strId : String \| Array<String>) Sets the value of this matrix.
jsx3.xml.Cacheable	setXMLId(strXMLId : String) Sets the XML ID of this object.
jsx3.xml.Cacheable	setXMLString(strXML : String) Sets the XML string of this object.
jsx3.xml.Cacheable	setXMLURL(strXMLURL : String) Sets the XML URL of this object.
void	synchronizeVScroller() Updates the scroll height and scroll position of the vertical scrollbar.
void	toggleItem(strRecordId : String, bOpen : boolean) Toggles the open/closed state for a node in the Matrix

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, 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.
void	setSuppressHScroller(intTrueFalse : int) Sets whether or not to supress display of the horizontal scrollbar.
void	setSuppressVScroller(intTrueFalse : int, bSuppressRepaint : boolean) Sets whether or not to supress display of the vertical scrollbar.
jsx3.gui.Matrix	setValue(strId : String \| Array<String>) Sets the value of this matrix.
jsx3.xml.Cacheable	setXMLId(strXMLId : String) Sets the XML ID of this object.
jsx3.xml.Cacheable	setXMLString(strXML : String) Sets the XML string of this object.
jsx3.xml.Cacheable	setXMLURL(strXMLURL : String) Sets the XML URL of this object.
void	synchronizeVScroller() Updates the scroll height and scroll position of the vertical scrollbar.
void	toggleItem(strRecordId : String, bOpen : boolean) Toggles the open/closed state for a node in the Matrix

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, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLTransformers, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

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, resetXslCacheData, setNodeSet, setShareResources, setSourceXML, setXMLTransformers, setXSLId, setXSLParam, setXSLString, setXSLURL, setXmlAsync, setXmlBind

Methods Inherited From jsx3.xml.CDF
adoptRecord, adoptRecordBefore, convertProperties, deleteRecordProperty, getRecord, getRecordNode, insertRecord, insertRecordBefore, insertRecordNode, 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.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, paintChildren, recalcBox, removeAttribute, removeAttributes, setAttribute, setDynamicProperty

Methods Inherited From jsx3.app.Model
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, 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.app.Model

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, 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

APPEND_IMG

static String APPEND_IMG

jsx:///images/matrix/append.gif

AUTOROW_FIRST_ROW

static final int AUTOROW_FIRST_ROW

AUTOROW_LAST_ROW

static final int AUTOROW_LAST_ROW

AUTOROW_NONE

static final int AUTOROW_NONE

AUTO_SCROLL_INTERVAL

static int AUTO_SCROLL_INTERVAL

DEFAULTXSLURL

static String DEFAULTXSLURL

DEFAULT_HEADER_HEIGHT

static int DEFAULT_HEADER_HEIGHT

DEFAULT_INFO_LABEL

static String DEFAULT_INFO_LABEL

Deprecated. This value is localized.

"Viewing rows {0} to {1} of {2}".
Wildcards are as follows:

{0} The index position of the first visible on-screen row
{1} The index position of the last visible on-screen row
{2} Total count of all records in the list

DEFAULT_PANEL_POOL_COUNT

static int DEFAULT_PANEL_POOL_COUNT

18. number of panels allowed on-screen before destroying the panel most distant from the current panel index

DEFAULT_PANEL_QUEUE_SIZE

static int DEFAULT_PANEL_QUEUE_SIZE

3. number of panels in the paint queue. As new panels are added to the queue to be painted, older, less-relevant panels in the queue are removed

DEFAULT_REAPER_INTERVAL

static int DEFAULT_REAPER_INTERVAL

250. number of milliseconds between the time a new panel is added and the reaper checks for content exceeding Matrix.DEFAULT_PANEL_POOL_COUNT

DEFAULT_ROWS_PER_PANEL

static int DEFAULT_ROWS_PER_PANEL

50. number of rows in a given panel

DEFAULT_ROW_HEIGHT

static int DEFAULT_ROW_HEIGHT

DEFAULT_XSL_URL

static String DEFAULT_XSL_URL

Deprecated. Renamed to DEFAULTXSLURL.

FOCUS_STYLE

static String FOCUS_STYLE

font-weight:bold

ICON

static String ICON

jsx:///images/matrix/file.gif (default)

ICON_MINUS

static String ICON_MINUS

jsx:///images/matrix/minus.gif (default)

ICON_PLUS

static String ICON_PLUS

jsx:///images/matrix/plus.gif (default)

INSERT_BEFORE_IMG

static String INSERT_BEFORE_IMG

jsx:///images/matrix/insert_before.gif

MINIMUM_COLUMN_WIDTH

static final String MINIMUM_COLUMN_WIDTH

4. minimum width of a column when minimized (set Display to 'none' to completely hide a column)

ON_PAINT_PAGE

static final String ON_PAINT_PAGE

jsxpaintpage. Event to subscribe to each time a page of content is about to be painted on-screen

PAGING_2PASS

static final int PAGING_2PASS

The outer container is first painted and then the entirety of the data is painted during a second pass

PAGING_CHUNKED

static final int PAGING_CHUNKED

The outer container is first painted. Chunked sets of data are painted on-screen during repeated passes until all data is painted

PAGING_OFF

static final int PAGING_OFF

Default. All data is painted at once with the outer container.

PAGING_PAGED

static final int PAGING_PAGED

The outer container is first painted. The first and last panels are painted during a second pass. As the user scrolls, relevant panels are added and unused panels are collected. (NOTE: Requires that row height be fixed.)

PAGING_STEPPED

static final int PAGING_STEPPED

The outer container is painted along with any rows which are immediate children of the rendering context and those descendant rows that have an open path to the context node. All other rows will be fetched when the state for their on-screen parent row is toggled to open.

SELECTION_BG

static String SELECTION_BG

jsx:///images/matrix/select.gif

SELECTION_MULTI_ROW

static final int SELECTION_MULTI_ROW

SELECTION_ROW

static final int SELECTION_ROW

1 (default)

SELECTION_UNSELECTABLE

static final int SELECTION_UNSELECTABLE

SORT_ASCENDING

static final String SORT_ASCENDING

ascending

SORT_ASCENDING_IMG

static String SORT_ASCENDING_IMG

jsx:///images/matrix/sort_asc.gif (default)

SORT_DESCENDING

static final String SORT_DESCENDING

descending

SORT_DESCENDING_IMG

static String SORT_DESCENDING_IMG

jsx:///images/matrix/sort_desc.gif (default)

sc"> descending

SORT_DESCENDING_IMG

static String SORT_DESCENDING_IMG

jsx:///images/matrix/sort_desc.gif (default)

Constructor Detail

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

adoptChild

void adoptChild(objChild : jsx3.app.Model, bRepaint : boolean, bForce : boolean)

Instance override

Parameters:

objChild – the child to adopt

bRepaint – if true or null, the object being adopted will be added to the parent's view via the parent's paintChild() method. This parameter is made available for those situations where a loop is executing and multiple objects are being adopted. As view operations are the most CPU intensive, passing false while looping through a collection of child objects to adopt will improve performance. After the last child is adopted, simply call repaint() on the parent to immediately synchronize the view.

bForce – if true, the adoption is forced, even if the parent/child don't accept such adoptions (onSetChild() and onSetParent() will still be called)

Overrides:

adoptChild in jsx3.app.Model

commitAutoRowSession

void commitAutoRowSession(objEvent : jsx3.gui.Event, intCellIndex : int)

Commits any active autorow session.

Parameters:

objEvent – If passed, Allows Model Event to fire.

intCellIndex – Focus will be applied to the autorow cell at this index (zero-based)

deleteRecord

jsx3.xml.Entity deleteRecord(strRecordId : String, bRedraw : boolean)

Removes a record from the XML data source of this object.

Parameters:

strRecordId – the jsxid attribute of the data record to remove.

bRedraw – if true or null, the on-screen view of this object is immediately updated to reflect the deleted record.

Returns:

the record removed from the data source or null if no such record found.

Overrides:

deleteRecord in jsx3.xml.CDF

deselectAllRecords

void deselectAllRecords()

Deselects all selected CDF records.

deselectRecord

void deselectRecord(strRecordId : String)

Deselects a CDF record within the Matrix. 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 value will be toggled.

Parameters:

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

doValidate

int doValidate()

Returns:

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.

focusCellById

void focusCellById(strCdfId : String, strAttName : String)

Applies focus to the on-screen cell that corresponds to the intersection of the element in the CDF source document identified by strCdfId, and the first column mapped to strAttName.

Parameters:

strCdfId – jsxid property for CDF record

strAttName – attribute name on the CDF record. For example, jsxtext

focusCellByIndex

void focusCellByIndex(strCdfId : String, intCellIndex : int)

Applies focus to the on-screen cell that corresponds to the intersection of the element in the CDF source document identified by strCdfId, and the cell at the given index.

Parameters:

strCdfId – jsxid property for CDF record

intCellIndex – zero-based index of cell (on-screen).

focusRowById

void focusRowById(strCdfId : String)

Applies focus to the on-screen row that corresponds to the element in the CDF source document identified by strCdfId. Note that since only cells can receive focus, this method will apply focus to the first cell child in the row.

Parameters:

strCdfId – jsxid property for CDF record

getAutoRow

int getAutoRow()

Returns whether or not an 'auto append' row will be rendered, allowing the user to automatically add new rows to the instance.

Returns:

jsx3.Boolean.TRUE or jsx3.Boolean.FALSE

getAutoRowSession

Object getAutoRowSession()

Returns an object array of name/value pairs representing the current auto row session. When the session is committed, this object will be converted into a CDF Record for the instance.

Returns:

getBodyBorder

String getBodyBorder()

Returns CSS property value(s) for a border (border: solid 1px #000000)

Returns:

getCanReorder

int getCanReorder()

Returns whether the column children can be reordered via user interaction. If no value is supplied the isntance will allow child columns to be reordered.

Returns:

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

getCanSort

int getCanSort()

Returns whether the list will render with sortable columns. If null or jsx3.Boolean.TRUE, the instance is sortable.

Returns:

getContentElement

HTMLElement getContentElement(strCdfId : String, strAttName : String)

Returns the HTML element that represents the intersection of the row identified by strCdfId and the first column 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:

getFixedColumnIndex

int getFixedColumnIndex(strDefault : String)

Returns the zero-based index of the on-screen column(s), to the left of which will be fixed and cannot be reordered. For example, if this value is set to 1, the first column can never be reordered and will always remain the first column. If this value is set to 2, the first two columns will be fixed. Setting this value to 0 is effectively the same as setting it to null

Parameters:

strDefault – The default value to use if null

Returns:

positive integer

getFocusStyle

String getFocusStyle(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 (Matrix.FOCUS_STYLE)

Returns:

getHeaderBorder

String getHeaderBorder()

Returns CSS property value(s) for a border (border: solid 1px #000000)

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.Matrix.DEFAULT_HEADER_HEIGHT.

Parameters:

strDefault – The default value to use if null

Returns:

getIcon

String getIcon(strDefault : String)

Returns the icon to use for those CDF records that do not explicitly specify an icon via the jsximg attribute

Parameters:

strDefault – The default value to use if null

Returns:

URL for icon to use. If null, jsx3.gui.Matrix.ICON will be applied when rendered.

getIconMinus

String getIconMinus(strDefault : String)

Returns the icon to use when the given tree node is in an open state.

Parameters:

strDefault – The default value to use if null

Returns:

URL for icon. If null, jsx3.gui.Matrix.ICON_MINUS will be applied when rendered.

getIconPlus

String getIconPlus(strDefault : String)

Returns the icon to use when the given tree node is in a closed state.

Parameters:

strDefault – The default value to use if null

Returns:

URL for icon to use. If null, jsx3.gui.Matrix.ICON_PLUS will be applied when rendered.

getPagingModel

int getPagingModel(strDefault : String)

Returns how data should be painted on-screen. If no value is specified, Matrix.PAGING_OFF will be applied. Note that the rendering model limits the available paging models:

Matrix.PAGING_OFF: Paint everthing to screen at once (container and data) (rendering model: all)
Matrix.PAGING_2PASS: Paint outer container and then perform a second pass to paint the data. (rendering model: deep, shallow)
Matrix.PAGING_CHUNKED: Paint outer container and then perform repeated paints until all data has been painted, regardless of scroll position. (rendering model: deep, shallow)
Matrix.PAGING_PAGED: Paint outer container. Paint First and last panels during second pass. Paint relevant panels when user scrolls to a given position. Discard excess panels. (rendering model: deep, shallow)
Matrix.PAGING_STEPPED: Paint root nodes and any open descendants. Paint others as they are toggled open. (rendering model: hierarchical)

Parameters:

strDefault – The default value to use if null

Returns:

getPanelPoolSize

int getPanelPoolSize(strDefault : String)

Returns the number panels (a panel contains a collection of rows--getRowsPerPanel()) that should be part of the pool. If a panel count greater than this value exists, scrolls to a given position. Discard excess panels. (rendering model: deep, shallow)

Matrix.PAGING_STEPPED: Paint root nodes and any open descendants. Paint others as they are toggled open. (rendering model: hierarchical)

Parameters:

strDefault – The default value to use if null

class Matrix

All Implemented Interfaces:

Since:

Parameters:

Parameters:

Overrides:

See Also:

Parameters:

Parameters:

Returns:

Overrides:

Parameters:

Parameters:

See Also:

Returns:

Overrides:

Parameters:

Parameters:

Parameters:

Parameters:

See Also:

Returns:

Returns:

Returns:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

See Also:

Parameters:

Returns:

See Also: