Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the TreeTable widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.

Hierarchy

Index

Properties

allowUnsorting: boolean

When true columns can be unsorted upon clicking sort.

behaviors: Record<string, Behavior>

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

Whether cell editors are loaded lazily.

cellSeparator: string

Separator text to use in output mode of editable cells with multiple components.

disabledTextSelection: boolean

Disables text selection on row click.

editInitEvent: string

Event that triggers row/cell editing.

editMode: EditMode

If editing is enables and whether entire rows or individual cells can be edited.

editable: boolean

Whether data in this data table can be edited.

event: string

Prefix of the event namespace used by the tree table.

expandMode: ExpandMode

Updates children only when set to children or the node itself with children when set to self on node expand.

filter: boolean

Whether filtering is enabled on this tree table.

filterDelay: number

Delay in milliseconds the filtering.

filterEvent: string

Event that trigger the tree table to be filtered.

formId?: string

ID of the form to use for AJAX requests.

id: string | string[]

The client-side ID of the widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

liveResize: boolean

Columns are resized live in this mode without using a resize helper.

multiSort: boolean

Whether multi sort (filtering by multiple columns) is enabled.

nativeElements: boolean

Whether native checkbox elements should be used for selection.

nodeType: string

Type of the row nodes of this tree table.

paginator: Partial<PaginatorCfg>

When pagination is enabled: The paginator configuration for the paginator.

postConstruct: PostConstructCallback

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).

postRefresh: PostRefreshCallback

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.

preDestroy: PreDestroyCallback

An optional callback that is invoked before this widget is about to be destroyed, e.g., when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

propagateSelectionDown: boolean

Defines if selections should propagate down.

propagateSelectionUp: boolean

Defines if selections should propagate up.

resizableColumns: boolean

Defines if columns can be resized or not.

saveOnCellBlur: boolean

Saves the changes in cell editing on blur, when set to false changes are discarded.

scrollHeight: number

Height of scrollable data.

scrollWidth: number

Width of scrollable data.

scrollable: boolean

Whether or not the data should be scrollable.

How rows may be selected.

sortMetaOrder: string[]

IDs of the columns by which to order. Order by the first column, then by the second, etc.

sorting: boolean

true if sorting is enabled on the data table, false otherwise.

stickyHeader: boolean

Sticky header stays in window viewport during scrolling.

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Generated using TypeDoc