jsx3.gui.Matrix Model Events

jsx3.gui.MatrixAPI

Object
Object Type	The JSX foundation class that this object is an instance of.
ID	The unique, system-assigned ID for this object.
Name	Sets the name assigned by the developer to identify this object.
Models
Rendering Model	Sets if the data will be rendered flat (deep or shallow) or hierarchical.
Rendering Ctxt	Sets the jsxid for the parent record whose children and/or descendants will be painted.
Selection Model	Sets the selection model.
Paging Model	Sets the paging model.
Paging Tuners
Panel Pool Size	When rendering model is Matrix.PAGING_PAGED, the maximum allowed number of pooled panels.
Rows Per Panel	When rendering model is Matrix.PAGING_PAGED, the number of rows in a panel.
Panel Queue Size	When rendering model is Matrix.PAGING_PAGED, the maximum allowed number of panels in the paint queue.
Scroll Info	Returns the info label to display when scrolling a paged instance.
Box
BG Color	Sets the background color.
Background	Sets the CSS background definition, such as `background-image:url(abc.gif);background-repeat:repeat-x;`.
Header Height	Sets the height of the header row in implied pixels.
Row Height	Sets the height of the data rows.
Header Border	Sets the border for the header row.
Body Border	Sets the border for the body.
Scale Width	Sets whether or not the column widths should be scaled to fit within the visible region, or if a horizontal scrollbar should be used.
Hide H-Scroller	Sets whether or not to hide the horizontal scrollbar.
Hide V-Scroller	Sets whether or not to hide the vertical scrollbar.
Tree
Render Nav	Sets whether or not to render the navigation controls on the first column when rendering in hierarchical mode.
Close Icon	The 16x16 transparent .gif used to signal that clicking the item collapses its contents.
Open Icon	The 16x16 transparent .gif used to signal that clicking the item displays/expands its contents.
Icon	The icon to use for items in the tree.
Interaction
Sort Path	Sets the attribute path to sort on, such as `@jsxtext`.
Sort Data Type	Sets the default data type for columns in this list/grid.
Sort Direction	Sets whether the Grid is sorted ascending (a-z) or descending (z-a).
Sortable	Sets whether or not this column is sortable.
Resizable	Sets whether or not the instance is resizable.
Reorderable	Sets whether or not the instance is sortable.
Fixed Columns	Sets index of the first column that can be reordered.
Auto Row	Sets whether or not the instance allows new rows to be added at runtime via user interaction.
Can Drag From	If `true (1)` (Enabled), this object supports drag events and allows any contained item to be dragged and dropped on another container supporting drop.
Can Drop On	If `true (1)` (Enabled), this object can be the target of drop events.
Bound Menu	Sets the jsxname property for the context menu instance to display on a right-click.
Tab Index	Sets the tab index.
Required	Determines if the form input field is required.
Interaction Styles
Focus Style	Sets the CSS style(s) to apply to a cell when it has cursor focus.
Selection BG	Sets the URL of the background-image to apply to the cell/row background to designate it as selected.
Spy Styles	Sets the CSS style(s) to apply to a cell when the cursor 'mouses over' the cell and a spyglass is applied.
XML/XSL
XML Cache Id	Sets the cache ID for the XML document this object is mapped to.
XML String	Sets an XML document as a string.
XML URL	Sets the URL for the resource.
XML Transformers	A comma-separated list of XSLT transformers.
Share Resources	If set to Share, this object does not delete its associated document from the cache when removed from the DOM.
XML Async	If set to Asynchronous and the XML data source of this control is loaded from a URL, then the data is loaded asynchronously and a loading message is displayed in this control until the data loads.
XML Bind	If set to Bound this control automatically repaints every time its XML cache document changes.
Metadata
Load Type	Sets the load type of this DOM branch.
Annotation	The annotation comment visible in the Component Hierarchy palette.
Help ID	A unique ID for use with context-sensitive help.

Object Type

Read-Only. The JSX foundation class that this object is an instance of.

ID

Read-Only. The unique, system-assigned ID for this object.

Getter: getId()

Name

Sets the name assigned by the developer to identify this object.

Getter: getName()

Setter: setName()

Property: jsxname

Rendering Model

Sets if the data will be rendered flat (deep or shallow) or hierarchical.

Default Value: deep

Getter: getRenderingModel()

Setter: setRenderingModel()

Property: jsxrenderingmodel

Allowed Values:

Deep ('deep')
Shallow ('shallow')
Hierarchical ('hierarchical')

Rendering Ctxt

Sets the jsxid for the parent record whose children and/or descendants will be painted.

Default Value: jsxroot (this is the ID used by the <data> node)

Getter: getRenderingContext()

Setter: setRenderingContext()

Property: jsxrenderingcontext

Selection Model

Sets the selection model.

Default Value: Single Row (jsx3.gui.Matrix.SELECTION_ROW)

Getter: getSelectionModel()

Setter: setSelectionModel()

Property: jsxselectionmodel

Allowed Values:

Not Selectable (jsx3.gui.Matrix.SELECTION_UNSELECTABLE)
Single Row (jsx3.gui.Matrix.SELECTION_ROW)
Multi-row (jsx3.gui.Matrix.SELECTION_MULTI_ROW)

Paging Model

Sets the paging model.

Default Value: No paging (jsx3.gui.Matrix.PAGING_OFF)

Getter: getPagingModel()

Setter: setPagingModel()

Property: jsxpagingmodel

Allowed Values:

No paging (jsx3.gui.Matrix.PAGING_OFF)
2-pass (jsx3.gui.Matrix.PAGING_2PASS)
Chunked (jsx3.gui.Matrix.PAGING_CHUNKED)
Paged (jsx3.gui.Matrix.PAGING_PAGED)
Stepped (hierarchical) (jsx3.gui.Matrix.PAGING_STEPPED)

Panel Pool Size

When rendering model is Matrix.PAGING_PAGED, the maximum allowed number of pooled panels.

Default Value: 5 (jsx3.gui.Matrix.DEFAULT_PANEL_POOL_COUNT)

Getter: getPanelPoolSize()

Setter: setPanelPoolSize()

Property: jsxpanelpoolsize

Rows Per Panel

When rendering model is Matrix.PAGING_PAGED, the number of rows in a panel.

Default Value: 50 (jsx3.gui.Matrix.DEFAULT_ROWS_PER_PANEL)

Getter: getRowsPerPanel()

Setter: setRowsPerPanel()

Property: jsxrowsperpanel

Panel Queue Size

When rendering model is Matrix.PAGING_PAGED, the maximum allowed number of panels in the paint queue.

Default Value: 3 (jsx3.gui.Matrix.DEFAULT_PANEL_QUEUE_SIZE)

Getter: getPanelQueueSize()

Setter: setPanelQueueSize()

Property: jsxpaintqueuesize

Scroll Info

Returns the info label to display when scrolling a paged instance.

Default Value: jsx3.gui.Matrix.DEFAULT_INFO_LABEL

Getter: getScrollInfoLabel()

Setter: setScrollInfoLabel()

Property: jsxscrollinfolabel

BG Color

Sets the background color. Accepts valid CSS values, such as predefined color names, RGB, or hexadecimal values. For example, red, rgb(255,0,0), or #ff0000.

Default Value: The default background color specified in the static field, DEFAULTBACKGROUNDCOLOR, of the component class. For example, the default background color for a list is #f3f2f4 and is specified in jsx3.gui.List.DEFAULTBACKGROUNDCOLOR. See the API documentation for the component. For some components, this property is empty.

Getter: getBackgroundColor()

Setter: setBackgroundColor()

Property: jsxbgcolor

Background

Sets the CSS background definition, such as background-image:url(abc.gif);background-repeat:repeat-x;.

Default Value: Empty

Getter: getBackground()

Setter: setBackground()

Property: jsxbg

Header Height

Sets the height of the header row in implied pixels. Only positive integers are allowed. Set to 0 if the list does not use a header.

Default Value: jsx3.gui.Matrix.DEFAULT_HEADER_HEIGHT. See the API documentation for this component.

Getter: getHeaderHeight()

Setter: setHeaderHeight()

Property: jsxheaderheight

Row Height

Sets the height of the data rows. Set to 0 if the data rows should use a flex height.

Default Value: jsx3.gui.Matrix.DEFAULT_ROW_HEIGHT.

Getter: getRowHeight()

Setter: setRowHeight()

Property: jsxrowheight

Header Border

Sets the border for the header row.

Default Value: Empty

Getter: getHeaderBorder()

Setter: setHeaderBorder()

Property: jsxheaderborder

Body Border

Sets the border for the body. Note: to set the border for an individual column, update the APIs for the given column.

Default Value: Empty

Getter: getBodyBorder()

Setter: setBodyBorder()

Property: jsxbodyborder

Scale Width

Sets whether or not the column widths should be scaled to fit within the visible region, or if a horizontal scrollbar should be used.

Default Value: false (jsx3.Boolean.FALSE)

Getter: getScaleWidth()

Setter: setScaleWidth()

Property: jsxscalewidth

Allowed Values:

True (jsx3.Boolean.TRUE)
False (jsx3.Boolean.FALSE)

Hide H-Scroller

Sets whether or not to hide the horizontal scrollbar. Set to true to hide it.

Getter: getSuppressHScroller()

Setter: setSuppressHScroller()

Property: jsxsuppresshscroll

Allowed Values:

True (jsx3.Boolean.TRUE)
False (jsx3.Boolean.FALSE)

Hide V-Scroller

Sets whether or not to hide the vertical scrollbar. Set to true to hide it.

Getter: getSuppressVScroller()

Setter: setSuppressVScroller()

Property: jsxsuppressvscroll

Allowed Values:

True (jsx3.Boolean.TRUE)
False (jsx3.Boolean.FALSE)

Render Nav

Sets whether or not to render the navigation controls on the first column when rendering in hierarchical mode.

Getter: getRenderNavigators()

Setter: setRenderNavigators()

Property: jsxrendernavigators

Allowed Values:

True (jsx3.Boolean.TRUE)
False (jsx3.Boolean.FALSE)

Close Icon

The 16x16 transparent .gif used to signal that clicking the item collapses its contents.

Default Value: jsx3.gui.Matrix.ICON_MINUS. See the API documentation for this component.

Getter: getIconMinus()

Setter: setIconMinus()

Property: jsxiconminus

Open Icon

The 16x16 transparent .gif used to signal that clicking the item displays/expands its contents.

Default Value: jsx3.gui.Matrix.ICON_PLUS. See the API documentation for this component.

Getter: getIconPlus()

Setter: setIconPlus()

Property: jsxiconplus

Icon

The icon to use for items in the tree.

Default Value: jsx3.gui.Matrix.ICON. See the API documentation for this component.

Getter: getIcon()

Setter: setIcon()

Property: jsxicon

Sort Path

Sets the attribute path to sort on, such as @jsxtext.

Getter: getSortPath()

Setter: setSortPath()

Property: jsxsortpath

Sort Data Type

Sets the default data type for columns in this list/grid.

Default Value: Text (jsx3.gui.Column.TYPETEXT)

Getter: getSortType()

Setter: setSortType()

Property: jsxsorttype

Allowed Values:

Text (jsx3.gui.Matrix.Column.TYPE_TEXT)
Numerical (jsx3.gui.Matrix.Column.TYPE_NUMBER)

Sort Direction

Sets whether the Grid is sorted ascending (a-z) or descending (z-a).

Default Value: Ascending (jsx3.gui.List.SORTASCENDING)

Getter: getSortDirection()

Setter: setSortDirection()

Property: jsxsortdirection

Allowed Values:

Ascending (a-z) (jsx3.gui.Matrix.SORT_ASCENDING)
Descending (z-a) (jsx3.gui.Matrix.SORT_DESCENDING)

Sortable

Sets whether or not this column is sortable.

Getter: getCanSort()

Setter: setCanSort()

Property: jsxsort

Allowed Values:

True (jsx3.Boolean.TRUE)
False (jsx3.Boolean.FALSE)

Resizable

Sets whether or not the instance is resizable.

Getter: getResizable()

Setter: setResizable()

Property: jsxresize

Allowed Values:

True (jsx3.Boolean.TRUE)
False (jsx3.Boolean.FALSE)

Reorderable

Sets whether or not the instance is sortable.

Getter: getCanReorder()

Setter: setCanReorder()

Property: jsxreorder

Allowed Values:

True (jsx3.Boolean.TRUE)
False (jsx3.Boolean.FALSE)

Fixed Columns

Sets index of the first column that can be reordered. All columns of a lesser index can not be reordered.

Getter: getFixedColumnIndex()

Setter: setFixedColumnIndex()

Property: jsxfixedcolumnindex

Auto Row

Sets whether or not the instance allows new rows to be added at runtime via user interaction. Note that hierarchical rendering and pagination (Matrix.PAGING_PAGED) do not support the auto row behavior.

Getter: getAutoRow()

Setter: setAutoRow()

Property: jsxautorow

Allowed Values:

Disabled (jsx3.gui.Matrix.AUTOROW_NONE)
Last Row (jsx3.gui.Matrix.AUTOROW_LAST_ROW)
First Row (jsx3.gui.Matrix.AUTOROW_FIRST_ROW)

Can Drag From

If true (1) (Enabled), this object supports drag events and allows any contained item to be dragged and dropped on another container supporting drop.

Default Value: Disabled (jsx3.Boolean.FALSE)

Getter: getCanDrag()

Setter: setCanDrag()

Property: jsxdrag

Allowed Values:

Enabled (jsx3.Boolean.TRUE)
Disabled (jsx3.Boolean.FALSE)

Can Drop On

If true (1) (Enabled), this object can be the target of drop events.

Default Value: Disabled (jsx3.Boolean.FALSE)

Getter: getCanDrop()

Setter: getCanDrop()

Property: jsxdrop

Allowed Values:

Enabled (jsx3.Boolean.TRUE)
Disabled (jsx3.Boolean.FALSE)

Bound Menu

Sets the jsxname property for the context menu instance to display on a right-click.

Getter: getMenu()

Setter: setMenu()

Property: jsxmenu

Tab Index

Sets the tab index. When tabbing between controls, the index group this component belongs to.

Default Value: Empty

Getter: getIndex()

Setter: setIndex()

Property: jsxindex

Required

Determines if the form input field is required.

Default Value: Optional (jsx3.gui.Form.OPTIONAL)

Getter: getRequired()

Setter: setRequired()

Property: jsxrequired

Allowed Values:

Required (jsx3.gui.Form.REQUIRED)
Optional (jsx3.gui.Form.OPTIONAL)

Focus Style

Sets the CSS style(s) to apply to a cell when it has cursor focus. For example: color:red

Default Value: font-weight:bold (jsx3.gui.Matrix.FOCUS_STYLE)

Getter: getFocusStyle()

Setter: setFocusStyle()

Property: jsxfocusstyle

Selection BG

Sets the URL of the background-image to apply to the cell/row background to designate it as selected. For example, jsx:///images/matrix/select.gif

Default Value: jsx:///images/matrix/select.gif (jsx3.gui.Matrix.SELECTION_BG)

Getter: getSelectionBG()

Setter: setSelectionBG()

Property: jsxselectionbg

Spy Styles

Sets the CSS style(s) to apply to a cell when the cursor 'mouses over' the cell and a spyglass is applied.

Default Value: textDecoration:underline

Getter: getSpyStyles()

Setter: setSpyStyles()

Property: jsxspystyle

XML Cache Id

Sets the cache ID for the XML document this object is mapped to.

Default Value: Unique ID assigned by the system

Getter: getXMLId()

Setter: setXMLId()

Property: jsxxmlid

XML String

Sets an XML document as a string.

Getter: getXMLString()

Setter: setXMLString()

Property: jsxxml

XML URL

Sets the URL for the resource. This resource is synchronously loaded when this object is painted on-screen.

Getter: getXMLURL()

Setter: setXMLURL()

Property: jsxxmlurl

XML Transformers

A comma-separated list of XSLT transformers. The source XML will be transformed in series by each of the transformers listed here before being placed in the XML cache. Each transformer is either a URI to an XSLT file or the XML cache id of an XSLT document.

Getter: getXMLTransformers()

Setter: setXMLTransformers()

Property: jsxxmltrans

Share Resources

If set to Share, this object does not delete its associated document from the cache when removed from the DOM.

Default Value: Cleanup (jsx3.xml.Cacheable.CLEANUPRESOURCES)

Getter: getShareResources()

Setter: setShareResources()

Property: jsxshare

Allowed Values:

Cleanup (jsx3.xml.Cacheable.CLEANUPRESOURCES)
Share (jsx3.xml.Cacheable.SHARERESOURCES)

XML Async

If set to Asynchronous and the XML data source of this control is loaded from a URL, then the data is loaded asynchronously and a loading message is displayed in this control until the data loads.

Default Value: Synchronous (jsx3.Boolean.FALSE)

Getter: getXmlAsync()

Setter: setXmlAsync()

Property: jsxxmlasync

Allowed Values:

Asynchronous (jsx3.Boolean.TRUE)
Synchronous (jsx3.Boolean.FALSE)

XML Bind

If set to Bound this control automatically repaints every time its XML cache document changes.

Default Value: Not Bound (jsx3.Boolean.FALSE)

Getter: getXmlBind()

Setter: setXmlBind()

Property: jsxxmlbind

Allowed Values:

Bound (jsx3.Boolean.TRUE)
Not Bound (jsx3.Boolean.FALSE)

Load Type

Sets the load type of this DOM branch.

Default Value: Normal (jsx3.app.Model.LT_NORMAL)

Getter: getLoadType()

Setter: setLoadType()

Property: jsxloadtype

Allowed Values:

Normal (jsx3.app.Model.LT_NORMAL)
Paint Async. (jsx3.app.Model.LT_SLEEP_PAINT)
Deserialize Async. (jsx3.app.Model.LT_SLEEP_DESER)
Paint & Deser. Async. (jsx3.app.Model.LT_SLEEP_PD)
Paint on Show (jsx3.app.Model.LT_SHOW_PAINT)
Deserialize on Show (jsx3.app.Model.LT_SHOW_DESER)

Annotation

The annotation comment visible in the Component Hierarchy palette.

Property: jsxannotation

Help ID

A unique ID for use with context-sensitive help.

Getter: getHelpId()

Setter: setHelpId()

Property: jsxhelpid