Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xe:djxDataGrid

f:javax.faces.Component
   xe:com.ibm.xsp.dojo.Widget
      xe:djxDataGrid

Description

Dojo Data Grid

Properties

Java

Java Class: com.ibm.xsp.extlib.component.dojo.grid.UIDojoDataGrid


basics

binding, object - javax.faces.component.UIComponent  [Inherited]
Control Binding
Specifies an expression that binds the control to a particular control property.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding false
loaded, boolean  [Inherited]
Loaded
Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
id, string  [Inherited]
Control Identifier
Specifies the name identifier for the control. No two controls can have the same name identifier in a single page.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
rendered, boolean  [Inherited]
Rendered Flag
Indicates whether or not the control should be displayed or processed on any subsequent form submission.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rendererType, string  [Inherited]
Renderer Type
Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true

dojo

dojoType, string  [Inherited]
Dojo Type
Sets the default Dojo Type used to create this control in the browser.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dojoAttributes, Collection of xp:dojoAttribute - com.ibm.xsp.dojo.DojoAttribute  [Inherited]
Dojo Attributes
Specifies a list of Dojo attributes.
Required Attribute false

dojo-widget

dir, string  [Inherited]
Direction
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dragRestriction, boolean  [Inherited]
Drag Restriction
To remove the drag capability
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
group, string  [Inherited]
Group
Defines a group belonging.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
lang, string  [Inherited]
Lang
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
waiRole, string  [Inherited]
ARIA Role
ARIA Role
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
waiState, string  [Inherited]
ARIA State
ARIA State
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
jsId, string
Js ID
The name of a JavaScript variable that will be created that will hold the grid object. This can then be referenced in scripts.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
store, string
Store
The name of JavaScript variable that holds the store object used to get data for the grid.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rowSelector, string
Row Selector
Specifying this table option adds a selection area on the left of the table to make row selection easier. The value of this option is a width to be used for the selector.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
selectionMode, string
Selection Mode
This option defines how row selection is handled
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
columnReordering, boolean
Column Reordering
This boolean property allows columns to be dynamically reordered. When enabled, a column header can be dragged and dropped at a new location causing the column to be moved.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
headerMenu, string
Header Menu
A menu can be associated with a header. This attribute names a dijit.Menu which is displayed when the header is clicked.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
autoHeight, int
Auto Height
A value that defines the height of the table in rows.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
singleClickEdit, boolean
Single Click Edit
A boolean value that defines whether a single or double click is needed to enter cell editing mode.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
loadingMessage, string
Loading Message
The message to show while the content of the grid is loading.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
errorMessage, string
Error Message
The message to show if an error has occurred loading the data.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
selectable, boolean
Selectable
Set to true if you want to enable text selection on your grid.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
updateDelay, int
Update Delay
A value, in milliseconds (default 1) to delay updates when receiving notifications from a datastore. Set to 0 to update your grid immediately. A larger value will result in a more performant grid when there are lots of datastore notifications happening, but there will be significant lag time in the update on-screen. The default value of 1 will basically re-render changes once the browser is idle.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
initialWidth, string
Initial Width
A CSS string value to use for autoWidth grids as their initial width. If not set, it defaults to the sum width of all columns. If set, it overrides any values passed to the grid via css or the html style parameter on the source node.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rowsPerPage, int
Rows displayed per apge
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
query, string
Query
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
escapeHTMLInData, boolean
escapeHTMLInData
This will escape HTML brackets from the data to prevent HTML from user-inputted data being rendered with may contain JavaScript and result in XSS attacks. This is true by default, and it is recommended that it remain true. Setting this to false will allow data to be displayed in the grid without filtering, and should be only used if it is known that the data won't contain malicious scripts. If HTML is needed in grid cells, it is recommended that you use the formatter function to generate the HTML (the output of formatter functions is not filtered, even with escapeHTMLInData set to true).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
storeComponentId, string
Component Store id
The REST service component id. This supercedes storeId to point to the actual store id.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

events

onBlur, string  [Inherited]
On Blur
Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onClick, string  [Inherited]
On Click
Connect to this function to receive notifications of mouse click events
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onClose, string  [Inherited]
On Close
Callback if someone tries to close the child, child will be closed if func returns true
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onDblClick, string  [Inherited]
On Double Click
Connect to this function to receive notifications of mouse double click events
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onFocus, string  [Inherited]
On Focus
Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onKeyDown, string  [Inherited]
On Key Down
Connect to this function to receive notifications of keys being pressed down
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onKeyPress, string  [Inherited]
On Key Press
Connect to this function to receive notifications of printable keys being typed.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onKeyUp, string  [Inherited]
On Key Up
Connect to this function to receive notifications of keys being released
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseDown, string  [Inherited]
On Mouse Down
Connect to this function to receive notifications of when the mouse button is pressed down
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseEnter, string  [Inherited]
On Mouse Enter
Connect to this function to receive notifications of when the mouse moves onto this widget
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseLeave, string  [Inherited]
on Mouse Leave
Connect to this function to receive notifications of when the mouse moves off of this widget
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseMove, string  [Inherited]
On Mouse Move
Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseOut, string  [Inherited]
On Mouse Out
Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseOver, string  [Inherited]
On Mouse Over
Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseUp, string  [Inherited]
On Mouse Uo
Connect to this function to receive notifications of when the mouse button is released
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onStyleRow, string
On StyleRow
TBD
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onRowClick, string
On Row Click
Fired when a row is clicked. The event contains references to the grid, cell and rowIndex.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onRowDblClick, string
On Row Double Click
Fired when a row is double clicked. The event contains references to the grid, cell and rowIndex.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onRowContextMenu, string
On Row ContextMenu
Fired when a row is selected and then right clicked.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

styling

disableTheme, boolean  [Inherited]
Disable Theme
A flag used to determine if the theme should be applied to this control.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
themeId, string  [Inherited]
Theme Id
The theme id that should be used to set the component properties when a theme is applied
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
style, string  [Inherited]
Style
HTML style attributes as cssText string or name/value hash
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
styleClass, string  [Inherited]
Style Class
HTML class attribute
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true